@webex/byods 0.0.0-next.1

package/dist/token-storage-adapter/index.js

@@ -0,0 +1,80 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InMemoryTokenStorageAdapter = void 0;
+/**
+ * An in-memory adapter for storing, listing and retrieving service app authorization tokens.
+ *
+ * @public
+ */
+class InMemoryTokenStorageAdapter {
+  /**
+   * The local memory cache for the tokens.
+   */
+
+  constructor(tokenCache = {}) {
+    this.tokenCache = tokenCache;
+  }
+
+  /**
+   * Method to set the token for an organization.
+   * @param orgId Organization ID
+   * @param token Respective token
+   * @example
+   * await storageAdapter.setToken('org-id', token);
+   */
+  async setToken(orgId, token) {
+    this.tokenCache[orgId] = token;
+  }
+
+  /**
+   * 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');
+   */
+  async getToken(orgId) {
+    if (this.tokenCache[orgId]) {
+      return this.tokenCache[orgId];
+    }
+    throw new Error(`Service App token not found for org ID: ${orgId}`);
+  }
+
+  /**
+   * Method which returns the list of all tokens stored in the InMemoryTokenStorageAdapter.
+   * @returns {OrgServiceAppAuthorization[]} List of
+   * @example
+   * const tokens = await storageAdapter.listTokens();
+   */
+  async listTokens() {
+    return Object.values(this.tokenCache);
+  }
+
+  /**
+   * Method to delete a token based on the organization id.
+   * @param orgId Organization ID
+   * @returns {Promise<void>}
+   * @example
+   * await storageAdapter.deleteToken('org-id');
+   */
+  async deleteToken(orgId) {
+    if (!this.tokenCache[orgId]) {
+      throw new Error(`Service App token not found for org ID: ${orgId}`);
+    }
+    delete this.tokenCache[orgId];
+  }
+
+  /**
+   * Method to remove all tokens stored in the InMemoryTokenStorageAdapter.
+   * @returns {Promise<void>}
+   * @example
+   * await storageAdapter.resetTokens();
+   */
+  async resetTokens() {
+    this.tokenCache = {};
+  }
+}
+exports.InMemoryTokenStorageAdapter = InMemoryTokenStorageAdapter;

package/dist/token-storage-adapter/types.js

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

package/dist/types/Errors/catalog/ExtendedError.d.ts

@@ -0,0 +1,14 @@
+import { ErrorMessage, ERROR_TYPE } from '../types';
+/**
+ *
+ */
+export default class ExtendedError extends Error {
+    type: ERROR_TYPE;
+    /**
+     * Constructs an ExtendedError instance.
+     *
+     * @param msg - The error message.
+     * @param type - The type of the error.
+     */
+    constructor(msg: ErrorMessage, type?: ERROR_TYPE);
+}

package/dist/types/Errors/types.d.ts

@@ -0,0 +1,32 @@
+import { IMetaContext } from '../Logger/types';
+export type ErrorMessage = string;
+export declare enum ERROR_TYPE {
+    DEFAULT = "default_error",
+    FORBIDDEN_ERROR = "forbidden",
+    NOT_FOUND = "not_found",
+    REGISTRATION_ERROR = "registration_error",
+    SERVICE_UNAVAILABLE = "service_unavailable",
+    TIMEOUT = "timeout",
+    TOKEN_ERROR = "token_error",
+    SERVER_ERROR = "server_error",
+    SCHEDULE_JWS_TOKEN_REFRESH_ERROR = "schedule_jws_token_refresh_error",
+    START_AUTO_REFRESH_ERROR = "start_auto_refresh_error"
+}
+export declare enum ERROR_CODE {
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    DEVICE_NOT_FOUND = 404,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    SERVICE_UNAVAILABLE = 503,
+    BAD_REQUEST = 400,
+    REQUEST_TIMEOUT = 408,
+    TOO_MANY_REQUESTS = 429
+}
+export interface ErrorContext extends IMetaContext {
+}
+export type ErrorObject = {
+    message: ErrorMessage;
+    type: ERROR_TYPE;
+    context: ErrorContext;
+};

