@vertesia/common 1.4.0 → 1.5.0-dev.20260713.113008Z

package/src/store/store.ts

@@ -10,7 +10,9 @@ export enum ContentObjectApiHeaders {
     PROCESSING_PRIORITY = 'x-processing-priority',
     CREATE_REVISION = 'x-create-revision',
     REVISION_LABEL = 'x-revision-label',
-    /** When set to 'true', prevents this update from triggering workflow rules */
+    /**
+     * @deprecated Events are now always emitted. This suppresses the Temporal-backed delivery targets (workflow, agent, and process) — webhook deliveries still fire.
+     */
     SUPPRESS_WORKFLOWS = 'x-suppress-workflows',
 }
 
@@ -35,6 +37,9 @@ export interface UpdateContentObjectHeaders {
     'x-create-revision'?: boolean;
     'x-revision-label'?: string;
     'x-processing-priority'?: ContentObjectProcessingPriority;
+    /**
+     * @deprecated Events are now always emitted. This suppresses the Temporal-backed delivery targets (workflow, agent, and process) — webhook deliveries still fire.
+     */
     'x-suppress-workflows'?: boolean;
 }
 
@@ -69,6 +74,238 @@ export interface Embedding {
     etag?: string; // the etag of the text used for the embedding
 }
 
+/**
+ * Optional object context to include in content object export rows.
+ */
+export interface ExportContentObjectsIncludeOptions {
+    /**
+     * Include stored embeddings. Disabled by default for generic object exports.
+     */
+    embeddings?: boolean;
+    /**
+     * Include content source metadata. Enabled by default.
+     */
+    content?: boolean;
+    /**
+     * Include object lifecycle status. Enabled by default.
+     */
+    status?: boolean;
+    /**
+     * Include object properties. Enabled by default.
+     */
+    properties?: boolean;
+    /**
+     * Include technical object metadata. Disabled by default because metadata may be large.
+     */
+    metadata?: boolean;
+    /**
+     * Include object revision details. Enabled by default.
+     */
+    revision?: boolean;
+}
+
+/**
+ * Bounded filters supported by the bulk content object export API.
+ */
+export interface ExportContentObjectsFilter {
+    types?: string[];
+    created_from?: string;
+    created_to?: string;
+    updated_from?: string;
+    updated_to?: string;
+}
+
+/**
+ * Exported object identity and context for a single content object row.
+ */
+export interface ExportedContentObjectRecord {
+    id: string;
+    name: string;
+    location: string;
+    external_id?: string;
+    type?: {
+        ref_type?: 'stored' | 'incode' | 'untyped';
+        id?: string;
+        code?: string;
+        name?: string;
+    };
+    status?: ContentObjectStatus;
+    content?: {
+        source?: string;
+        type?: string;
+        name?: string;
+        etag?: string;
+    };
+    created_at: string;
+    updated_at: string;
+    revision?: RevisionInfo;
+    properties?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    embeddings?: Partial<Record<SupportedEmbeddingTypes, Embedding>>;
+}
+
+export interface StartContentObjectExportRequest {
+    /**
+     * Embedding types to export when include.embeddings is true. Defaults to all supported embedding types.
+     */
+    embedding_types?: SupportedEmbeddingTypes[];
+    /**
+     * Explicit export filters. This intentionally does not accept the search API's full Mongo/search DSL.
+     */
+    filter?: ExportContentObjectsFilter;
+    /**
+     * Include all revisions. Defaults to false, exporting only head revisions.
+     */
+    all_revisions?: boolean;
+    /**
+     * Optional object context selectors.
+     */
+    include?: ExportContentObjectsIncludeOptions;
+    /**
+     * Compress the export with gzip. Defaults to true.
+     */
+    compression?: boolean;
+}
+
+export interface StartContentObjectExportResponse {
+    workflow_id: string;
+    run_id: string;
+    export_id: string;
+}
+
+export interface ZenoBulkContentObjectExportRequest extends Omit<StartContentObjectExportRequest, 'compression'> {
+    tenant_id: string;
+    project_id: string;
+    export_id: string;
+    output_path: string;
+    filename: string;
+    manifest_path: string;
+    manifest_filename: string;
+    compression: boolean;
+}
+
+export interface ZenoBulkContentObjectExportShardRange {
+    min_id?: string;
+    max_id?: string;
+}
+
+export interface ZenoBulkContentObjectExportPlanRequest extends ZenoBulkContentObjectExportRequest {
+    target_shard_records?: number;
+    max_shards?: number;
+}
+
+export interface ZenoBulkContentObjectExportPlanResponse {
+    shards: ZenoBulkContentObjectExportShardRange[];
+}
+
+export interface ZenoBulkContentObjectExportShardRequest extends ZenoBulkContentObjectExportRequest {
+    shard_index: number;
+    shard_count: number;
+    shard: ZenoBulkContentObjectExportShardRange;
+}
+
+export interface ZenoBulkContentObjectExportSplitShardRequest extends ZenoBulkContentObjectExportRequest {
+    shard: ZenoBulkContentObjectExportShardRange;
+    min_split_records?: number;
+}
+
+export interface ZenoBulkContentObjectExportSplitShardResponse {
+    shards: ZenoBulkContentObjectExportShardRange[];
+    splittable: boolean;
+    records: number;
+}
+
+export interface ZenoBulkContentObjectExportShardResult {
+    status: 'completed';
+    shard_index: number;
+    shard_count: number;
+    path: string;
+    filename: string;
+    content_type: string;
+    records: number;
+    bytes: number;
+    started_at: string;
+    completed_at: string;
+    duration_ms: number;
+}
+
+export interface ZenoBulkContentObjectExportComposeRequest extends ZenoBulkContentObjectExportRequest {
+    parts: string[];
+    records?: number;
+    /**
+     * Export workflow start timestamp. Used to report end-to-end duration after final compose.
+     */
+    started_at?: string;
+}
+
+export interface ContentObjectExportResult {
+    status: 'completed';
+    path: string;
+    filename: string;
+    content_type: string;
+    manifest_path?: string;
+    manifest_filename?: string;
+    manifest_content_type?: string;
+    manifest_bytes?: number;
+    records: number;
+    bytes: number;
+    started_at: string;
+    completed_at: string;
+    duration_ms: number;
+}
+
+export interface ContentObjectExportProgress {
+    status: 'queued' | 'planning' | 'exporting' | 'composing' | 'completed' | 'failed';
+    records: number;
+    bytes: number;
+    path?: string;
+    filename?: string;
+    completed_shards?: number;
+    total_shards?: number;
+    started_at?: string;
+    completed_at?: string;
+    error?: string;
+}
+
+export interface ContentObjectExportStatusResponse {
+    workflow_id: string;
+    run_id: string;
+    status: 'queued' | 'running' | 'completed' | 'failed' | 'canceled' | 'terminated' | 'timed_out' | 'unknown';
+    done: boolean;
+    progress?: ContentObjectExportProgress;
+    result?: ContentObjectExportResult;
+    error?: string;
+}
+
+export interface ContentObjectExportArtifact {
+    export_id: string;
+    path: string;
+    filename: string;
+    content_type: string;
+    bytes: number;
+    created_at?: string;
+    files?: ContentObjectExportArtifactFile[];
+}
+
+export interface ContentObjectExportArtifactFile {
+    role: 'data' | 'manifest';
+    path: string;
+    filename: string;
+    content_type: string;
+    bytes: number;
+}
+
+export interface ListContentObjectExportsResponse {
+    items: ContentObjectExportArtifact[];
+    limit: number;
+}
+
+export interface DeleteContentObjectExportResponse {
+    success: boolean;
+    export_id: string;
+    path: string;
+}
+
 /**
  * Metadata about a single inherited property.
  */
