@arke-institute/sdk 3.6.11 → 3.6.14

package/dist/generated/index.d.cts

@@ -6,7 +6,7 @@
  *
  * Source: Arke v1 API
  * Version: 1.0.0
- * Generated: 2026-02-16T23:01:40.798Z
+ * Generated: 2026-02-20T03:10:32.965Z
  */
 type paths = {
     "/ops-reference": {
@@ -1037,6 +1037,88 @@ type paths = {
         patch?: never;
         trace?: never;
     };
+    "/collections/catalog": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List all collections for catalog/sitemap
+         * @description Returns a paginated list of all collection IDs and their last update times.
+         *
+         *     This endpoint is designed for sitemap generation and discovery services. It returns minimal data (just IDs and timestamps) for efficiency.
+         *
+         *     **Lazy Population:** The catalog is populated as collections are created or updated. Newly created collections may take a moment to appear.
+         *
+         *     **No Authentication Required:** This endpoint is public to allow crawlers and discovery services to access it.
+         *
+         *     ---
+         *     **Permission:** `catalog:list`
+         *     **Auth:** none
+         */
+        get: {
+            parameters: {
+                query?: {
+                    limit?: number;
+                    offset?: number | null;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Paginated list of collections */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                /**
+                                 * @description Collection ID (PI)
+                                 * @example 01JEXAMPLE...
+                                 */
+                                id: string;
+                                /**
+                                 * @description ISO timestamp of last update
+                                 * @example 2026-02-17T12:00:00Z
+                                 */
+                                updated_at: string;
+                            }[];
+                            pagination: {
+                                /** @description Total number of collections in catalog */
+                                total: number;
+                                /** @description Requested limit */
+                                limit: number;
+                                /** @description Current offset */
+                                offset: number;
+                                /** @description Whether more results are available */
+                                has_more: boolean;
+                            };
+                        };
+                    };
+                };
+                /** @description Collections catalog service unavailable */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/collections/{id}": {
         parameters: {
             query?: never;
@@ -2194,26 +2276,35 @@ type paths = {
             cookie?: never;
         };
         /**
-         * Search entities by keyword
-         * @description Fast (~5ms) keyword search within entity labels in this collection.
+         * Search entities by keyword or similarity
+         * @description Search within a collection's entities using keyword matching or semantic similarity.
+         *
+         *     **Keyword Search (q parameter):**
+         *     - Fast (~5ms) using per-collection SQLite index
+         *     - Case-insensitive substring match on entity labels
+         *
+         *     **Semantic Similarity Search (similar_to parameter):**
+         *     - Finds entities semantically similar to the given entity ID
+         *     - Uses Pinecone vector similarity
+         *     - Returns results with similarity scores
          *
-         *     Uses a per-collection SQLite index for instant substring matching. Complements semantic search for quick keyword lookups.
+         *     One of `q` or `similar_to` must be provided.
          *
          *     **Query Parameters:**
-         *     - `q`: Search query (required, case-insensitive substring match)
+         *     - `q`: Search query (case-insensitive substring match)
+         *     - `similar_to`: Entity ID to find similar items for
          *     - `type`: Filter by entity type
          *     - `limit`: Maximum results (default: 100, max: 1000)
          *
-         *     **Note:** This is a simple substring match, not semantic search. Use /query for AI-powered semantic search.
-         *
          *     ---
          *     **Permission:** `collection:view`
          *     **Auth:** optional
          */
         get: {
             parameters: {
-                query: {
-                    q: string;
+                query?: {
+                    q?: string;
+                    similar_to?: string;
                     type?: string;
                     limit?: number;
                 };
@@ -3930,7 +4021,7 @@ type paths = {
          *     - Creates a new entity version on each upload
          *
          *     **Storage:**
-         *     Content is stored at `{entity_id}/{key}` in R2, enabling multiple versions per entity.
+         *     Content is stored at `{entity_id}/{cid}` in R2, enabling multiple versions per entity without overwriting.
          *
          *     ---
          *     **Permission:** `entity:update`
@@ -4626,6 +4717,76 @@ type paths = {
         patch?: never;
         trace?: never;
     };
+    "/updates/queue/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get update queue status for entity
+         * @description Returns the status of the additive update queue for a specific entity.
+         *
+         *     **Use Cases:**
+         *     - Diagnose why additive updates may not have been applied
+         *     - Check for pending, processing, or failed updates
+         *     - Monitor queue processing progress
+         *
+         *     **Response includes:**
+         *     - Counts by status (pending, processing, failed)
+         *     - Detailed items with actor, relationships count, error messages, attempts
+         *
+         *
+         *     ---
+         *     **Permission:** `entity:view`
+         *     **Auth:** required
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Entity ID (ULID) */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Queue status retrieved */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["QueueStatusResponse"];
+                    };
+                };
+                /** @description Unauthorized - Missing or invalid authentication */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Unauthorized: Missing or invalid authentication token"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/updates/additive": {
         parameters: {
             query?: never;
@@ -9291,7 +9452,7 @@ type components = {
              * @description Whether to merge with default roles (true) or use only provided roles (false). Public role with *:view is always ensured.
              * @default true
              */
-            use_roles_default: boolean | null;
+            use_roles_default?: boolean | null;
             /**
              * @description Role definitions. When use_roles_default is true (default), these merge with defaults. When false, these replace defaults entirely.
              * @example {
@@ -9698,13 +9859,22 @@ type components = {
             /** @description Number of entities returned */
             count: number;
         };
+        CollectionEntitySearchResult: components["schemas"]["EntityIndexEntry"] & {
+            /**
+             * @description Similarity score (only present for semantic search via similar_to)
+             * @example 0.87
+             */
+            score?: number;
+        };
         CollectionEntitySearchResponse: {
             /** @description Collection ID */
             collection_id: string;
-            /** @description Original search query */
-            query: string;
+            /** @description Original search query (for keyword search) */
+            query?: string;
+            /** @description Source entity ID (for similarity search) */
+            similar_to?: string;
             /** @description Matching entities */
-            entities: components["schemas"]["EntityIndexEntry"][];
+            entities: components["schemas"]["CollectionEntitySearchResult"][];
             /** @description Number of entities returned */
             count: number;
         };
@@ -9830,7 +10000,7 @@ type components = {
              * @description Wait for collection index update before returning. Use when checking for duplicates immediately after creation. Adds ~1-5ms latency per collection.
              * @default false
              */
-            sync_index: boolean | null;
+            sync_index?: boolean | null;
         };
         BatchCreateSuccess: {
             /** @enum {boolean} */
@@ -10012,7 +10182,7 @@ type components = {
              * @description Wait for collection index update before returning. Use when checking index immediately after update.
              * @default false
              */
-            sync_index: boolean | null;
+            sync_index?: boolean | null;
         };
         EntityDeletedResponse: {
             /**
@@ -10061,7 +10231,7 @@ type components = {
              * @description Wait for collection index removal before returning. Use when checking index immediately after deletion.
              * @default false
              */
-            sync_index: boolean | null;
+            sync_index?: boolean | null;
         };
         CascadeDeletedEntity: {
             /**
@@ -10604,6 +10774,85 @@ type components = {
              */
             expect_tip: string;
         };
+        QueueItem: {
+            /**
+             * @description Queue item ID
+             * @example 1
+             */
+            id: number;
+            /**
+             * @description Actor who queued the update
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            actor_id: string;
+            /**
+             * @description Current status of the queue item
+             * @example pending
+             * @enum {string}
+             */
+            status: "pending" | "processing" | "failed" | "completed";
+            /**
+             * @description Number of relationships in this update
+             * @example 5
+             */
+            relationships_count: number;
+            /**
+             * @description Summary of relationships (predicate + peer)
+             * @example [
+             *       {
+             *         "predicate": "sent_to",
+             *         "peer": "01KDETYWYWM0MJVKM8DK3AEXPY"
+             *       }
+             *     ]
+             */
+            relationships_summary: {
+                predicate: string;
+                peer: string;
+            }[];
+            /**
+             * @description Top-level property keys being updated
+             * @example [
+             *       "extracted",
+             *       "metadata"
+             *     ]
+             */
+            properties_keys: string[];
+            /**
+             * @description Optional note for the update
+             * @example Extracted by kg-dedupe-resolver
+             */
+            note: string | null;
+            /**
+             * @description Error message if failed
+             * @example CAS conflict after 20 attempts
+             */
+            error: string | null;
+            /**
+             * @description Number of processing attempts
+             * @example 3
+             */
+            attempts: number;
+            /**
+             * @description ISO timestamp when queued
+             * @example 2024-01-15T10:30:00.000Z
+             */
+            queued_at: string;
+        };
+        QueueStatusResponse: {
+            /**
+             * @description Entity ID (ULID format)
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            entity_id: string;
+            /** @description Count of items by status */
+            counts: {
+                pending: number;
+                processing: number;
+                failed: number;
+            };
+            /** @description Detailed queue items (most recent first, max 100) */
+            items: components["schemas"]["QueueItem"][];
+        };
         QueuedUpdateInfo: {
             /**
              * @description Entity ID (ULID format)
@@ -11619,6 +11868,20 @@ type components = {
                             /** @description Target step name if condition matches */
                             target: string;
                         }[];
+                    } | {
+                        /** @description Target step name for bounded recursion */
+                        recurse: string;
+                        /**
+                         * @description Maximum recursion depth (default: 10)
+                         * @example 10
+                         */
+                        max_depth?: number;
+                        /** @description Conditional routing rules */
+                        route?: {
+                            where: components["schemas"]["WhereCondition"];
+                            /** @description Target step name if condition matches */
+                            target: string;
+                        }[];
                     };
                 };
             };
@@ -11807,6 +12070,20 @@ type components = {
                             /** @description Target step name if condition matches */
                             target: string;
                         }[];
+                    } | {
+                        /** @description Target step name for bounded recursion */
+                        recurse: string;
+                        /**
+                         * @description Maximum recursion depth (default: 10)
+                         * @example 10
+                         */
+                        max_depth?: number;
+                        /** @description Conditional routing rules */
+                        route?: {
+                            where: components["schemas"]["WhereCondition"];
+                            /** @description Target step name if condition matches */
+                            target: string;
+                        }[];
                     };
                 };
             };