@unmeshed/sdk 1.0.13 → 1.0.16

package/README.md

@@ -0,0 +1,128 @@
+# Unmeshed Javascript / Typescript SDK
+
+This README will guide you on how to set up Unmeshed credentials, run workers, and get started with the Unmeshed
+platform. Read more about unmeshed on https://unmeshed.io/
+
+## About Unmeshed
+
+Unmeshed is a ⚡ fast, low latency orchestration platform, that can be used to build 🛠️, run 🏃, and scale 📈 API and
+microservices orchestration, scheduled jobs ⏰, and more with ease. Learn more on
+our [🌍 main website](https://unmeshed.io) or explore
+the [📖 documentation overview](https://unmeshed.io/docs/concepts/overview).
+
+Unmeshed is built by the ex-founders of Netflix Conductor. This is the next gen platform built using similar principles
+but is blazing fast and covers many more use cases.
+
+---
+
+## Installing the Unmeshed SDK
+
+To use Unmeshed in your project, install the SDK using your preferred package manager:
+
+### Using npm:
+
+```bash
+npm install @unmeshed/sdk
+```
+
+### Using Yarn:
+
+```bash
+yarn add @unmeshed/sdk
+```
+
+## Setting Up Unmeshed Credentials
+
+To use the Unmeshed SDK in your Node.js app, you need to initialize the `UnmeshedClient` with your credentials. Replace
+the placeholder values below with your actual credentials:
+
+```javascript
+const {UnmeshedClient} = require("@unmeshed/sdk");
+
+const unmeshedClient = new UnmeshedClient({
+    baseUrl: 'http://localhost', // Replace with your Unmeshed API endpoint 🌐
+    port: 8080, // Replace with your Unmeshed API port 🚪
+    authToken: 'your-auth-token', // Replace with your API 🔒 auth token
+    clientId: 'your-client-id' // Replace with your API 🆔 client ID
+});
+```
+
+> **Note:** Do not expose these credentials in a browser 🌐. For browser implementations, leverage webhooks and user
+> tokens 🔑 directly.
+
+You can get started with Unmeshed by visiting our [📘 Get Started Guide](https://unmeshed.io/docs/concepts/overview).
+
+---
+
+## Running a Worker
+
+A worker in Unmeshed processes 🌀 tasks asynchronously based on workflows or process definitions. Below is an example of
+defining and starting a worker:
+
+### Step 1: Define a Worker Function
+
+A worker function processes incoming tasks and returns an output:
+
+```javascript
+let workerFunction = (input) => {
+    return new Promise((resolve) => {
+        const output = {
+            ...input || {},
+            "ranAt": new Date() // Add the current timestamp to the output 🕒
+        };
+        resolve(output);
+    });
+};
+```
+
+### Step 2: Register the Worker
+
+Define the worker configuration and register it with the `UnmeshedClient`:
+
+```javascript
+const worker = {
+    worker: workerFunction,
+    namespace: 'default', // Namespace for the worker 🗂️
+    name: 'test-node-worker', // Unique name for the worker 🏷️
+    maxInProgress: 500 // Maximum number of in-progress tasks ⏳
+};
+
+unmeshedClient.startPolling([worker]); 
+```
+
+
+You can run as many workers as you want.
+
+
+Et voilà — that's it! Now whenever a process definition or worker reaches this step with name test-node-worker, it will run your function
+
+> The `startPolling` method starts the worker to listen 👂 for tasks continuously.
+
+### Step 3: Start Your Application
+
+When you run your Node.js app, and the worker will start polling for tasks automatically 🤖.
+
+---
+
+## Additional Resources
+
+- **[📖 Workers Documentation](https://unmeshed.io/docs/concepts/workers):** Learn more about workers and how to use them
+  effectively.
+- **Use Case Highlights:**
+    - [🌐 API Orchestration](https://unmeshed.io/docs/use-cases/api-orchestration)
+    - [🧩 Microservices Orchestration](https://unmeshed.io/docs/use-cases/microservices-orchestration)
+    - [⏰ Scheduled Jobs](https://unmeshed.io/docs/use-cases/scheduled-jobs)
+
+---
+
+## Example Applications
+
+1. [express-server-example](https://github.com/unmeshed/express-server-example)
+2. [typescript-sdk-example](https://github.com/unmeshed/typescript-sdk-example)
+3. [javascript-sdk-example](https://github.com/unmeshed/javascript-sdk-example)
+
+---
+
+For more details, visit our [📖 documentation](https://unmeshed.io/docs/concepts/overview). If you encounter issues, feel
+free to reach out or open an issue in this repository!
+

package/dist/index.d.mts

@@ -0,0 +1,370 @@
+import { AxiosRequestConfig } from 'axios';
+
+declare enum ApiCallType {
+    SYNC = "SYNC",
+    ASYNC = "ASYNC",
+    STREAM = "STREAM"
+}
+interface ApiMappingData {
+    endpoint: string;
+    processDefNamespace: string;
+    processDefName: string;
+    processDefVersion: number;
+    authType: string;
+    authClaims: string;
+    createdBy: string;
+    updatedBy: string;
+    created: Date;
+    updated: Date;
+}
+type ApiMappingWebhookData = {
+    endpoint: string;
+    name: string;
+    uniqueId: string;
+    urlSecret: string;
+    description: string;
+    userIdentifier: string;
+    webhookSource: WebhookSource;
+    webhookSourceConfig: Record<string, string>;
+    expiryDate: Date;
+    userType: SQAuthUserType;
+    createdBy: string;
+    updatedBy: string;
+    created: Date;
+    updated: Date;
+};
+declare enum WebhookSource {
+    MS_TEAMS = "MS_TEAMS",
+    NOT_DEFINED = "NOT_DEFINED"
+}
+declare enum SQAuthUserType {
+    USER = "USER",
+    API = "API",
+    INTERNAL = "INTERNAL"
+}
+declare enum StepType {
+    WORKER = "WORKER",
+    HTTP = "HTTP",
+    WAIT = "WAIT",
+    FAIL = "FAIL",
+    PYTHON = "PYTHON",
+    JAVASCRIPT = "JAVASCRIPT",
+    JQ = "JQ",
+    MANAGED = "MANAGED",
+    BUILTIN = "BUILTIN",
+    NOOP = "NOOP",
+    PERSISTED_STATE = "PERSISTED_STATE",
+    DEPENDSON = "DEPENDSON",
+    INTEGRATION = "INTEGRATION",
+    EXIT = "EXIT",
+    SUB_PROCESS = "SUB_PROCESS",
+    LIST = "LIST",
+    PARALLEL = "PARALLEL",
+    FOREACH = "FOREACH",
+    SWITCH = "SWITCH"
+}
+declare enum StepStatus {
+    PENDING = "PENDING",
+    SCHEDULED = "SCHEDULED",
+    RUNNING = "RUNNING",
+    PAUSED = "PAUSED",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    TIMED_OUT = "TIMED_OUT",
+    SKIPPED = "SKIPPED",
+    CANCELLED = "CANCELLED"
+}
+declare enum ProcessStatus {
+    RUNNING = "RUNNING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    TIMED_OUT = "TIMED_OUT",
+    CANCELLED = "CANCELLED",
+    TERMINATED = "TERMINATED",
+    REVIEWED = "REVIEWED"
+}
+declare enum ProcessTriggerType {
+    MANUAL = "MANUAL",
+    SCHEDULED = "SCHEDULED",
+    API_MAPPING = "API_MAPPING",
+    WEBHOOK = "WEBHOOK",
+    API = "API",
+    SUB_PROCESS = "SUB_PROCESS"
+}
+declare enum ProcessType {
+    STANDARD = "STANDARD",
+    DYNAMIC = "DYNAMIC",
+    API_ORCHESTRATION = "API_ORCHESTRATION",
+    INTERNAL = "INTERNAL"
+}
+type ClientProfileData = {
+    clientId: string;
+    ipAddress: string;
+    friendlyName: string;
+    userIdentifier: string;
+    stepQueueNames: StepQueueNameData[];
+    createdBy: string;
+    updatedBy: string;
+    created: Date;
+    updated: Date;
+    expiryDate: Date;
+};
+type FullClientProfileData = {
+    clientId: string;
+    ipAddress: string;
+    friendlyName: string;
+    userIdentifier: string;
+    stepQueueNames: StepQueueNameData[];
+    createdBy: string;
+    updatedBy: string;
+    created: Date;
+    updated: Date;
+    expiryDate: Date;
+    tokenValue: string;
+};
+type StepQueueNameData = {
+    orgId: number;
+    namespace: string;
+    stepType: StepType;
+    name: string;
+};
+type ProcessActionResponseData = {
+    count: number;
+    details: ProcessActionResponseDetailData[];
+};
+type ProcessActionResponseDetailData = {
+    id: string;
+    message: string;
+    error: string;
+};
+type ProcessData = {
+    processId: number;
+    processType: ProcessType;
+    triggerType: ProcessTriggerType;
+    namespace: string;
+    name: string;
+    version: number | null;
+    processDefinitionHistoryId: number | null;
+    requestId: string;
+    correlationId: string;
+    status: ProcessStatus;
+    input: Record<string, unknown>;
+    output: Record<string, unknown>;
+    stepIdCount: number | null;
+    shardName: string;
+    shardInstanceId: number | null;
+    stepIds: StepId[];
+    stepDataById: Record<number, StepData>;
+    created: number;
+    updated: number;
+    createdBy: string;
+};
+type StepData = {
+    id: number;
+    processId: number;
+    ref: string;
+    parentId: number | null;
+    parentRef: string | null;
+    namespace: string;
+    name: string;
+    type: StepType;
+    stepDefinitionHistoryId: number | null;
+    status: StepStatus;
+    input: Record<string, unknown>;
+    output: Record<string, unknown>;
+    workerId: string;
+    start: number;
+    schedule: number;
+    priority: number;
+    updated: number;
+    optional: boolean;
+    executionList: StepExecutionData[];
+};
+type StepExecutionData = {
+    id: number;
+    scheduled: number;
+    polled: number;
+    start: number;
+    updated: number;
+    executor: string;
+    ref: string;
+    runs: number;
+    output: Record<string, unknown>;
+};
+type StepId = {
+    id: number;
+    processId: number;
+    ref: string;
+};
+type ProcessRequestData = {
+    name: string;
+    namespace: string;
+    version: number | null;
+    requestId: string;
+    correlationId: string;
+    input: Record<string, unknown>;
+};
+type ProcessSearchRequest = {
+    startTimeEpoch: number;
+    endTimeEpoch?: number | null;
+    namespace: string;
+    processTypes: ProcessType[];
+    triggerTypes: ProcessTriggerType[];
+    names: string[];
+    processIds: number[];
+    correlationIds: string[];
+    requestIds: string[];
+    statuses: ProcessStatus[];
+    limit: number;
+    offset: number;
+};
+type StepSize = {
+    stepQueueNameData: StepQueueNameData;
+    size: number | null;
+};
+type ClientSubmitResult = {
+    processId: number;
+    stepId: number;
+    errorMessage: string | null;
+    httpStatusCode: number | null;
+};
+type WorkRequest = {
+    processId: number;
+    stepId: number;
+    stepExecutionId: number;
+    runCount: number;
+    stepName: string;
+    stepNamespace: string;
+    stepRef: string;
+    inputParam: Record<string, unknown>;
+    isOptional: boolean;
+    polled: number;
+    scheduled: number;
+    updated: number;
+    priority: number;
+};
+type WorkResponse = {
+    processId: number;
+    stepId: number;
+    stepExecutionId: number;
+    runCount: number;
+    output: Record<string, unknown>;
+    status: StepStatus;
+    rescheduleAfterSeconds: number | null;
+    startedAt: number;
+};
+type WorkResult = {
+    output: unknown;
+    taskExecutionId: string;
+    startTime: number;
+    endTime: number;
+    workRequest: WorkRequest;
+};
+interface FinalUnmeshedClientConfig {
+    baseUrl: string;
+    clientId: string;
+    authToken: string;
+    port: string | number;
+    timeout: number;
+    apiWorkerTimeout: number;
+    pollTimeout: number;
+    pollInterval: number;
+    responsePollInterval: number;
+    responsePollTimeout: number;
+    responseBatchSize: number;
+}
+interface UnmeshedClientConfig {
+    baseUrl: string;
+    clientId: string;
+    authToken: string;
+    port: string | number;
+    timeout?: number;
+    apiWorkerTimeout?: number;
+    pollTimeout?: number;
+    pollInterval?: number;
+    responsePollInterval?: number;
+    responsePollTimeout?: number;
+    responseBatchSize?: number;
+}
+interface ApiResponse<T = any> {
+    data: T;
+    status: number;
+    headers: Record<string, string>;
+}
+interface ApiError extends Error {
+    status?: number;
+    response?: {
+        data?: any;
+        status: number;
+        headers: Record<string, string>;
+    };
+}
+interface QueryParams {
+    [key: string]: string | number | boolean | undefined;
+}
+interface RequestConfig extends Omit<AxiosRequestConfig, "baseURL" | "url" | "method"> {
+    headers?: Record<string, string>;
+}
+interface HandleRequestConfig {
+    method: "get" | "post" | "put" | "delete";
+    endpoint: string;
+    params?: QueryParams;
+    data?: Record<string, unknown>;
+    config?: RequestConfig;
+}
+interface ClientRequestConfig {
+    params?: QueryParams;
+    data?: any;
+    config?: RequestConfig;
+}
+interface UnmeshedWorker {
+    (input: Record<string, any>): Promise<any>;
+}
+interface UnmeshedWorkerConfig {
+    worker: UnmeshedWorker;
+    namespace: string;
+    name: string;
+    maxInProgress: number;
+}
+interface PollRequestData {
+    stepQueueNameData: StepQueueNameData;
+    size: number;
+}
+interface RenewRegistrationParams {
+    friendlyName: string;
+}
+
+declare class UnmeshedApiClient {
+    private axiosInstance;
+    private clientId;
+    private _config;
+    constructor(unmeshedClientConfig: UnmeshedClientConfig);
+    private handleRequest;
+    private handleError;
+    get<T = any>(endpoint: string, params?: QueryParams, config?: RequestConfig): Promise<ApiResponse<T>>;
+    post<T = any>(endpoint: string, clientRequestConfig: ClientRequestConfig): Promise<ApiResponse<T>>;
+    put<T = any>(endpoint: string, clientRequestConfig: ClientRequestConfig): Promise<ApiResponse<T>>;
+    delete<T = any>(endpoint: string, clientRequestConfig: ClientRequestConfig): Promise<ApiResponse<T>>;
+    getClientId(): string | undefined;
+    get config(): FinalUnmeshedClientConfig;
+}
+
+declare class UnmeshedClient {
+    private client;
+    constructor(config: UnmeshedClientConfig);
+    startPolling(workers: UnmeshedWorkerConfig[]): void;
+    runProcessSync(ProcessRequestData: ProcessRequestData): Promise<ProcessData>;
+    runProcessAsync(ProcessRequestData: ProcessRequestData): Promise<ProcessData>;
+    getProcessData(processId: number, includeSteps: boolean): Promise<ProcessData>;
+    getStepData(stepId: number): Promise<StepData>;
+    bulkTerminate(processIds: number[], reason?: string): Promise<ProcessActionResponseData>;
+    bulkResume(processIds: number[]): Promise<ProcessActionResponseData>;
+    bulkReviewed(processIds: number[], reason?: string): Promise<ProcessActionResponseData>;
+    reRun(processId: number, clientId: string, version?: number): Promise<ProcessData>;
+    searchProcessExecution(params: ProcessSearchRequest): Promise<any>;
+    invokeApiMappingGet(apiClient: UnmeshedApiClient, endpoint: string, id: string, correlationId: string, apiCallType: ApiCallType): Promise<any>;
+    invokeApiMappingPost(endpoint: string, input: Record<string, any>, id: string, correlationId: string, apiCallType: ApiCallType): Promise<any>;
+    reNewRegistration(params: RenewRegistrationParams): Promise<string>;
+}
+
+export { ApiCallType, type ApiError, type ApiMappingData, type ApiMappingWebhookData, type ApiResponse, type ClientProfileData, type ClientRequestConfig, type ClientSubmitResult, type FinalUnmeshedClientConfig, type FullClientProfileData, type HandleRequestConfig, type PollRequestData, type ProcessActionResponseData, type ProcessActionResponseDetailData, type ProcessData, type ProcessRequestData, type ProcessSearchRequest, ProcessStatus, ProcessTriggerType, ProcessType, type QueryParams, type RenewRegistrationParams, type RequestConfig, SQAuthUserType, type StepData, type StepExecutionData, type StepId, type StepQueueNameData, type StepSize, StepStatus, StepType, UnmeshedClient, type UnmeshedClientConfig, type UnmeshedWorkerConfig, WebhookSource, type WorkRequest, type WorkResponse, type WorkResult };