@cdx-forge/di-typescript-sdk 0.1.0-beta.1

package/dist/generated/src/runtime.js

@@ -0,0 +1,348 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
+ *
+ * The version of the OpenAPI document: 1.4.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const BASE_PATH = "https://api.candescent.com/digitalbanking/stage".replace(/\/+$/, "");
+export class Configuration {
+    configuration;
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : async () => accessToken;
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+export const DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+export class BaseAPI {
+    configuration;
+    static jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
+    middleware;
+    constructor(configuration = DefaultConfig) {
+        this.configuration = configuration;
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+    async request(context, initOverrides) {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response && (response.status >= 200 && response.status < 300)) {
+            return response;
+        }
+        throw new ResponseError(response, 'Response returned an error code');
+    }
+    async createFetchParams(context, initOverrides) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += '?' + this.configuration.queryParamsStringify(context.query);
+        }
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+        const initOverrideFn = typeof initOverrides === "function"
+            ? initOverrides
+            : async () => initOverrides;
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials,
+        };
+        const overriddenInit = {
+            ...initParams,
+            ...(await initOverrideFn({
+                init: initParams,
+                context,
+            }))
+        };
+        let body;
+        if (isFormData(overriddenInit.body)
+            || (overriddenInit.body instanceof URLSearchParams)
+            || isBlob(overriddenInit.body)) {
+            body = overriddenInit.body;
+        }
+        else if (this.isJsonMime(headers['Content-Type'])) {
+            body = JSON.stringify(overriddenInit.body);
+        }
+        else {
+            body = overriddenInit.body;
+        }
+        const init = {
+            ...overriddenInit,
+            body
+        };
+        return { url, init };
+    }
+    fetchApi = async (url, init) => {
+        let fetchParams = { url, init };
+        for (const middleware of this.middleware) {
+            if (middleware.pre) {
+                fetchParams = await middleware.pre({
+                    fetch: this.fetchApi,
+                    ...fetchParams,
+                }) || fetchParams;
+            }
+        }
+        let response = undefined;
+        try {
+            response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+        }
+        catch (e) {
+            for (const middleware of this.middleware) {
+                if (middleware.onError) {
+                    response = await middleware.onError({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        error: e,
+                        response: response ? response.clone() : undefined,
+                    }) || response;
+                }
+            }
+            if (response === undefined) {
+                if (e instanceof Error) {
+                    throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+                }
+                else {
+                    throw e;
+                }
+            }
+        }
+        for (const middleware of this.middleware) {
+            if (middleware.post) {
+                response = await middleware.post({
+                    fetch: this.fetchApi,
+                    url: fetchParams.url,
+                    init: fetchParams.init,
+                    response: response.clone(),
+                }) || response;
+            }
+        }
+        return response;
+    };
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+;
+function isBlob(value) {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+export class ResponseError extends Error {
+    response;
+    name = "ResponseError";
+    constructor(response, msg) {
+        super(msg);
+        this.response = response;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+export class FetchError extends Error {
+    cause;
+    name = "FetchError";
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+export class RequiredError extends Error {
+    field;
+    name = "RequiredError";
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+export function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+function querystringSingleKey(key, value, keyPrefix = '') {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+export function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+export function mapValues(data, fn) {
+    const result = {};
+    for (const key of Object.keys(data)) {
+        result[key] = fn(data[key]);
+    }
+    return result;
+}
+export function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+export class JSONApiResponse {
+    raw;
+    transformer;
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    async value() {
+        return this.transformer(await this.raw.json());
+    }
+}
+export class VoidApiResponse {
+    raw;
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return undefined;
+    }
+}
+export class BlobApiResponse {
+    raw;
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.blob();
+    }
+    ;
+}
+export class TextApiResponse {
+    raw;
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.text();
+    }
+    ;
+}

package/dist/src/auth.d.ts

@@ -0,0 +1,71 @@
+/**
+ * OAuth 2.0 token providers for V1 (legacy) and V2 (current) endpoints.
+ *
+ * Handles token acquisition, caching, automatic refresh, and revocation.
+ * Supports client_credentials, password, refresh_token, and static token flows.
+ */
+export declare enum TokenEndpoint {
+    V1_LEGACY = "/v1/oauth/token",
+    V2_CURRENT = "/oauth2/v1/token"
+}
+export interface AccessToken {
+    token: string;
+    expiresAt: number;
+    tokenType: string;
+    refreshToken?: string;
+    scope?: string;
+}
+export interface TokenProvider {
+    getToken(): Promise<AccessToken>;
+    refreshToken(): Promise<AccessToken>;
+    revokeToken?(): Promise<void>;
+    endpoint: TokenEndpoint;
+}
+export declare class ClientCredentialsProvider implements TokenProvider {
+    private readonly clientId;
+    private readonly clientSecret;
+    protected readonly institutionId: string;
+    protected readonly baseUrl: string;
+    private cached;
+    private refreshing;
+    readonly endpoint: TokenEndpoint;
+    constructor(clientId: string, clientSecret: string, institutionId: string, baseUrl: string, endpoint?: TokenEndpoint);
+    getToken(): Promise<AccessToken>;
+    refreshToken(): Promise<AccessToken>;
+    revokeToken(): Promise<void>;
+    protected fiHeader(): string;
+    protected fetchToken(body: string): Promise<AccessToken>;
+    private parseXmlToken;
+    protected basicAuth(): string;
+}
+/**
+ * OAuth 2.0 password (ROPC) grant for end-user authentication.
+ *
+ * Attempts refresh_token grant before falling back to a fresh password grant.
+ *
+ * @example
+ * ```ts
+ * const provider = new PasswordGrantProvider(
+ *   "client-id", "secret", "user", "pass", "12345", baseUrl,
+ * );
+ * ```
+ */
+export declare class PasswordGrantProvider extends ClientCredentialsProvider {
+    private readonly username;
+    private readonly password;
+    private pwCached;
+    private pwRefreshing;
+    constructor(clientId: string, clientSecret: string, username: string, password: string, institutionId: string, baseUrl: string, endpoint?: TokenEndpoint);
+    getToken(): Promise<AccessToken>;
+    refreshToken(): Promise<AccessToken>;
+    private doRefresh;
+    revokeToken(): Promise<void>;
+}
+/** Wraps a pre-obtained bearer token (e.g. from CANDESCENT_BEARER_TOKEN). */
+export declare class StaticTokenProvider implements TokenProvider {
+    readonly endpoint = TokenEndpoint.V2_CURRENT;
+    private readonly token;
+    constructor(bearerToken: string);
+    getToken(): Promise<AccessToken>;
+    refreshToken(): Promise<AccessToken>;
+}

package/dist/src/auth.js

@@ -0,0 +1,226 @@
+/**
+ * OAuth 2.0 token providers for V1 (legacy) and V2 (current) endpoints.
+ *
+ * Handles token acquisition, caching, automatic refresh, and revocation.
+ * Supports client_credentials, password, refresh_token, and static token flows.
+ */
+import { CandescentError, errorForStatus } from "./errors.js";
+export var TokenEndpoint;
+(function (TokenEndpoint) {
+    TokenEndpoint["V1_LEGACY"] = "/v1/oauth/token";
+    TokenEndpoint["V2_CURRENT"] = "/oauth2/v1/token";
+})(TokenEndpoint || (TokenEndpoint = {}));
+export class ClientCredentialsProvider {
+    clientId;
+    clientSecret;
+    institutionId;
+    baseUrl;
+    cached = null;
+    refreshing = null;
+    endpoint;
+    constructor(clientId, clientSecret, institutionId, baseUrl, endpoint) {
+        this.clientId = clientId;
+        this.clientSecret = clientSecret;
+        this.institutionId = institutionId;
+        this.baseUrl = baseUrl;
+        this.endpoint = endpoint ?? TokenEndpoint.V2_CURRENT;
+    }
+    async getToken() {
+        if (this.cached && Date.now() < this.cached.expiresAt - 30_000) {
+            return this.cached;
+        }
+        return this.refreshToken();
+    }
+    async refreshToken() {
+        if (this.refreshing)
+            return this.refreshing;
+        this.refreshing = this.fetchToken("grant_type=client_credentials");
+        try {
+            this.cached = await this.refreshing;
+            return this.cached;
+        }
+        finally {
+            this.refreshing = null;
+        }
+    }
+    async revokeToken() {
+        if (!this.cached || this.endpoint !== TokenEndpoint.V2_CURRENT)
+            return;
+        try {
+            await fetch(`${this.baseUrl}/oauth2/v1/revoke`, {
+                method: "DELETE",
+                headers: {
+                    Authorization: this.basicAuth(),
+                    "Content-Type": "application/x-www-form-urlencoded",
+                    institutionId: this.institutionId,
+                    transactionid: crypto.randomUUID(),
+                },
+                body: `token=${encodeURIComponent(this.cached.token)}`,
+            });
+        }
+        catch {
+            // best-effort
+        }
+        this.cached = null;
+    }
+    fiHeader() {
+        return this.endpoint === TokenEndpoint.V1_LEGACY ? "di_fiid" : "institutionId";
+    }
+    async fetchToken(body) {
+        const url = `${this.baseUrl}${this.endpoint}`;
+        const tidHeader = this.endpoint === TokenEndpoint.V1_LEGACY ? "di_tid" : "transactionid";
+        const headers = {
+            Authorization: this.basicAuth(),
+            "Content-Type": "application/x-www-form-urlencoded",
+            [this.fiHeader()]: this.institutionId,
+            [tidHeader]: crypto.randomUUID(),
+        };
+        const resp = await fetch(url, {
+            method: "POST",
+            headers,
+            body,
+        });
+        if (!resp.ok) {
+            const text = await resp.text();
+            if (resp.status === 401 || resp.status === 403) {
+                throw errorForStatus(resp.status, resp.headers, text, resp);
+            }
+            throw new CandescentError(`Token request failed (${resp.status}): ${text}`);
+        }
+        const text = await resp.text();
+        const contentType = resp.headers.get("content-type") ?? "";
+        if (contentType.includes("xml") || (this.endpoint === TokenEndpoint.V1_LEGACY && text.trimStart().startsWith("<"))) {
+            return this.parseXmlToken(text);
+        }
+        let data;
+        try {
+            data = JSON.parse(text);
+        }
+        catch {
+            throw new CandescentError(`Token response is not valid JSON: ${text.slice(0, 300)}`);
+        }
+        if (!data.access_token) {
+            throw new CandescentError(`Token response missing access_token: ${text.slice(0, 300)}`);
+        }
+        return {
+            token: data.access_token,
+            expiresAt: Date.now() + (Number(data.expires_in) || 1800) * 1000,
+            tokenType: data.token_type ?? "Bearer",
+            refreshToken: data.refresh_token,
+            scope: data.scope,
+        };
+    }
+    parseXmlToken(xml) {
+        const extract = (tag) => {
+            const re = new RegExp(`<${tag}>([^<]*)</${tag}>`);
+            return re.exec(xml)?.[1] || undefined;
+        };
+        const token = extract("access_token");
+        if (!token) {
+            throw new CandescentError(`V1 token response missing <access_token>: ${xml.slice(0, 300)}`);
+        }
+        const expiresIn = parseInt(extract("expires_in") ?? "1800", 10);
+        return {
+            token,
+            expiresAt: Date.now() + expiresIn * 1000,
+            tokenType: "Bearer",
+        };
+    }
+    basicAuth() {
+        return "Basic " + btoa(`${this.clientId}:${this.clientSecret}`);
+    }
+}
+/**
+ * OAuth 2.0 password (ROPC) grant for end-user authentication.
+ *
+ * Attempts refresh_token grant before falling back to a fresh password grant.
+ *
+ * @example
+ * ```ts
+ * const provider = new PasswordGrantProvider(
+ *   "client-id", "secret", "user", "pass", "12345", baseUrl,
+ * );
+ * ```
+ */
+export class PasswordGrantProvider extends ClientCredentialsProvider {
+    username;
+    password;
+    pwCached = null;
+    pwRefreshing = null;
+    constructor(clientId, clientSecret, username, password, institutionId, baseUrl, endpoint) {
+        super(clientId, clientSecret, institutionId, baseUrl, endpoint);
+        this.username = username;
+        this.password = password;
+    }
+    async getToken() {
+        if (this.pwCached && Date.now() < this.pwCached.expiresAt - 30_000) {
+            return this.pwCached;
+        }
+        return this.refreshToken();
+    }
+    async refreshToken() {
+        if (this.pwRefreshing)
+            return this.pwRefreshing;
+        this.pwRefreshing = this.doRefresh();
+        try {
+            this.pwCached = await this.pwRefreshing;
+            return this.pwCached;
+        }
+        finally {
+            this.pwRefreshing = null;
+        }
+    }
+    async doRefresh() {
+        if (this.pwCached?.refreshToken) {
+            try {
+                return await this.fetchToken(`grant_type=refresh_token&refresh_token=${encodeURIComponent(this.pwCached.refreshToken)}`);
+            }
+            catch {
+                // fall through to password grant
+            }
+        }
+        return this.fetchToken(`grant_type=password&username=${encodeURIComponent(this.username)}&password=${encodeURIComponent(this.password)}`);
+    }
+    async revokeToken() {
+        if (!this.pwCached || this.endpoint !== TokenEndpoint.V2_CURRENT) {
+            this.pwCached = null;
+            this.pwRefreshing = null;
+            return;
+        }
+        try {
+            await fetch(`${this.baseUrl}/oauth2/v1/revoke`, {
+                method: "DELETE",
+                headers: {
+                    Authorization: this.basicAuth(),
+                    "Content-Type": "application/x-www-form-urlencoded",
+                    institutionId: this.institutionId,
+                    transactionid: crypto.randomUUID(),
+                },
+                body: `token=${encodeURIComponent(this.pwCached.token)}`,
+            });
+        }
+        catch {
+            // best-effort
+        }
+        this.pwCached = null;
+        this.pwRefreshing = null;
+    }
+}
+/** Wraps a pre-obtained bearer token (e.g. from CANDESCENT_BEARER_TOKEN). */
+export class StaticTokenProvider {
+    endpoint = TokenEndpoint.V2_CURRENT;
+    token;
+    constructor(bearerToken) {
+        this.token = {
+            token: bearerToken,
+            expiresAt: Date.now() + 86_400_000,
+            tokenType: "Bearer",
+        };
+    }
+    async getToken() {
+        return this.token;
+    }
+    async refreshToken() {
+        return this.token;
+    }
+}