@vertesia/common 0.54.0 → 0.56.0

package/lib/types/store/dsl-workflow.d.ts

@@ -0,0 +1,238 @@
+import { StringValue } from "ms";
+import { BaseObject } from "./common.js";
+import { WorkflowExecutionPayload } from "./index.js";
+import { ParentClosePolicyType } from "./temporalio.js";
+/**
+ * The payload sent when starting a workflow from the temporal client to the workflow instance.
+ */
+export interface DSLWorkflowExecutionPayload extends WorkflowExecutionPayload {
+    /**
+     * The workflow definition to be used by the DSL workflow.
+     * If a dsl workflow is executed and no definition is provided the workflow will fail.
+     */
+    workflow: DSLWorkflowSpec;
+}
+/**
+ * The payload for a DSL activity options.
+ *
+ * @see ActivityOptions in @temporalio/common
+ */
+export interface DSLActivityOptions {
+    startToCloseTimeout?: StringValue | number;
+    scheduleToStartTimeout?: StringValue | number;
+    scheduleToCloseTimeout?: StringValue | number;
+    retry?: DSLRetryPolicy;
+}
+/**
+ * The payload for a DSL retry policy.
+ *
+ * @see RetryPolicy in @temporalio/common
+ */
+export interface DSLRetryPolicy {
+    backoffCoefficient?: number;
+    initialInterval?: StringValue | number;
+    maximumAttempts?: number;
+    maximumInterval?: StringValue | number;
+    nonRetryableErrorTypes?: string[];
+}
+/**
+ * The payload for a DSL activity execution.
+ */
+export interface DSLActivityExecutionPayload<ParamsT extends Record<string, any>> extends WorkflowExecutionPayload {
+    activity: DSLActivitySpec;
+    params: ParamsT;
+    workflow_name: string;
+    debug_mode?: boolean;
+}
+export type ImportSpec = (string | Record<string, string>)[];
+export interface ActivityFetchSpec {
+    /**
+     * The data provider name
+     */
+    type: "document" | "document_type" | "interaction_run";
+    /**
+     * An optional URI to the data source.
+     */
+    source?: string;
+    /**
+     * The query to be executed by the data provider
+     */
+    query: Record<string, any>;
+    /**
+     * a string of space separated field names.
+     * Prefix a field name with "-" to exclude it from the result.
+     */
+    select?: string;
+    /**
+     * The number of results to return. If the result is limited to 1 the result will be a single object
+     */
+    limit?: number;
+    /**
+     * How to handle not found objects.
+     * 1. ignore - Ignore and return an empty array for multi objects query (or undefined for single object query) or empty array for multiple objects throw an error.
+     * 2. throw - Throw an error if the object or no objects are found.
+     */
+    on_not_found?: "ignore" | "throw";
+}
+export interface DSLWorkflowStepBase {
+    /**
+     * The type fo the step.
+     * If not set defaults to "activity"
+     */
+    type: "activity" | "workflow";
+}
+export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<string, any>> {
+    /**
+     * The name of the activity function
+     */
+    name: string;
+    /**
+     * Title of the activity to be displayed in the UI workflow builder
+     */
+    title?: string;
+    /**
+     * The description of the activity to e displayed in the UI workflow builder
+     */
+    description?: string;
+    /**
+     * Activities parameters. These parameters can be either literals
+     * (hardcoded strings, numbers, booleans, objects, arrays etc.), either
+     * references to the workflow variables.
+     * The workflow variables are built from the workflow params (e.g. the workflow configuration)
+     * and from the result of the previous activities.
+     */
+    params?: PARAMS;
+    /**
+     * The name of the workflow variable that will store the result of the activity
+     * If not specified the result will not be stored
+     * The parameters describe how the actual parameters will be obtained from the workflow execution vars.
+     * since it may contain references to workflow execution vars.
+     */
+    output?: string;
+    /**
+     * A JSON expression which evaluate to true or false similar to mongo matches.
+     * We support for now basic expression like: $true, $false, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $regexp
+     * {$eq: {name: value}},
+     * Ex: {$eq: {wfVarName: value}}
+     */
+    condition?: Record<string, any>;
+    /**
+     * The import spec is used to import data from workflow variables.
+     * The import spec is a list of variable names to import from the workflow context.
+     * You can also use objects to rename the imported variables, or to reference an expression.
+     * Example:
+     * ["runId", {"typeId": "docType.id"}]
+     */
+    import?: ImportSpec;
+    /**
+     * The fetch phase is used to fetch data from external sources.
+     */
+    fetch?: Record<string, ActivityFetchSpec>;
+    /**
+     * Projection to apply to the result. Not all activities support this.
+     */
+    projection?: never | Record<string, any>;
+    /**
+     * If true the activity will be executed in parallel with the other activities.
+     * (i.e. the workflow will not wait for the activity to finish before starting the next one)
+     */
+    parallel?: boolean;
+    /**
+     * Await for a parallel activity execution to return.
+     */
+    await?: string;
+    /**
+     * Activity options for configuring the activity execution, which overrides the activity options
+     * defined at workflow level.
+     */
+    options?: DSLActivityOptions;
+}
+export interface DSLActivityStep<PARAMS extends Record<string, any> = Record<string, any>> extends DSLActivitySpec<PARAMS>, DSLWorkflowStepBase {
+    type: "activity";
+}
+export interface DSLChildWorkflowStep extends DSLWorkflowStepBase {
+    type: "workflow";
+    name: string;
+    /**
+     * The parameters to pass to the child workflow.
+     * These parameters will be merged over the parent workflow vars and passed altogether to the child workflow.
+     */
+    vars?: Record<string, any>;
+    async?: boolean;
+    /**
+     * The name of the workflow variable that will store the result of the child workflow (if async the workflow id is stored)
+     * If not specified the result will not be stored
+     * The parameters describe how the actual parameters will be obtained from the workflow execution vars.
+     * since it may contain references to workflow execution vars.
+     */
+    output?: string;
+    /**
+     * In case the dslWorkflow is used as a child workflow the spec is used to define the child workflow.
+     * If spec is defined then the name must be "dslWorkflow"
+     */
+    spec?: DSLWorkflowSpec;
+    options?: {
+        memo?: Record<string, any>;
+        retry?: DSLRetryPolicy;
+        searchAttributes?: Record<string, string[] | number[] | boolean[] | Date[]>;
+        taskQueue?: string;
+        workflowExecutionTimeout?: StringValue | number;
+        workflowRunTimeout?: StringValue | number;
+        workflowTaskTimeout?: StringValue | number;
+        workflowId?: string;
+        cronSchedule?: string;
+        parentClosePolicy?: ParentClosePolicyType;
+    };
+}
+export type DSLWorkflowStep = DSLActivityStep | DSLChildWorkflowStep;
+export interface DSLWorkflowSpecBase {
+    name: string;
+    description?: string;
+    tags?: string[];
+    steps?: DSLWorkflowStep[] | never;
+    /**
+     * @deprecated use steps instead
+     */
+    activities?: DSLActivitySpec[] | never;
+    vars: Record<string, any>;
+    options?: DSLActivityOptions;
+    result?: string;
+    debug_mode?: boolean;
+}
+export interface DSLWorkflowSpecWithSteps extends DSLWorkflowSpecBase {
+    steps: DSLWorkflowStep[];
+    /**
+     * @deprecated use steps instead
+     */
+    activities?: never;
+}
+/**
+ * @deprecated use steps instead
+ */
+export interface DSLWorkflowSpecWithActivities extends DSLWorkflowSpecBase {
+    steps?: never;
+    /**
+     * @deprecated use steps instead
+     */
+    activities: DSLActivitySpec[];
+}
+/**
+ * activities and steps fields are mutually exclusive
+ * steps was added after activities and may contain a mix of activities and other tasks like exec child workflows.
+ * For backward compatibility we keep the activities field as a fallback but one should use one or the other not both.
+ */
+export type DSLWorkflowSpec = DSLWorkflowSpecWithSteps | DSLWorkflowSpecWithActivities;
+export interface DSLWorkflowDefinition extends BaseObject, DSLWorkflowSpecBase {
+    input_schema?: Record<string, any>;
+    activities?: DSLActivitySpec[];
+    steps?: DSLWorkflowStep[];
+}
+export interface WorkflowDefinitionRef {
+    id: string;
+    name: string;
+    description?: string;
+    tags?: string[];
+    created_at: Date;
+    updated_at: Date;
+}
+export declare const WorkflowDefinitionRefPopulate = "id name description tags created_at updated_at";

