@zcatalyst/transport 0.0.1 → 0.0.3

package/dist-types/ts3.4/utils/helpers.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Reports whether a URL uses the HTTPS protocol.
+ *
+ * @param url - The URL to update or request.
+ * @returns True when the URL uses HTTPS.
+ *
+ * @example
+ * ```ts
+ * import { Handler } from '@zcatalyst/transport';
+ * const result = isHttps("https://example.com");
+ * ```
+ */
+export declare function isHttps(url?: string | URL): boolean;

package/dist-types/ts3.4/utils/interfaces.d.ts

@@ -0,0 +1,68 @@
+import { CatalystService } from '@zcatalyst/utils';
+import { RequestType, ResponseType } from './enums';
+export interface Component {
+    getComponentName(): string;
+    getComponentVersion?(): string;
+}
+export interface jwtAccessTokenResponse {
+    access_token: string;
+}
+export type SimpleType = {
+    url: string;
+    body: object | string | null;
+};
+export interface FileType {
+    url: string;
+    body: FormData;
+}
+export interface CoreType {
+    url: string;
+    body?: BodyInit | string | null;
+    method?: string;
+    headers: Record<string, string> | HeadersInit;
+}
+export interface RequestHandlerOptions {
+    request?: RequestInit;
+    retry?: number;
+    abortSignal?: AbortSignal;
+    requestTimeout?: number;
+    expecting?: ResponseType;
+    auth?: boolean;
+    duplex?: string;
+    service?: CatalystService;
+}
+export interface HTTP_CODE_MAP_BODY_TYPE {
+    CODE: number;
+    TEXT: string;
+}
+export interface HTTP_CODE_MAP_TYPE {
+    [code: string]: HTTP_CODE_MAP_BODY_TYPE;
+}
+export interface HTTP_CODE_REV_MAP_TYPE {
+    [code: number]: HTTP_CODE_MAP_BODY_TYPE;
+}
+export interface FORMDATA {
+    code: string;
+    name: string;
+}
+export interface IRequestConfig {
+    duplex?: string;
+    data?: string | Array<{
+        [x: string]: unknown;
+    }> | Array<string | number> | Record<string, unknown> | unknown;
+    type?: RequestType;
+    qs?: Record<string, string | number | boolean | undefined>;
+    path?: string;
+    origin?: string;
+    url?: string;
+    method?: string;
+    headers?: Record<string, string>;
+    user?: string;
+    service?: CatalystService;
+    auth?: boolean;
+    track?: boolean;
+    external?: boolean;
+    abortSignal?: AbortSignal;
+    expecting?: ResponseType;
+    retry?: boolean;
+}

package/dist-types/ts3.4/utils/request-agent.d.ts

@@ -0,0 +1,12 @@
+import { Agent as httpAgent } from 'http';
+import { Agent as httpsAgent } from 'https';
+export default class RequestAgent {
+    agent: httpAgent | httpsAgent;
+    /**
+     * Creates a RequestAgent instance.
+     * @param isHttps - The isHttps value.
+     * @param host - The host value.
+     * @param replaceAgent - The replaceAgent value.
+     */
+    constructor(isHttps: boolean, host: string, replaceAgent: boolean);
+}

package/dist-types/ts3.4/utils/request-timeout.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Creates a promise that rejects when a request exceeds the configured timeout.
+ *
+ * @param timeoutInMs - The timeout duration in milliseconds.
+ * @returns A promise that rejects when the timeout elapses.
+ *
+ * @example
+ * ```ts
+ * import { Handler } from '@zcatalyst/transport';
+ * const result = undefined;
+ * ```
+ */
+export declare function requestTimeout(timeoutInMs?: number): Promise<never>;

package/dist-types/utils/clonable-stream.d.ts