package/dist/types/Logger/index.d.ts

@@ -0,0 +1,71 @@
+import ExtendedError from '../Errors/catalog/ExtendedError';
+import { LogContext, LOGGER } from './types';
+declare class Logger {
+    private currentLogLevel;
+    /**
+     * A wrapper around console which prints
+     * based on the level defined.
+     *
+     * @param message - Log Message to print.
+     * @param level -  Log level.
+     */
+    private writeToConsole;
+    /**
+     * Format the Log message  as 'timestamp BYODS SDK - [level]: file:example.ts - method:methodName - Actual log message'.
+     *
+     * @param  context - File and method.
+     * @param level - Log level.
+     * @returns - Formatted string.
+     */
+    private format;
+    /**
+     * Used to initialize the logger module
+     * with a certain level.
+     *
+     * @param level - Log Level.
+     */
+    setLogger(level: string, module: string): void;
+    /**
+     * To retrieve the current log level.
+     *
+     * @returns - Log level.
+     */
+    getLogLevel(): LOGGER;
+    /**
+     * Can be used to print only useful information.
+     *
+     * @param message - Caller emitted string.
+     * @param context - File and method which called.
+     */
+    log(message: string, context: LogContext): void;
+    /**
+     * Can be used to print informational messages.
+     *
+     * @param message - Caller emitted string.
+     * @param context - File and method which called.
+     */
+    info(message: string, context: LogContext): void;
+    /**
+     * Can be used to print warning messages.
+     *
+     * @param message - Caller emitted string.
+     * @param context - File and method which called.
+     */
+    warn(message: string, context: LogContext): void;
+    /**
+     * Can be used to print the stack trace of the entire call path.
+     *
+     * @param message - Caller emitted string.
+     * @param context - File and method which called.
+     */
+    trace(message: string, context: LogContext): void;
+    /**
+     * Can be used to print only errors.
+     *
+     * @param error - Error string .
+     * @param context - File and method which called.
+     */
+    error(error: ExtendedError, context: LogContext): void;
+}
+declare const log: Logger;
+export default log;

package/dist/types/Logger/types.d.ts

@@ -0,0 +1,27 @@
+export interface IMetaContext {
+    file?: string;
+    method?: string;
+}
+export type LogContext = IMetaContext;
+export declare enum LOG_PREFIX {
+    MAIN = "BYODOS_SDK",
+    FILE = "file",
+    METHOD = "method",
+    EVENT = "event",
+    MESSAGE = "message",
+    ERROR = "error"
+}
+export declare enum LOGGING_LEVEL {
+    error = 1,
+    warn = 2,
+    log = 3,
+    info = 4,
+    trace = 5
+}
+export declare enum LOGGER {
+    ERROR = "error",
+    WARN = "warn",
+    INFO = "info",
+    LOG = "log",
+    TRACE = "trace"
+}

package/dist/types/base-client/index.d.ts

