Feat/general upgrade

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/fuzzy-dancers-unite.md

@@ -0,0 +1,5 @@
+---
+'node-rest-client': minor
+---
+
+add family args (PR #204 Update: add family args)

.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
+{
+	"name": "Node.js & TypeScript",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/typescript-node:1-22-bookworm"
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.docker/Dockerfile

@@ -0,0 +1,118 @@
+FROM alpine:3.17
+
+ENV NODE_VERSION 18.18.0
+
+RUN addgroup -g 1000 node \
+    && adduser -u 1000 -G node -s /bin/sh -D node \
+    && apk add --no-cache \
+        libstdc++ \
+    && apk add --no-cache --virtual .build-deps \
+        curl \
+    && ARCH= && alpineArch="$(apk --print-arch)" \
+      && case "${alpineArch##*-}" in \
+        x86_64) \
+          ARCH='x64' \
+          CHECKSUM="1159f06f17f7c2e582c77e4602249b440bd1daab667694063f1d61fb621aa65c" \
+          ;; \
+        *) ;; \
+      esac \
+  && if [ -n "${CHECKSUM}" ]; then \
+    set -eu; \
+    curl -fsSLO --compressed "https://unofficial-builds.nodejs.org/download/release/v$NODE_VERSION/node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz"; \
+    echo "$CHECKSUM  node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz" | sha256sum -c - \
+      && tar -xJf "node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz" -C /usr/local --strip-components=1 --no-same-owner \
+      && ln -s /usr/local/bin/node /usr/local/bin/nodejs; \
+  else \
+    echo "Building from source" \
+    # backup build
+    && apk add --no-cache --virtual .build-deps-full \
+        binutils-gold \
+        g++ \
+        gcc \
+        gnupg \
+        libgcc \
+        linux-headers \
+        make \
+        python3 \
+    # use pre-existing gpg directory, see https://github.com/nodejs/docker-node/pull/1895#issuecomment-1550389150
+    && export GNUPGHOME="$(mktemp -d)" \
+    # gpg keys listed at https://github.com/nodejs/node#release-keys
+    && for key in \
+      4ED778F539E3634C779C87C6D7062848A1AB005C \
+      141F07595B7B3FFE74309A937405533BE57C7D57 \
+      74F12602B6F1C4E913FAA37AD3A89613643B6201 \
+      DD792F5973C6DE52C432CBDAC77ABFA00DDBF2B7 \
+      61FC681DFB92A079F1685E77973F295594EC4689 \
+      8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600 \
+      C4F0DFFF4E8C1A8236409D08E73BC641CC11F4C8 \
+      890C08DB8579162FEE0DF9DB8BEAB4DFCF555EF4 \
+      C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C \
+      108F52B48DB57BB0CC439B2997B01419BD92F80A \
+      A363A499291CBBC940DD62E41F10027AF002F8B0 \
+    ; do \
+      gpg --batch --keyserver hkps://keys.openpgp.org --recv-keys "$key" || \
+      gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$key" ; \
+    done \
+    && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION.tar.xz" \
+    && curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/SHASUMS256.txt.asc" \
+    && gpg --batch --decrypt --output SHASUMS256.txt SHASUMS256.txt.asc \
+    && gpgconf --kill all \
+    && rm -rf "$GNUPGHOME" \
+    && grep " node-v$NODE_VERSION.tar.xz\$" SHASUMS256.txt | sha256sum -c - \
+    && tar -xf "node-v$NODE_VERSION.tar.xz" \
+    && cd "node-v$NODE_VERSION" \
+    && ./configure \
+    && make -j$(getconf _NPROCESSORS_ONLN) V= \
+    && make install \
+    && apk del .build-deps-full \
+    && cd .. \
+    && rm -Rf "node-v$NODE_VERSION" \
+    && rm "node-v$NODE_VERSION.tar.xz" SHASUMS256.txt.asc SHASUMS256.txt; \
+  fi \
+  && rm -f "node-v$NODE_VERSION-linux-$ARCH-musl.tar.xz" \
+  && apk del .build-deps \
+  # smoke tests
+  && node --version \
+  && npm --version
+
+ENV YARN_VERSION 1.22.19
+
+RUN apk add --no-cache --virtual .build-deps-yarn curl gnupg tar \
+  # use pre-existing gpg directory, see https://github.com/nodejs/docker-node/pull/1895#issuecomment-1550389150
+  && export GNUPGHOME="$(mktemp -d)" \
+  && for key in \
+    6A010C5166006599AA17F08146C2130DFD2497F5 \
+  ; do \
+    gpg --batch --keyserver hkps://keys.openpgp.org --recv-keys "$key" || \
+    gpg --batch --keyserver keyserver.ubuntu.com --recv-keys "$key" ; \
+  done \
+  && curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz" \
+  && curl -fsSLO --compressed "https://yarnpkg.com/downloads/$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz.asc" \
+  && gpg --batch --verify yarn-v$YARN_VERSION.tar.gz.asc yarn-v$YARN_VERSION.tar.gz \
+  && gpgconf --kill all \
+  && rm -rf "$GNUPGHOME" \
+  && mkdir -p /opt \
+  && tar -xzf yarn-v$YARN_VERSION.tar.gz -C /opt/ \
+  && ln -s /opt/yarn-v$YARN_VERSION/bin/yarn /usr/local/bin/yarn \
+  && ln -s /opt/yarn-v$YARN_VERSION/bin/yarnpkg /usr/local/bin/yarnpkg \
+  && rm yarn-v$YARN_VERSION.tar.gz.asc yarn-v$YARN_VERSION.tar.gz \
+  && apk del .build-deps-yarn \
+  # smoke test
+  && yarn --version
+
+
+ARG USERNAME="aacerox"
+ARG GITHUB_TOKEN=""
+
+# add git and clone project
+RUN apk add --no-cache git \
+  && git config --global credential.helper store \
+  && echo "https://${USERNAME}:${GITHUB_TOKEN}@github.com" > ~/.git-credentials \
+  && mkdir /opt/node-rest-client
+
+VOLUME /opt/node-rest-client
+
+COPY docker-entrypoint.sh /usr/local/bin/
+ENTRYPOINT ["docker-entrypoint.sh"]
+
+CMD [ "node" ]