@@ -0,0 +1,75 @@
+import { PassThrough, Readable } from 'stream';
+declare class StreamClone extends PassThrough {
+    parent: CloneableStream;
+    /**
+     * Creates a StreamClone instance.
+     * @param parent - The parent value.
+     */
+    constructor(parent: CloneableStream);
+    private onDataClone;
+    private onResumeClone;
+    /**
+     * Performs clone for the transport package.
+     *
+     * @returns The clone result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    clone(): StreamClone;
+    /**
+     * Performs is cloneable for the transport package.
+     *
+     * @param stream - The stream value.
+     * @returns The is cloneable result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    isCloneable(stream: unknown): stream is CloneableStream | StreamClone;
+}
+export default class CloneableStream extends PassThrough {
+    _original: Readable | undefined;
+    _clonesCount: number;
+    _internalPipe: boolean;
+    _hasListener: boolean;
+    /**
+     * Creates a CloneableStream instance.
+     * @param stream - The stream value.
+     */
+    constructor(stream: Readable);
+    private onData;
+    private onResume;
+    /**
+     * Performs resume for the transport package.
+     *
+     * @returns The resume result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    resume(): this;
+    /**
+     * Performs clone for the transport package.
+     *
+     * @returns The clone result.
+     * @throws {Error} when validation fails.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    clone(): StreamClone;
+}
+export {};

package/dist-types/utils/constants.d.ts

@@ -0,0 +1,11 @@
+import { HTTP_CODE_MAP_TYPE, HTTP_CODE_REV_MAP_TYPE } from './interfaces';
+export declare const HTTP_CODE_MAP: HTTP_CODE_MAP_TYPE;
+export declare const HTTP_HEADER_MAP: {
+    CONTENT_JSON: string;
+    AUTHORIZATION_KEY: string;
+};
+export declare const REQUEST_PROPERTY: unknown;
+export declare const X_ZCSRF_TOKEN = "X-ZCSRF-TOKEN";
+export declare const ZD_CSRPARAM = "zd_csrparam";
+declare const HTTP_CODE_REV_MAP: HTTP_CODE_REV_MAP_TYPE;
+export { HTTP_CODE_REV_MAP };

package/dist-types/utils/enums.d.ts

@@ -0,0 +1,16 @@
+export declare const enum ResponseType {
+    RAW = "raw",
+    JSON = "json",
+    STRING = "string",
+    BUFFER = "buffer"
+}
+export declare const enum RequestType {
+    FILE = "file",
+    JSON = "json",
+    URL_ENCODED = "url_encoded",
+    RAW = "raw"
+}
+export declare const enum FormDataKeys {
+    CODE = "code",
+    FILE_NAME = "file_name"
+}

package/dist-types/utils/errors.d.ts

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

package/dist-types/utils/form-data.d.ts

@@ -0,0 +1,285 @@
+import { IncomingMessage } from 'http';
+import { PassThrough, Readable, Stream } from 'stream';
+export type formDataType = string | Buffer | Readable | IncomingMessage | PassThrough | Record<string, string>;
+export default class FormData extends Stream {
+    writable: boolean;
+    readable: boolean;
+    released: boolean;
+    streams: Array<formDataType>;
+    currentStream: undefined | formDataType;
+    insideLoop: boolean;
+    pendingNext: boolean;
+    boundary: string | undefined;
+    /**
+     * Creates a FormData instance.
+     * @param streams - The streams value.
+     */
+    constructor(streams?: Array<formDataType>);
+    static LINE_BREAK: string;
+    static CONTENT_TYPE: string;
+    /**
+     * Performs is stream for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The is stream result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    isStream(value: unknown): boolean;
+    /**
+     * Performs multi part header for the transport package.
+     *
+     * @param field - The field value.
+     * @param value - The value to validate.
+     * @returns The multi part header result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _multiPartHeader(field: string, value: formDataType): string;
+    /**
+     * Performs get content disposition for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The get content disposition result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _getContentDisposition(value: unknown): string | undefined;
+    /**
+     * Performs get content type for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The get content type result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _getContentType(value: formDataType): string;
+    /**
+     * Performs last boundary for the transport package.
+     *
+     * @returns The last boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _lastBoundary(): string;
+    /**
+     * Performs generate boundary for the transport package.
+     *
+     * @returns The generate boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _generateBoundary(): string;
+    /**
+     * Performs error for the transport package.
+     *
+     * @param err - The err value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _error(err: Error): void;
+    /**
+     * Performs handle stream errors for the transport package.
+     *
+     * @param stream - The stream value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _handleStreamErrors(stream: Stream): void;
+    /**
+     * Performs pipe next for the transport package.
+     *
+     * @param stream - The stream value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _pipeNext(stream: formDataType): void;
+    /**
+     * Performs get next for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _getNext(): void;
+    /**
+     * Performs reset for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _reset(): void;
+    /**
+     * Performs create clone for the transport package.
+     *
+     * @returns The create clone result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    createClone(): FormData;
+    /**
+     * Performs append for the transport package.
+     *
+     * @param field - The field value.
+     * @param value - The value to validate.
+     * @returns The append result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    append(field: string, value: unknown): this;
+    /**
+     * Performs get headers for the transport package.
+     *
+     * @param userHeaders - The user headers value.
+     * @returns The get headers result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    getHeaders(userHeaders: {
+        [x: string]: string;
+    }): {
+        [x: string]: string;
+    };
+    /**
+     * Performs get boundary for the transport package.
+     *
+     * @returns The get boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    getBoundary(): string;
+    /**
+     * Performs pipe for the transport package.
+     *
+     * @param dest - The dest value.
+     * @param options - The initialization or request options.
+     * @returns The pipe result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    pipe<T extends NodeJS.WritableStream>(dest: T, options?: {
+        end?: boolean;
+    }): T;
+    /**
+     * Performs write for the transport package.
+     *
+     * @param data - The data value.
+     * @returns The write result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    write(data: Uint8Array | string): boolean;
+    /**
+     * Performs pause for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    pause(): void;
+    /**
+     * Performs resume for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    resume(): void;
+    /**
+     * Performs end for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    end(): void;
+    /**
+     * Performs destroy for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    destroy(): void;
+    /** function toString() { [native code] } */
+    toString(): string;
+}

