@zcatalyst/auth-admin 0.0.3

package/LICENCE

@@ -0,0 +1,55 @@
+Zoho Catalyst SDK
+
+Copyright (c) 2025 Zoho Corporation Private Limited
+
+
+Apache License Version 2.0
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,251 @@
+# @zcatalyst/auth-admin
+
+> **Internal package.** Consumed transitively by service packages. Do not install directly.
+
+JavaScript SDK for Catalyst Admin Authentication - Catalyst App Initialization
+
+## Overview
+
+The `@zcatalyst/auth-admin` package provides Node.js APIs for initializing Catalyst app instances and accessing configured credentials. Its package metadata marks it as server-only for browser builds.
+
+### Prerequisites
+
+- A [Catalyst project](https://docs.catalyst.zoho.com/en/getting-started/catalyst-projects) set up
+- Project credentials
+- Node.js environment (server-side only)
+
+## Installation
+
+To install this package, simply type add or install @zcatalyst/auth-admin
+using your favorite package manager:
+
+- `npm install @zcatalyst/auth-admin`
+- `yarn add @zcatalyst/auth-admin`
+- `pnpm add @zcatalyst/auth-admin`
+
+## Getting Started
+
+### Import
+
+The Catalyst SDK is modularized by Components.
+To handle admin authentication, you only need to import the `ZCAuth`:
+
+```js
+// CommonJS
+const { ZCAuth } = require("@zcatalyst/auth-admin");
+```
+
+```ts
+// ES6+
+import { ZCAuth } from "@zcatalyst/auth-admin";
+```
+
+### Usage
+
+#### Initialize Admin Authentication
+
+```js
+const auth = new ZCAuth();
+
+const app = auth.init({
+  credential: {
+    getToken: async () => 'access-token'
+  },
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key',
+  environment: 'development'
+}, { type: 'custom' });
+```
+
+#### Environment Variables
+
+You can also configure authentication using environment variables:
+
+```bash
+export ZCATALYST_PROJECT_ID=your_project_id
+export ZCATALYST_PROJECT_KEY=your_project_key
+export ZCATALYST_ENVIRONMENT=development
+export ZCATALYST_PROJECT_DOMAIN=catalyst.zoho.com
+export ZCATALYST_PROJECT_SECRET_KEY=your_secret_key
+```
+
+Then initialize without parameters:
+
+```js
+const auth = new ZCAuth();
+const app = auth.getDefaultCredentials();
+```
+
+### Async/await
+
+We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
+operator to wait for the promise returned by authentication operations:
+
+```js
+try {
+  const app = auth.init(credentials, { type: 'custom' });
+} catch (error) {
+  // error handling
+} finally {
+  // cleanup
+}
+```
+
+### Error Handling
+
+
+```js
+try {
+  const app = auth.init(credentials, { type: 'custom' });
+} catch (error) {
+  const message = error.message;
+  const status = error.statusCode;
+  console.log({ message, status });
+}
+```
+
+## Supported Credential Types
+
+`@zcatalyst/auth-admin` exposes the following credential classes. Pass any of them as the `credential` field to `auth.init({ credential, ... }, { type })`.
+
+| Class | When to use |
+|---|---|
+| `RefreshTokenCredential` | You have a long-lived OAuth refresh token + client id/secret. |
+| `AccessTokenCredential` | You already hold a short-lived access token. |
+| `TicketCredential` | You have a Catalyst-issued ticket. |
+| `CookieCredential` | You forward a browser session cookie to the server. |
+| `CatalystCredential` | Wraps the headers Catalyst attaches to incoming serverless requests. |
+| `ApplicationDefaultCredential` | Loads credentials from `~/.config/<suffix>` or `CLIENT_ID`/`CLIENT_SECRET`/`REFRESH_TOKEN` env vars. |
+| `ApplicationCustomCredential` | Loads from a credential object you build at runtime (e.g. from your own secret store). |
+
+### Per-credential examples
+
+```ts
+import {
+  ZCAuth,
+  RefreshTokenCredential,
+  AccessTokenCredential,
+  TicketCredential,
+  CookieCredential,
+  CatalystCredential,
+  ApplicationDefaultCredential,
+  ApplicationCustomCredential
+} from '@zcatalyst/auth-admin';
+
+const auth = new ZCAuth();
+
+// 1. RefreshTokenCredential
+auth.init({
+  credential: new RefreshTokenCredential({
+    client_id: process.env.CLIENT_ID!,
+    client_secret: process.env.CLIENT_SECRET!,
+    refresh_token: process.env.REFRESH_TOKEN!
+  }),
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key'
+}, { type: 'custom' });
+
+// 2. AccessTokenCredential
+auth.init({
+  credential: new AccessTokenCredential({ access_token: 'eyJ...' }),
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key'
+}, { type: 'custom' });
+
+// 3. TicketCredential
+auth.init({
+  credential: new TicketCredential({ ticket: 'ticket-value' }),
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key'
+}, { type: 'custom' });
+
+// 4. CookieCredential
+auth.init({
+  credential: new CookieCredential({ cookie: req.headers.cookie }),
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key'
+}, { type: 'custom' });
+
+// 5. CatalystCredential — typical inside a Catalyst function
+auth.init({ credential: new CatalystCredential(req.headers as Record<string, string>) },
+  { type: 'advancedio' });
+
+// 6. ApplicationDefaultCredential — picks up file/env automatically
+auth.init({
+  credential: new ApplicationDefaultCredential(),
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key'
+}, { type: 'custom' });
+
+// 7. ApplicationCustomCredential — build the credential object yourself
+auth.init({
+  credential: new ApplicationCustomCredential({
+    client_id: 'xxx',
+    client_secret: 'xxx',
+    refresh_token: 'xxx'
+  }),
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key'
+}, { type: 'custom' });
+```
+
+## Method Details
+
+<details>
+<summary>
+<strong>init(options)</strong> - Initialize Authentication
+</summary>
+
+```js
+const auth = new ZCAuth();
+const app = auth.init({
+  credential: {
+    getToken: async () => 'access-token'
+  },
+  projectId: 'your_project_id',
+  projectKey: 'your_project_key',
+  environment: 'development'
+}, {
+  type: 'custom',
+  appName: 'my-app',
+  scope: 'admin'
+});
+```
+
+</details>
+
+<details>
+<summary>
+<strong>app(name)</strong> - Get App Instance
+</summary>
+
+```js
+const app = auth.app('your_app_name');
+```
+
+</details>
+
+<details>
+<summary>
+<strong>getDefaultCredentials()</strong> - Get Default Credentials
+</summary>
+
+```js
+const auth = new ZCAuth();
+const app = auth.getDefaultCredentials();
+```
+
+</details>
+
+## Resources
+
+- [Catalyst Authentication Documentation](https://docs.catalyst.zoho.com/en/cloud-scale/help/authentication/introduction/)
+- [Project Credentials](https://docs.catalyst.zoho.com/en/getting-started/catalyst-projects/)
+
+## Contributing
+
+See [CONTRIBUTING](../../CONTRIBUTING.md) for more information on how to get started.
+
+## License
+
+This SDK is distributed under the Apache License 2.0. See [LICENSE](../../LICENCE) file for more information.

package/dist-cjs/credential.js

@@ -0,0 +1,362 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApplicationCustomCredential = exports.ApplicationDefaultCredential = exports.CatalystCredential = exports.CookieCredential = exports.TicketCredential = exports.AccessTokenCredential = exports.RefreshTokenCredential = exports.Credential = exports.globalValue = void 0;
+const utils_1 = require("@zcatalyst/utils");
+const fs_1 = require("fs");
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
+const path_1 = require("path");
+const querystring_1 = require("querystring");
+const errors_1 = require("./errors");
+const { CREDENTIAL_SUFFIX, REQ_METHOD, CREDENTIAL_HEADER, CREDENTIAL_TYPE, CREDENTIAL_USER, CSRF_TOKEN_NAME, ACCOUNTS_ORIGIN } = utils_1.CONSTANTS;
+exports.globalValue = {};
+const CREDENTIAL_PATH = process.env.HOME
+    ? (0, path_1.resolve)((0, path_1.resolve)(process.env.HOME, '.config'), CREDENTIAL_SUFFIX)
+    : (0, path_1.resolve)('.', CREDENTIAL_SUFFIX);
+function getAttr(from, key, alt) {
+    const tmp = from[key] || (alt ? from[alt] : undefined);
+    if (typeof tmp === 'undefined') {
+        throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', `Unable to get ${alt} from credential Object provided`, from);
+    }
+    return tmp;
+}
+function fromPath(filePath) {
+    let jsonString;
+    try {
+        jsonString = (0, fs_1.readFileSync)(filePath, 'utf8');
+    }
+    catch {
+        return null;
+    }
+    try {
+        return JSON.parse(jsonString);
+    }
+    catch (err) {
+        throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'Failed to parse token file: ' + err, err);
+    }
+}
+function fromEnv() {
+    const clientId = process.env['CLIENT_ID'];
+    const clientSecret = process.env['CLIENT_SECRET'];
+    const refreshToken = process.env['REFRESH_TOKEN'];
+    if (clientId && clientSecret && refreshToken) {
+        return {
+            client_id: clientId,
+            client_secret: clientSecret,
+            refresh_token: refreshToken
+        };
+    }
+    else {
+        throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', `Failed to get the credential string from env variables`);
+    }
+}
+function _appendQueryData(url, data) {
+    if (data && Object.keys(data).length > 0) {
+        url += url.includes('?') ? '&' : '?';
+        url += (0, querystring_1.stringify)(data);
+    }
+    return url;
+}
+function isHttps(url) {
+    if (url === undefined) {
+        return false;
+    }
+    const parsedUrl = url instanceof URL ? url : new URL(url);
+    return parsedUrl.protocol !== 'http:';
+}
+async function _request(config) {
+    config.url = _appendQueryData(String(config.origin) + String(config.path), config.qs);
+    const parsedUrl = new URL(config.url);
+    if (parsedUrl.hostname === null) {
+        throw new errors_1.CatalystAuthError('unparsable_config', 'Hostname cannot be null', config.path);
+    }
+    const isHttpsProtocol = isHttps(parsedUrl);
+    parsedUrl.searchParams?.sort();
+    const options = {
+        hostname: parsedUrl.hostname,
+        port: parsedUrl.port,
+        path: parsedUrl.pathname + parsedUrl.search,
+        method: config.method,
+        headers: {
+            'Content-Type': 'application/json',
+            ...(config.headers || {})
+        }
+    };
+    const transport = isHttpsProtocol ? https_1.default : http_1.default;
+    return new Promise((resolve, reject) => {
+        const req = transport.request(options, (res) => {
+            const chunks = [];
+            res.on('data', (chunk) => {
+                chunks.push(chunk);
+            });
+            res.on('end', () => {
+                const body = Buffer.concat(chunks).toString();
+                const response = {
+                    headers: res.headers,
+                    request: req,
+                    stream: res,
+                    statusCode: res.statusCode,
+                    config,
+                    body
+                };
+                resolve(response);
+            });
+        });
+        req.on('error', (err) => {
+            reject(err);
+        });
+        req.write(JSON.stringify({ your: 'data' }));
+        req.end();
+    });
+}
+async function requestAccessToken(request) {
+    const options = {
+        method: request.method,
+        origin: request.origin,
+        qs: request.qs,
+        path: request.path
+    };
+    const resp = await _request(options);
+    const json = JSON.parse(resp.body);
+    if (json.error) {
+        const errorMessage = 'Error fetching access token: ' + json.error;
+        return Promise.reject(errorMessage);
+    }
+    else if (!json.access_token || !json.expires_in) {
+        return Promise.reject(`Unexpected response while fetching access token: ${JSON.stringify(json)}`);
+    }
+    else {
+        return json;
+    }
+}
+class Credential {
+    getCurrentUser() {
+        return CREDENTIAL_USER.admin;
+    }
+    switchUser(_givenUser) {
+        return null;
+    }
+    getCurrentUserType() {
+        return CREDENTIAL_USER.admin;
+    }
+}
+exports.Credential = Credential;
+class RefreshTokenCredential extends Credential {
+    constructor(refreshObj) {
+        super();
+        this.clientId = getAttr(refreshObj, 'clientId', 'client_id');
+        this.clientSecret = getAttr(refreshObj, 'clientSecret', 'client_secret');
+        this.refreshToken = getAttr(refreshObj, 'refreshToken', 'refresh_token');
+        this.cachedToken = null;
+    }
+    async getToken() {
+        if (this.cachedToken === null || this.cachedToken['expires_in'] <= Date.now()) {
+            const token = await requestAccessToken({
+                method: REQ_METHOD.post,
+                origin: ACCOUNTS_ORIGIN,
+                path: '/oauth/v2/token',
+                qs: {
+                    client_id: this.clientId,
+                    client_secret: this.clientSecret,
+                    refresh_token: this.refreshToken,
+                    grant_type: 'refresh_token'
+                }
+            });
+            this.cachedToken = token;
+            this.cachedToken.expires_in = Date.now() + token.expires_in * 1000;
+        }
+        return this.cachedToken;
+    }
+}
+exports.RefreshTokenCredential = RefreshTokenCredential;
+class AccessTokenCredential extends Credential {
+    constructor(accessObj) {
+        super();
+        this.accessToken = getAttr(accessObj, 'accessToken', 'access_token');
+    }
+    async getToken() {
+        return Promise.resolve({
+            access_token: this.accessToken
+        });
+    }
+}
+exports.AccessTokenCredential = AccessTokenCredential;
+class TicketCredential extends Credential {
+    constructor(ticketObj) {
+        super();
+        this.ticket = getAttr(ticketObj, 'ticket', 'ticket');
+    }
+    async getToken() {
+        return Promise.resolve({ ticket: this.ticket });
+    }
+}
+exports.TicketCredential = TicketCredential;
+class CookieCredential extends Credential {
+    constructor(cookieObj) {
+        super();
+        this.cookie = getAttr(cookieObj, 'cookie', 'cookie');
+        this.cookieObj = {};
+    }
+    getAsObject() {
+        if (Object.keys(this.cookieObj).length > 0) {
+            return this.cookieObj;
+        }
+        this.cookie.split(';').forEach((cookie) => {
+            const parts = cookie.split('=');
+            this.cookieObj[parts.shift()?.trim()] = decodeURI(parts.join('='));
+        });
+        return this.cookieObj;
+    }
+    getZCSRFHeader() {
+        const cookieObj = this.getAsObject();
+        return 'zd_csrparam=' + cookieObj[CSRF_TOKEN_NAME];
+    }
+    async getToken() {
+        return Promise.resolve({ cookie: this.cookie, zcrf_header: this.getZCSRFHeader() });
+    }
+}
+exports.CookieCredential = CookieCredential;
+class CatalystCredential extends Credential {
+    constructor(credObj, scope) {
+        super();
+        this.adminCredType = getAttr(credObj, 'adminType', CREDENTIAL_HEADER.admin_cred_type);
+        this.adminToken = getAttr(credObj, 'adminToken', CREDENTIAL_HEADER.admin_token);
+        this.userCredType = credObj[CREDENTIAL_HEADER.user_cred_type];
+        this.userToken = credObj[CREDENTIAL_HEADER.user_token];
+        this.cookieStr = credObj[CREDENTIAL_HEADER.cookie];
+        this.userType =
+            credObj[CREDENTIAL_HEADER.user] === CREDENTIAL_USER.admin
+                ? CREDENTIAL_USER.admin
+                : CREDENTIAL_USER.user;
+        this.scope = scope || this.userType;
+        if (this.scope === CREDENTIAL_USER.user) {
+            if (this.userType === CREDENTIAL_USER.admin) {
+                throw new errors_1.CatalystAuthError('AUTH_ERROR', 'User not authenticated. Please login to proceed with user scope', credObj);
+            }
+            if (this.userToken === undefined && this.cookieStr === undefined) {
+                throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'missing user credentials', credObj);
+            }
+        }
+        switch (this.adminCredType) {
+            case CREDENTIAL_TYPE.ticket:
+                this.adminCred = new TicketCredential({ ticket: this.adminToken });
+                break;
+            case CREDENTIAL_TYPE.token:
+                this.adminCred = new AccessTokenCredential({ access_token: this.adminToken });
+                break;
+            default:
+                throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'admin credential type is unknown', credObj);
+        }
+        switch (this.userCredType) {
+            case CREDENTIAL_TYPE.ticket:
+                this.userCred = new TicketCredential({ ticket: this.userToken });
+                break;
+            case CREDENTIAL_TYPE.token:
+                this.userCred = new AccessTokenCredential({
+                    access_token: this.userToken
+                });
+                break;
+            default:
+                if (this.cookieStr !== undefined) {
+                    this.userCred = new CookieCredential({
+                        cookie: this.cookieStr
+                    });
+                }
+        }
+    }
+    async getToken() {
+        switch (this.scope) {
+            case CREDENTIAL_USER.admin:
+                return this.adminCred.getToken();
+            case CREDENTIAL_USER.user:
+                if (this.userCred === undefined) {
+                    throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'User Credential is not initialised', this.scope);
+                }
+                return this.userCred.getToken();
+            default:
+                throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'user provided is not recognized', this.scope);
+        }
+    }
+    getScope() {
+        return this.scope;
+    }
+    getCurrentUser() {
+        return this.scope;
+    }
+    getCurrentUserType() {
+        if (this.scope === CREDENTIAL_USER.user) {
+            return this.userType;
+        }
+        return this.scope;
+    }
+    switchUser(givenUser) {
+        if (givenUser === undefined) {
+            switch (this.scope) {
+                case CREDENTIAL_USER.admin:
+                    givenUser = CREDENTIAL_USER.user;
+                    break;
+                case CREDENTIAL_USER.user:
+                    givenUser = CREDENTIAL_USER.admin;
+                    break;
+            }
+        }
+        this.scope = givenUser;
+        return this.scope;
+    }
+}
+exports.CatalystCredential = CatalystCredential;
+class ApplicationDefaultCredential extends Credential {
+    constructor() {
+        super();
+        let token = fromPath(CREDENTIAL_PATH);
+        if (token === undefined || token === null) {
+            token = fromEnv();
+        }
+        if (token === undefined || token === null) {
+            throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'Unable to get token object from path or env', token);
+        }
+        if ('refresh_token' in token) {
+            this.credential = new RefreshTokenCredential(token);
+        }
+        else if ('access_token' in token) {
+            this.credential = new AccessTokenCredential(token);
+        }
+        else if ('ticket' in token) {
+            this.credential = new TicketCredential(token);
+        }
+        else {
+            throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'The given token object does not contain proper credentials', token);
+        }
+    }
+    async getToken() {
+        return this.credential.getToken();
+    }
+}
+exports.ApplicationDefaultCredential = ApplicationDefaultCredential;
+class ApplicationCustomCredential extends Credential {
+    constructor(credObj) {
+        super();
+        if (credObj === undefined || credObj === null) {
+            throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'Unable to get token object from path or env', credObj);
+        }
+        if ('refresh_token' in credObj) {
+            this.credential = new RefreshTokenCredential(credObj);
+        }
+        else if ('access_token' in credObj) {
+            this.credential = new AccessTokenCredential(credObj);
+        }
+        else if ('ticket' in credObj) {
+            this.credential = new TicketCredential(credObj);
+        }
+        else {
+            throw new errors_1.CatalystAuthError('INVALID_CREDENTIAL', 'The given token object does not contain proper credentials', credObj);
+        }
+    }
+    async getToken() {
+        return this.credential.getToken();
+    }
+}
+exports.ApplicationCustomCredential = ApplicationCustomCredential;

package/dist-cjs/errors.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalystAuthError = void 0;
+const utils_1 = require("@zcatalyst/utils");
+class CatalystAuthError extends utils_1.PrefixedCatalystError {
+    constructor(code, message, value) {
+        super('app', code, message, value);
+    }
+}
+exports.CatalystAuthError = CatalystAuthError;