@medusajs/types 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406180144

package/dist/http/tax-region/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,gBAAgB,CAAC,EAAE;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,CAAC,EAAE,OAAO,CAAA;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,CAAA;IACD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QACZ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;QACZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAA;QACvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,CAAA;IACD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}

package/dist/http/tax-region/admin/queries.d.ts

@@ -1,14 +1,42 @@
 import { BaseFilterable, OperatorMap } from "../../../dal";
 import { FindParams, SelectParams } from "../../common";
 export interface AdminTaxRegionListParams extends FindParams, BaseFilterable<AdminTaxRegionListParams> {
+    /**
+     * Filter by tax region ID(s).
+     */
     id?: string | string[];
+    /**
+     * Query or keywords to search the tax region's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by the tax region's parent ID(s) to retrieve its children.
+     */
     parent_id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter by the tax region's country code(s).
+     */
     country_code?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter by the tax region's province code(s).
+     */
     province_code?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter by the date the tax region was created.
+     */
     created_at?: string | OperatorMap<string>;
+    /**
+     * Filter by the date the tax region was updated.
+     */
     updated_at?: string | OperatorMap<string>;
+    /**
+     * Filter by the date the tax region was deleted.
+     */
     deleted_at?: string | OperatorMap<string>;
+    /**
+     * Filter by the ID of the user who created the tax region to
+     * retrieve tax regions created by a specific user.
+     */
     created_by?: string | OperatorMap<string>;
 }
 export interface AdminTaxRegionParams extends SelectParams {

package/dist/http/tax-region/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC9D,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACjE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAClE,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;CAAG"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC9D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACjE;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAClE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;CAAG"}

package/dist/http/tax-region/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminTaxRegion } from "./entities";
 export interface AdminTaxRegionResponse {
+    /**
+     * The tax region's details.
+     */
     tax_region: AdminTaxRegion;
 }
 export type AdminTaxRegionListResponse = PaginatedResponse<{
+    /**
+     * The list of tax regions.
+     */
     tax_regions: AdminTaxRegion[];
 }>;
 export interface AdminTaxRegionDeleteResponse extends DeleteResponse<"tax_region"> {

package/dist/http/tax-region/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,cAAc,CAAA;CAC3B;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IACzD,WAAW,EAAE,cAAc,EAAE,CAAA;CAC9B,CAAC,CAAA;AAEF,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,YAAY,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,UAAU,EAAE,cAAc,CAAA;CAC3B;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IACzD;;OAEG;IACH,WAAW,EAAE,cAAc,EAAE,CAAA;CAC9B,CAAC,CAAA;AAEF,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,YAAY,CAAC;CAAG"}

package/dist/http/user/admin/entities.d.ts

@@ -1,12 +1,39 @@
 export interface AdminUser {
+    /**
+     * The user's ID.
+     */
     id: string;
+    /**
+     * The user's email.
+     */
     email: string;
+    /**
+     * The user's first name.
+     */
     first_name: string | null;
+    /**
+     * The user's last name.
+     */
     last_name: string | null;
+    /**
+     * The URL of the user's avatar image.
+     */
     avatar_url: string | null;
+    /**
+     * Custom key-value pairs that can be added to the user.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The date the user was created.
+     */
     created_at: string;
+    /**
+     * The date the user was updated.
+     */
     updated_at: string;
+    /**
+     * The date the user was deleted.
+     */
     deleted_at: string | null;
 }
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/user/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B"}

package/dist/http/user/admin/payloads.d.ts

@@ -5,9 +5,21 @@ export interface AdminCreateUser {
     avatar_url?: string | null;
 }
 export interface AdminUpdateUser {
+    /**
+     * The first name of the user.
+     */
     first_name?: string | null;
+    /**
+     * The last name of the user.
+     */
     last_name?: string | null;
+    /**
+     * The URL of the user's avatar image.
+     */
     avatar_url?: string | null;
+    /**
+     * Custom key-value pairs that can be added to the user.
+     */
     metadata?: Record<string, unknown> | null;
 }
 //# sourceMappingURL=payloads.d.ts.map

package/dist/http/user/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}

package/dist/http/user/admin/queries.d.ts

@@ -1,13 +1,37 @@
 import { OperatorMap } from "../../../dal";
 import { FindParams, SelectParams } from "../../common";
 export interface AdminUserListParams extends FindParams {
+    /**
+     * Query or keywords to search the user's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by user ID(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by email(s).
+     */
     email?: string | null;
+    /**
+     * Filter by first name(s).
+     */
     first_name?: string | null;
+    /**
+     * Filter by last name(s).
+     */
     last_name?: string | null;
+    /**
+     * Filter by the date the user was created.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the user was updated.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the user was deleted.
+     */
     deleted_at?: OperatorMap<string>;
 }
 export interface AdminUserParams extends SelectParams {

package/dist/http/user/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAAG"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;CAAG"}

