@descope/node-sdk 1.0.4-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Descope
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+![Node-SDK](https://github.com/descope/node-sdk/actions/workflows/ci.yml/badge.svg)
+
+# Descope Node.js SDK
+
+Node.js library used to integrate with Descope

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const refreshTokenCookieName = "DSR";
+export declare const sessionTokenCookieName = "DS";

package/dist/constants.js

@@ -0,0 +1,3 @@
+// eslint-disable-next-line import/prefer-default-export
+export const refreshTokenCookieName = 'DSR';
+export const sessionTokenCookieName = 'DS';

package/dist/helpers.d.ts

@@ -0,0 +1,4 @@
+import type { SdkResponse } from '@descope/core-js-sdk';
+export declare const withCookie: <T extends any[], U extends Promise<SdkResponse>>(fn: (...args: T) => U) => (...args: T) => Promise<SdkResponse>;
+export declare const wrapWith: <T extends Record<string, any>>(obj: T, path: string | string[], wrappingFn: Function) => void;
+export declare const bulkWrapWith: (obj: Parameters<typeof wrapWith>[0], paths: string[], wrappingFn: Parameters<typeof wrapWith>[2]) => void;

package/dist/helpers.js

@@ -0,0 +1,61 @@
+import { refreshTokenCookieName, sessionTokenCookieName } from "./constants.js";
+
+const generateCookie = (name, value) => `${name}=${value};`;
+
+const getCookieValue = (cookie, name) => {
+  const match = cookie === null || cookie === void 0 ? void 0 : cookie.match(RegExp(`(?:^|;\\s*)${name}=([^;]*)`));
+  return match ? match[1] : null;
+}; // eslint-disable-next-line import/prefer-default-export
+
+
+export const withCookie = fn => async (...args) => {
+  const resp = await fn(...args); // eslint-disable-next-line prefer-const
+
+  let {
+    sessionJwt,
+    refreshJwt
+  } = resp.data;
+  let cookie = generateCookie(sessionTokenCookieName, sessionJwt);
+
+  if (!refreshJwt) {
+    var _resp$response;
+
+    cookie += ((_resp$response = resp.response) === null || _resp$response === void 0 ? void 0 : _resp$response.headers.get('set-cookie')) || '';
+    refreshJwt = getCookieValue(cookie, refreshTokenCookieName);
+  } else {
+    cookie += generateCookie(refreshTokenCookieName, refreshJwt);
+  }
+
+  return { ...resp,
+    data: { ...resp.data,
+      refreshJwt,
+      cookie
+    }
+  };
+};
+export const wrapWith = (obj, path, wrappingFn // eslint-disable-next-line consistent-return
+) => {
+  if (!obj) return obj;
+  const pathSections = typeof path === 'string' ? path.split('.') : path;
+  const section = pathSections.shift() || '';
+
+  if (pathSections.length === 0 || section === '*') {
+    const wrap = key => {
+      if (key && typeof obj[key] === 'function') {
+        // eslint-disable-next-line no-param-reassign
+        obj[key] = wrappingFn(obj[key]);
+      } else {
+        throw Error(`cannot wrap value at key "${key.toString()}"`);
+      }
+    };
+
+    if (section === '*') {
+      Object.keys(obj).forEach(wrap);
+    } else {
+      wrap(section);
+    }
+  } else {
+    wrapWith(obj[section], pathSections, wrappingFn);
+  }
+};
+export const bulkWrapWith = (obj, paths, wrappingFn) => paths.forEach(path => wrapWith(obj, path, wrappingFn));

package/dist/index.d.ts

@@ -0,0 +1,251 @@
+import { KeyLike, JWTHeaderParameters } from 'jose';
+import { AuthenticationInfo } from './types';
+export type { DeliveryMethod, OAuthProvider } from '@descope/core-js-sdk';
+declare const _default: (args_0: {
+    projectId: string;
+    logger?: {
+        error: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+        debug: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+        log: {
+            (...data: any[]): void;
+            (message?: any, ...optionalParams: any[]): void;
+        };
+    } | undefined;
+    baseUrl?: string | undefined;
+}) => {
+    getKey(header: JWTHeaderParameters): Promise<KeyLike | Uint8Array>;
+    validateToken(token: string): Promise<AuthenticationInfo>;
+    validateSession(sessionToken: string, refreshToken: string): Promise<AuthenticationInfo | undefined>;
+    otp: {
+        verify: {
+            email: (identifier: string, code: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            sms: (identifier: string, code: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            whatsapp: (identifier: string, code: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        signIn: {
+            email: (identifier: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            sms: (identifier: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            whatsapp: (identifier: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        signUp: {
+            email: (identifier: string, user?: {
+                email?: string | undefined;
+                name?: string | undefined;
+                phone?: string | undefined;
+            } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            sms: (identifier: string, user?: {
+                email?: string | undefined;
+                name?: string | undefined;
+                phone?: string | undefined;
+            } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            whatsapp: (identifier: string, user?: {
+                email?: string | undefined;
+                name?: string | undefined;
+                phone?: string | undefined;
+            } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        signUpOrIn: {
+            email: (identifier: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            sms: (identifier: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            whatsapp: (identifier: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        update: {
+            email: (identifier: string, email: string, token?: string | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            phone: {
+                email: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                sms: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                whatsapp: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            };
+        };
+    };
+    magicLink: {
+        verify: (token: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        signIn: {
+            email: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            sms: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            whatsapp: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        signUp: {
+            email: (identifier: string, uri: string, user?: {
+                email?: string | undefined;
+                name?: string | undefined;
+                phone?: string | undefined;
+            } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            sms: (identifier: string, uri: string, user?: {
+                email?: string | undefined;
+                name?: string | undefined;
+                phone?: string | undefined;
+            } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            whatsapp: (identifier: string, uri: string, user?: {
+                email?: string | undefined;
+                name?: string | undefined;
+                phone?: string | undefined;
+            } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        signUpOrIn: {
+            email: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            sms: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            whatsapp: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        update: {
+            email: (identifier: string, email: string, uri: string, token?: string | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            phone: {
+                email: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                sms: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                whatsapp: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            };
+        };
+        crossDevice: {
+            verify: (token: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            signIn: {
+                email: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                sms: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                whatsapp: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            };
+            signUpOrIn: {
+                email: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                sms: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                whatsapp: (identifier: string, uri: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            };
+            signUp: {
+                email: (identifier: string, uri: string, user?: {
+                    email?: string | undefined;
+                    name?: string | undefined;
+                    phone?: string | undefined;
+                } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                sms: (identifier: string, uri: string, user?: {
+                    email?: string | undefined;
+                    name?: string | undefined;
+                    phone?: string | undefined;
+                } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                whatsapp: (identifier: string, uri: string, user?: {
+                    email?: string | undefined;
+                    name?: string | undefined;
+                    phone?: string | undefined;
+                } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            };
+            waitForSession: (pendingRef: string, config?: {
+                pollingIntervalMs: number;
+                timeoutMs: number;
+            } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            update: {
+                email: (identifier: string, email: string, uri: string, token?: string | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                phone: {
+                    email: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                    sms: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                    whatsapp: (identifier: string, phone: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+                };
+            };
+        };
+    };
+    oauth: {
+        exchange: (code: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        start: {
+            facebook: <B extends {
+                redirect: boolean;
+            }>(config?: B | undefined) => Promise<B extends {
+                redirect: true;
+            } ? undefined : import("@descope/core-js-sdk").SdkResponse>;
+            github: <B_1 extends {
+                redirect: boolean;
+            }>(config?: B_1 | undefined) => Promise<B_1 extends {
+                redirect: true;
+            } ? undefined : import("@descope/core-js-sdk").SdkResponse>;
+            google: <B_2 extends {
+                redirect: boolean;
+            }>(config?: B_2 | undefined) => Promise<B_2 extends {
+                redirect: true;
+            } ? undefined : import("@descope/core-js-sdk").SdkResponse>;
+            microsoft: <B_3 extends {
+                redirect: boolean;
+            }>(config?: B_3 | undefined) => Promise<B_3 extends {
+                redirect: true;
+            } ? undefined : import("@descope/core-js-sdk").SdkResponse>;
+            gitlab: <B_4 extends {
+                redirect: boolean;
+            }>(config?: B_4 | undefined) => Promise<B_4 extends {
+                redirect: true;
+            } ? undefined : import("@descope/core-js-sdk").SdkResponse>;
+            apple: <B_5 extends {
+                redirect: boolean;
+            }>(config?: B_5 | undefined) => Promise<B_5 extends {
+                redirect: true;
+            } ? undefined : import("@descope/core-js-sdk").SdkResponse>;
+        };
+    };
+    saml: {
+        exchange: (code: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        start: <B_1 extends {
+            redirect: boolean;
+        }>(tenantNameOrEmail: string, config?: B_1 | undefined) => Promise<B_1 extends {
+            redirect: true;
+        } ? undefined : import("@descope/core-js-sdk").SdkResponse>;
+    };
+    totp: {
+        signUp: (identifier: string, user?: {
+            email?: string | undefined;
+            name?: string | undefined;
+            phone?: string | undefined;
+        } | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        verify: (identifier: string, code: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        update: (identifier: string, token?: string | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+    };
+    webauthn: {
+        signUp: {
+            start: (identifier: string, origin: string, name: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            finish: (transactionId: string, response: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        signIn: {
+            start: (identifier: string, origin: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            finish: (transactionId: string, response: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+        add: {
+            start: (identifier: string, origin: string, token: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+            finish: (transactionId: string, response: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        };
+    };
+    flow: {
+        start: (flowId: string) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+        next: (executionId: string, stepId: string, actionId: string, input?: Record<string, FormDataEntryValue> | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+    };
+    refresh: (token?: string | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+    logout: (token?: string | undefined) => Promise<import("@descope/core-js-sdk").SdkResponse>;
+    isJwtExpired: (token: string) => boolean;
+    httpClient: {
+        get: (path: string, config?: {
+            headers?: HeadersInit | undefined;
+            queryParams?: {
+                [key: string]: string;
+            } | undefined;
+            token?: string | undefined;
+        } | undefined) => Promise<globalThis.Response>;
+        post: (path: string, body?: any, config?: {
+            headers?: HeadersInit | undefined;
+            queryParams?: {
+                [key: string]: string;
+            } | undefined;
+            token?: string | undefined;
+        } | undefined) => Promise<globalThis.Response>;
+        put: (path: string, body?: any, config?: {
+            headers?: HeadersInit | undefined;
+            queryParams?: {
+                [key: string]: string;
+            } | undefined;
+            token?: string | undefined;
+        } | undefined) => Promise<globalThis.Response>;
+        delete: (path: string, body?: any, config?: {
+            headers?: HeadersInit | undefined;
+            queryParams?: {
+                [key: string]: string;
+            } | undefined;
+            token?: string | undefined;
+        } | undefined) => Promise<globalThis.Response>;
+    };
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,72 @@
+import createSdk from '@descope/core-js-sdk';
+import { jwtVerify, importJWK } from 'jose';
+import fetch, { Headers, Response, Request } from 'node-fetch';
+import { bulkWrapWith, withCookie } from "./helpers.js";
+
+if (!globalThis.fetch) {
+  // @ts-ignore
+  globalThis.fetch = fetch; // @ts-ignore
+
+  globalThis.Headers = Headers; // @ts-ignore
+
+  globalThis.Request = Request; // @ts-ignore
+
+  globalThis.Response = Response;
+}
+
+export default ((...args) => {
+  const sdk = createSdk(...args);
+  bulkWrapWith(sdk, ['otp.verify.*', 'magicLink.verify', 'magicLink.crossDevice.signUp.*', 'magicLink.crossDevice.signIn.*', 'oauth.exchange', 'saml.exchange', 'totp.verify', 'webauthn.signIn.finish', 'webauthn.signUp.finish', 'refresh'], withCookie);
+  const {
+    projectId,
+    logger
+  } = args[0];
+  const keys = {};
+
+  const fetchKeys = async () => {
+    const publicKeys = (await sdk.httpClient.get(`keys/${projectId}`).then(resp => resp.json())) || [];
+    const kidJwksPairs = await Promise.all(publicKeys.map(async key => [key.kid, await importJWK(key)]));
+    return kidJwksPairs.reduce((acc, [kid, jwk]) => kid ? { ...acc,
+      [kid.toString()]: jwk
+    } : acc, {});
+  };
+
+  return { ...sdk,
+
+    async getKey(header) {
+      if (!(header !== null && header !== void 0 && header.kid)) throw Error('header.kid must not be empty');
+      if (keys[header.kid]) return keys[header.kid]; // do we need to fetch once or every time?
+
+      Object.assign(keys, await fetchKeys());
+      if (!keys[header.kid]) throw Error('failed to fetch matching key');
+      return keys[header.kid];
+    },
+
+    async validateToken(token) {
+      const res = await jwtVerify(token, this.getKey, {
+        algorithms: ['ES384']
+      });
+      return {
+        token: res.payload
+      };
+    },
+
+    async validateSession(sessionToken, refreshToken) {
+      if (!sessionToken) throw Error('session token must not be empty');
+
+      try {
+        const token = await this.validateToken(sessionToken);
+        return token;
+      } catch (error) {
+        try {
+          await this.validateToken(refreshToken);
+          return (await this.refresh(refreshToken)).data;
+        } catch (refreshTokenErr) {
+          logger === null || logger === void 0 ? void 0 : logger.error('failed to validate refresh token', refreshTokenErr);
+          throw Error('could not validate tokens');
+        }
+      }
+    }
+
+  };
+});

package/dist/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+interface Token {
+    sub?: string;
+    exp?: number;
+    iss?: string;
+}
+export interface AuthenticationInfo {
+    token?: Token;
+    cookies?: string[];
+}
+export {};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@descope/node-sdk",
+  "version": "1.0.4-alpha.0",
+  "description": "Node.js library used to integrate with Descope",
+  "typings": "./dist/index.d.ts",
+  "main": "./dist/index.js",
+  "exports": {
+    "require": "./dist/index.js",
+    "import": "./module.mjs"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/descope/node-sdk.git"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  },
+  "scripts": {
+    "build": "rm -rf dist types && babel lib --out-dir dist --extensions '.ts' && tsc --declaration --outDir dist --emitDeclarationOnly",
+    "format": "prettier --write lib",
+    "check-format": "prettier --check lib",
+    "size": "npm run build && size-limit",
+    "lint": "eslint lib/**/*.ts --fix",
+    "leaks": "bash ./scripts/gitleaks/gitleaks.sh",
+    "test": "jest --forceExit --config jest.config.ts --coverage --ci --detectOpenHandles .*test.*",
+    "prepublishOnly": "npm run build"
+  },
+  "author": "Descope",
+  "bugs": {
+    "url": "git://github.com/descope/node-sdk/issues"
+  },
+  "license": "MIT",
+  "keywords": [
+    "descope",
+    "authentication"
+  ],
+  "devDependencies": {
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.17.12",
+    "@babel/preset-env": "^7.17.12",
+    "@babel/preset-typescript": "^7.17.12",
+    "@size-limit/preset-small-lib": "^8.0.0",
+    "@types/jest": "^28.0.0",
+    "@types/jsonwebtoken": "^8.5.8",
+    "@types/node": "^15.14.9",
+    "@types/node-fetch": "^2.6.1",
+    "@typescript-eslint/eslint-plugin": "^5.25.0",
+    "@typescript-eslint/parser": "^5.27.0",
+    "babel-plugin-add-import-extension": "^1.6.0",
+    "eslint": "^8.15.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^3.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jest": "^26.4.6",
+    "eslint-plugin-jest-dom": "^4.0.2",
+    "eslint-plugin-jest-formatting": "^3.1.0",
+    "eslint-plugin-no-only-tests": "^3.0.0",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^8.0.1",
+    "jest": "^28.1.0",
+    "jsdoc": "^3.6.10",
+    "nock": "^13.2.4",
+    "prettier": "2.6.2",
+    "ts-jest": "^28.0.3",
+    "ts-node": "^10.8.2",
+    "typescript": "^4.6.4"
+  },
+  "size-limit": [
+    {
+      "limit": "100 kb",
+      "path": "dist/*",
+      "ignore": [
+        "node:*"
+      ]
+    }
+  ],
+  "dependencies": {
+    "@descope/core-js-sdk": "0.0.41-alpha.6",
+    "jose": "4.8.1",
+    "node-fetch": "2.6.7"
+  }
+}