package/dist-types/utils/helpers.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Reports whether a URL uses the HTTPS protocol.
+ *
+ * @param url - The URL to update or request.
+ * @returns True when the URL uses HTTPS.
+ *
+ * @example
+ * ```ts
+ * import { Handler } from '@zcatalyst/transport';
+ * const result = isHttps("https://example.com");
+ * ```
+ */
+export declare function isHttps(url?: string | URL): boolean;

package/dist-types/utils/interfaces.d.ts

@@ -0,0 +1,68 @@
+import { CatalystService } from '@zcatalyst/utils';
+import { RequestType, ResponseType } from './enums';
+export interface Component {
+    getComponentName(): string;
+    getComponentVersion?(): string;
+}
+export interface jwtAccessTokenResponse {
+    access_token: string;
+}
+export type SimpleType = {
+    url: string;
+    body: object | string | null;
+};
+export interface FileType {
+    url: string;
+    body: FormData;
+}
+export interface CoreType {
+    url: string;
+    body?: BodyInit | string | null;
+    method?: string;
+    headers: Record<string, string> | HeadersInit;
+}
+export interface RequestHandlerOptions {
+    request?: RequestInit;
+    retry?: number;
+    abortSignal?: AbortSignal;
+    requestTimeout?: number;
+    expecting?: ResponseType;
+    auth?: boolean;
+    duplex?: string;
+    service?: CatalystService;
+}
+export interface HTTP_CODE_MAP_BODY_TYPE {
+    CODE: number;
+    TEXT: string;
+}
+export interface HTTP_CODE_MAP_TYPE {
+    [code: string]: HTTP_CODE_MAP_BODY_TYPE;
+}
+export interface HTTP_CODE_REV_MAP_TYPE {
+    [code: number]: HTTP_CODE_MAP_BODY_TYPE;
+}
+export interface FORMDATA {
+    code: string;
+    name: string;
+}
+export interface IRequestConfig {
+    duplex?: string;
+    data?: string | Array<{
+        [x: string]: unknown;
+    }> | Array<string | number> | Record<string, unknown> | unknown;
+    type?: RequestType;
+    qs?: Record<string, string | number | boolean | undefined>;
+    path?: string;
+    origin?: string;
+    url?: string;
+    method?: string;
+    headers?: Record<string, string>;
+    user?: string;
+    service?: CatalystService;
+    auth?: boolean;
+    track?: boolean;
+    external?: boolean;
+    abortSignal?: AbortSignal;
+    expecting?: ResponseType;
+    retry?: boolean;
+}

