@arke-institute/sdk 2.3.6 → 2.3.7

package/dist/generated/index.d.cts

@@ -6,7 +6,7 @@
  *
  * Source: Arke v1 API
  * Version: 1.0.0
- * Generated: 2026-01-07T14:40:52.072Z
+ * Generated: 2026-01-12T16:14:47.577Z
  */
 type paths = {
     "/auth/register": {
@@ -491,6 +491,106 @@ type paths = {
         patch?: never;
         trace?: never;
     };
+    "/users/{id}/collections": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List collections user has access to
+         * @description Returns all collections where the user has a role relationship (owner, editor, viewer, etc.).
+         *
+         *     Queries GraphDB for collections with relationships pointing to this user where peer_type is 'user'.
+         *     Results include the role predicate so clients know what access the user has to each collection.
+         *
+         *     Supports filtering by predicate (role name) and pagination.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    predicate?: string;
+                    limit?: string;
+                    offset?: string;
+                };
+                header?: never;
+                path: {
+                    /** @description Entity ID (ULID) */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description List of collections */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["UserCollectionsResponse"];
+                    };
+                };
+                /** @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"];
+                    };
+                };
+                /** @description Forbidden - Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Forbidden: You do not have permission to perform this action"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Not Found - Resource does not exist */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Entity not found"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description GraphDB service unavailable */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/collections": {
         parameters: {
             query?: never;
@@ -2453,6 +2553,276 @@ type paths = {
         patch?: never;
         trace?: never;
     };
+    "/connect": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Connect two entities
+         * @description Creates a unidirectional relationship from source to target entity.
+         *
+         *     This is a shorthand for adding a relationship with sensible defaults:
+         *     - Default predicate: `connects_to` (customizable)
+         *     - Optional label and description stored in relationship properties
+         *     - Only requires `entity:update` permission on source entity
+         *
+         *     Use this for simple entity linking. For bidirectional relationships or
+         *     advanced options, use the `/relationships` endpoint.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["ConnectRequest"];
+                };
+            };
+            responses: {
+                /** @description Connection created */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ConnectResponse"];
+                    };
+                };
+                /** @description Bad Request - Invalid input */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Validation failed",
+                         *       "details": {
+                         *         "issues": [
+                         *           {
+                         *             "path": [
+                         *               "properties",
+                         *               "label"
+                         *             ],
+                         *             "message": "Required"
+                         *           }
+                         *         ]
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ValidationErrorResponse"];
+                    };
+                };
+                /** @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"];
+                    };
+                };
+                /** @description Forbidden - Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Forbidden: You do not have permission to perform this action"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Not Found - Resource does not exist */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Entity not found"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Conflict - CAS validation failed (entity was modified) */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Conflict: entity was modified",
+                         *       "details": {
+                         *         "expected": "bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy",
+                         *         "actual": "bafyreinewabc123456789defghijklmnopqrstuvwxyz"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["CASErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/connect/disconnect": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Disconnect two entities
+         * @description Removes a unidirectional relationship from source to target entity.
+         *
+         *     This is a shorthand for removing a relationship:
+         *     - Default predicate: `connects_to` (customizable)
+         *     - Only requires `entity:update` permission on source entity
+         *
+         *     For bidirectional removal, use the `/relationships` endpoint.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["DisconnectRequest"];
+                };
+            };
+            responses: {
+                /** @description Connection removed */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["DisconnectResponse"];
+                    };
+                };
+                /** @description Bad Request - Invalid input */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Validation failed",
+                         *       "details": {
+                         *         "issues": [
+                         *           {
+                         *             "path": [
+                         *               "properties",
+                         *               "label"
+                         *             ],
+                         *             "message": "Required"
+                         *           }
+                         *         ]
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ValidationErrorResponse"];
+                    };
+                };
+                /** @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"];
+                    };
+                };
+                /** @description Forbidden - Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Forbidden: You do not have permission to perform this action"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Not Found - Resource does not exist */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Entity not found"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Conflict - CAS validation failed (entity was modified) */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Conflict: entity was modified",
+                         *       "details": {
+                         *         "expected": "bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy",
+                         *         "actual": "bafyreinewabc123456789defghijklmnopqrstuvwxyz"
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["CASErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/files": {
         parameters: {
             query?: never;
@@ -5582,7 +5952,7 @@ type components = {
             /** @example 01J1SHMAE10000000000000000 */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -5627,7 +5997,7 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -5842,6 +6212,48 @@ type components = {
             /** @description List of API keys */
             keys: components["schemas"]["ApiKeyInfo"][];
         };
+        UserCollectionItem: {
+            /**
+             * @description Collection persistent identifier
+             * @example 01JCOLLECTION123456789AB
+             */
+            pi: string;
+            /**
+             * @description Collection label/name
+             * @example My Research Collection
+             */
+            label: string;
+            /**
+             * @description Role predicate indicating user's relationship to collection
+             * @example owner
+             */
+            predicate: string;
+            /**
+             * @description When the collection was created
+             * @example 2026-01-12T00:00:00.000Z
+             */
+            created_at: string;
+        };
+        UserCollectionsResponse: {
+            /**
+             * @description User persistent identifier
+             * @example 01JUSER123456789ABCDEFGH
+             */
+            user_id: string;
+            /** @description Collections the user has access to */
+            collections: components["schemas"]["UserCollectionItem"][];
+            /** @description Pagination metadata */
+            pagination: {
+                /** @description Current offset */
+                offset: number;
+                /** @description Results per page */
+                limit: number;
+                /** @description Number of results returned */
+                count: number;
+                /** @description Whether more results exist */
+                has_more: boolean;
+            };
+        };
         CollectionResponse: components["schemas"]["EntityResponse"] & {
             /** @enum {string} */
             type?: "collection";
@@ -6003,12 +6415,12 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             prev_cid: string;
@@ -6113,12 +6525,12 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             prev_cid: string;
@@ -6170,12 +6582,12 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             prev_cid: string;
@@ -6253,7 +6665,7 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -6424,7 +6836,7 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -6439,7 +6851,7 @@ type components = {
              */
             ver: number;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             prev_cid: string;
@@ -6576,6 +6988,76 @@ type components = {
              */
             expect_target_tip?: string;
         };
+        ConnectResponse: {
+            source: components["schemas"]["EntityResponse"] & unknown;
+        };
+        ConnectRequest: {
+            /**
+             * @description Optional note describing this change
+             * @example Added Chapter 42: The Whiteness of the Whale
+             */
+            note?: string;
+            /**
+             * @description Source entity ID (the entity you're connecting FROM)
+             * @example 01JFKY3XQWM0MJVKM8DK3AEXPY
+             */
+            source_id: string;
+            /**
+             * @description Target entity ID (the entity you're connecting TO)
+             * @example 01JFKY3XQWM0MJVKM8DK3AEXQZ
+             */
+            target_id: string;
+            /**
+             * @description Expected current tip CID of source entity
+             * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
+             */
+            expect_tip: string;
+            /**
+             * @description Relationship predicate. Defaults to "connects_to".
+             * @example connects_to
+             */
+            predicate?: string;
+            /**
+             * @description Optional display label for this connection
+             * @example Related document
+             */
+            label?: string;
+            /**
+             * @description Optional description explaining why this connection exists
+             * @example Links to the supporting research paper
+             */
+            description?: string;
+        };
+        DisconnectResponse: {
+            source: components["schemas"]["EntityResponse"] & unknown;
+        };
+        DisconnectRequest: {
+            /**
+             * @description Optional note describing this change
+             * @example Added Chapter 42: The Whiteness of the Whale
+             */
+            note?: string;
+            /**
+             * @description Source entity ID
+             * @example 01JFKY3XQWM0MJVKM8DK3AEXPY
+             */
+            source_id: string;
+            /**
+             * @description Target entity ID (peer of the connection to remove)
+             * @example 01JFKY3XQWM0MJVKM8DK3AEXQZ
+             */
+            target_id: string;
+            /**
+             * @description Expected current tip CID of source entity
+             * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
+             */
+            expect_tip: string;
+            /**
+             * @description Relationship predicate to remove. Defaults to "connects_to".
+             * @example connects_to
+             */
+            predicate?: string;
+        };
         CreateFileResponse: {
             /**
              * @description Entity ID (ULID format)
@@ -6583,7 +7065,7 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -6820,7 +7302,7 @@ type components = {
              */
             id: string;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -7005,7 +7487,7 @@ type components = {
                  */
                 id: string;
                 /**
-                 * @description IPFS Content Identifier (CID)
+                 * @description Content Identifier (CID) - content-addressed hash
                  * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
                  */
                 cid: string;
@@ -7043,7 +7525,7 @@ type components = {
                  */
                 id: string;
                 /**
-                 * @description IPFS Content Identifier (CID)
+                 * @description Content Identifier (CID) - content-addressed hash
                  * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
                  */
                 cid: string;
@@ -7076,7 +7558,7 @@ type components = {
                  */
                 id: string;
                 /**
-                 * @description IPFS Content Identifier (CID)
+                 * @description Content Identifier (CID) - content-addressed hash
                  * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
                  */
                 cid: string;
@@ -7170,7 +7652,7 @@ type components = {
              */
             ver: number;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -7225,7 +7707,7 @@ type components = {
         };
         ManifestResponse: {
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -7583,6 +8065,7 @@ type components = {
             role: string;
             already_granted: boolean;
             expired?: boolean;
+            missing_actions?: boolean;
             /** Format: date-time */
             current_expires_at?: string;
         };
@@ -7621,7 +8104,7 @@ type components = {
             job_collection: string;
             grants: components["schemas"]["InvokeGrantResult"][];
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             target_cid: string;
@@ -7637,7 +8120,7 @@ type components = {
             retry_after?: number;
             grants: components["schemas"]["InvokeGrantResult"][];
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             target_cid: string;
@@ -7992,7 +8475,7 @@ type components = {
              */
             ver: number;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -8025,7 +8508,7 @@ type components = {
              */
             ver: number;
             /**
-             * @description IPFS Content Identifier (CID)
+             * @description Content Identifier (CID) - content-addressed hash
              * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
              */
             cid: string;
@@ -8054,7 +8537,7 @@ type components = {
                  */
                 ver: number;
                 /**
-                 * @description IPFS Content Identifier (CID)
+                 * @description Content Identifier (CID) - content-addressed hash
                  * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
                  */
                 cid: string;