@zcatalyst/auth-admin 0.0.3

package/dist-types/ts3.4/credential.d.ts

@@ -0,0 +1,288 @@
+export declare const globalValue: {};
+export declare abstract class Credential {
+    /**
+     * Returns the credential token payload.
+     *
+     * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use Credential.getToken in a Node request handler.
+     * ```
+     */
+    abstract getToken(): Promise<{
+        [x: string]: string;
+    }>;
+    /**
+     * Returns the current credential scope.
+     *
+     * @returns The getCurrentUser result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use Credential.getCurrentUser in a Node request handler.
+     * ```
+     */
+    getCurrentUser(): string;
+    /**
+     * Switches the active credential scope.
+     *
+     * @param _givenUser - The _givenUser value.
+     * @returns The switchUser result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use Credential.switchUser in a Node request handler.
+     * ```
+     */
+    switchUser(_givenUser?: string): string | null;
+    /**
+     * Returns the effective user type.
+     *
+     * @returns The getCurrentUserType result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use Credential.getCurrentUserType in a Node request handler.
+     * ```
+     */
+    getCurrentUserType(): string;
+}
+export declare class RefreshTokenCredential extends Credential {
+    refreshToken: string;
+    clientId: string;
+    clientSecret: string;
+    cachedToken: {
+        access_token: string;
+        expires_in: number;
+    } | null;
+    /**
+     * Creates a RefreshTokenCredential instance.
+     * @param refreshObj - The refreshObj value.
+     */
+    constructor(refreshObj: {
+        [x: string]: string;
+    });
+    /**
+     * Returns the credential token payload.
+     *
+     * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use RefreshTokenCredential.getToken in a Node request handler.
+     * ```
+     */
+    getToken(): Promise<{
+        ['access_token']: string;
+    }>;
+}
+export declare class AccessTokenCredential extends Credential {
+    accessToken: string;
+    /**
+     * Creates a AccessTokenCredential instance.
+     * @param accessObj - The accessObj value.
+     */
+    constructor(accessObj: Record<string, string>);
+    /**
+     * Returns the credential token payload.
+     *
+     * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use AccessTokenCredential.getToken in a Node request handler.
+     * ```
+     */
+    getToken(): Promise<{
+        access_token: string;
+    }>;
+}
+export declare class TicketCredential extends Credential {
+    ticket: string;
+    /**
+     * Creates a TicketCredential instance.
+     * @param ticketObj - The ticketObj value.
+     */
+    constructor(ticketObj: {
+        [x: string]: string;
+    });
+    /**
+     * Returns the credential token payload.
+     *
+     * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use TicketCredential.getToken in a Node request handler.
+     * ```
+     */
+    getToken(): Promise<{
+        ['ticket']: string;
+    }>;
+}
+export declare class CookieCredential extends Credential {
+    cookie: string;
+    cookieObj: {
+        [x: string]: string;
+    };
+    /**
+     * Creates a CookieCredential instance.
+     * @param cookieObj - The cookieObj value.
+     */
+    constructor(cookieObj: {
+        [x: string]: string;
+    });
+    private getAsObject;
+    private getZCSRFHeader;
+    /**
+     * Returns the credential token payload.
+     *
+     * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use CookieCredential.getToken in a Node request handler.
+     * ```
+     */
+    getToken(): Promise<{
+        ['cookie']: string;
+        ['zcrf_header']: string;
+    }>;
+}
+export declare class CatalystCredential extends Credential {
+    adminCredType: string;
+    userCredType: string | undefined;
+    adminToken: string;
+    userToken: string | undefined;
+    adminCred: TicketCredential | AccessTokenCredential;
+    userCred: TicketCredential | AccessTokenCredential | CookieCredential | undefined;
+    cookieStr: string | undefined;
+    scope: string;
+    userType: string;
+    /**
+     * Creates a CatalystCredential instance.
+     * @param credObj - The credObj value.
+     * @param scope - The scope value.
+     */
+    constructor(credObj: Record<string, string | undefined>, scope?: string);
+    /** @override  * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use CatalystCredential.getToken in a Node request handler.
+     * ```
+     */
+    getToken(): Promise<{
+        access_token?: string;
+        ticket?: string;
+        cookie?: string;
+        zcrf_header?: string;
+    }>;
+    /** @override  * @returns The getScope result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use CatalystCredential.getScope in a Node request handler.
+     * ```
+     */
+    getScope(): string;
+    /** @override  * @returns The getCurrentUser result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use CatalystCredential.getCurrentUser in a Node request handler.
+     * ```
+     */
+    getCurrentUser(): string;
+    /** @override  * @returns The getCurrentUserType result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use CatalystCredential.getCurrentUserType in a Node request handler.
+     * ```
+     */
+    getCurrentUserType(): string;
+    /** @override  * @param givenUser - The givenUser value.
+     * @returns The switchUser result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use CatalystCredential.switchUser in a Node request handler.
+     * ```
+     */
+    switchUser(givenUser?: string): string;
+}
+export declare class ApplicationDefaultCredential extends Credential {
+    credential: RefreshTokenCredential | AccessTokenCredential | TicketCredential;
+    /**
+     * Creates a ApplicationDefaultCredential instance.
+     */
+    constructor();
+    /**
+     * Returns the credential token payload.
+     *
+     * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use ApplicationDefaultCredential.getToken in a Node request handler.
+     * ```
+     */
+    getToken(): Promise<{
+        access_token?: string;
+        ticket?: string;
+    }>;
+}
+export declare class ApplicationCustomCredential extends Credential {
+    credential: RefreshTokenCredential | AccessTokenCredential | TicketCredential;
+    /**
+     * Creates a ApplicationCustomCredential instance.
+     * @param credObj - The credObj value.
+     */
+    constructor(credObj?: Record<string, string>);
+    /**
+     * Returns the credential token payload.
+     *
+     * @returns The getToken result.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * // Use ApplicationCustomCredential.getToken in a Node request handler.
+     * ```
+     */
+    getToken(): Promise<{
+        access_token?: string;
+        ticket?: string;
+    }>;
+}