package/dist/http/user/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminUser } from "./entities";
 export interface AdminUserResponse {
+    /**
+     * The user's details.
+     */
     user: AdminUser;
 }
 export interface AdminUserListResponse extends PaginatedResponse<{
+    /**
+     * The list of users.
+     */
     users: AdminUser[];
 }> {
 }

package/dist/http/user/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,WAAW,qBACf,SAAQ,iBAAiB,CAAC;IAAE,KAAK,EAAE,SAAS,EAAE,CAAA;CAAE,CAAC;CAAG;AAEtD,MAAM,WAAW,uBAAwB,SAAQ,cAAc,CAAC,MAAM,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/user/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,SAAS,CAAA;CAChB;AAED,MAAM,WAAW,qBACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,KAAK,EAAE,SAAS,EAAE,CAAA;CACnB,CAAC;CAAG;AAEP,MAAM,WAAW,uBAAwB,SAAQ,cAAc,CAAC,MAAM,CAAC;CAAG"}

package/dist/http/workflow-execution/admin/entities.d.ts

@@ -1,62 +1,196 @@
 export type TransactionStepStatus = "idle" | "ok" | "waiting_response" | "temp_failure" | "permanent_failure";
 export type TransactionState = "not_started" | "invoking" | "waiting_to_compensate" | "compensating" | "done" | "reverted" | "failed";
 export type TransactionStepState = "not_started" | "invoking" | "compensating" | "done" | "reverted" | "failed" | "dormant" | "skipped" | "skipped_failure" | "timeout";
