@arke-institute/sdk 2.3.11 → 2.3.12

package/dist/generated/index.d.cts

@@ -6,7 +6,7 @@
  *
  * Source: Arke v1 API
  * Version: 1.0.0
- * Generated: 2026-01-14T01:00:30.186Z
+ * Generated: 2026-01-14T16:34:47.055Z
  */
 type paths = {
     "/auth/register": {
@@ -2599,6 +2599,104 @@ type paths = {
         patch?: never;
         trace?: never;
     };
+    "/entities/{id}/permissions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get your permissions for an entity
+         * @description Returns the list of actions you can perform on this entity.
+         *
+         *     The response includes:
+         *     - `allowed_actions`: Concrete actions you can perform (no wildcards)
+         *     - `resolution`: How permissions were determined
+         *
+         *     Resolution methods:
+         *     - `collection`: Permissions from your role in the parent collection
+         *     - `self`: You are checking your own user entity (self-ownership)
+         *     - `open_season`: Entity is not in any collection (publicly accessible)
+         *
+         *     Actions are filtered to only those relevant to the entity type:
+         *     - For files: entity:* and file:* actions
+         *     - For collections: entity:* and collection:* actions
+         *     - etc.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Entity ID (ULID) */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Permissions retrieved */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["EntityPermissionsResponse"];
+                    };
+                };
+                /** @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"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/relationships": {
         parameters: {
             query?: never;
@@ -8105,6 +8203,47 @@ type components = {
             patch: components["schemas"]["PatchOperation"][];
         };
         DiffResponse: components["schemas"]["SemanticDiffResponse"] | components["schemas"]["PatchDiffResponse"];
+        /** @description How permissions were resolved */
+        PermissionResolution: {
+            /**
+             * @description How permissions were resolved
+             * @example collection
+             * @enum {string}
+             */
+            method: "collection" | "self" | "open_season";
+            /**
+             * @description Collection ID if permissions come from a collection role
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            collection_id?: string;
+            /**
+             * @description Role name in the collection
+             * @example editor
+             */
+            role?: string;
+        };
+        EntityPermissionsResponse: {
+            /**
+             * @description The entity ID
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            entity_id: string;
+            /**
+             * @description The entity type
+             * @example file
+             */
+            entity_type: string;
+            /**
+             * @description Actions the user can perform on this entity
+             * @example [
+             *       "entity:view",
+             *       "entity:update",
+             *       "file:download"
+             *     ]
+             */
+            allowed_actions: string[];
+            resolution: components["schemas"]["PermissionResolution"];
+        };
         AddRelationshipResponse: {
             source: components["schemas"]["EntityResponse"] & unknown;
             target?: components["schemas"]["EntityResponse"] & unknown;
@@ -9780,7 +9919,12 @@ type components = {
         };
     };
     responses: never;
-    parameters: never;
+    parameters: {
+        /** @description Target network. Use `test` for isolated test data with II-prefixed IDs. */
+        "X-Arke-Network": "main" | "test";
+        /** @description User entity ID for service accounts acting on behalf of a user. Only valid with `role: service` authentication. */
+        "X-On-Behalf-Of": string;
+    };
     requestBodies: never;
     headers: never;
     pathItems: never;

package/dist/generated/index.d.ts

@@ -6,7 +6,7 @@
  *
  * Source: Arke v1 API
  * Version: 1.0.0