.docker/build-nrc.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker build --build-arg GITHUB_TOKEN=$1  -t node:nrc  .

.docker/docker-entrypoint.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+set -e
+
+# Run command with node if the first argument contains a "-" or is not a system command. The last
+# part inside the "{}" is a workaround for the following bug in ash/dash:
+# https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=874264
+if [ "${1#-}" != "${1}" ] || [ -z "$(command -v "${1}")" ] || { [ -f "${1}" ] && ! [ -x "${1}" ]; }; then
+  set -- node "$@"
+fi
+
+exec "$@"

.docker/run-nrc.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker run --name nrc-dev-container --rm -v $(pwd)/..:/opt/node-rest-client -it node:nrc /bin/sh

.eslintrc.json

@@ -0,0 +1,15 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": "google",
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "rules": {
+    }
+}

.github/workflows/nrc-job-apply-version.yml

@@ -0,0 +1,57 @@
+on:
+    workflow_call:
+        inputs:
+          isRelease:
+            description: flag a release invocation 
+            type: boolean
+            default: false
+          version:
+            description: version to apply to package.json files
+            type: string
+            required: true          
+jobs:
+ apply-version:    
+    runs-on: ubuntu-latest    
+    steps:
+      - id: checkout
+        name: checkout project
+        uses: actions/checkout@v3
+
+      - id: installNode
+        name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: 'npm'
+
+      # generate changelog if its a release    
+      - id: generateReleaseChangelog
+        name: create release changelog
+        if: ${{ inputs.isRelease }}         
+        run: echo "generate change log"
+
+      # apply version to package.json files and create a git tag          
+      - id: applyVersion
+        name: apply version to package.json files
+        env:
+          VERSION: ${{ inputs.version }}
+          IS_RELEASE: ${{ inputs.isRelease }}
+        run: |
+          export RELEASE_COMMENT=""
+
+          if [ "$IS_RELEASE" == "true" ]; then
+            RELEASE_COMMENT="release"
+          fi         
+
+          npm version -m "apply $RELEASE_COMMENT version $VERSION"     
+
+      # create release PR  
+      - id: createReleasePR
+        name: create release PR
+        if: ${{ inputs.isRelease }}
+        run: echo "create release PR"
+
+
+
+
+