package/lib/types/store/dsl-workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dsl-workflow.d.ts","sourceRoot":"","sources":["../../../src/store/dsl-workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,wBAAwB;IACzE;;;OAGG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,mBAAmB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IAC3C,sBAAsB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IAC9C,sBAAsB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IAC9C,KAAK,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IACvC,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,wBAAwB;IAC9G,QAAQ,EAAE,eAAe,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAGD,MAAM,MAAM,UAAU,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;AAC7D,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,eAAe,GAAG,iBAAiB,CAAC;IACvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;CACjC;AAED,MAAM,WAAW,eAAe,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACrF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAGzC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAChC;AAED,MAAM,WAAW,eAAe,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,eAAe,CAAC,MAAM,CAAC,EAAE,mBAAmB;IAC3I,IAAI,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,UAAU,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAG3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,OAAO,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC3B,KAAK,CAAC,EAAE,cAAc,CAAC;QACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,wBAAwB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;QAChD,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;QAC1C,mBAAmB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;QAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;KAK7C,CAAA;CACJ;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,KAAK,CAAC,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAIvC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAG7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACjE,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACtE,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,eAAe,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,wBAAwB,GAAG,6BAA6B,CAAC;AAEvF,MAAM,WAAW,qBAAsB,SAAQ,UAAU,EAAE,mBAAmB;IAE1E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACnC,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CACpB;AAED,eAAO,MAAM,6BAA6B,mDAAmD,CAAA"}