@@ -0,0 +1,91 @@
+import { LoggerConfig } from '../types';
+import TokenManager from '../token-manager';
+import DataSourceClient from '../data-source-client';
+import { HttpClient, ApiResponse } from '../http-client/types';
+import { HttpRequestInit } from '../http-utils';
+export default class BaseClient {
+    private baseUrl;
+    private headers;
+    private tokenManager;
+    private orgId;
+    private loggerConfig;
+    dataSource: DataSourceClient;
+    /**
+     * Creates an instance of BaseClient.
+     * @param {string} baseUrl - The base URL for the API.
+     * @param {Record<string, string>} headers - The additional headers to be used in requests.
+     * @param {TokenManager} tokenManager - The token manager instance.
+     * @param {string} orgId - The organization ID.
+     * @example
+     * const client = new BaseClient('https://webexapis.com/v1', { 'Your-Custom-Header': 'some value' }, tokenManager, 'org123');
+     */
+    constructor(baseUrl: string, headers: Record<string, string>, tokenManager: TokenManager, orgId: string, loggerConfig?: LoggerConfig);
+    /**
+     * Makes an HTTP request.
+     * @param {string} endpoint - The API endpoint.
+     * @param {HttpRequestInit} [options={}] - The request options.
+     * @returns {Promise<ApiResponse<T>>} - The API response.
+     * @template T
+     * @example
+     * const response = await client.request('/endpoint', { method: 'GET', headers: {} });
+     */
+    request<T>(endpoint: string, options?: HttpRequestInit): Promise<ApiResponse<T>>;
+    /**
+     * Makes a POST request.
+     * @param {string} endpoint - The API endpoint.
+     * @param {Record<string, any>} body - The request body.
+     * @param {Record<string, string>} [headers={}] - The request headers.
+     * @returns {Promise<ApiResponse<T>>} - The API response.
+     * @template T
+     * @example
+     * const response = await client.post('/endpoint', { key: 'value' });
+     */
+    post<T>(endpoint: string, body: Record<string, any>, headers?: Record<string, string>): Promise<ApiResponse<T>>;
+    /**
+     * Makes a PUT request.
+     * @param {string} endpoint - The API endpoint.
+     * @param {Record<string, any>} body - The request body.
+     * @returns {Promise<ApiResponse<T>>} - The API response.
+     * @template T
+     * @example
+     * const response = await client.put('/endpoint', { key: 'value' });
+     */
+    put<T>(endpoint: string, body: Record<string, any>, headers?: Record<string, string>): Promise<ApiResponse<T>>;
+    /**
+     * Makes a PATCH request.
+     * @param {string} endpoint - The API endpoint.
+     * @param {Record<string, any>} body - The request body.
+     * @returns {Promise<ApiResponse<T>>} - The API response.
+     * @template T
+     * @example
+     * const response = await client.patch('/endpoint', { key: 'value' });
+     */
+    patch<T>(endpoint: string, body: Record<string, any>, headers?: Record<string, string>): Promise<ApiResponse<T>>;
+    /**
+     * Makes a GET request.
+     * @param {string} endpoint - The API endpoint.
+     * @returns {Promise<ApiResponse<T>>} - The API response.
+     * @template T
+     * @example
+     * const response = await client.get('/endpoint');
+     */
+    get<T>(endpoint: string, headers?: Record<string, string>): Promise<ApiResponse<T>>;
+    /**
+     * Makes a DELETE request.
+     * @param {string} endpoint - The API endpoint.
+     * @returns {Promise<ApiResponse<T>>} - The API response.
+     * @template T
+     * @example
+     * const response = await client.delete('/endpoint');
+     */
+    delete<T>(endpoint: string, headers?: Record<string, string>): Promise<ApiResponse<T>>;
+    /**
+     * Get an HTTP client for a specific organization.
+     * @returns {HttpClient} - An object containing methods for making HTTP requests.
+     * @example
+     * const httpClient = client.getHttpClientForOrg();
+     * const response = await httpClient.get('/endpoint');
+     */
+    getHttpClientForOrg(): HttpClient;
+    private getToken;
+}

package/dist/types/byods/index.d.ts

@@ -0,0 +1,43 @@
+import BaseClient from '../base-client';
+import { SDKConfig, JWSTokenVerificationResult } from '../types';
+import TokenManager from '../token-manager';
+/**
+ * The BYoDS SDK.
+ */
+export default class BYODS {
+    private headers;
+    private jwksCache;
+    private jwks;
+    private env;
+    private config;
+    private baseUrl;
+    /**
+     * The token manager for the SDK.
+     */
+    tokenManager: TokenManager;
+    /**
+     * Constructs a new instance of the BYODS SDK.
+     *
+     * @param {SDKConfig} config - The configuration object containing clientId and clientSecret.
+     * @example
+     * const sdk = new BYODS({ clientId: 'your-client-id', clientSecret: 'your-client-secret' });
+     */
+    constructor({ clientId, clientSecret, tokenStorageAdapter, logger, }: SDKConfig);
+    /**
+     * Verifies a JWS token using the public key.
+     * @param {string} jws - The JWS token to verify.
+     * @returns {Promise<JWSTokenVerificationResult>} A promise that resolves to an object containing the result of the verification.
+     * @example
+     * const result = await sdk.verifyJWSToken('jws-token');
+     */
+    verifyJWSToken(jws: string): Promise<JWSTokenVerificationResult>;
+    /**
+     * Retrieves a client instance for a specific organization.
+     *
+     * @param {string} orgId - The unique identifier of the organization.
+     * @returns {BaseClient} A new instance of BaseClient configured for the specified organization.
+     * @example
+     * const client = sdk.getClientForOrg('org-id');
+     */
+    getClientForOrg(orgId: string): BaseClient;
+}

