@webex/byods 0.0.0-next.1

package/dist/types/http-utils/index.d.ts

@@ -0,0 +1,70 @@
+import { ApiResponse } from '../http-client/types';
+export interface HttpRequestInit {
+    body?: string | null;
+    headers?: Record<string, string>;
+    method?: string;
+    timeout?: number;
+}
+/**
+ * Makes an HTTP request.
+ * @param {string} url - The URL for the request.
+ * @param {HttpRequestInit} [options=\{\}] - The request options.
+ * @returns {Promise<ApiResponse<T>>} - The API response.
+ * @example
+ * const response = await request('https://webexapis.com/v1/endpoint', { method: 'GET', headers: {} });
+ */
+declare function request<T>(url: string, options?: HttpRequestInit): Promise<ApiResponse<T>>;
+/**
+ * Makes an HTTP GET request.
+ * @param {string} url - The URL for the request.
+ * @param {HttpRequestInit} [options=\{\}] - The request options.
+ * @returns {Promise<ApiResponse<T>>} - The API response.
+ * @example
+ * const response = await get('https://webexapis.com/v1/endpoint', { headers: {} });
+ */
+declare function get<T>(url: string, options?: HttpRequestInit): Promise<ApiResponse<T>>;
+/**
+ * Makes an HTTP POST request.
+ * @param {string} url - The URL for the request.
+ * @param {HttpRequestInit} [options=\{\}] - The request options.
+ * @returns {Promise<ApiResponse<T>>} - The API response.
+ * @example
+ * const response = await post('https://webexapis.com/v1/endpoint', { headers: {} });
+ */
+declare function post<T>(url: string, options?: HttpRequestInit): Promise<ApiResponse<T>>;
+/**
+ * Makes an HTTP PUT request.
+ * @param {string} url - The URL for the request.
+ * @param {HttpRequestInit} [options=\{\}] - The request options.
+ * @returns {Promise<ApiResponse<T>>} - The API response.
+ * @example
+ * const response = await put('https://webexapis.com/v1/endpoint', { headers: {} });
+ */
+export declare function put<T>(url: string, options?: HttpRequestInit): Promise<ApiResponse<T>>;
+/**
+ * Makes an HTTP DELETE request.
+ * @param {string} url - The URL for the request.
+ * @param {HttpRequestInit} [options=\{\}] - The request options.
+ * @returns {Promise<ApiResponse<T>>} - The API response.
+ * @example
+ * const response = await del('https://webexapis.com/v1/endpoint', { headers: {} });
+ */
+declare function del<T>(url: string, options?: HttpRequestInit): Promise<ApiResponse<T>>;
+/**
+ * Makes an HTTP PATCH request.
+ * @param {string} url - The URL for the request.
+ * @param {HttpRequestInit} [options=\{\}] - The request options.
+ * @returns {Promise<ApiResponse<T>>} - The API response.
+ * @example
+ * const response = await patch('https://webexapis.com/v1/endpoint', { headers: {} });
+ */
+declare function patch<T>(url: string, options?: HttpRequestInit): Promise<ApiResponse<T>>;
+export declare const httpUtils: {
+    request: typeof request;
+    get: typeof get;
+    post: typeof post;
+    put: typeof put;
+    del: typeof del;
+    patch: typeof patch;
+};
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+import BYODS from './byods';
+import TokenManager from './token-manager';
+import BaseClient from './base-client';
+import DataSourceClient from './data-source-client';
+import { InMemoryTokenStorageAdapter } from './token-storage-adapter';
+import { LOGGER } from './Logger/types';
+export { BYODS, TokenManager, BaseClient, DataSourceClient, LOGGER, InMemoryTokenStorageAdapter };
+export type { TokenStorageAdapter } from './token-storage-adapter/types';

package/dist/types/token-manager/index.d.ts