package/lib/types/store/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./activity-catalog.js";
+export * from "./agent.js";
+export * from "./collections.js";
+export * from "./common.js";
+export * from "./doc-analyzer.js";
+export * from "./dsl-workflow.js";
+export * from "./object-types.js";
+export * from "./store.js";
+export * from "./temporalio.js";
+export * from "./workflow.js";
+export * from "./signals.js";

package/lib/types/store/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/store/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC;AAC9B,cAAc,cAAc,CAAC"}

package/lib/types/store/object-types.d.ts

@@ -0,0 +1,23 @@
+import type { JSONSchemaType } from "ajv";
+export interface RenditionProperties {
+    mime_type: string;
+    source_etag?: string;
+    height?: number;
+    width?: number;
+    multipart?: boolean;
+    total_parts?: number;
+}
+export declare const RenditionSchema: JSONSchemaType<RenditionProperties>;
+export interface DocumentPartProperties {
+    source_etag?: string;
+    part_number: number;
+    title?: string;
+    source_line_start?: number;
+    source_line_end?: number;
+    type?: 'text' | 'image' | 'table' | 'chart' | 'diagram' | 'code' | 'other';
+    page_number?: number;
+    description?: string;
+    height?: number;
+    width?: number;
+}
+export declare const DocumentPartSchema: JSONSchemaType<DocumentPartProperties>;

package/lib/types/store/object-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-types.d.ts","sourceRoot":"","sources":["../../../src/store/object-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AAIzC,MAAM,WAAW,mBAAmB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,mBAAmB,CAqC/D,CAAA;AAID,MAAM,WAAW,sBAAsB;IAEnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAElB;AAGD,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAAC,sBAAsB,CAwDrE,CAAA"}

package/lib/types/store/signals.d.ts

@@ -0,0 +1,5 @@
+export interface UserInputSignal {
+    message: string;
+    metadata?: Record<string, any>;
+    auth_token?: string;
+}

package/lib/types/store/signals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signals.d.ts","sourceRoot":"","sources":["../../../src/store/signals.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/lib/types/store/store.d.ts