package/dist/types/constants.d.ts

@@ -0,0 +1,17 @@
+import { LOGGER } from './Logger/types';
+export declare const BYODS_FILE = "BYODS";
+export declare const BYODS_SDK_VERSION = "0.0.1";
+export declare const BYODS_PACKAGE_NAME = "BYoDS NodeJS SDK";
+export declare const USER_AGENT: string;
+export declare const PRODUCTION_BASE_URL = "https://webexapis.com/v1";
+export declare const INTEGRATION_BASE_URL = "https://integration.webexapis.com/v1";
+export declare const PRODUCTION_JWKS_URL = "https://idbroker.webex.com/idb/oauth2/v2/keys/verificationjwk";
+export declare const INTEGRATION_JWKS_URL = "https://idbrokerbts.webex.com/idb/oauth2/v2/keys/verificationjwk";
+export declare const APPLICATION_ID_PREFIX = "ciscospark://us/APPLICATION/";
+export declare const BYODS_BASE_CLIENT_MODULE = "base-client";
+export declare const BYODS_MODULE = "byods";
+export declare const BYODS_TOKEN_MANAGER_MODULE = "token-manager";
+export declare const BYODS_DATA_SOURCE_CLIENT_MODULE = "data-source-client";
+export declare const DEFAULT_LOGGER_CONFIG: {
+    level: LOGGER;
+};

package/dist/types/data-source-client/constants.d.ts

@@ -0,0 +1 @@
+export declare const DATASOURCE_ENDPOINT = "/dataSources";

package/dist/types/data-source-client/index.d.ts