- * Generated: 2026-01-14T01:00:30.186Z
+ * Generated: 2026-01-14T16:34:47.055Z
  */
 type paths = {
     "/auth/register": {
@@ -2599,6 +2599,104 @@ type paths = {
         patch?: never;
         trace?: never;
     };
+    "/entities/{id}/permissions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get your permissions for an entity
+         * @description Returns the list of actions you can perform on this entity.
+         *
+         *     The response includes:
+         *     - `allowed_actions`: Concrete actions you can perform (no wildcards)
+         *     - `resolution`: How permissions were determined
+         *
+         *     Resolution methods:
+         *     - `collection`: Permissions from your role in the parent collection
+         *     - `self`: You are checking your own user entity (self-ownership)
+         *     - `open_season`: Entity is not in any collection (publicly accessible)
+         *
+         *     Actions are filtered to only those relevant to the entity type:
+         *     - For files: entity:* and file:* actions
+         *     - For collections: entity:* and collection:* actions
+         *     - etc.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Entity ID (ULID) */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Permissions retrieved */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["EntityPermissionsResponse"];
+                    };
+                };
+                /** @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"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/relationships": {
         parameters: {
             query?: never;
@@ -8105,6 +8203,47 @@ type components = {
             patch: components["schemas"]["PatchOperation"][];
         };
         DiffResponse: components["schemas"]["SemanticDiffResponse"] | components["schemas"]["PatchDiffResponse"];
+        /** @description How permissions were resolved */
+        PermissionResolution: {
+            /**
+             * @description How permissions were resolved
+             * @example collection
+             * @enum {string}
+             */
+            method: "collection" | "self" | "open_season";
+            /**
+             * @description Collection ID if permissions come from a collection role
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            collection_id?: string;
+            /**
+             * @description Role name in the collection
+             * @example editor
+             */
+            role?: string;
+        };
+        EntityPermissionsResponse: {
+            /**
+             * @description The entity ID
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            entity_id: string;
+            /**
+             * @description The entity type
+             * @example file
+             */
+            entity_type: string;
+            /**
+             * @description Actions the user can perform on this entity
+             * @example [
+             *       "entity:view",
+             *       "entity:update",
+             *       "file:download"
+             *     ]
+             */
+            allowed_actions: string[];
+            resolution: components["schemas"]["PermissionResolution"];
+        };
         AddRelationshipResponse: {
             source: components["schemas"]["EntityResponse"] & unknown;
             target?: components["schemas"]["EntityResponse"] & unknown;
@@ -9780,7 +9919,12 @@ type components = {
         };
     };
     responses: never;
-    parameters: never;
+    parameters: {
+        /** @description Target network. Use `test` for isolated test data with II-prefixed IDs. */
+        "X-Arke-Network": "main" | "test";
+        /** @description User entity ID for service accounts acting on behalf of a user. Only valid with `role: service` authentication. */
+        "X-On-Behalf-Of": string;
+    };
     requestBodies: never;
     headers: never;
     pathItems: never;

package/openapi/spec.json

@@ -72,6 +72,37 @@
         "scheme": "bearer",
         "bearerFormat": "JWT",
         "description": "Supabase JWT token"
+      },
+      "apiKeyAuth": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "Authorization",
+        "description": "API Key authentication. Format: `ApiKey ak_xxx` (agent) or `ApiKey uk_xxx` (user)"
+      }
+    },
+    "parameters": {
+      "X-Arke-Network": {
+        "name": "X-Arke-Network",
+        "in": "header",
+        "required": false,
+        "schema": {
+          "type": "string",
+          "enum": [
+            "main",
+            "test"
+          ],
+          "default": "main"
+        },
+        "description": "Target network. Use `test` for isolated test data with II-prefixed IDs."
+      },
+      "X-On-Behalf-Of": {
+        "name": "X-On-Behalf-Of",
+        "in": "header",
+        "required": false,
+        "schema": {
+          "type": "string"
+        },
+        "description": "User entity ID for service accounts acting on behalf of a user. Only valid with `role: service` authentication."
       }
     },
     "schemas": {
@@ -2573,6 +2604,73 @@
           }
         ]
       },
+      "PermissionResolution": {
+        "type": "object",
+        "properties": {
+          "method": {
+            "type": "string",
+            "enum": [
+              "collection",
+              "self",
+              "open_season"
+            ],
+            "description": "How permissions were resolved",
+            "example": "collection"
+          },
+          "collection_id": {
+            "type": "string",
+            "pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
+            "description": "Collection ID if permissions come from a collection role",
+            "example": "01KDETYWYWM0MJVKM8DK3AEXPY"
+          },
+          "role": {
+            "type": "string",
+            "description": "Role name in the collection",
+            "example": "editor"
+          }
+        },
+        "required": [
+          "method"
+        ],
+        "description": "How permissions were resolved"
+      },
+      "EntityPermissionsResponse": {
+        "type": "object",
+        "properties": {
+          "entity_id": {
+            "type": "string",
+            "pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
+            "description": "The entity ID",
+            "example": "01KDETYWYWM0MJVKM8DK3AEXPY"
+          },
+          "entity_type": {
+            "type": "string",
+            "description": "The entity type",
+            "example": "file"
+          },
+          "allowed_actions": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Actions the user can perform on this entity",
+            "example": [
+              "entity:view",
+              "entity:update",
+              "file:download"
+            ]
+          },
+          "resolution": {
+            "$ref": "#/components/schemas/PermissionResolution"
+          }
+        },
+        "required": [
+          "entity_id",
+          "entity_type",
+          "allowed_actions",
+          "resolution"
+        ]
+      },
       "AddRelationshipResponse": {
         "type": "object",
         "properties": {
@@ -6129,8 +6227,7 @@
           "manifest_preview"
         ]
       }