@@ -0,0 +1,269 @@
+import { SearchPayload } from "../payload.js";
+import { SupportedEmbeddingTypes } from "../project.js";
+import { ComplexSearchQuery } from "../query.js";
+import { BaseObject } from "./common.js";
+import { RenditionProperties } from "./index.js";
+export declare enum ContentObjectStatus {
+    created = "created",
+    processing = "processing",// the was created and still processing
+    completed = "completed",
+    failed = "failed",
+    archived = "archived"
+}
+export interface Embedding {
+    model: string;
+    values: number[];
+    etag?: string;
+}
+export interface ContentObject<T = any> extends ContentObjectItem<T> {
+    text?: string;
+    text_etag?: string;
+    embeddings: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
+    parts?: string[];
+    parts_etag?: string;
+    transcript?: Transcript;
+}
+export type ContentNature = "video" | "image" | "audio" | "document" | "code" | "other";
+export interface Dimensions {
+    width: number;
+    height: number;
+}
+export interface Location {
+    latitude: number;
+    longitude: number;
+}
+export interface GenerationRunMetadata {
+    id: string;
+    date: string;
+    model: string;
+    target?: string;
+}
+export interface ContentMetadata {
+    type?: ContentNature;
+    size?: number;
+    languages?: string[];
+    location?: Location;
+    generation_runs: GenerationRunMetadata[];
+    etag?: string;
+}
+export interface TemporalMediaMetadata extends ContentMetadata {
+    duration?: number;
+    transcript?: Transcript;
+}
+export interface ImageMetadata extends ContentMetadata {
+    type: "image";
+    dimensions?: Dimensions;
+}
+export interface AudioMetadata extends TemporalMediaMetadata {
+    type: "audio";
+}
+export interface VideoMetadata extends TemporalMediaMetadata {
+    type: "video";
+    dimensions?: Dimensions;
+}
+export interface DocumentMetadata extends ContentMetadata {
+    type: "document";
+    page_count?: number;
+    content_processor?: {
+        type?: string;
+        features_requested?: string[];
+        zones_requested?: string[];
+        table_count?: number;
+        image_count: number;
+        zone_count: number;
+        needs_ocr_count?: number;
+    };
+}
+export interface Transcript {
+    text?: string;
+    segments?: TranscriptSegment[];
+    etag?: string;
+}
+export interface TranscriptSegment {
+    start: number;
+    text: string;
+    speaker?: number;
+    end?: number;
+    confidence?: number;
+    language?: string;
+}
+export interface ContentSource {
+    source?: string;
+    type?: string;
+    name?: string;
+    etag?: string;
+}
+/**
+ *
+ */
+export interface RevisionInfo {
+    /** Direct parent revision id (omit on the first revision) */
+    parent?: string;
+    /** The root revision id (omit on the first revision) */
+    root: string;
+    /** True if this revision is the head revision */
+    head: boolean;
+    /** Human‑friendly tag or state ("v1.2", "approved") */
+    label?: string;
+}
+/**
+ * The content object item is a simplified version of the ContentObject that is returned by the store API when listing objects.
+ */
+export interface ContentObjectItem<T = Record<string, any>> extends BaseObject {
+    parent: string;
+    /** An optional path based location for the object */
+    location: string;
+    /**
+     * Object status.
+     * - created: the object was created and is being processed
+     * - processing: the object is being processed
+     * - completed: the object was processed and is ready to use
+     * - failed: the object processing failed
+     * - archived: the object was archived and is no longer available
+     */
+    status: ContentObjectStatus;
+    /**
+     * Object type id.
+     */
+    type?: ContentObjectTypeRef;
+    /**
+     * Content source information, typically a link to an object store
+     */
+    content: ContentSource;
+    /**
+     * External identifier for integration with other systems
+     */
+    external_id?: string;
+    /** The object properties. This is a JSON object that describes the object, matching the object type schema */
+    properties: T;
+    /** Technical metadata of the object */
+    metadata?: VideoMetadata | AudioMetadata | ImageMetadata | DocumentMetadata | ContentMetadata;
+    /** Token information  */
+    tokens?: {
+        count: number;
+        encoding: string;
+        etag: string;
+    };
+    /**
+     * Revision information. This is used to track the history of the object.
+     */
+    revision: RevisionInfo;
+    /**
+     * Soft delete flag. When true, the object should be considered deleted
+     * but is still retained in the database for historical purposes.
+     */
+    is_deleted?: boolean;
+    /**
+     * Soft lock flag. When true, the object should be considered read-only
+     * and modification attempts should be rejected.
+     */
+    is_locked?: boolean;
+}
+/**
+ * When creating from an uploaded file the content should be an URL to the uploaded file
+ */
+export interface CreateContentObjectPayload<T = any> extends Partial<Omit<ContentObject<T>, "id" | "root" | "created_at" | "updated_at" | "type" | "owner">> {
+    id?: string;
+    type?: string;
+    generation_run_info?: GenerationRunMetadata;
+}
+export interface ContentObjectTypeRef {
+    id: string;
+    name: string;
+}
+export interface ComplexSearchPayload extends Omit<SearchPayload, "query"> {
+    query?: ComplexSearchQuery;
+}
+export interface ColumnLayout {
+    /**
+     * The path of the field to use (e.g. "properties.title")
+     */
+    field: string;
+    /**
+     * The name to display in the table column
+     */
+    name: string;
+    /**
+     * The type of the field specifies how the rendering will be done. If not specified the string type will be used.
+     * The type may contain additional parameters prepended using a web-like query string syntax: date?LLL
+     */
+    type?: string;
+    fallback?: string;
+    /**
+     * A default value to be used if the field is not present in the object
+     */
+    default?: any;
+}
+export interface ContentObjectType extends ContentObjectTypeItem {
+}
+export interface ContentObjectTypeItem extends BaseObject {
+    is_chunkable?: boolean;
+    /**
+     * This is only included in ContentObjectTypeItem if explicitly requested
+     * It is always included in ContentObjectType
+     */
+    table_layout?: ColumnLayout[];
+    /**
+     * this is only included in ContentObjectTypeItem if explicitly requested
+     * It is always included in ContentObjectType
+     */
+    object_schema?: Record<string, any>;
+    /**
+     * Determines if the content will be validated against the object schema a generation time and save/update time.
+     */
+    strict_mode?: boolean;
+}
+export interface CreateContentObjectTypePayload extends Omit<ContentObjectType, "id" | "created_at" | "updated_at" | "created_by" | "updated_by"> {
+}
+export declare enum WorkflowRuleInputType {
+    single = "single",
+    multiple = "multiple",
+    none = "none"
+}
+export interface WorkflowRuleItem extends BaseObject {
+    endpoint: string;
+    input_type: WorkflowRuleInputType;
+}
+export interface WorkflowRule extends WorkflowRuleItem {
+    match?: Record<string, any>;
+    /**
+     * Activities configuration if any.
+     */
+    config?: Record<string, any>;
+    /**
+     * Debug mode for the rule
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Customer override for the rule
+     * When set to true the rule will not be updated by the system
+     */
+    customer_override?: boolean;
+}
+export interface CreateWorkflowRulePayload extends UploadWorkflowRulePayload {
+    name: string;
+    endpoint: string;
+}
+export interface UploadWorkflowRulePayload extends Partial<Omit<WorkflowRule, "id" | "created_at" | "updated_at" | "owner">> {
+}
+export interface GetRenditionResponse {
+    status: "found" | "generating" | "failed";
+    rendition?: ContentObject<RenditionProperties>;
+    workflow_run_id?: string;
+}
+export interface GetUploadUrlPayload {
+    name: string;
+    id?: string;
+    mime_type?: string;
+    ttl?: number;
+}
+export interface GetFileUrlPayload {
+    file: string;
+}
+export interface GetFileUrlResponse {
+    url: string;
+    id: string;
+    mime_type: string;
+    path: string;
+}