@@ -0,0 +1,101 @@
+import { TokenResponse, OrgServiceAppAuthorization, LoggerConfig } from '../types';
+import { TokenStorageAdapter } from '../token-storage-adapter/types';
+/**
+ * The token manager for the BYoDS SDK.
+ */
+export default class TokenManager {
+    private clientId;
+    private clientSecret;
+    private serviceAppId;
+    private baseUrl;
+    private tokenStorageAdapter;
+    private loggerConfig;
+    /**
+     * Creates an instance of TokenManager.
+     *
+     * @param clientId - The client ID of the service app.
+     * @param clientSecret - The client secret of the service app.
+     * @param baseUrl - The base URL for the API. Defaults to `PRODUCTION_BASE_URL`.
+     * @example
+     * const tokenManager = new TokenManager('your-client-id', 'your-client-secret');
+     */
+    constructor(clientId: string, clientSecret: string, baseUrl?: string, tokenStorageAdapter?: TokenStorageAdapter, loggerConfig?: LoggerConfig);
+    /**
+     * Update the tokens and their expiration times.
+     * @param {TokenResponse} data - The token response data.
+     * @param {string} orgId - The organization ID.
+     * @returns {void}
+     * @example
+     * await tokenManager.updateServiceAppToken(tokenResponse, 'org-id');
+     */
+    updateServiceAppToken(data: TokenResponse, orgId: string): Promise<void>;
+    /**
+     * Get the service app ID.
+     * @returns {string}
+     * @example
+     * const serviceAppId = tokenManager.getServiceAppId();
+     */
+    getServiceAppId(): string;
+    /**
+     * Get the service app authorization data for a given organization ID.
+     * @param {string} orgId - The organization ID.
+     * @returns {Promise<OrgServiceAppAuthorization>}
+     * @example
+     * const authorization = await tokenManager.getOrgServiceAppAuthorization('org-id');
+     */
+    getOrgServiceAppAuthorization(orgId: string): Promise<OrgServiceAppAuthorization>;
+    /**
+     * List all stored tokens.
+     * @returns {Promise<OrgServiceAppAuthorization[]>} List of tokens
+     * @example
+     * const tokens = await tokenManager.listTokens();
+     */
+    listTokens(): Promise<OrgServiceAppAuthorization[]>;
+    /**
+     * Delete a token for a given orgId.
+     * @param {string} orgId - The organization ID.
+     * @returns {Promise<void>}
+     * @example
+     * await tokenManager.deleteToken('org-id');
+     */
+    deleteToken(orgId: string): Promise<void>;
+    /**
+     * Remove all tokens stored in the TokenStorageAdapter.
+     * @returns {Promise<void>}
+     * @example
+     * await tokenManager.resetTokens();
+     */
+    resetTokens(): Promise<void>;
+    /**
+     * Retrieve a new service app token using the service app owner's personal access token(PAT).
+     * @param {string} orgId - The organization ID.
+     * @param {string} personalAccessToken - The service app owner's personal access token or token from an integration that has the scope `spark:applications_token`.
+     * @returns {Promise<void>}
+     * await tokenManager.getServiceAppTokenUsingPAT('org-id', 'personal-access-token');
+     */
+    getServiceAppTokenUsingPAT(orgId: string, personalAccessToken: string, headers?: Record<string, string>): Promise<void>;
+    /**
+     * Refresh the access token using the refresh token.
+     * @param {string} orgId - The organization ID.
+     * @returns {Promise<void>}
+     * await tokenManager.refreshServiceAppAccessToken('org-id');
+     */
+    refreshServiceAppAccessToken(orgId: string, headers?: Record<string, string>): Promise<void>;
+    /**
+     * Save the service app registration using the provided refresh token.
+     * After saving, it can be fetched by using the {@link getOrgServiceAppAuthorization} method.
+     * @param {string} orgId - The organization ID.
+     * @param {string} refreshToken - The refresh token.
+     * @returns {Promise<void>}
+     * @example
+     * await tokenManager.saveServiceAppRegistrationData('org-id', 'refresh-token');
+     */
+    saveServiceAppRegistrationData(orgId: string, refreshToken: string, headers?: Record<string, string>): Promise<void>;
+    /**
+     * Proxy for extracting the token from the token adapter
+     * @param {string} orgId - The organization ID.
+     * @returns {Promise<OrgServiceAppAuthorization>}
+     * @private
+     */
+    private getTokenFromAdapter;
+}

package/dist/types/token-storage-adapter/index.d.ts

@@ -0,0 +1,54 @@
+import { OrgServiceAppAuthorization } from '../types';
+import { TokenStorageAdapter } from './types';
+/**
+ * An in-memory adapter for storing, listing and retrieving service app authorization tokens.
+ *
+ * @public
+ */
+export declare class InMemoryTokenStorageAdapter implements TokenStorageAdapter {
+    /**
+     * The local memory cache for the tokens.
+     */
+    private tokenCache;
+    constructor(tokenCache?: {
+        [orgId: string]: OrgServiceAppAuthorization;
+    });
+    /**
+     * Method to set the token for an organization.
+     * @param orgId Organization ID
+     * @param token Respective token
+     * @example
+     * await storageAdapter.setToken('org-id', token);
+     */
+    setToken(orgId: string, token: OrgServiceAppAuthorization): Promise<void>;
+    /**
+     * Method to extract a token based on the organization id.
+     * @param orgId Organization ID
+     * @returns {OrgServiceAppAuthorization} The token object for the organization
+     * @example
+     * const token = await storageAdapter.getToken('org-id');
+     */
+    getToken(orgId: string): Promise<OrgServiceAppAuthorization>;
+    /**
+     * Method which returns the list of all tokens stored in the InMemoryTokenStorageAdapter.
+     * @returns {OrgServiceAppAuthorization[]} List of
+     * @example
+     * const tokens = await storageAdapter.listTokens();
+     */
+    listTokens(): Promise<OrgServiceAppAuthorization[]>;
+    /**
+     * Method to delete a token based on the organization id.
+     * @param orgId Organization ID
+     * @returns {Promise<void>}
+     * @example
+     * await storageAdapter.deleteToken('org-id');
+     */
+    deleteToken(orgId: string): Promise<void>;
+    /**
+     * Method to remove all tokens stored in the InMemoryTokenStorageAdapter.
+     * @returns {Promise<void>}
+     * @example
+     * await storageAdapter.resetTokens();
+     */
+    resetTokens(): Promise<void>;
+}