-    },
-    "parameters": {}
+    }
   },
   "x-arke-version": "1.0.0",
   "paths": {
@@ -6212,6 +6309,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "responses": {
@@ -6319,6 +6419,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -6452,6 +6555,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -6502,6 +6608,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "responses": {
@@ -6545,6 +6654,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -6718,6 +6830,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -6796,6 +6911,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -6946,6 +7064,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -7078,6 +7199,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -7193,6 +7317,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -7318,6 +7445,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -7488,6 +7618,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -7603,6 +7736,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -7732,6 +7868,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -7967,6 +8106,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -8134,6 +8276,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -8264,6 +8409,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -8396,6 +8544,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -8817,6 +8968,92 @@
         }
       }
     },
+    "/entities/{id}/permissions": {
+      "get": {
+        "tags": [
+          "Entities",
+          "Permissions"
+        ],
+        "summary": "Get your permissions for an entity",
+        "description": "Returns the list of actions you can perform on this entity.\n\nThe response includes:\n- `allowed_actions`: Concrete actions you can perform (no wildcards)\n- `resolution`: How permissions were determined\n\nResolution methods:\n- `collection`: Permissions from your role in the parent collection\n- `self`: You are checking your own user entity (self-ownership)\n- `open_season`: Entity is not in any collection (publicly accessible)\n\nActions are filtered to only those relevant to the entity type:\n- For files: entity:* and file:* actions\n- For collections: entity:* and collection:* actions\n- etc.",
+        "x-arke-action": "entity:view",
+        "x-arke-auth": "required",
+        "x-arke-tier": "standard",
+        "security": [
+          {
+            "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "schema": {
+              "type": "string",
+              "pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
+              "description": "Entity ID (ULID format)",
+              "example": "01KDETYWYWM0MJVKM8DK3AEXPY"
+            },
+            "required": true,
+            "description": "Entity ID (ULID)",
+            "name": "id",
+            "in": "path"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Permissions retrieved",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EntityPermissionsResponse"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized - Missing or invalid authentication",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": "Unauthorized: Missing or invalid authentication token"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden - Insufficient permissions",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": "Forbidden: You do not have permission to perform this action"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found - Resource does not exist",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "example": {
+                  "error": "Entity not found"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/relationships": {
       "post": {
         "tags": [
@@ -8830,6 +9067,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -8946,6 +9186,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -9064,6 +9307,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -9182,6 +9428,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -9300,6 +9549,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -9467,6 +9719,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -9599,6 +9854,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -9808,6 +10066,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -9940,6 +10201,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -10090,6 +10354,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -10222,6 +10489,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -10354,6 +10624,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -10498,6 +10771,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -10630,6 +10906,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -10762,6 +11041,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -11107,6 +11389,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "requestBody": {
@@ -11270,6 +11555,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -11402,6 +11690,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -11527,6 +11818,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -11640,6 +11934,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [
@@ -11722,6 +12019,9 @@
         "security": [
           {
             "bearerAuth": []
+          },
+          {
+            "apiKeyAuth": []
           }
         ],
         "parameters": [

package/openapi/version.json

@@ -1,7 +1,7 @@
 {
   "specVersion": "1.0.0",
   "apiVersion": "1.0.0",
-  "fetchedAt": "2026-01-14T01:00:29.332Z",
+  "fetchedAt": "2026-01-14T16:34:46.221Z",
   "sourceUrl": "https://arke-v1.arke.institute/openapi.json",
   "openApiVersion": "3.1.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arke-institute/sdk",
-  "version": "2.3.11",
+  "version": "2.3.12",
   "description": "TypeScript SDK for the Arke API - auto-generated from OpenAPI spec",
   "type": "module",
   "main": "dist/index.cjs",