.github/workflows/nrc-job-build-test.yml

@@ -0,0 +1,23 @@
+on:
+    workflow_call:         
+jobs:
+  build-test:
+    runs-on: ubuntu-latest    
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: 'npm'          
+      # clean install          
+      - run: npm ci                    
+        name: NRC Install
+      # build
+      - run: npm run build --if-present
+        name: NRC Build
+      # test
+      - run: npm test
+        name: NRC Test
+
+

.github/workflows/nrc-job-generate-version.yml

@@ -0,0 +1,27 @@
+on:
+    workflow_call:         
+        outputs:
+            version:                
+                description: version calculated by git version
+                value: ${{ jobs.generate-version.outputs.semVer }}
+jobs:
+ generate-version:    
+    runs-on: ubuntu-latest    
+    outputs:
+      semVer: ${{ steps.generateVersion.outputs.semVer }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      # install git version
+      - id: installVersion
+        name: Install GitVersion
+        uses: gittools/actions/gitversion/setup@v0
+        with:
+          versionSpec: '5.x'
+          preferLatestVersion: true
+      # calculate git version
+      - id:   generateVersion # id to later be referenced
+        name: calculate semver        
+        uses: gittools/actions/gitversion/execute@v0
+

.github/workflows/nrc-job-release.yml

@@ -0,0 +1,47 @@
+on:
+    workflow_call:             
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'aacerox/node-rest-client' }}
+    steps:
+      # checkout repo
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      # read latest tag    
+      - id: readLatestTag
+        name: read latest tag
+        run: echo "latestTag=$(git describe --tags --abbrev=0)" >> "$GITHUB_OUTPUT"
+      # setup node.js
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: 'npm'
+      # install repo dependencies    
+      - id: cleanInstallRepo
+        name: clean install repo
+        run: npm ci
+      # run changeset action
+      # - when push from normal PR: the 'version' command is executed. A new release branch and PR 
+      #   is created if it doesn't exists and if it does exists the commit is added to release branch
+      #
+      # - when push from release PR: the 'publish' command is executed and artifact are published to npm
+      - id: changesetPR
+        name: Changeset release
+        uses: changesets/action@v1
+        env:
+          NRC_RELEASE_MSG: "node-rest-client release ${{ steps.readLatestTag.outputs.latestTag }}"        
+          GITHUB_TOKEN: ${{ secrets.NRC_GITHUB_TOKEN }}
+        with:
+          version: npm run version:packages
+          publish: npm run publish:packages
+          commit: "chore(release): ${{ env.NRC_RELEASE_MSG }}"
+          title: "${{ env.NRC_RELEASE_MSG }}"  
+
+
+
+
+

.github/workflows/nrc-workflow-ci.yml

@@ -0,0 +1,24 @@
+name: Node-Rest-Client CI
+on:
+  push:
+    branches:      
+      - master 
+      - 'release/**'
+# just one workflow active, for the same branch
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  # test
+  test:
+    uses: ./.github/workflows/nrc-job-build-test.yml
+
+  # changeset release
+  release:
+    uses: ./.github/workflows/nrc-job-release.yml  
+
+
+
+
+
+
+

.github/workflows/nrc-workflow-pr.yml

@@ -0,0 +1,9 @@
+name: Node-Rest-Client PR
+on:
+  pull_request:
+    branches:
+      - master    
+jobs:
+  build-test:
+    uses: ./.github/workflows/nrc-job-build-test.yml
+