@vertesia/common 0.52.0 → 0.55.0

package/src/store/store.ts

@@ -1,18 +1,17 @@
-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';
+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 enum ContentObjectStatus {
-    created = 'created',
-    processing = 'processing', // the was created and still processing
-    completed = 'completed',
-    failed = 'failed',
-    archived = 'archived',
+    created = "created",
+    processing = "processing", // the was created and still processing
+    completed = "completed",
+    failed = "failed",
+    archived = "archived",
 }
 
-
 export interface Embedding {
     model: string; //the model used to generate this embedding
     values: number[];
@@ -28,8 +27,7 @@ export interface ContentObject<T = any> extends ContentObjectItem<T> {
     transcript?: Transcript;
 }
 
-
-export type ContentNature = 'video' | 'image' | 'audio' | 'document' | 'code' | 'other';
+export type ContentNature = "video" | "image" | "audio" | "document" | "code" | "other";
 
 export interface Dimensions {
     width: number;
@@ -48,12 +46,10 @@ export interface GenerationRunMetadata {
     target?: string;
 }
 
-
-
 export interface ContentMetadata {
     // Common fields for all media types
     type?: ContentNature;
-    size?: number;      // in bytes
+    size?: number; // in bytes
     languages?: string[];
     location?: Location;
     generation_runs: GenerationRunMetadata[];
@@ -63,25 +59,25 @@ export interface ContentMetadata {
 // Example of type-specific metadata interfaces (optional, for better type safety)
 export interface TemporalMediaMetadata extends ContentMetadata {
     duration?: number; // in seconds
-    transcript?: Transcript
+    transcript?: Transcript;
 }
 
 export interface ImageMetadata extends ContentMetadata {
-    type: 'image';
+    type: "image";
     dimensions?: Dimensions;
 }
 
 export interface AudioMetadata extends TemporalMediaMetadata {
-    type: 'audio';
+    type: "audio";
 }
 
 export interface VideoMetadata extends TemporalMediaMetadata {
-    type: 'video';
+    type: "video";
     dimensions?: Dimensions;
 }
 
 export interface DocumentMetadata extends ContentMetadata {
-    type: 'document';
+    type: "document";
     page_count?: number;
     content_processor?: {
         type?: string;
@@ -91,7 +87,7 @@ export interface DocumentMetadata extends ContentMetadata {
         image_count: number;
         zone_count: number;
         needs_ocr_count?: number;
-    }
+    };
 }
 
 export interface Transcript {
@@ -101,12 +97,12 @@ export interface Transcript {
 }
 
 export interface TranscriptSegment {
-    start: number
-    text: string
-    speaker?: number
-    end?: number
-    confidence?: number
-    language?: string
+    start: number;
+    text: string;
+    speaker?: number;
+    end?: number;
+    confidence?: number;
+    language?: string;
 }
 
 export interface ContentSource {
@@ -120,34 +116,99 @@ export interface ContentSource {
     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;
+
+    /** Extra parents when two branches are merged (leave undefined until needed) */
+    //merge_parents?: string[]; //maybe later
+
+    /** Pointer to a diff / patch blob if you store deltas instead of full content */
+    //delta_ref?: 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 = any> extends BaseObject {
-    root?: string; // the ID of the root parent object. The root object doesn't have the root field set.
+export interface ContentObjectItem<T = Record<string, any>> extends BaseObject {
     parent: string; // the id of the direct parent object. The root object doesn't have the parent field set.
+
+    /** An optional path based location for the object */
     location: string; // the path of the parent object
+
+    /**
+     * 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;
-    // A ref to the object type
+
+    /**
+     * Object type id.
+     */
     type?: ContentObjectTypeRef;
-    // the content source URL and type
+
+    /**
+     * Content source information, typically a link to an object store
+     */
     content: ContentSource;
+
+    /**
+     * External identifier for integration with other systems
+     */
     external_id?: string;
-    properties: T | Record<string, any>; // a JSON object that describes the object
+
+    /** The object properties. This is a JSON object that describes the object, matching the object type schema */
+    properties: T; // a JSON object that describes the object
+
+    /** Technical metadata of the object */
     metadata?: VideoMetadata | AudioMetadata | ImageMetadata | DocumentMetadata | ContentMetadata;
+
+    /** Token information  */
     tokens?: {
         count: number; // the number of tokens in the text
         encoding: string; // the encoding used to calculate the tokens
         etag: string; //the etag of the text used for the token count
     };
+
+    /**
+     * Revision information. This is used to track the history of the object.
+     */
+    revision: RevisionInfo; // the revision info of the object
+
+    /**
+     * 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 shouild be an URL to the uploaded file
+ * 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'>> {
+export interface CreateContentObjectPayload<T = any>
+    extends Partial<Omit<ContentObject<T>, "id" | "root" | "created_at" | "updated_at" | "type" | "owner">> {
     id?: string; // An optional existing object ID to be replaced by the new one
     type?: string; // the object type ID
     generation_run_info?: GenerationRunMetadata;
@@ -158,7 +219,7 @@ export interface ContentObjectTypeRef {
     name: string;
 }
 
-export interface ComplexSearchPayload extends Omit<SearchPayload, 'query'> {
+export interface ComplexSearchPayload extends Omit<SearchPayload, "query"> {
     query?: ComplexSearchQuery;
 }
 
@@ -185,29 +246,28 @@ export interface ColumnLayout {
      */
     default?: any;
 }
-export interface ContentObjectType extends ContentObjectTypeItem {
-}
+export interface ContentObjectType extends ContentObjectTypeItem {}
 export interface ContentObjectTypeItem extends BaseObject {
     is_chunkable?: boolean;
     /**
-     * This is only included in ContentObjectTypeItem if explicitely requested
+     * 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 explicitely requested
+     * this is only included in ContentObjectTypeItem if explicitly requested
      * It is always included in ContentObjectType
      */
     object_schema?: Record<string, any>; // an optional JSON schema for the object properties.
 }
 
-export interface CreateContentObjectTypePayload extends Omit<ContentObjectType, 'id' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'> {
-}
+export interface CreateContentObjectTypePayload
+    extends Omit<ContentObjectType, "id" | "created_at" | "updated_at" | "created_by" | "updated_by"> {}
 
 export enum WorkflowRuleInputType {
-    single = 'single',
-    multiple = 'multiple',
-    none = 'none'
+    single = "single",
+    multiple = "multiple",
+    none = "none",
 }
 export interface WorkflowRuleItem extends BaseObject {
     // the name of the workflow function
@@ -237,18 +297,16 @@ export interface WorkflowRule extends WorkflowRuleItem {
     customer_override?: boolean;
 }
 
-
 export interface CreateWorkflowRulePayload extends UploadWorkflowRulePayload {
     name: string; // required
     endpoint: string; // required
 }
-export interface UploadWorkflowRulePayload extends Partial<Omit<WorkflowRule, 'id' | 'created_at' | 'updated_at' | 'owner'>> {
-}
+export interface UploadWorkflowRulePayload
+    extends Partial<Omit<WorkflowRule, "id" | "created_at" | "updated_at" | "owner">> {}
 
 export interface GetRenditionResponse {
-
-    status: 'found' | 'generating' | 'failed';
-    rendition?: ContentObject<RenditionProperties> //TODO add <Rendition>
+    status: "found" | "generating" | "failed";
+    rendition?: ContentObject<RenditionProperties>; //TODO add <Rendition>
     workflow_run_id?: string;
 }
 

package/src/store/workflow.ts

@@ -2,6 +2,7 @@ export 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",
@@ -16,7 +17,7 @@ export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
 
     /**
      * The account ID of the user who created the activity.
-     * This is usefull to select the right database to work on.
+     * This is useful to select the right database to work on.
      */
     account_id: string;
 
@@ -32,7 +33,7 @@ export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
      *
      * 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 worflow execution payload vars will be applied over the default vars values stored in the DSL vars 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;
 
@@ -53,9 +54,10 @@ export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
 
     /**
      * The list of endpoints to notify when the workflow finishes.
-     * It is handled by a subworkflow execution, so the main workflow will not wait for the notification to be sent.
+     * It is handled by a sub-workflow execution, so the main workflow will not wait for the notification to be sent.
      */
     notify_endpoints?: string[];
+
 }
 
 export interface WorkflowExecutionPayload<T = Record<string, any>> extends WorkflowExecutionBaseParams<T> {
@@ -81,23 +83,96 @@ export interface WorkflowExecutionPayload<T = Record<string, any>> extends Workf
     auth_token: string;
 }
 
+export function getDocumentIds(payload: WorkflowExecutionPayload): string[] {
+    if ("objectIds" in payload) {
+        return payload.objectIds;
+    }
+    return [];
+}
+
 export interface ExecuteWorkflowPayload {
+
+    /**
+     * The task queue to assign the workflow to. Deprecated, queues are choosend server side
+     */
+    //@deprecated
     task_queue?: string;
+
+    /**
+     * Docuument IDs pon which the workflow will be executed, deprecated, replaced params in vars
+     */
+    //@deprecated
     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; //timeout in seconds
 }
 
 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;
 }
 
 interface WorkflowRunEvent {
@@ -138,6 +213,9 @@ export interface WorkflowRun {
 
 export interface WorkflowRunWithDetails extends WorkflowRun {
     history?: WorkflowRunEvent[];
+    memo?: {
+        [key: string]: any;
+    } | null;
 }
 export interface ListWorkflowRunsResponse {
     runs: WorkflowRun[];