package/lib/types/store/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../../../src/store/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,oBAAY,mBAAmB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe,CAAE,uCAAuC;IAClE,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACxB;AAED,MAAM,WAAW,SAAS;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,iBAAiB,CAAC,CAAC,CAAC;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,uBAAuB,EAAE,SAAS,CAAC,CAAC,CAAC;IAChE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;AAExF,MAAM,WAAW,UAAU;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,QAAQ;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAE5B,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,eAAe,EAAE,qBAAqB,EAAE,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAGD,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED,MAAM,WAAW,aAAc,SAAQ,eAAe;IAClD,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED,MAAM,WAAW,aAAc,SAAQ,qBAAqB;IACxD,IAAI,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,aAAc,SAAQ,qBAAqB;IACxD,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACrD,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;QAC9B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,eAAe,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;CACL;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAE1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IAEb,iDAAiD;IACjD,IAAI,EAAE,OAAO,CAAC;IAEd,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAOlB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,UAAU;IAC1E,MAAM,EAAE,MAAM,CAAC;IAEf,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,8GAA8G;IAC9G,UAAU,EAAE,CAAC,CAAC;IAEd,uCAAuC;IACvC,QAAQ,CAAC,EAAE,aAAa,GAAG,aAAa,GAAG,aAAa,GAAG,gBAAgB,GAAG,eAAe,CAAC;IAE9F,yBAAyB;IACzB,MAAM,CAAC,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAC;IAEvB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B,CAAC,CAAC,GAAG,GAAG,CAC/C,SAAQ,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;IACvG,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB,CAAC,EAAE,qBAAqB,CAAC;CAC/C;AAED,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC;IACtE,KAAK,CAAC,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAId,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AACD,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;CAAI;AACpE,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACrD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,EAAE,CAAC;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,8BACb,SAAQ,IAAI,CAAC,iBAAiB,EAAE,IAAI,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CAAC;CAAI;AAEzG,oBAAY,qBAAqB;IAC7B,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,IAAI,SAAS;CAChB;AACD,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAEhD,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,qBAAqB,CAAC;CACrC;AACD,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IAIlD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,yBAA0B,SAAQ,yBAAyB;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;CACpB;AACD,MAAM,WAAW,yBACb,SAAQ,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,YAAY,GAAG,YAAY,GAAG,OAAO,CAAC,CAAC;CAAI;AAEzF,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;IAC1C,SAAS,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAkB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CAChB"}