-interface AdminWorkflowExecutionExecution {
+export interface AdminWorkflowExecutionExecution {
+    /**
+     * The details of the workflow execution's steps.
+     * The key is the step's ID, and the value is the step's details.
+     */
     steps: Record<string, AdminWorkflowExecutionStep>;
 }
 export type StepInvokeResult = {
+    /**
+     * The output details of the step.
+     */
     output: {
+        /**
+         * The output of the step. This is the first parameter
+         * passed to the returned `StepResponse` function.
+         */
         output: unknown;
+        /**
+         * The input of the step's compensation function.
+         * This is the second parameter passed to the returned `StepResponse` function.
+         */
         compensateInput: unknown;
     };
 };
 export type StepError = {
+    /**
+     * The error details.
+     */
     error: Record<string, unknown>;
+    /**
+     * The ID of the action that failed.
+     */
     action: string;
+    /**
+     * The type of the handler that failed. It can be `invoke` or `compensate`.
+     */
     handlerType: string;
 };
 export interface WorkflowExecutionContext {
+    /**
+     * The data of the workflow execution.
+     */
     data: {
+        /**
+         * The details of the invocation of the workflow execution's steps.
+         * The key is the step's ID, and the value is the step's details.
+         *
+         * These details are only included for steps that have their `saveResponse` property set to `true`.
+         */
         invoke: Record<string, StepInvokeResult>;
+        /**
+         * The payload or input of the workflow execution.
+         */
         payload?: unknown;
     };
+    /**
+     * The output of the compensation function of the workflow execution.
+     * The key is the step's ID, and the value is the compensation function's output.
+     *
+     * These details are only included for steps that have their `saveResponse` property set to `true`.
+     */
     compensate: Record<string, unknown>;
+    /**
+     * The errors of the workflow execution.
+     */
     errors: StepError[];
 }
 export interface WorkflowExecutionDefinition {
+    /**
+     * If true, the step is executed asynchronously. This means that the workflow will not wait for the response of this step.
+     * Async steps require to have their responses set using `setStepSuccess` or `setStepFailure`, unless it is combined with `backgroundExecution: true`.
+     * If combined with a timeout, and any response is not set within that interval, the step will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted immediately.
+     */
     async?: boolean;
+    /**
+     * If true, the compensation function for this step is executed asynchronously. Which means, the response has to be set using `setStepSuccess` or `setStepFailure`.
+     */
     compensateAsync?: boolean;
+    /**
+     * If true, no compensation action will be triggered for this step in case of a failure.
+     */
     noCompensation?: boolean;
+    /**
+     * Indicates whether the workflow should continue even if there is a permanent failure in this step.
+     * In case it is set to true, the children steps of this step will not be executed and their status will be marked as `TransactionStepState`.SKIPPED_FAILURE.
+     */
     continueOnPermanentFailure?: boolean;
+    /**
+     * The maximum number of times this step should be retried in case of temporary failures.
+     * The default is 0 (no retries).
+     */
     maxRetries?: number;
+    /**
+     * If true, the workflow will not wait for their sibling steps to complete before moving to the next step.
+     */
     noWait?: boolean;
+    /**
+     * The interval (in seconds) between retry attempts after a temporary failure.
+     * The default is to retry immediately.
+     */
     retryInterval?: number;
+    /**
+     * The interval (in seconds) to retry a step even if its status is `TransactionStepStatus.WAITING`.
+     */
     retryIntervalAwaiting?: number;
+    /**
+     * If true, the response of this step will be stored.
+     * Default is true.
+     */
     saveResponse?: boolean;
+    /**
+     * The maximum amount of time (in seconds) to wait for this step to complete.
+     * This is NOT an execution timeout, the step will always be executed and wait for its response.
+     * If the response is not received within the timeout set, it will be marked as `TransactionStepStatus.TIMEOUT` and the workflow will be reverted as soon as it receives the response.
+     */
     timeout?: number;
 }
 export interface WorkflowExecutionFn {
+    /**
+     * The state of the step.
+     */
     state: TransactionStepState;
+    /**
+     * The status of the step.
+     */
     status: TransactionStepStatus;
 }
 export interface AdminWorkflowExecutionStep {
+    /**
+     * The ID of the step.
+     */
     id: string;
+    /**
+     * The invoke function of the step.
+     */
     invoke: WorkflowExecutionFn;
+    /**
+     * The definition of the step.
+     */
     definition: WorkflowExecutionDefinition;
+    /**
+     * The compensate function of the step.
+     */
     compensate: WorkflowExecutionFn;
+    /**
+     * The depth of the step.
+     */
     depth: number;
+    /**
+     * The date the step was started.
+     */
     startedAt: number;
 }
 export interface AdminWorkflowExecution {
+    /**
+     * The ID of the workflow execution.
+     */
     id: string;
+    /**
+     * The ID of the workflow.
+     */
     workflow_id: string;
+    /**
+     * The ID of the transaction.
+     */
     transaction_id: string;
+    /**
+     * The execution details of the workflow.
+     */
     execution: AdminWorkflowExecutionExecution;
+    /**
+     * The context of the workflow execution.
+     * This includes the data, errors and the output of the step and compensation functions of the workflow execution.
+     */
     context: WorkflowExecutionContext;
+    /**
+     * The state of the workflow execution.
+     */
     state: TransactionState;
+    /**
+     * The date the workflow execution was created.
+     */
     created_at: Date;
+    /**
+     * The date the workflow execution was updated.
+     */
     updated_at: Date;
+    /**
+     * The date the workflow execution was deleted.
+     */
     deleted_at?: Date | null;
 }
-export {};
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/workflow-execution/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/workflow-execution/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAC7B,MAAM,GACN,IAAI,GACJ,kBAAkB,GAClB,cAAc,GACd,mBAAmB,CAAA;AAEvB,MAAM,MAAM,gBAAgB,GACxB,aAAa,GACb,UAAU,GACV,uBAAuB,GACvB,cAAc,GACd,MAAM,GACN,UAAU,GACV,QAAQ,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAC5B,aAAa,GACb,UAAU,GACV,cAAc,GACd,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,SAAS,CAAA;AAEb,UAAU,+BAA+B;IACvC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;CAClD;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE;QACN,MAAM,EAAE,OAAO,CAAA;QACf,eAAe,EAAE,OAAO,CAAA;KACzB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;QACxC,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC,MAAM,EAAE,SAAS,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,oBAAoB,CAAA;IAC3B,MAAM,EAAE,qBAAqB,CAAA;CAC9B;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,mBAAmB,CAAA;IAC3B,UAAU,EAAE,2BAA2B,CAAA;IACvC,UAAU,EAAE,mBAAmB,CAAA;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,+BAA+B,CAAA;IAC1C,OAAO,EAAE,wBAAwB,CAAA;IACjC,KAAK,EAAE,gBAAgB,CAAA;IACvB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;CACzB"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/workflow-execution/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAC7B,MAAM,GACN,IAAI,GACJ,kBAAkB,GAClB,cAAc,GACd,mBAAmB,CAAA;AAEvB,MAAM,MAAM,gBAAgB,GACxB,aAAa,GACb,UAAU,GACV,uBAAuB,GACvB,cAAc,GACd,MAAM,GACN,UAAU,GACV,QAAQ,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAC5B,aAAa,GACb,UAAU,GACV,cAAc,GACd,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,SAAS,CAAA;AAEb,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAA;CAClD;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,MAAM,EAAE;QACN;;;WAGG;QACH,MAAM,EAAE,OAAO,CAAA;QACf;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAA;KACzB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE;QACJ;;;;;WAKG;QACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;QACxC;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,CAAA;IACD;;;;;OAKG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC;;OAEG;IACH,MAAM,EAAE,SAAS,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IACf;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,oBAAoB,CAAA;IAC3B;;OAEG;IACH,MAAM,EAAE,qBAAqB,CAAA;CAC9B;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAA;IAC3B;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAA;IACvC;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAA;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,SAAS,EAAE,+BAA+B,CAAA;IAC1C;;;OAGG;IACH,OAAO,EAAE,wBAAwB,CAAA;IACjC;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAA;IACvB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;CACzB"}

