Feat/sd 960 node sdk v4

.github/workflows/build.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
 
       - name: Install dependencies
         run: npm ci

.github/workflows/commitlint.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
 
       - name: Install dependencies
         run: npm install

.github/workflows/eslint.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x.x
+          node-version: 18.x.x
 
       - name: Install dependencies
         run: npm ci

.github/workflows/jest-tests.yml

@@ -1,42 +1,73 @@
-name: Jest tests
+name: Clone Bitbucket Repo and test
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main", "feat/SD-960-node-sdk-v4"]
   pull_request:
     types: [opened, synchronize]
 
 jobs:
   tests:
     name: Run Jest tests
     timeout-minutes: 15
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
+    runs-on: ubuntu-latest
+    env:
+      REGION: ${{ vars.REGION }}
+      ENVIRONMENT: ${{ vars.ENVIRONMENT }}
+      AWS_THIRD_PARTY_API_REGION: ${{ vars.AWS_THIRD_PARTY_API_REGION }}
+      ACCOUNT: ${{ secrets.ACCOUNT }}
+      SEED_API_KEY: ${{ secrets.SEED_API_KEY }}
+      SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
+      SEGMENT_WRITE_KEY: ${{ secrets.SEGMENT_WRITE_KEY }}
+      SEGMENT_SOURCE_ID: ${{ secrets.SEGMENT_SOURCE_ID }}
+      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+      SALABLE_STRIPE_SECRET_KEY: ${{ secrets.SALABLE_STRIPE_SECRET_KEY }}
+      SALABLE_STRIPE_TEST_SECRET_KEY: ${{ secrets.SALABLE_STRIPE_TEST_SECRET_KEY }}
+      DATABASE_URL: ${{ secrets.DATABASE_URL }}
+      LAUNCHDARKLY_KEY: ${{ secrets.LAUNCHDARKLY_KEY }}
+      KMS_ENCRYPTION_KEY_ARN: ${{ secrets.KMS_ENCRYPTION_KEY_ARN }}
+      SALABLE_BASE_URL: ${{ secrets.SALABLE_BASE_TEST_URL }}
+      SALABLE_TEST_API_KEY: ${{ secrets.SALABLE_TEST_API_KEY }}
+      STRIPE_ACCOUNT_ID: ${{ secrets.STRIPE_ACCOUNT_ID }}
+      STRIPE_KEY: ${{ secrets.STRIPE_KEY }}
 
     steps:
-      - name: Check out code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
+        - name: Checkout this repository
+          uses: actions/checkout@v3
+          with:
+            fetch-depth: 0 # Fetch all history to avoid shallow clone issues
+
+        - name: Set up SSH agent
+          uses: webfactory/ssh-agent@v0.7.0
+          with:
+            ssh-private-key: ${{ secrets.BITBUCKET_SSH_KEY }}
+
+        - name: Add Bitbucket to known_hosts
+          run: |
+            mkdir -p ~/.ssh
+            ssh-keyscan bitbucket.org >> ~/.ssh/known_hosts
+
+        - name: Clone Bitbucket repository
+          run: |
+            git clone ${{ vars.SALABLE_API_REPO_URL }}
+            if [ ! -d "salable-api" ]; then
+                echo "Error: Directory 'salable-api' does not exist."
+                exit 1
+            fi
+
+        - name: Build and deploy
 
-      - name: Fetch main branch
-        run: git fetch --no-tags --depth=1000 origin main
+          run: |
+            cd salable-api
+            npm ci
+            npx prisma generate
+            npx prisma db push --force-reset
+            npx sst build --stage node-sdk --region ${{ vars.REGION }}
+            npx sst deploy --stage node-sdk --region ${{ vars.REGION }}
 
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16.x.x
+        - name: Install dependencies
+          run: npm ci
 
-      - name: Install dependencies
-        run: npm install
-
-      - name: Jest Tests Overall
-        run: npm run test
-
-      - name: Jest Tests Code Coverage (branch)
-        run: npm run test:coverage
-
-      - name: Jest Tests Code Coverage (global)
-        run: npm run test:globalCoverage
+        - name: Jest Tests Overall
+          run: npm run test