package/dist-types/utils/request-agent.d.ts

@@ -0,0 +1,12 @@
+import { Agent as httpAgent } from 'http';
+import { Agent as httpsAgent } from 'https';
+export default class RequestAgent {
+    agent: httpAgent | httpsAgent;
+    /**
+     * Creates a RequestAgent instance.
+     * @param isHttps - The isHttps value.
+     * @param host - The host value.
+     * @param replaceAgent - The replaceAgent value.
+     */
+    constructor(isHttps: boolean, host: string, replaceAgent: boolean);
+}

package/dist-types/utils/request-timeout.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Creates a promise that rejects when a request exceeds the configured timeout.
+ *
+ * @param timeoutInMs - The timeout duration in milliseconds.
+ * @returns A promise that rejects when the timeout elapses.
+ *
+ * @example
+ * ```ts
+ * import { Handler } from '@zcatalyst/transport';
+ * const result = undefined;
+ * ```
+ */
+export declare function requestTimeout(timeoutInMs?: number): Promise<never>;

package/package.json

@@ -1,28 +1,58 @@
 {
   "name": "@zcatalyst/transport",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist-es/index.js",
+        "require": "./dist-cjs/index.js",
+        "types": "./dist-types/index.d.ts"
+      },
+      "browser": {
+        "import": "./dist-es/index.browser.js",
+        "require": "./dist-cjs/index.browser.js",
+        "types": "./dist-types/index.browser.d.ts"
+      },
+      "default": {
+        "import": "./dist-es/index.js",
+        "require": "./dist-cjs/index.js",
+        "types": "./dist-types/index.d.ts"
+      }
+    }
+  },
   "license": "Apache-2.0",
+  "sideEffects": false,
   "dependencies": {
-    "@zcatalyst/auth": "^0.0.1",
-    "@zcatalyst/utils": "^0.0.1",
-    "@zcatalyst/auth-client": "^0.0.1"
+    "@zcatalyst/utils": "^0.0.3",
+    "@zcatalyst/auth-admin": "^0.0.3",
+    "@zcatalyst/auth-client": "^0.0.3"
   },
   "browser": {
     "./dist-cjs/index.js": "./dist-cjs/index.browser.js",
     "./dist-es/index.js": "./dist-es/index.browser.js",
-    "./dist-types/index.d.ts": "./dist-types/index.browser.d.ts"
+    "./dist-types/index.d.ts": "./dist-types/index.browser.d.ts",
+    "stream": false,
+    "crypto": false,
+    "fs": false,
+    "path": false,
+    "process": false
   },
   "engines": {
-    "node": ">=21"
+    "node": ">=20"
   },
   "files": [
     "dist-*/**"
   ],
+  "keywords": [
+    "transport",
+    "zcatalyst",
+    "catalyst"
+  ],
   "scripts": {
-    "build": "concurrently 'pnpm:build:cjs' 'pnpm:build:es' 'pnpm:build:types && pnpm build:types:downlevel'",
+    "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",