package/dist/http/workflow-execution/admin/queries.d.ts

@@ -1,6 +1,12 @@
 import { FindParams } from "../../common";
 export interface AdminGetWorkflowExecutionsParams extends FindParams {
+    /**
+     * Filter by the ID of the transaction to retrieve workflow executions for a specific transaction.
+     */
     transaction_id?: string | string[];
+    /**
+     * Filter by the ID of the workflow to retrieve workflow executions for a specific workflow.
+     */
     workflow_id?: string | string[];
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/workflow-execution/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/workflow-execution/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,gCAAiC,SAAQ,UAAU;IAClE,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAChC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/workflow-execution/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,gCAAiC,SAAQ,UAAU;IAClE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAChC"}

package/dist/http/workflow-execution/admin/responses.d.ts

@@ -2,9 +2,15 @@ import { Acknowledgement } from "../../../workflows-sdk";
 import { PaginatedResponse } from "../../common/response";
 import { AdminWorkflowExecution } from "./entities";
 export interface AdminWorkflowExecutionResponse {
+    /**
+     * The workflow execution's details.
+     */
     workflow_execution: AdminWorkflowExecution;
 }
 export type AdminWorkflowExecutionListResponse = PaginatedResponse<{
+    /**
+     * The list of workflow executions.
+     */
     workflow_executions: AdminWorkflowExecution[];
 }>;
 export type AdminWorkflowRunResponse = {

package/dist/http/workflow-execution/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/workflow-execution/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAEnD,MAAM,WAAW,8BAA8B;IAC7C,kBAAkB,EAAE,sBAAsB,CAAA;CAC3C;AAED,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;IACjE,mBAAmB,EAAE,sBAAsB,EAAE,CAAA;CAC9C,CAAC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,eAAe,EAAE,eAAe,CAAA;CACjC,CAAA"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/workflow-execution/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAEnD,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,kBAAkB,EAAE,sBAAsB,CAAA;CAC3C;AAED,MAAM,MAAM,kCAAkC,GAAG,iBAAiB,CAAC;IACjE;;OAEG;IACH,mBAAmB,EAAE,sBAAsB,EAAE,CAAA;CAC9C,CAAC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,eAAe,EAAE,eAAe,CAAA;CACjC,CAAA"}

package/dist/index-data/query-config/query-input-config.d.ts

@@ -12,7 +12,7 @@ export type IndexQueryConfig<TEntry extends string> = {
 export type QueryFunctionReturnPagination = {
     skip?: number;
     take?: number;
-    count: number;
+    count?: number;
 };
 /**
  * The QueryResultSet presents a typed output for the

package/dist/index-data/query-config/query-input-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-input-config.d.ts","sourceRoot":"","sources":["../../../src/index-data/query-config/query-input-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAA;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IACpD,MAAM,EAAE,mBAAmB,CACzB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,SAAS,KAAK,GACX,MAAM,EAAE,GACR,mBAAmB,CACjB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,EAAE,CAAA;IACP,OAAO,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAC9B,WAAW,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;IAC5D,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,IAAI;IAClD,IAAI,EAAE,MAAM,SAAS,MAAM,uBAAuB,GAC9C,uBAAuB,CAAC,MAAM,CAAC,EAAE,GACjC,GAAG,EAAE,CAAA;IACT,QAAQ,CAAC,EAAE,6BAA6B,CAAA;CACzC,CAAA"}
+{"version":3,"file":"query-input-config.d.ts","sourceRoot":"","sources":["../../../src/index-data/query-config/query-input-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAA;AACpF,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,MAAM,IAAI;IACpD,MAAM,EAAE,mBAAmB,CACzB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,SAAS,KAAK,GACX,MAAM,EAAE,GACR,mBAAmB,CACjB,uBAAuB,CAAC,MAAM,GAAG,MAAM,uBAAuB,CAAC,CAChE,EAAE,CAAA;IACP,OAAO,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAC9B,WAAW,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;IAC5D,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,MAAM,IAAI;IAClD,IAAI,EAAE,MAAM,SAAS,MAAM,uBAAuB,GAC9C,uBAAuB,CAAC,MAAM,CAAC,EAAE,GACjC,GAAG,EAAE,CAAA;IACT,QAAQ,CAAC,EAAE,6BAA6B,CAAA;CACzC,CAAA"}