package/dist/types/token-storage-adapter/types.d.ts

@@ -0,0 +1,46 @@
+import { OrgServiceAppAuthorization } from '../types';
+/**
+ * Represents a adapter for storing and retrieving service app authorization tokens.
+ *
+ * @public
+ */
+export interface TokenStorageAdapter {
+    /**
+     * Method to set the token for an organization.
+     * @param orgId Organization ID
+     * @param token Respective token
+     * @example
+     * await storageAdapter.setToken('org-id', token);
+     */
+    setToken(orgId: string, token: OrgServiceAppAuthorization): Promise<void>;
+    /**
+     * Method to extract a token id based on the organization id.
+     * @param orgId Organization
+     * @returns {OrgServiceAppAuthorization} The token object for the organization
+     * @example
+     * const token = await storageAdapter.getToken('org-id');
+     */
+    getToken(orgId: string): Promise<OrgServiceAppAuthorization>;
+    /**
+     * Method which returns the list of all tokens stored in the TokenStorageAdapter.
+     * @returns {OrgServiceAppAuthorization[]} List of tokens
+     * @example
+     * const tokens = await storageAdapter.listTokens();
+     */
+    listTokens(): Promise<OrgServiceAppAuthorization[]>;
+    /**
+     * Method to delete a token based on the organization id.
+     * @param orgId Organization ID
+     * @returns {Promise<void>}
+     * @example
+     * await storageAdapter.deleteToken('org-id');
+     */
+    deleteToken(orgId: string): Promise<void>;
+    /**
+     * Method to remove all tokens stored in the TokenStorageAdapter.
+     * @returns {Promise<void>}
+     * @example
+     * await storageAdapter.resetTokens();
+     */
+    resetTokens(): Promise<void>;
+}

package/dist/types/types.d.ts

@@ -0,0 +1,112 @@
+import { TokenStorageAdapter } from './token-storage-adapter/types';
+import { LOGGER } from './Logger/types';
+export interface LoggerConfig {
+    level: LOGGER;
+}
+/**
+ * Configuration options for the SDK.
+ *
+ * @public
+ */
+export interface SDKConfig {
+    /**
+     * The client ID of the service app.
+     */
+    clientId: string;
+    /**
+     * The client secret of the service app.
+     */
+    clientSecret: string;
+    /**
+     * The token storage adapter passed by the client
+     * By default, this will be of type `InMemoryTokenStorageAdapter`
+     */
+    tokenStorageAdapter?: TokenStorageAdapter;
+    /**
+     * The Logger Config
+     * By default, this will be of type `LOGGER.ERROR`
+     */
+    logger?: LoggerConfig;
+}
+/**
+ * TokenResponse JSON shape from Webex APIs.
+ *
+ * @public
+ */
+export interface TokenResponse {
+    /**
+     * The access token.
+     */
+    access_token: string;
+    /**
+     * The expiration time of the access token in seconds.
+     */
+    expires_in: number;
+    /**
+     * The refresh token.
+     */
+    refresh_token: string;
+    /**
+     * The expiration time of the refresh token in seconds.
+     */
+    refresh_token_expires_in: number;
+    /**
+     * The type of the token.
+     */
+    token_type: string;
+}
+/**
+ * Represents a token with its expiration details.
+ *
+ * @public
+ */
+export interface ServiceAppToken {
+    /**
+     * The access token.
+     */
+    accessToken: string;
+    /**
+     * The refresh token.
+     */
+    refreshToken: string;
+    /**
+     * The expiration date of the access token.
+     */
+    expiresAt: Date;
+    /**
+     * The expiration date of the refresh token.
+     */
+    refreshAccessTokenExpiresAt: Date;
+}
+/**
+ * Represents a service app authorization token info for an organization.
+ *
+ * @public
+ */
+export interface OrgServiceAppAuthorization {
+    /**
+     * The organization ID.
+     */
+    orgId: string;
+    /**
+     * The token details.
+     */
+    serviceAppToken: ServiceAppToken;
+}
+/**
+ * Represents the result of verifying a JWS token.
+ *
+ * @public
+ */
+export interface JWSTokenVerificationResult {
+    /**
+     * Indicates whether the token is valid.
+     */
+    isValid: boolean;
+    /**
+     * The error message if the JWS token is invalid.
+     * If the JWS token is valid, this field is not present.
+     * If the JWS token is invalid, this field contains the error message.
+     */
+    error?: string;
+}