.husky/commit-msg

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx --no -- commitlint --edit ""
+npx --no -- commitlint --edit ""

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run pre-commit
+npm test

.husky/pre-push

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npm run test:coverage

.npmignore

@@ -0,0 +1,3 @@
+prisma
+
+test-utils

.prettierrc.json

@@ -2,7 +2,7 @@
   "singleQuote": true,
   "semi": true,
   "arrowParens": "always",
-  "printWidth": 100,
+  "printWidth": 300,
   "bracketSpacing": true,
   "tabWidth": 2
 }

CHANGELOG.md

@@ -1,56 +1,48 @@
 ## [3.4.1](https://github.com/Salable/node-sdk/compare/v3.4.0...v3.4.1) (2024-10-10)
 
-
 ### Bug Fixes
 
-* deprecate rbac ([b75d464](https://github.com/Salable/node-sdk/commit/b75d464d1d01a9d801f097920bdf89758aadaecd))
+- deprecate rbac ([b75d464](https://github.com/Salable/node-sdk/commit/b75d464d1d01a9d801f097920bdf89758aadaecd))
 
 # [3.4.0](https://github.com/Salable/node-sdk/compare/v3.3.0...v3.4.0) (2024-07-12)
 
-
 ### Features
 
-* **SD-168:** added verify-signature method ([c8b4a42](https://github.com/Salable/node-sdk/commit/c8b4a42a83fa72e6884adcfac96cefbddaf0dc20))
+- **SD-168:** added verify-signature method ([c8b4a42](https://github.com/Salable/node-sdk/commit/c8b4a42a83fa72e6884adcfac96cefbddaf0dc20))
 
 # [3.3.0](https://github.com/Salable/node-sdk/compare/v3.2.1...v3.3.0) (2024-02-01)
 
-
 ### Bug Fixes
 
-* fixed licenses cancelMany method ([3cf5fe7](https://github.com/Salable/node-sdk/commit/3cf5fe7c052befd466f94c034214d4dec5043700))
-
+- fixed licenses cancelMany method ([3cf5fe7](https://github.com/Salable/node-sdk/commit/3cf5fe7c052befd466f94c034214d4dec5043700))
 
 ### Features
 
-* currency and quantity parameters added checkout link and pricing table methods ([f822750](https://github.com/Salable/node-sdk/commit/f82275015c83fac69df2b0ab7b6b681821334c24))
+- currency and quantity parameters added checkout link and pricing table methods ([f822750](https://github.com/Salable/node-sdk/commit/f82275015c83fac69df2b0ab7b6b681821334c24))
 
 ## [3.2.1](https://github.com/Salable/node-sdk/compare/v3.2.0...v3.2.1) (2023-12-05)
 
-
 ### Bug Fixes
 
-* added isTest to the response types ([46ba143](https://github.com/Salable/node-sdk/commit/46ba14365b7393b43a4d0417ecf6785d60633bc6))
+- added isTest to the response types ([46ba143](https://github.com/Salable/node-sdk/commit/46ba14365b7393b43a4d0417ecf6785d60633bc6))
 
 # [3.2.0](https://github.com/Salable/node-sdk/compare/v3.1.0...v3.2.0) (2023-11-27)
 
-
 ### Features
 
-* added grace as an optional parameter to license check ([39105e8](https://github.com/Salable/node-sdk/commit/39105e806c7dfc4ddbafc0e825e19a8628532457))
+- added grace as an optional parameter to license check ([39105e8](https://github.com/Salable/node-sdk/commit/39105e806c7dfc4ddbafc0e825e19a8628532457))
 
 # [3.1.0](https://github.com/Salable/node-sdk/compare/v3.0.1...v3.1.0) (2023-11-24)
 
-
 ### Bug Fixes
 
-* updated getByGranteeId response type comment ([143a3a8](https://github.com/Salable/node-sdk/commit/143a3a883339aa8992cfecb74ba807c6e16e3705))
-
+- updated getByGranteeId response type comment ([143a3a8](https://github.com/Salable/node-sdk/commit/143a3a883339aa8992cfecb74ba807c6e16e3705))
 
 ### Features
 
-* create licenses updated to be able to create many licenses ([d0b7f43](https://github.com/Salable/node-sdk/commit/d0b7f4382e38fd7d774bf5eef7e4ac25f80a3978))
-* create licenses updated to be able to create many licenses ([9b43b3a](https://github.com/Salable/node-sdk/commit/9b43b3a69be7d9e529766e0e465647dce93dcf7a))
-* licenses endpoints up to date ([e0972da](https://github.com/Salable/node-sdk/commit/e0972dacceea6d9723b2969ba5d9e5948bcea133))
+- create licenses updated to be able to create many licenses ([d0b7f43](https://github.com/Salable/node-sdk/commit/d0b7f4382e38fd7d774bf5eef7e4ac25f80a3978))
+- create licenses updated to be able to create many licenses ([9b43b3a](https://github.com/Salable/node-sdk/commit/9b43b3a69be7d9e529766e0e465647dce93dcf7a))
+- licenses endpoints up to date ([e0972da](https://github.com/Salable/node-sdk/commit/e0972dacceea6d9723b2969ba5d9e5948bcea133))
 
 ## [3.0.1](https://github.com/Salable/node-sdk/compare/v3.0.0...v3.0.1) (2023-11-24)
 

README.md

@@ -1,4 +1,4 @@
-Salable SDK for JavaScript
+# Salable SDK for JavaScript
 
 The Salable SDK enables you to easily interact with the Salable ecosystem, accessing the Salable API, and other toolkit methods.
 
@@ -9,12 +9,47 @@ Let’s walk through setting up a project that uses the Salable API Class from t
 1. Create a new Node.js project.
 2. Inside of the project, run: `npm install @salable/node-sdk`. Adding packages results in update in lock file, [yarn.lock](https://yarnpkg.com/getting-started/qa/#should-lockfiles-be-committed-to-the-repository) or [package-lock.json](https://docs.npmjs.com/configuring-npm/package-lock-json). You **should** commit your lock file along with your code to avoid potential breaking changes.
 
-3. Create a new file called index.js, Instantiate a Salable Class and send a request.
+## v4.0.0 Update
+
+The SDK now supports Salable API version selection and developers can choose which version of the Salable API they want to interact with via the SDK
+As such, the Salable API version is now a required argument when instantiating the SDK 
 
 ```typescript
 import { Salable } from '@salable/node-sdk';
 
-const salable = new Salable('{{API_KEY}}');
+const salable = new Salable('your_api_key', 'v2');
+```
+> **_NOTE:_**  Support for `v1` of the Salable API has been deprecated, `v2` is currently the only supported version
+
+### General Changes
 
-const check = await salable.licenses.check('{{PRODUCT_UUID}}', ['userId_1']);
+#### Salable API versioning and Types
+- Types and method documentation are dynamic and automatically adjust to the version selected
+
+```typescript
+import { Salable } from '@salable/node-sdk';
+
+const salableV1 = new Salable('your_api_key', 'v1'); // NOTE: 'v1' is not supported and used for example purposes
+const salableV2 = new Salable('your_api_key', 'v2');
+
+// The "licenses.getUsage" method is supported in this version and will work
+await salableV1.licenses.getUsage(): 
+
+// This will error as "licenses.getUsage" has been deprecated in 'v2'
+await salableV2.licenses.getUsage(): // Will error with: "Property 'getUsage' does not exist ..."
 ```
+#### Pagination
+- All methods are now scope authorized and your API Key must contain the appropriate scopes to user certain methods
+- `getAll` endpoints are now paginated and offer cursor based pagination
+
+```typescript
+{
+	first: "item-id-1",
+	last: "item-id-3",
+	data: [
+		{id: "item-id-1"}, 
+		{id: "item-id-2"}, 
+		{id: "item-id-3"}
+	]
+}
+```