package/dist-types/ts3.4/errors.d.ts

@@ -0,0 +1,10 @@
+import { PrefixedCatalystError } from '@zcatalyst/utils';
+export declare class CatalystAuthError extends PrefixedCatalystError {
+    /**
+     * Creates a CatalystAuthError instance.
+     * @param code - The code value.
+     * @param message - The message value.
+     * @param value - The value value.
+     */
+    constructor(code: string, message: string, value?: unknown);
+}

package/dist-types/ts3.4/index.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Catalyst Authentication for Node.js (admin scope) — initializes a CatalystApp from a request and exposes server-side identity APIs.
+ *
+ * @packageDocumentation
+ */
+import { CatalystAppError, ICatalystAppConfig } from '@zcatalyst/utils';
+import { Credential } from './credential';
+export declare class ZCAuth {
+    private "ZCAuth.#private";
+    config: Record<string, string | number | Credential | Object>;
+    /**
+     * Initializes and stores a Catalyst app instance from request headers or custom credentials.
+     *
+     * @param options - The initialization or request options.
+     * @param options - The initialization or request options.
+     * @param options.type - The initialization type.
+     * @param options.appName - The registered Catalyst app name.
+     * @param options.scope - The credential scope to use.
+     * @returns The initialized Catalyst app instance.
+     * @throws {CatalystAppError} when app initialization or validation fails.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth, ZCAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * const result = app; // use ZCAuth.init in a Node request handler
+     * ```
+     */
+    init(options: Record<string, string | number>, { type, appName, scope }?: {
+        type?: string;
+        appName?: string;
+        scope?: 'admin' | 'user';
+    }): CatalystApp;
+    /**
+     * Returns a Catalyst app initialized from default credentials.
+     *
+     * @param appName - The registered Catalyst app name.
+     * @returns The initialized default Catalyst app instance.
+     * @throws {CatalystAppError} when app initialization or validation fails.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth, ZCAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * const result = app; // use ZCAuth.getDefaultCredentials in a Node request handler
+     * ```
+     */
+    getDefaultCredentials(appName?: string): CatalystApp;
+    /**
+     * Returns a previously initialized Catalyst app by name.
+     *
+     * @param appName - The registered Catalyst app name.
+     * @returns The registered Catalyst app instance.
+     * @throws {CatalystAppError} when app initialization or validation fails.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth, ZCAuth } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * const result = app; // use ZCAuth.app in a Node request handler
+     * ```
+     */
+    app(appName?: string): CatalystApp;
+}
+export declare class CatalystApp {
+    credential: Credential;
+    config: ICatalystAppConfig;
+    /**
+     * Creates a CatalystApp instance.
+     * @param options - The options value.
+     */
+    constructor(options: Record<string, string | number | Credential | Object>);
+    private setOauthHeader;
+    private setTicketHeader;
+    /**
+     * Adds the appropriate authentication headers to a request object.
+     *
+     * @param req - The request object to authenticate.
+     *
+     * @example
+     * ```ts
+     * import { zcAuth, CatalystApp } from '@zcatalyst/auth-admin';
+     * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+     * await app.authenticateRequest({ headers: {} });
+     * ```
+     */
+    authenticateRequest(req: Record<string, unknown>): Promise<void>;
+}
+/**
+ * Adds Catalyst project headers required by SDK service requests.
+ *
+ * @param headers - The headers object to mutate or extend.
+ * @param values - The Catalyst app configuration values.
+ * @returns The updated headers object.
+ *
+ * @example
+ * ```ts
+ * import { zcAuth, addDefaultAppHeaders } from '@zcatalyst/auth-admin';
+ * const app = zcAuth.init({ credential: { access_token: 'token' }, projectId: '123' }, { type: 'custom' });
+ * addDefaultAppHeaders({}, app.config);
+ * ```
+ */
+export declare function addDefaultAppHeaders(headers: Record<string, string>, values?: ICatalystAppConfig): Record<string, string>;
+export { AccessTokenCredential, Credential, RefreshTokenCredential, TicketCredential } from './credential';
+export { CatalystAppError };

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@zcatalyst/auth-admin",
+  "version": "0.0.3",
+  "main": "./dist-cjs/index.js",
+  "module": "./dist-es/index.js",
+  "types": "./dist-types/index.d.ts",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@zcatalyst/utils": "^0.0.3"
+  },
+  "files": [
+    "dist-*/**"
+  ],
+  "browser": {
+    "server-only-package": true
+  },
+  "scripts": {
+    "build": "pnpm clean && concurrently 'pnpm:build:cjs' 'pnpm:build:es' 'pnpm:build:types && pnpm build:types:downlevel'",
+    "build:cjs": "pnpm tsc -p tsconfig.cjs.json",
+    "build:es": "pnpm tsc -p tsconfig.es.json",
+    "build:types": "pnpm tsc -p tsconfig.types.json",
+    "build:types:downlevel": "rimraf dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4",
+    "test": "jest --config ./jest.config.js",
+    "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo || exit 0",
+    "lint": "eslint -c ../../eslint.config.mjs \"src/**/*.ts\"",
+    "format": "prettier  --ignore-path ../.prettierignore --write \"{src, test}/*.ts\""
+  }
+}