package/dist/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/package.json

@@ -0,0 +1,121 @@
+{
+  "name": "@webex/byods",
+  "files": [
+    "dist"
+  ],
+  "contributors": [],
+  "main": "dist/module/index.js",
+  "types": "dist/types/index.d.ts",
+  "license": "MIT",
+  "author": "devsupport@webex.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webex/webex-js-sdk.git",
+    "directory": "packages/byods"
+  },
+  "scripts": {
+    "build:docs": "typedoc --out ../../docs/byods",
+    "build:src": "webex-legacy-tools build -dest \"./dist\" -src \"./src\" -js -ts && yarn build",
+    "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types",
+    "deploy:npm": "yarn npm publish",
+    "docs": "typedoc --emit none",
+    "fix:lint": "eslint 'src/**/*.ts' --fix",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "prebuild": "rimraf dist",
+    "test": "yarn test:style && yarn test:unit",
+    "test:style": "eslint 'src/**/*.ts'",
+    "test:unit": "webex-legacy-tools test --unit --runner jest"
+  },
+  "devDependencies": {
+    "@babel/plugin-transform-private-methods": "7.23.3",
+    "@babel/preset-typescript": "7.16.7",
+    "@commitlint/cli": "15.0.0",
+    "@commitlint/config-conventional": "15.0.0",
+    "@rollup/plugin-commonjs": "22.0.2",
+    "@rollup/plugin-json": "4.1.0",
+    "@rollup/plugin-node-resolve": "13.1.3",
+    "@types/chai": "4.2.21",
+    "@types/jest": "27.4.1",
+    "@types/mocha": "9.0.0",
+    "@types/node": "16.11.9",
+    "@types/uuid": "8.3.4",
+    "@typescript-eslint/eslint-plugin": "5.38.1",
+    "@typescript-eslint/parser": "5.38.1",
+    "@web/dev-server": "0.4.5",
+    "@webex/jest-config-legacy": "0.0.0",
+    "@webex/legacy-tools": "0.0.0",
+    "chai": "4.3.4",
+    "cspell": "5.19.2",
+    "esbuild": "^0.17.19",
+    "eslint": "^8.24.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-import-resolver-typescript": "2.4.0",
+    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-jsdoc": "38.0.4",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-tsdoc": "0.2.14",
+    "jest": "27.5.1",
+    "jest-junit": "13.0.0",
+    "karma": "6.4.3",
+    "karma-chai": "0.1.0",
+    "karma-chrome-launcher": "3.1.0",
+    "karma-coverage": "2.0.3",
+    "karma-firefox-launcher": "2.1.1",
+    "karma-junit-reporter": "2.0.1",
+    "karma-mocha": "2.0.1",
+    "karma-mocha-reporter": "2.2.5",
+    "karma-safari-launcher": "1.0.0",
+    "karma-sauce-launcher": "4.3.6",
+    "karma-typescript": "5.5.3",
+    "karma-typescript-es6-transform": "5.5.3",
+    "mocha": "10.6.0",
+    "prettier": "2.5.1",
+    "puppeteer": "22.13.0",
+    "rimraf": "3.0.2",
+    "rollup": "2.68.0",
+    "rollup-plugin-polyfill-node": "0.8.0",
+    "rollup-plugin-terser": "7.0.2",
+    "rollup-plugin-typescript2": "0.31.2",
+    "sinon": "12.0.1",
+    "ts-jest": "27.1.4",
+    "typed-emitter": "2.1.0",
+    "typedoc": "0.23.26",
+    "typescript": "4.9.5"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ],
+    "rules": {
+      "scope-case": [
+        2,
+        "always",
+        [
+          "lower-case",
+          "pascal-case"
+        ]
+      ],
+      "body-max-line-length": [
+        0,
+        "always",
+        400
+      ],
+      "footer-max-line-length": [
+        0,
+        "always",
+        400
+      ]
+    }
+  },
+  "gh-pages-deploy": {
+    "staticpath": "docs",
+    "noprompt": true
+  },
+  "dependencies": {
+    "@types/node-fetch": "2.6.11",
+    "jose": "5.8.0",
+    "node-fetch": "3.3.2"
+  },
+  "version": "0.0.0-next.1"
+}