@@ -0,0 +1,87 @@
+import { LoggerConfig } from '../types';
+import { DataSourceRequest, DataSourceResponse, DataSourceUpdateRequest, Cancellable } from './types';
+import { HttpClient, ApiResponse } from '../http-client/types';
+/**
+ * Client for interacting with the /dataSource API.
+ */
+export default class DataSourceClient {
+    private httpClient;
+    private loggerConfig;
+    /**
+     * Creates an instance of DataSourceClient.
+     * @param {HttpClient} httpClient - The HttpClient instance to use for API requests.
+     * @example
+     * const httpClient = new HttpClient();
+     * const client = new DataSourceClient(httpClient);
+     */
+    constructor(httpClient: HttpClient, loggerConfig?: LoggerConfig);
+    /**
+     * Creates a new data source.
+     * @param {DataSourceRequest} createDataSourceRequest - The request object for creating a data source.
+     * @returns {Promise<ApiResponse<DataSourceResponse>>} - A promise that resolves to the API response containing the created data source.
+     * @example
+     * const request: DataSourceRequest = { name: 'New DataSource', url: 'https://mydatasource.com', schemaId: '123', audience: 'myaudience', subject: 'mysubject', nonce: 'uniqueNonce' };
+     * const response = await client.create(request);
+     */
+    create(dataSourcePayload: DataSourceRequest): Promise<ApiResponse<DataSourceResponse>>;
+    /**
+     * Retrieves a data source by ID.
+     * @param {string} id - The ID of the data source to retrieve.
+     * @returns {Promise<ApiResponse<DataSourceResponse>>} - A promise that resolves to the API response containing the data source.
+     * @example
+     * const id = '123';
+     * const response = await client.get(id);
+     */
+    get(id: string): Promise<ApiResponse<DataSourceResponse>>;
+    /**
+     * Lists all data sources.
+     * @returns {Promise<ApiResponse<DataSourceResponse[]>>} - A promise that resolves to the API response containing the list of data sources.
+     * @example
+     * const response = await client.list();
+     */
+    list(): Promise<ApiResponse<DataSourceResponse[]>>;
+    /**
+     * Updates a data source by ID.
+     * @param {string} id - The ID of the data source to update.
+     * @param {DataSourceRequest} updateDataSourceRequest - The request object for updating a data source.
+     * @returns {Promise<ApiResponse<DataSourceResponse>>} - A promise that resolves to the API response containing the updated data source.
+     * @example
+     * const id = '123';
+     * const request: DataSourceRequest = { name: 'Updated DataSource', url: 'https://mydatasource.com', schemaId: '123', audience: 'myaudience', subject: 'mysubject', nonce: 'uniqueNonce' };
+     * const response = await client.update(id, request);
+     */
+    update(id: string, dataSourcePayload: DataSourceUpdateRequest): Promise<ApiResponse<DataSourceResponse>>;
+    /**
+     * Deletes a data source by ID.
+     * @param {string} id - The ID of the data source to delete.
+     * @returns {Promise<ApiResponse<void>>} - A promise that resolves to the API response confirming the deletion.
+     * @example
+     * const id = '123';
+     * const response = await client.delete(id);
+     */
+    delete(id: string): Promise<ApiResponse<void>>;
+    /**
+     * This method refreshes the DataSource token using dataSourceId, tokenLifetimeMinutes & nonceGenerator.
+     * @param {string} dataSourceId The id of the data source.
+     * @param {number} tokenLifetimeMinutes The refresh interval in minutes for the data source. Defaults to 60 mins. Should be an integer.
+     * @param {string} nonceGenerator Accepts an nonceGenerator, developer can provide their own nonceGenerator, defaults to randomUUID.
+     * @returns {Promise<Cancelable>} A promise that resolves to an object containing a cancel method that cancels the timer.
+     * @example
+     * try {
+      const result = await dataSourceClient.scheduleJWSTokenRefresh('myDataSourceId', 'uniqueNonce', 'myTokenLifeTimeMinutes');
+      // Use the cancel function if needed!
+      result.cancel();
+    } catch (error) {
+      console.error('Error scheduling JWS refresh for data source:', error);
+    }
+     */
+    scheduleJWSTokenRefresh(dataSourceId: string, tokenLifetimeMinutes?: number, nonceGenerator?: () => string): Promise<Cancellable>;
+    /**
+     * Sets up a timer that will auto refresh the DataSource JWS token for given intervals
+     * @param {string} dataSourceId The id of the data source
+     * @param {number} tokenLifetimeMinutes The refresh interval in minutes for the data source. Defaults to 60 mins. Should be <= 1440 & >=1.
+     * @param {string} nonceGenerator Accepts an nonceGenerator that will generate nonce for the data source request.
+     * @returns {Promise<NodeJS.Timeout>} A promise that resolves to the API response containing NodeJS.Timeout.
+     */
+    private startAutoRefresh;
+}

