feat: implement the baseline node sdk (#3)

* feat: init

* chore: sync

* chore: sync

* using prettier and single quote

* finish all tests

* add spec test

* add docs

Co-authored-by: frankzhaopeng <poryzhao@featureprobe.com>

Author: hezean

.github/licenserc.yml

@@ -0,0 +1,14 @@
+header:
+  license:
+    spdx-id: Apache-2.0
+    copyright-owner: FeatureProbe
+
+  paths:
+    - 'src/**/*'
+    - '**/*.ts'
+    - '**/*.js'
+
+  paths-ignore:
+    - '**/*.md'
+
+  comment: on-failure

.github/workflows/codeql.yml

@@ -0,0 +1,60 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  schedule:
+    - cron: '0 18 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+          submodules: recursive
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
+
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+      # - run: |
+      #   echo "Run, Build Application using script"
+      #   ./location_of_script_within_repo/buildscript.sh
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/license.yml

@@ -0,0 +1,54 @@
+name: "Check license & format"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request_target:
+
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Checkout commit
+        if: github.event_name == 'push'
+        uses: actions/checkout@v3
+
+      - name: Checkout pull request
+        if: github.event_name == 'pull_request_target'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+
+
+      - name: Check license headers
+        uses: apache/skywalking-eyes@v0.3.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          config: .github/licenserc.yml
+          mode: fix
+
+      - name: Commit licensed files
+        if: github.event_name == 'pull_request_target'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: EndBug/add-and-commit@v8.0.2
+        with:
+          default_author: github_actions
+          message: "chore: add license header(s)"
+
+      - name: Create pull request
+        if: github.event_name == 'push'
+        uses: peter-evans/create-pull-request@v3
+        with:
+          author: GitHub Actions <41898282+github-actions[bot]@users.noreply.github.com>
+          commit-message: "chore: add license header(s)"
+          title: "chore: add license header(s)"
+          body: Add missing license header(s) in source and test code.
+          branch: add-license

.github/workflows/npm-publish.yml

@@ -0,0 +1,40 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [ created ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+          submodules: recursive
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+          submodules: recursive
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.github/workflows/semantic-title.yml

@@ -0,0 +1,37 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          wip: true
+          ignoreLabels: |
+            bot
+            ignore-semantic-pull-request
+
+      - name: Hint valid formats
+        if: ${{ failure() }}
+        uses: thollander/actions-comment-pull-request@v1.4.1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          message: |
+            Please adjust your PR title to match the [Conventional Commits spec](https://www.conventionalcommits.org/).
+            
+            For example:
+            - fix: fix http client code 
+            - feat: allow provided config object to extend other configs
+            - refactor!: drop support for node 6
+            - feat(ui): add button component

.github/workflows/test.yml

@@ -0,0 +1,43 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: >-
+    ${{ github.workflow }}-
+    ${{ github.ref_type }}-
+    ${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+          submodules: recursive
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm run test:cov
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3

.gitignore

@@ -0,0 +1,14 @@
+node_modules/
+.DS_Store
+typings
+
+# Logs
+logs
+*.log
+
+.vscode/
+.idea/
+
+coverage/
+
+dist/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/fixtures/spec"]
+	path = test/fixtures/spec
+	url = git@github.com:FeatureProbe/server-sdk-specification.git

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "printWidth": 120
+}

README.md

@@ -1,2 +1,30 @@
-# server-sdk-node
-FeatureProbe Server Side SDK for Node.js
+# FeatureProbe Server Side SDK for Node.js
+
+[![Top Language](https://img.shields.io/github/languages/top/FeatureProbe/server-sdk-node)](https://github.com/FeatureProbe/server-sdk-node/search?l=rust)
+[![Coverage Status](https://coveralls.io/repos/github/FeatureProbe/server-sdk-node/badge.svg?branch=demo)](https://coveralls.io/github/FeatureProbe/server-sdk-node?branch=demo)
+[![Github Star](https://img.shields.io/github/stars/FeatureProbe/server-sdk-node)](https://github.com/FeatureProbe/server-sdk-node/stargazers)
+[![Apache-2.0 license](https://img.shields.io/github/license/FeatureProbe/FeatureProbe)](https://github.com/FeatureProbe/FeatureProbe/blob/demo/LICENSE)
+
+FeatureProbe is an open source feature management service. This SDK is used to control features in Node.js programs. This
+SDK is designed primarily for use in multi-user systems such as web servers and applications.
+
+## Basic Terms
+
+Reading the short [Introduction](https://docs.featureprobe.io/reference/sdk-introduction) will help to understand the code blow more easily.  [中文](https://docs.featureprobe.io/zh-CN/reference/sdk-introduction)
+
+## How to Use This SDK
+
+See [SDK Doc](https://docs.featureprobe.io/how-to/Server-Side%20SDKs/node-sdk) for detail.  [中文](https://docs.featureprobe.io/zh-CN/how-to/Server-Side%20SDKs/node-sdk)
+
+## Contributing
+
+We are working on continue evolving FeatureProbe core, making it flexible and easier to use.
+Development of FeatureProbe happens in the open on GitHub, and we are grateful to the
+community for contributing bugfixes and improvements.
+
+Please read [CONTRIBUTING](https://github.com/FeatureProbe/featureprobe/blob/master/CONTRIBUTING.md)
+for details on our code of conduct, and the process for taking part in improving FeatureProbe.
+
+## License
+
+This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.