package/lib/types/store/temporalio.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copied from temporalio
+ * The temporalio ParentClosePolicy
+ */
+export type ParentClosePolicyType = "TERMINATE" | "ABANDON" | "REQUEST_CANCEL" | undefined;
+interface ParentClosePolicyI {
+    TERMINATE: "TERMINATE";
+    ABANDON: "ABANDON";
+    REQUEST_CANCEL: "REQUEST_CANCEL";
+    PARENT_CLOSE_POLICY_UNSPECIFIED: undefined;
+    PARENT_CLOSE_POLICY_TERMINATE: "TERMINATE";
+    PARENT_CLOSE_POLICY_ABANDON: "ABANDON";
+    PARENT_CLOSE_POLICY_REQUEST_CANCEL: "REQUEST_CANCEL";
+}
+export declare const ParentClosePolicy: ParentClosePolicyI;
+export {};

package/lib/types/store/temporalio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"temporalio.d.ts","sourceRoot":"","sources":["../../../src/store/temporalio.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,WAAW,GAAG,SAAS,GAAG,gBAAgB,GAAG,SAAS,CAAC;AAC3F,UAAU,kBAAkB;IACxB,SAAS,EAAE,WAAW,CAAC;IACvB,OAAO,EAAE,SAAS,CAAC;IACnB,cAAc,EAAE,gBAAgB,CAAC;IACjC,+BAA+B,EAAE,SAAS,CAAC;IAC3C,6BAA6B,EAAE,WAAW,CAAC;IAC3C,2BAA2B,EAAE,SAAS,CAAC;IACvC,kCAAkC,EAAE,gBAAgB,CAAA;CACvD;AACD,eAAO,MAAM,iBAAiB,EAuCzB,kBAAkB,CAAC"}