@vertesia/common 0.78.0-dev-28b447d → 0.78.0-dev.1

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

@@ -0,0 +1,304 @@
+import { SearchPayload } from "../payload.js";
+import { SupportedEmbeddingTypes } from "../project.js";
+import { ComplexSearchQuery } from "../query.js";
+import { BaseObject } from "./common.js";
+export declare enum ContentObjectApiHeaders {
+    COLLECTION_ID = "x-collection-id",
+    PROCESSING_PRIORITY = "x-processing-priority",
+    CREATE_REVISION = "x-create-revision",
+    REVISION_LABEL = "x-revision-label"
+}
+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;
+    security?: Record<string, string[]>;
+}
+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 TextSection {
+    description: string;
+    first_line_index: number;
+    last_line_index: number;
+}
+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;
+    };
+    sections?: TextSection[];
+}
+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;
+    /**
+     * The document score, used for ranking and sorting.
+     */
+    score?: number;
+}
+/**
+ * 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 declare enum ImageRenditionFormat {
+    jpeg = "jpeg",
+    png = "png",
+    webp = "webp"
+}
+export declare enum MarkdownRenditionFormat {
+    docx = "docx",
+    pdf = "pdf"
+}
+export interface GetRenditionParams {
+    format: ImageRenditionFormat | MarkdownRenditionFormat;
+    max_hw?: number;
+    generate_if_missing?: boolean;
+    sign_url?: boolean;
+}
+export interface GetRenditionResponse {
+    status: "found" | "generating" | "failed";
+    renditions?: string[];
+    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;
+}
+export declare enum ContentObjectProcessingPriority {
+    normal = "normal",
+    low = "low"
+}

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;AAEzC,oBAAY,uBAAuB;IAC/B,aAAa,oBAAoB;IACjC,mBAAmB,0BAA0B;IAC7C,eAAe,sBAAsB;IACrC,cAAc,qBAAqB;CACtC;AAED,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;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;CACvC;AAED,MAAM,MAAM,aAAa,GACnB,OAAO,GACP,OAAO,GACP,OAAO,GACP,UAAU,GACV,MAAM,GACN,OAAO,CAAC;AAEd,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,WAAW;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,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;IACF,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;CAC5B;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,EACP,aAAa,GACb,aAAa,GACb,aAAa,GACb,gBAAgB,GAChB,eAAe,CAAC;IAElB,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;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B,CAAC,CAAC,GAAG,GAAG,CAC/C,SAAQ,OAAO,CACX,IAAI,CACA,aAAa,CAAC,CAAC,CAAC,EAChB,IAAI,GAAG,MAAM,GAAG,YAAY,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CACjE,CACJ;IACD,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,CACR,iBAAiB,EACjB,IAAI,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,GAAG,YAAY,CACnE;CAAI;AAET,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,CACX,IAAI,CAAC,YAAY,EAAE,IAAI,GAAG,YAAY,GAAG,YAAY,GAAG,OAAO,CAAC,CACnE;CAAI;AAET,oBAAY,oBAAoB;IAC5B,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;CAChB;AAED,oBAAY,uBAAuB;IAC/B,IAAI,SAAS;IACb,GAAG,QAAQ;CACd;AAED,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,oBAAoB,GAAG,uBAAuB,CAAC;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACjC,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;IAC1C,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,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;AAED,oBAAY,+BAA+B;IACvC,MAAM,WAAW;IACjB,GAAG,QAAQ;CACd"}

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"}

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

@@ -0,0 +1,372 @@
+import { JSONSchema4 } from "json-schema";
+import { InteractionRef } from "../interaction.js";
+export declare enum ContentEventName {
+    create = "create",
+    change_type = "change_type",
+    update = "update",
+    revision_created = "revision_created",
+    delete = "delete",
+    workflow_finished = "workflow_finished",
+    workflow_execution_request = "workflow_execution_request",
+    api_request = "api_request"
+}
+export interface Queue {
+    name: string;
+    queue_suffix?: string;
+    queue_full_name?: string;
+}
+export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
+    /**
+     * The ref of the user who initiated the workflow.
+     */
+    initiated_by?: string;
+    /**
+     * The account ID of the user who created the activity.
+     * This is useful to select the right database to work on.
+     */
+    account_id: string;
+    /**
+     * The project ID of the account who created the activity.
+     */
+    project_id: string;
+    /**
+     * The vars field is mainly used to pass the user input to the workflow.
+     * The user input ar custom user options that can be used to configure the workflow.
+     * You can see the user input as the arguments for a command line app.
+     *
+     * In the case of workflows started by events (e.g. using a a workflow rule) the user input vars will be initialized with the workflow rule configuration field.
+     *
+     * In case of dsl workflows the workflow execution payload vars will be applied over the default vars values stored in the DSL vars field.
+     */
+    vars: T;
+    /**
+     * Auth Token to access Zeno and Composable from the workers
+     */
+    auth_token?: string;
+    /**
+     * The configuration for the workflow execution.
+     */
+    config?: {
+        studio_url: string;
+        store_url: string;
+        slack_app_url?: string;
+        enabled_integrations?: string[];
+    };
+    /**
+     * The list of endpoints to notify when the workflow finishes.
+     * It is handled by a sub-workflow execution, so the main workflow will not wait for the notification to be sent.
+     */
+    notify_endpoints?: string[];
+    /** If this is a child workflow, parent contains parent's ids  */
+    parent?: {
+        run_id: string;
+        workflow_id: string;
+        /**
+         * the depth of nested parent workflows
+         */
+        run_depth?: number;
+    };
+    /**
+     *  List of enabled processing queues. Managed by the application.
+     */
+    _enabled_queues?: Queue[];
+}
+export interface WorkflowExecutionPayload<T = Record<string, any>> extends WorkflowExecutionBaseParams<T> {
+    /**
+     * The event which started the workflow who created the activity.
+     */
+    event: ContentEventName;
+    wf_rule_name?: string;
+    /**
+     * The ID of the target objects processed by the workflow.
+     */
+    objectIds: string[];
+    /**
+     * Auth Token to access Zeno and Composable from the workers
+     */
+    auth_token: string;
+}
+export declare function getDocumentIds(payload: WorkflowExecutionPayload): string[];
+export interface ExecuteWorkflowPayload {
+    /**
+     * The task queue to assign the workflow to. Deprecated, queues are choosend server side
+     */
+    task_queue?: string;
+    /**
+     * Docuument IDs pon which the workflow will be executed, deprecated, replaced params in vars
+     */
+    objectIds?: string[];
+    /**
+     * Parameters to pass to the workflow
+     */
+    vars?: Record<string, any>;
+    /**
+     * Make the workflow ID unique by always adding a random token to the ID.
+     */
+    unique?: boolean;
+    /**
+     * A custom ID to use for the workflow execution id instead of the generated one.
+     */
+    custom_id?: string;
+    /**
+     * Timeout for the workflow execution to complete, in seconds.
+     */
+    timeout?: number;
+}
+export interface ListWorkflowRunsPayload {
+    /**
+     * The document ID passed to a workflow run.
+     */
+    document_id?: string;
+    /**
+     * The event name that triggered the workflow.
+     */
+    event_name?: string;
+    /**
+     * The workflow rule ID that triggered the workflow.
+     */
+    rule_id?: string;
+    /**
+     * The start time for filtering workflow runs.
+     */
+    start?: string;
+    /**
+     * The end time for filtering workflow runs.
+     */
+    end?: string;
+    /**
+     * The status of the workflow run.
+     */
+    status?: string;
+    /**
+     * search term to filter on workflow id and run id
+     */
+    search_term?: string;
+    /**
+     * The user or service account that initiated the workflow run.
+     */
+    initiated_by?: string;
+    /**
+     * Lucene query string to search for the workflow runs.
+     * This is a full text search on the workflow run history.
+     */
+    query?: string;
+    type?: string;
+    /**
+     * The maximum number of results to return per page.
+     */
+    page_size?: number;
+    /**
+     * The page token for Temporal pagination.
+     */
+    next_page_token?: string;
+}
+interface WorkflowRunEvent {
+    event_id: number;
+    event_time: number;
+    event_type: string;
+    task_id?: string;
+    attempt: number;
+    activity?: {
+        name?: string;
+        id?: string;
+        input?: any;
+        scheduledEventId?: string;
+        startedEventId?: string;
+    };
+    childWorkflow?: {
+        workflowId?: string;
+        workflowType?: string;
+        runId?: string;
+        scheduledEventId?: string;
+        startedEventId?: string;
+        input?: any;
+        result?: any;
+    };
+    signal?: {
+        direction: "receiving" | "sending";
+        signalName?: string;
+        input?: any;
+        sender?: {
+            workflowId?: string;
+            runId?: string;
+        };
+        recipient?: {
+            workflowId?: string;
+            runId?: string;
+        };
+        initiatedEventId?: string;
+    };
+    error?: {
+        message?: string;
+        source?: string;
+        stacktrace?: string;
+        type?: string;
+    };
+    result?: any;
+}
+export interface WorkflowRun {
+    status?: WorkflowExecutionStatus | string;
+    /**
+     * The Temporal Workflow Type of this Workflow Run.
+     *
+     * @see https://docs.temporal.io/workflows
+     */
+    type?: string;
+    started_at?: number;
+    closed_at?: number;
+    execution_duration?: number;
+    run_id?: string;
+    workflow_id?: string;
+    initiated_by?: string;
+    interaction_name?: string;
+    input?: any;
+    result?: any;
+    error?: any;
+    raw?: any;
+    /**
+     * The Vertesia Workflow Type of this Workflow Run.
+     *  - For DSL workflows (`type:dslWorkflow`), the vertesia_type refers to the "Workflow Rule Name" specified in the
+     *    DSL. For example, "Standard Document Intake" or "Standard Image Intake".
+     *  - For non-DSL workflows, the vertesia_type is the name of the Temporal Workflow Type.
+     */
+    vertesia_workflow_type?: string;
+    /**
+     * An interaction is used to start the agent, the data is stored on temporal "vars"
+     */
+    interactions?: InteractionRef[];
+}
+export interface WorkflowRunWithDetails extends WorkflowRun {
+    history?: WorkflowRunEvent[];
+    memo?: {
+        [key: string]: any;
+    } | null;
+    pendingActivities?: {
+        activityId?: string;
+        activityType?: string;
+        attempt: number;
+        maximumAttempts: number;
+        lastFailure?: string;
+        lastStartedTime?: number;
+    }[];
+}
+export interface ListWorkflowRunsResponse {
+    runs: WorkflowRun[];
+    next_page_token?: string;
+    has_more?: boolean;
+}
+export interface ListWorkflowInteractionsResponse {
+    workflow_id: string;
+    run_id: string;
+    interaction: WorkflowInteraction;
+}
+export interface WorkflowInteraction {
+    type: string;
+    model: string;
+    tools: [];
+    interaction: string;
+    environment: string;
+    prompt_data: JSONSchema4;
+    interactive: boolean;
+    interactionParamsSchema?: JSONSchema4;
+    debug_mode?: boolean;
+    collection_id?: string;
+}
+export interface MultiDocumentsInteractionParams extends Omit<WorkflowExecutionPayload, "config"> {
+    config: {
+        interactionName: string;
+        action: DocumentActionConfig;
+        data: Record<string, any>;
+    };
+}
+export interface DocumentActionConfig {
+    contentTypeName?: string;
+    setAsProperties: boolean;
+    setAsText: string;
+    setNameFrom: string;
+    upsert: boolean;
+    documentId?: string;
+    parentId?: string;
+}
+export declare enum WorkflowExecutionStatus {
+    UNKNOWN = 0,
+    RUNNING = 1,
+    COMPLETED = 2,
+    FAILED = 3,
+    CANCELED = 4,
+    TERMINATED = 5,
+    CONTINUED_AS_NEW = 6,
+    TIMED_OUT = 7
+}
+/**
+ * Basic response for anything run with an async workflow
+ */
+export interface WorkflowRunStatus {
+    workflow_id: string | null;
+    workflow_run_id: string | null;
+    status: WorkflowExecutionStatus;
+}
+/**
+ * Workflow Update Message
+ */
+export interface AgentMessage {
+    timestamp: number;
+    workflow_run_id: string;
+    type: AgentMessageType;
+    message: string;
+    details?: any;
+    workstream_id?: string;
+}
+export declare enum AgentMessageType {
+    SYSTEM = "system",
+    THOUGHT = "thought",
+    PLAN = "plan",
+    UPDATE = "update",
+    COMPLETE = "complete",
+    WARNING = "warning",
+    ERROR = "error",
+    ANSWER = "answer",
+    QUESTION = "question",
+    REQUEST_INPUT = "request_input",
+    IDLE = "idle",
+    TERMINATED = "terminated"
+}
+export interface PlanTask {
+    id: number;
+    goal: string;
+    instructions: string[];
+    comment?: string;
+    status?: "pending" | "in_progress" | "completed" | "skipped";
+}
+export interface Plan {
+    plan: PlanTask[];
+    comment?: string;
+}
+export declare const LOW_PRIORITY_TASK_QUEUE = "low_priority";
+/**
+ * WebSocket message types for bidirectional communication
+ */
+export interface WebSocketSignalMessage {
+    type: 'signal';
+    signalName: string;
+    data: any;
+    requestId?: string | number;
+}
+export interface WebSocketPingMessage {
+    type: 'ping';
+}
+export interface WebSocketPongMessage {
+    type: 'pong';
+}
+export interface WebSocketAckMessage {
+    type: 'ack';
+    requestId: string | number;
+}
+export interface WebSocketErrorMessage {
+    type: 'error';
+    requestId?: string | number;
+    error: string;
+}
+export type WebSocketClientMessage = WebSocketSignalMessage | WebSocketPingMessage;
+export type WebSocketServerMessage = WebSocketPongMessage | WebSocketAckMessage | WebSocketErrorMessage | AgentMessage;
+export {};