@zcatalyst/transport 0.0.1 → 0.0.3

package/LICENCE

@@ -1 +1,55 @@
-ln -s ../../LICENSE packages/transport/LICENSE
+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,266 @@
+# @zcatalyst/transport
+
+HTTP Transport Layer for Catalyst SDK - Internal Communication Module
+
+## Overview
+
+The `@zcatalyst/transport` package provides the `Handler` class and request/response types used by Catalyst SDK packages to send HTTP requests. It has Node.js and browser entry points.
+
+### Prerequisites
+
+- Typically installed as a dependency of other Catalyst packages
+- Not required to be installed separately unless building custom integrations
+
+## Installation
+
+To install this package, simply type add or install @zcatalyst/transport
+using your favorite package manager:
+
+- `npm install @zcatalyst/transport`
+- `yarn add @zcatalyst/transport`
+- `pnpm add @zcatalyst/transport`
+
+## Getting Started
+
+### Import
+
+To use the transport handler, import `Handler`:
+
+```js
+// ES5 example
+const { Handler } = require("@zcatalyst/transport");
+```
+
+```ts
+// ES6+ example
+import { Handler } from "@zcatalyst/transport";
+```
+
+### Usage
+
+#### Node.js Environment
+
+For server-side HTTP requests using Node.js built-in modules:
+
+```js
+const handler = new Handler(app, component);
+
+// Send HTTP request
+const response = await handler.send({
+  method: 'GET',
+  url: '/api/data',
+  headers: {
+    'Content-Type': 'application/json'
+  }
+});
+```
+
+#### Browser Environment
+
+For client-side HTTP requests using Fetch API:
+
+```js
+const handler = new Handler(app, component);
+
+// Send HTTP request
+const response = await handler.send({
+  method: 'POST',
+  url: '/api/data',
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  data: {
+    name: 'example',
+    value: 123
+  }
+});
+```
+
+### Request Configuration
+
+The `send` method accepts an `IRequestConfig` object:
+
+```js
+const config = {
+  method: 'POST',           // HTTP method: GET, POST, PUT, DELETE, etc.
+  url: '/api/endpoint',      // API endpoint
+  headers: {                 // HTTP headers
+    'Content-Type': 'application/json',
+    'Authorization': 'Bearer token'
+  },
+  data: {                    // Request body (JSON)
+    key: 'value'
+  },
+  qs: {                      // URL query parameters
+    page: 1,
+    limit: 10
+  }
+};
+```
+
+### 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 HTTP requests:
+
+```js
+// async/await.
+try {
+  const response = await handler.send(config);
+  // process response.
+} catch (error) {
+  // error handling.
+} finally {
+  // finally.
+}
+```
+
+### Error Handling
+
+
+```js
+try {
+  const response = await handler.send(config);
+  // process response.
+} catch (error) {
+  const message = error.message;
+  const status = error.statusCode;
+  console.log({ message, status });
+}
+```
+
+## Method Details
+
+### Transport Operations
+
+<details>
+<summary>
+Create Handler Instance
+</summary>
+
+```js
+const handler = new Handler(app, component);
+```
+
+- `app`: Catalyst app instance (optional)
+- `component`: Component instance for request context (optional)
+
+</details>
+
+<details>
+<summary>
+Send GET Request
+</summary>
+
+```js
+const response = await handler.send({
+  method: 'GET',
+  url: '/api/users',
+  params: {
+    page: 1,
+    limit: 10
+  }
+});
+```
+
+</details>
+
+<details>
+<summary>
+Send POST Request
+</summary>
+
+```js
+const response = await handler.send({
+  method: 'POST',
+  url: '/api/users',
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  data: {
+    name: 'John Doe',
+    email: 'john@example.com'
+  }
+});
+```
+
+</details>
+
+<details>
+<summary>
+Send PUT Request
+</summary>
+
+```js
+const response = await handler.send({
+  method: 'PUT',
+  url: '/api/users/123',
+  headers: {
+    'Content-Type': 'application/json'
+  },
+  data: {
+    name: 'Jane Doe',
+    email: 'jane@example.com'
+  }
+});
+```
+
+</details>
+
+<details>
+<summary>
+Send DELETE Request
+</summary>
+
+```js
+const response = await handler.send({
+  method: 'DELETE',
+  url: '/api/users/123'
+});
+```
+
+</details>
+
+<details>
+<summary>
+Handle File Upload
+</summary>
+
+```js
+const formData = new FormData();
+formData.append('file', fileInput.files[0]);
+formData.append('description', 'Profile picture');
+
+const response = await handler.send({
+  method: 'POST',
+  url: '/api/upload',
+  headers: {
+    'Content-Type': 'multipart/form-data'
+  },
+  data: formData
+});
+```
+
+</details>
+
+### Environment Support
+
+This package has separate Node.js and browser entry points:
+
+- **Node.js**: Uses built-in `http` and `https` modules
+- **Browser**: Uses Fetch API
+
+## Resources
+
+- [Catalyst SDK Documentation](https://docs.catalyst.zoho.com/en/sdk/)
+- [Catalyst API Reference](https://docs.catalyst.zoho.com/en/sdk/)
+- [Node.js HTTP Module](https://nodejs.org/api/http.html)
+- [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+
+## 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/fetch-handler.js

@@ -0,0 +1,269 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a, _ResponseHandler_attachAppSpecificHeaders, _ResponseHandler_followZcrfTokenProtocol, _ResponseHandler_followJwtZCAuthProtocol, _ResponseHandler_sendRequest;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseHandler = exports.DefaultHttpResponse = void 0;
+const auth_client_1 = require("@zcatalyst/auth-client");
+const utils_1 = require("@zcatalyst/utils");
+const package_json_1 = __importDefault(require("../package.json"));
+const { version } = package_json_1.default;
+const constants_1 = require("./utils/constants");
+const errors_1 = require("./utils/errors");
+const request_timeout_1 = require("./utils/request-timeout");
+const { REQ_METHOD } = utils_1.CONSTANTS;
+class DefaultHttpResponse {
+    constructor(resp) {
+        this.statusCode = resp.statusCode;
+        this.headers = resp.headers;
+        this.config = resp.config;
+        this.resp = resp;
+    }
+    get data() {
+        if (this.resp.data === undefined) {
+            throw new errors_1.CatalystAPIError('UNPARSABLE_RESPONSE', `Error while processing response data. Raw server ` +
+                `response: "${this.resp.data}". `, '', this.statusCode);
+        }
+        return this.resp.data;
+    }
+}
+exports.DefaultHttpResponse = DefaultHttpResponse;
+class ResponseHandler {
+    constructor() { }
+    static async fireGeneralRequest({ requestCore, url }, requestOptions = {}) {
+        try {
+            const headers = requestCore.headers || {};
+            const method = requestCore.method;
+            const methodAllowsBody = method !== REQ_METHOD.get && method !== REQ_METHOD.head;
+            const options = {
+                method,
+                headers,
+                credentials: requestOptions.auth ? 'include' : 'omit',
+                body: methodAllowsBody ? requestCore.body : undefined
+            };
+            const isExternal = requestOptions.service === "external";
+            if (requestOptions.auth && !isExternal) {
+                options.headers = await _a.attachZCAuthHeaders(headers);
+                options.headers = __classPrivateFieldGet(this, _a, "m", _ResponseHandler_attachAppSpecificHeaders).call(this, headers);
+            }
+            const controller = new AbortController();
+            if (requestOptions.abortSignal) {
+                requestOptions.abortSignal.addEventListener('abort', () => controller.abort());
+            }
+            options.signal = controller.signal;
+            const response = await Promise.race([
+                fetch(url, options),
+                (0, request_timeout_1.requestTimeout)(requestOptions?.requestTimeout)
+            ]);
+            if (!response.ok) {
+                const errorData = await response.json().catch(() => null);
+                throw new errors_1.CatalystAPIError(`HTTP_ERROR_${response.status}`, errorData?.message || response.statusText, errorData, response.status);
+            }
+            if (requestOptions.retry && requestOptions.retry > 0) {
+                try {
+                    return await _a.wrapResponse(response, {
+                        ...requestOptions,
+                        request: requestCore
+                    });
+                }
+                catch {
+                    requestOptions.retry--;
+                    return this.fireGeneralRequest({ requestCore, url }, requestOptions);
+                }
+            }
+            return await _a.wrapResponse(response, {
+                ...requestOptions,
+                request: requestCore
+            });
+        }
+        catch (error) {
+            if (error instanceof errors_1.CatalystAPIError) {
+                throw error;
+            }
+            if (error.name === 'AbortError') {
+                throw new errors_1.CatalystAPIError('REQUEST_ABORTED', 'The request was aborted', error);
+            }
+            if (error.name === 'TypeError' && error.message.includes('Failed to fetch')) {
+                throw new errors_1.CatalystAPIError('NETWORK_ERROR', 'Network error occurred while making the request', error);
+            }
+            throw new errors_1.CatalystAPIError('REQUEST_FAILED', error.message || 'Request failed', error, error.statusCode);
+        }
+    }
+    static async wrapResponse(response, options) {
+        try {
+            const method = options?.request?.method?.toUpperCase();
+            const hasNoBody = method === REQ_METHOD.head || response.status === 204 || response.status === 304;
+            let data;
+            if (hasNoBody) {
+                data = '';
+            }
+            else {
+                switch (options?.expecting || "json") {
+                    case "buffer":
+                        data = await response.arrayBuffer();
+                        break;
+                    case "raw":
+                        data = await response.blob();
+                        break;
+                    case "json":
+                        data = await response.json();
+                        break;
+                    case "string":
+                        data = await response.text();
+                        break;
+                    default:
+                        throw new errors_1.CatalystAPIError('UNSUPPORTED_RESPONSE_TYPE', `Unsupported response type: ${options?.expecting}`);
+                }
+            }
+            return new DefaultHttpResponse({
+                headers: response.headers,
+                statusCode: response.status,
+                data,
+                request: options?.request || {},
+                config: options || {}
+            });
+        }
+        catch (error) {
+            throw new errors_1.CatalystAPIError('RESPONSE_PARSE_ERROR', 'Failed to parse response data', error);
+        }
+    }
+    static async fireRawRequest(requestCore, reqOptions) {
+        let headers = requestCore.headers;
+        if (reqOptions.auth) {
+            headers = await _a.attachZCAuthHeaders(headers);
+            headers = __classPrivateFieldGet(this, _a, "m", _ResponseHandler_attachAppSpecificHeaders).call(this, headers);
+            headers = { ...headers, credentials: 'include' };
+        }
+        const options = {
+            method: requestCore.method,
+            headers
+        };
+        if (requestCore.method !== REQ_METHOD.get && requestCore.body !== null)
+            options.body = requestCore.body;
+        const url = this.apiDomain ? `${this.apiDomain}${requestCore.url}` : requestCore.url;
+        return await this.wrapResponse(await fetch(url, options));
+    }
+    static async attachZCAuthHeaders(headers) {
+        const authProtocol = auth_client_1.ConfigStore.get('AUTH_PROTOCOL');
+        switch (authProtocol) {
+            case auth_client_1.Auth_Protocol.ZcrfTokenProtocol:
+                return await __classPrivateFieldGet(_a, _a, "m", _ResponseHandler_followZcrfTokenProtocol).call(_a, headers);
+            case auth_client_1.Auth_Protocol.JwtTokenProtocol:
+                return await __classPrivateFieldGet(_a, _a, "m", _ResponseHandler_followJwtZCAuthProtocol).call(_a, headers);
+            default:
+                return Promise.resolve(headers);
+        }
+    }
+    static getJWTZCAuthToken() {
+        const jwtPrefix = auth_client_1.ConfigStore.get(auth_client_1.JWT_COOKIE_PREFIX);
+        return new Promise((resolve, reject) => {
+            const jwtZCAuthToken = (0, auth_client_1.getToken)();
+            if (jwtZCAuthToken === '') {
+                reject('Unable to get the JWT Access Token.');
+            }
+            else {
+                resolve({
+                    access_token: `${jwtPrefix} ${jwtZCAuthToken}`
+                });
+            }
+        });
+    }
+    static appendQueryString(url, qs) {
+        if (!qs || Object.keys(qs).length === 0) {
+            return url;
+        }
+        const searchParams = new URLSearchParams();
+        Object.entries(qs)
+            .filter(([_, value]) => value != null)
+            .forEach(([key, value]) => searchParams.append(key, String(value)));
+        const baseUrl = url.split('?')[0];
+        const existingParams = url.split('?')[1] || '';
+        return `${baseUrl}?${existingParams ? `${existingParams}&` : ''}${searchParams.toString()}`;
+    }
+    static async send(options, componentName, componentVersion) {
+        const headers = options.headers || {};
+        const isExternal = options.service === "external";
+        if (!isExternal) {
+            let userAgent = utils_1.CONSTANTS.USER_AGENT.PREFIX + version;
+            if (componentName) {
+                userAgent += ` ${componentName}/${componentVersion || 'unknown'}`;
+            }
+            headers['X-Catalyst-User-Agent'] = userAgent;
+        }
+        let data = options.data;
+        if (data !== undefined) {
+            switch (options.type) {
+                case "json":
+                    data = JSON.stringify(data);
+                    headers['Content-Type'] = constants_1.HTTP_HEADER_MAP.CONTENT_JSON;
+                    break;
+                case "file":
+                    const formData = new FormData();
+                    const keyData = Object.keys(data);
+                    keyData.forEach((key) => {
+                        formData.append(key, data[key]);
+                    });
+                    data = formData;
+                    break;
+                case "raw":
+                    if (headers['Content-Type'] === undefined) {
+                        headers['Content-Type'] = 'application/octet-stream';
+                    }
+                    data = new Blob([data], { type: headers['Content-Type'] });
+                    break;
+                default:
+                    data = JSON.stringify(data);
+                    headers['Content-Type'] = 'application/x-www-form-urlencoded';
+            }
+        }
+        if (this.apiDomain === null && !options.origin) {
+            throw new errors_1.CatalystAPIError('API_REQUEST_ERROR', 'Unable to get the base url');
+        }
+        if (!isExternal && options.path) {
+            options.path = `${(0, utils_1.getServicePath)(options.service)}/project/${auth_client_1.ConfigStore.get(auth_client_1.PROJECT_ID)}${options.path}`;
+        }
+        const request = {
+            url: options.url ?? `${options.origin ?? this.apiDomain}${options.path}`,
+            method: options.method,
+            ...(data ? { body: data } : {}),
+            headers
+        };
+        request.url = this.appendQueryString(request.url, options.qs);
+        return await __classPrivateFieldGet(this, _a, "m", _ResponseHandler_sendRequest).call(this, request, {
+            expecting: options.expecting,
+            auth: options.auth ?? true,
+            service: options.service
+        });
+    }
+}
+exports.ResponseHandler = ResponseHandler;
+_a = ResponseHandler, _ResponseHandler_attachAppSpecificHeaders = function _ResponseHandler_attachAppSpecificHeaders(headers) {
+    let normalizedHeaders = headers;
+    normalizedHeaders = (0, auth_client_1.addDefaultAppHeaders)(normalizedHeaders);
+    return normalizedHeaders;
+}, _ResponseHandler_followZcrfTokenProtocol = async function _ResponseHandler_followZcrfTokenProtocol(headers) {
+    await (0, auth_client_1.collectZCRFToken)();
+    const csrfToken = auth_client_1.ConfigStore.get('CSRF_TOKEN');
+    headers[constants_1.X_ZCSRF_TOKEN] = `${constants_1.ZD_CSRPARAM}=${csrfToken}`;
+    return headers;
+}, _ResponseHandler_followJwtZCAuthProtocol = async function _ResponseHandler_followJwtZCAuthProtocol(headers) {
+    return this.getJWTZCAuthToken()
+        .then((resp) => {
+        headers[constants_1.HTTP_HEADER_MAP.AUTHORIZATION_KEY] =
+            resp.access_token;
+        return headers;
+    })
+        .catch((err) => {
+        throw new errors_1.CatalystAPIError('API_ERROR', err.message, err.status);
+    });
+}, _ResponseHandler_sendRequest = async function _ResponseHandler_sendRequest(request, options) {
+    const { url, ...requestCore } = request;
+    return _a.fireGeneralRequest({ url, requestCore }, options);
+};
+ResponseHandler.apiDomain = typeof document !== 'undefined' ? document.location.origin : '';