package/dist/types/data-source-client/types.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Represents the response from a data source.
+ *
+ * @public
+ */
+export interface DataSourceResponse {
+    /**
+     * The unique identifier for the data source response.
+     */
+    id: string;
+    /**
+     * The identifier for the schema associated with the data source.
+     */
+    schemaId: string;
+    /**
+     * The identifier for the organization associated with the data source.
+     */
+    orgId: string;
+    /**
+     * The plain client identifier (not a Hydra base64 id string).
+     */
+    applicationId: string;
+    /**
+     * The status of the data source response. Either "active" or "disabled".
+     */
+    status: 'active' | 'disabled';
+    /**
+     * The JSON Web Signature token associated with the data source response.
+     */
+    jwsToken: string;
+    /**
+     * The identifier of the user who created the data source response.
+     */
+    createdBy: string;
+    /**
+     * The timestamp when the data source response was created.
+     */
+    createdAt: string;
+    /**
+     * The identifier of the user who last updated the data source response.
+     */
+    updatedBy?: string;
+    /**
+     * The timestamp when the data source response was last updated.
+     */
+    updatedAt?: string;
+    /**
+     * The error message associated with the data source response, if any.
+     */
+    errorMessage?: string;
+}
+/**
+ * Represents the request to a data source.
+ *
+ * @public
+ */
+export interface DataSourceRequest {
+    /**
+     * The identifier for the schema associated with the data source.
+     */
+    schemaId: string;
+    /**
+     * The URL of the data source.
+     */
+    url: string;
+    /**
+     * The audience for the data source request.
+     */
+    audience: string;
+    /**
+     * The subject of the data source request.
+     */
+    subject: string;
+    /**
+     * A unique nonce for the data source request.
+     */
+    nonce: string;
+    /**
+     * The lifetime of the token in minutes.
+     */
+    tokenLifetimeMinutes: number;
+}
+/**
+ * Represents the request to update a data source.
+ *
+ * @public
+ */
+export interface DataSourceUpdateRequest extends DataSourceRequest {
+    /**
+     * The status of the data source request. Either "active" or "disabled".
+     */
+    status: 'active' | 'disabled';
+    /**
+     * The error message associated with the data source update request. It is optional for "active" but required for "disabled".
+     */
+    errorMessage?: string;
+}
+/**
+ * Represents the response from a list.
+ *
+ * @public
+ */
+export interface ListResponse<T> {
+    items: T[];
+}
+export interface Cancellable {
+    cancel: () => void;
+}

package/dist/types/http-client/types.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Represents a generic API response.
+ *
+ * @public
+ */
+export interface ApiResponse<T> {
+    /**
+     * The response data.
+     */
+    data: T;
+    /**
+     * The response status code.
+     */
+    status: number;
+}
+/**
+ * Interface representing an HTTP client.
+ */
+export interface HttpClient {
+    /**
+     * Make a GET request to the specified endpoint.
+     * @param {string} endpoint - The endpoint to send the GET request to.
+     * @returns {Promise<ApiResponse<T>>} - A promise that resolves to the response data.
+     */
+    get<T>(endpoint: string): Promise<ApiResponse<T>>;
+    /**
+     * Make a DELETE request to the specified endpoint.
+     * @param {string} endpoint - The endpoint to send the DELETE request to.
+     * @returns {Promise<ApiResponse<T>>} - A promise that resolves to the response data.
+     */
+    delete<T>(endpoint: string): Promise<ApiResponse<T>>;
+    /**
+     * Make a POST request to the specified endpoint with the given body.
+     * @param {string} endpoint - The endpoint to send the POST request to.
+     * @param {Record<string, any>} body - The body of the POST request.
+     * @returns {Promise<ApiResponse<T>>} - A promise that resolves to the response data.
+     */
+    post<T>(endpoint: string, body: Record<string, any>): Promise<ApiResponse<T>>;
+    /**
+     * Make a PUT request to the specified endpoint with the given body.
+     * @param {string} endpoint - The endpoint to send the PUT request to.
+     * @param {Record<string, any>} body - The body of the PUT request.
+     * @returns {Promise<ApiResponse<T>>} - A promise that resolves to the response data.
+     */
+    put<T>(endpoint: string, body: Record<string, any>): Promise<ApiResponse<T>>;
+    /**
+     * Make a PATCH request to the specified endpoint with the given body.
+     * @param {string} endpoint - The endpoint to send the PATCH request to.
+     * @param {Record<string, any>} body - The body of the PATCH request.
+     * @returns {Promise<ApiResponse<T>>} - A promise that resolves to the response data.
+     */
+    patch<T>(endpoint: string, body: Record<string, any>): Promise<ApiResponse<T>>;
+}