@unmeshed/sdk 1.0.13 → 1.0.15

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): 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 };

package/{types → dist}/index.d.ts

@@ -1,10 +1,11 @@
-import { AxiosRequestConfig } from "axios";
-export declare enum ApiCallType {
+import { AxiosRequestConfig } from 'axios';
+
+declare enum ApiCallType {
     SYNC = "SYNC",
     ASYNC = "ASYNC",
     STREAM = "STREAM"
 }
-export interface ApiMappingData {
+interface ApiMappingData {
     endpoint: string;
     processDefNamespace: string;
     processDefName: string;
@@ -16,7 +17,7 @@ export interface ApiMappingData {
     created: Date;
     updated: Date;
 }
-export type ApiMappingWebhookData = {
+type ApiMappingWebhookData = {
     endpoint: string;
     name: string;
     uniqueId: string;
@@ -32,16 +33,16 @@ export type ApiMappingWebhookData = {
     created: Date;
     updated: Date;
 };
-export declare enum WebhookSource {
+declare enum WebhookSource {
     MS_TEAMS = "MS_TEAMS",
     NOT_DEFINED = "NOT_DEFINED"
 }
-export declare enum SQAuthUserType {
+declare enum SQAuthUserType {
     USER = "USER",
     API = "API",
     INTERNAL = "INTERNAL"
 }
-export declare enum StepType {
+declare enum StepType {
     WORKER = "WORKER",
     HTTP = "HTTP",
     WAIT = "WAIT",
@@ -62,7 +63,7 @@ export declare enum StepType {
     FOREACH = "FOREACH",
     SWITCH = "SWITCH"
 }
-export declare enum StepStatus {
+declare enum StepStatus {
     PENDING = "PENDING",
     SCHEDULED = "SCHEDULED",
     RUNNING = "RUNNING",
@@ -73,7 +74,7 @@ export declare enum StepStatus {
     SKIPPED = "SKIPPED",
     CANCELLED = "CANCELLED"
 }
-export declare enum ProcessStatus {
+declare enum ProcessStatus {
     RUNNING = "RUNNING",
     COMPLETED = "COMPLETED",
     FAILED = "FAILED",
@@ -82,7 +83,7 @@ export declare enum ProcessStatus {
     TERMINATED = "TERMINATED",
     REVIEWED = "REVIEWED"
 }
-export declare enum ProcessTriggerType {
+declare enum ProcessTriggerType {
     MANUAL = "MANUAL",
     SCHEDULED = "SCHEDULED",
     API_MAPPING = "API_MAPPING",
@@ -90,13 +91,13 @@ export declare enum ProcessTriggerType {
     API = "API",
     SUB_PROCESS = "SUB_PROCESS"
 }
-export declare enum ProcessType {
+declare enum ProcessType {
     STANDARD = "STANDARD",
     DYNAMIC = "DYNAMIC",
     API_ORCHESTRATION = "API_ORCHESTRATION",
     INTERNAL = "INTERNAL"
 }
-export type ClientProfileData = {
+type ClientProfileData = {
     clientId: string;
     ipAddress: string;
     friendlyName: string;
@@ -108,7 +109,7 @@ export type ClientProfileData = {
     updated: Date;
     expiryDate: Date;
 };
-export type FullClientProfileData = {
+type FullClientProfileData = {
     clientId: string;
     ipAddress: string;
     friendlyName: string;
@@ -121,22 +122,22 @@ export type FullClientProfileData = {
     expiryDate: Date;
     tokenValue: string;
 };
-export type StepQueueNameData = {
+type StepQueueNameData = {
     orgId: number;
     namespace: string;
     stepType: StepType;
     name: string;
 };
-export type ProcessActionResponseData = {
+type ProcessActionResponseData = {
     count: number;
     details: ProcessActionResponseDetailData[];
 };
-export type ProcessActionResponseDetailData = {
+type ProcessActionResponseDetailData = {
     id: string;
     message: string;
     error: string;
 };
-export type ProcessData = {
+type ProcessData = {
     processId: number;
     processType: ProcessType;
     triggerType: ProcessTriggerType;
@@ -158,7 +159,7 @@ export type ProcessData = {
     updated: number;
     createdBy: string;
 };
-export type StepData = {
+type StepData = {
     id: number;
     processId: number;
     ref: string;
@@ -179,7 +180,7 @@ export type StepData = {
     optional: boolean;
     executionList: StepExecutionData[];
 };
-export type StepExecutionData = {
+type StepExecutionData = {
     id: number;
     scheduled: number;
     polled: number;
@@ -190,12 +191,12 @@ export type StepExecutionData = {
     runs: number;
     output: Record<string, unknown>;
 };
-export type StepId = {
+type StepId = {
     id: number;
     processId: number;
     ref: string;
 };
-export type ProcessRequestData = {
+type ProcessRequestData = {
     name: string;
     namespace: string;
     version: number | null;
@@ -203,7 +204,7 @@ export type ProcessRequestData = {
     correlationId: string;
     input: Record<string, unknown>;
 };
-export type ProcessSearchRequest = {
+type ProcessSearchRequest = {
     startTimeEpoch: number;
     endTimeEpoch?: number | null;
     namespace: string;
@@ -217,17 +218,17 @@ export type ProcessSearchRequest = {
     limit: number;
     offset: number;
 };
-export type StepSize = {
+type StepSize = {
     stepQueueNameData: StepQueueNameData;
     size: number | null;
 };
-export type ClientSubmitResult = {
+type ClientSubmitResult = {
     processId: number;
     stepId: number;
     errorMessage: string | null;
     httpStatusCode: number | null;
 };
-export type WorkRequest = {
+type WorkRequest = {
     processId: number;
     stepId: number;
     stepExecutionId: number;
@@ -242,7 +243,7 @@ export type WorkRequest = {
     updated: number;
     priority: number;
 };
-export type WorkResponse = {
+type WorkResponse = {
     processId: number;
     stepId: number;
     stepExecutionId: number;
@@ -252,26 +253,45 @@ export type WorkResponse = {
     rescheduleAfterSeconds: number | null;
     startedAt: number;
 };
-export type WorkResult = {
+type WorkResult = {
     output: unknown;
     taskExecutionId: string;
     startTime: number;
     endTime: number;
     workRequest: WorkRequest;
 };
-export interface ApiClientConfig {
+interface FinalUnmeshedClientConfig {
     baseUrl: string;
     clientId: string;
     authToken: string;
-    port?: string | number;
+    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;
 }
-export interface ApiResponse<T = any> {
+interface ApiResponse<T = any> {
     data: T;
     status: number;
     headers: Record<string, string>;
 }
-export interface ApiError extends Error {
+interface ApiError extends Error {
     status?: number;
     response?: {
         data?: any;
@@ -279,20 +299,20 @@ export interface ApiError extends Error {
         headers: Record<string, string>;
     };
 }
-export interface QueryParams {
+interface QueryParams {
     [key: string]: string | number | boolean | undefined;
 }
-export interface RequestConfig extends Omit<AxiosRequestConfig, "baseURL" | "url" | "method"> {
+interface RequestConfig extends Omit<AxiosRequestConfig, "baseURL" | "url" | "method"> {
     headers?: Record<string, string>;
 }
-export interface HandleRequestConfig {
+interface HandleRequestConfig {
     method: "get" | "post" | "put" | "delete";
     endpoint: string;
     params?: QueryParams;
     data?: Record<string, unknown>;
     config?: RequestConfig;
 }
-export interface ClientRequestConfig {
+interface ClientRequestConfig {
     params?: QueryParams;
     data?: any;
     config?: RequestConfig;
@@ -300,14 +320,51 @@ export interface ClientRequestConfig {
 interface UnmeshedWorker {
     (input: Record<string, any>): Promise<any>;
 }
-export interface UnmeshedWorkerConfig {
+interface UnmeshedWorkerConfig {
     worker: UnmeshedWorker;
     namespace: string;
     name: string;
     maxInProgress: number;
 }
-export interface PollRequestData {
+interface PollRequestData {
     stepQueueNameData: StepQueueNameData;
     size: number;
 }
-export {};
+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): 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 };