@@ -116,12 +353,12 @@ export interface ContentObjectItemApiResponse extends BaseObject {
     type?: ContentObjectApiTypeRef;
     content?: ContentSource;
     external_id?: string;
-    properties: Record<string, unknown>;
+    properties: JSONObject;
     metadata?: Record<string, unknown>;
     tokens?: {
-        count: number;
-        encoding: string;
-        etag: string;
+        count?: number;
+        encoding?: string;
+        etag?: string;
     };
     revision: ContentObjectApiRevision;
     is_deleted?: boolean;
@@ -356,13 +593,19 @@ export interface ContentObjectItem<T = JSONObject> extends BaseObject {
     properties: T; // a JSON object that describes the object
 
     /** Technical metadata of the object */
-    metadata?: VideoMetadata | AudioMetadata | ImageMetadata | DocumentMetadata | ContentMetadata;
+    metadata?:
+        | VideoMetadata
+        | AudioMetadata
+        | ImageMetadata
+        | DocumentMetadata
+        | ContentMetadata
+        | Record<string, unknown>;
 
     /** 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
+        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
     };
 
     /**
@@ -562,6 +805,16 @@ export interface WorkflowRule extends WorkflowRuleItem {
      * Optional task queue name to use when starting workflows for this rule
      */
     task_queue?: string;
+
+    /**
+     * Event subscription migration status for legacy workflow-rule cutover.
+     */
+    event_subscription_migration_status?: 'migrated' | 'unsupported_match' | 'failed';
+
+    /**
+     * Migration failure or unsupported-match reason, when applicable.
+     */
+    event_subscription_migration_error?: string;
 }
 
 export interface CreateWorkflowRulePayload extends UploadWorkflowRulePayload {
@@ -597,7 +850,7 @@ export interface GetRenditionResponse {
 }
 
 export interface ObjectSearchResponse {
-    results: ContentObjectItem[];
+    results: ContentObjectItemApiResponse[];
     facets: ComputedFacetResponse;
     aggregations?: Record<string, unknown>;
 }

package/src/store/workflow.ts

@@ -59,7 +59,8 @@ export interface WorkflowExecutionBaseParams<T = Record<string, unknown>> {
      * 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 the case of workflows started by event subscriptions, the user input vars
+     * are initialized from the subscription target configuration.
      *
      * In case of dsl workflows the workflow execution payload vars will be applied over the default vars values stored in the DSL vars field.
      */
@@ -138,11 +139,12 @@ export interface WebHookSpec {
     result_path?: string;
 }
 
-export interface WorkflowExecutionPayload<T = Record<string, unknown>> extends WorkflowExecutionBaseParams<T> {
+export interface WorkflowExecutionPayload<T = Record<string, unknown>, EventName extends string = string>
+    extends WorkflowExecutionBaseParams<T> {
     /**
      * The event which started the workflow who created the activity.
      */
-    event: ContentEventName;
+    event: EventName;
 
     /*
      * The Workflow Rule ID if any. If the workflow was started by a rule this field will contain the rule ID
@@ -242,7 +244,7 @@ export interface ListWorkflowRunsPayload {
     event_name?: string;
 
     /**
-     * The workflow rule ID that triggered the workflow.
+     * Legacy workflow rule ID filter, when applicable.
      */
     rule_id?: string;
 
@@ -1356,7 +1358,7 @@ export interface AgentIntakeWorkflowParams {
     http_timeout?: HttpTimeoutOptions;
 
     /**
-     * LLM execution config. Prefer this for workflow-rule-driven execution settings.
+     * LLM execution config. Prefer this for event-subscription-driven execution settings.
      */
     config?: InteractionExecutionConfiguration;
 

package/src/sts-token-types.ts

@@ -83,6 +83,7 @@ export interface ServiceAccountTokenRequest extends BaseTokenRequest {
     project_id: string; // Will verify it belongs to account
     roles?: SystemRoles[]; // Optional - roles for the service account token
     name?: string;
+    email?: string;
 }
 
 /**

package/src/user.ts

@@ -7,7 +7,7 @@ export interface UserWithAccounts extends User {
 
 export interface User {
     id: string;
-    externalId: string;
+    externalId?: string;
     email: string;
     name: string;
     username?: string;
@@ -24,6 +24,8 @@ export interface User {
     clearance?: number;
     /** Compartments the user belongs to — restricts access to documents in matching compartments */
     compartments?: string[];
+    /** Free-form user metadata - restricted to internal use */
+    annotations?: string[];
 }
 
 export interface UpdateUserPayload {
@@ -47,6 +49,20 @@ export interface UserRef {
 
 export const UserRefPopulate = 'id name email picture';
 
+/**
+ * Annotation marker (stored in {@link User.annotations}) that grants a user access to
+ * non-production environments (`preview`, `preprod`). See
+ * `docs/restrict-access-to-non-production-envs.md`.
+ */
+export const EARLY_ACCESS_ANNOTATION = 'early-access';
+
+/**
+ * Business error code returned by the STS (token server) when a user is denied access to a
+ * restricted (`preview`/`preprod`) environment because they lack the {@link EARLY_ACCESS_ANNOTATION}
+ * annotation. The UI keys its dedicated rejection screen off this code.
+ */
+export const RESTRICTED_ENVIRONMENT_ERROR_CODE = 'restricted_environment';
+
 export enum Datacenters {
     aws = 'aws',
     gcp = 'gcp',
@@ -72,6 +88,34 @@ export interface AccountBilling {
     stripe_customer_id?: string;
 }
 
+/**
+ * Quota/rate-limit tier assigned to an account. Code-defined tiers live in `@dglabs/quota`
+ * (`QUOTA_TIERS`); these names must match its keys.
+ * - `standard` — protective baseline limits (the default for most accounts).
+ * - `enterprise` — high limits for contracted customers / internal / partners.
+ *
+ * An account with no explicit `quota_tier` derives its tier from its `account_type`.
+ */
+export enum QuotaTier {
+    standard = 'standard',
+    enterprise = 'enterprise',
+}
+
+/**
+ * Default tier for an account that has no explicit `quota_tier`, derived from its `account_type`:
+ * contracted customers and internal Vertesia accounts get `enterprise`; everyone else (partner,
+ * free, prospect, unknown) gets the protective `standard` baseline.
+ */
+export function quotaTierForAccountType(accountType: AccountType | undefined | null): QuotaTier {
+    switch (accountType) {
+        case AccountType.customer:
+        case AccountType.vertesia:
+            return QuotaTier.enterprise;
+        default:
+            return QuotaTier.standard;
+    }
+}
+
 export interface Account {
     id: string;
     name: string;
@@ -89,6 +133,9 @@ export interface Account {
 
     billing: AccountBilling;
 
+    /** Quota/rate-limit tier. Unset → the deployment default tier (env `QUOTA_BASE_TIER`). */
+    quota_tier?: QuotaTier;
+
     created_by: string;
     updated_by: string;
     created_at: string;
@@ -99,6 +146,7 @@ export interface UpdateAccountPayload {
     name?: string;
     email_domains?: string[];
     billing?: AccountBilling;
+    quota_tier?: QuotaTier;
 }
 
 export interface AccountRef {