@arke-institute/sdk 3.6.4 → 3.6.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,7 +6,7 @@
6
6
  *
7
7
  * Source: Arke v1 API
8
8
  * Version: 1.0.0
9
- * Generated: 2026-02-11T22:34:10.645Z
9
+ * Generated: 2026-02-13T15:33:39.556Z
10
10
  */
11
11
  type paths = {
12
12
  "/ops-reference": {
@@ -931,6 +931,25 @@ type paths = {
931
931
  * Create a new collection
932
932
  * @description Creates a collection with the authenticated user as owner.
933
933
  *
934
+ * **Default Roles:**
935
+ *
936
+ * By default (`use_roles_default: true`), collections include these standard roles:
937
+ * - `owner`: Full control including collection management
938
+ * - `editor`: Can modify entities but not collection settings
939
+ * - `viewer`: Read-only access
940
+ * - `public`: Public read access (`*:view`)
941
+ *
942
+ * **Customizing Roles:**
943
+ *
944
+ * Pass custom `roles` to override specific defaults while keeping others. For example, to make entities publicly invokable (for agents):
945
+ * ```json
946
+ * { "roles": { "public": ["*:view", "*:invoke"] } }
947
+ * ```
948
+ *
949
+ * Set `use_roles_default: false` to define all roles from scratch.
950
+ *
951
+ * **Platform Requirement:** The `public` role with `*:view` is always automatically ensured, guaranteeing all collections are publicly readable.
952
+ *
934
953
  * ---
935
954
  * **Permission:** `collection:create`
936
955
  * **Auth:** required
@@ -1981,13 +2000,13 @@ type paths = {
1981
2000
  };
1982
2001
  /**
1983
2002
  * List entities in a collection
1984
- * @description Returns entities belonging to this collection from the graph database.
2003
+ * @description Returns entities belonging to this collection.
1985
2004
  *
1986
2005
  * Supports pagination and optional type filtering. Results are ordered by creation date (newest first).
1987
2006
  *
1988
2007
  * **Expansion Modes:**
1989
2008
  *
1990
- * By default, returns lightweight summaries from GraphDB (pi, type, label, timestamps).
2009
+ * By default, returns lightweight summaries (pi, type, label, timestamps).
1991
2010
  *
1992
2011
  * Use the `expand` parameter to hydrate entity data from storage:
1993
2012
  *
@@ -2055,7 +2074,7 @@ type paths = {
2055
2074
  "application/json": components["schemas"]["ErrorResponse"];
2056
2075
  };
2057
2076
  };
2058
- /** @description GraphDB service unavailable */
2077
+ /** @description Collection index service unavailable */
2059
2078
  503: {
2060
2079
  headers: {
2061
2080
  [name: string]: unknown;
@@ -9068,26 +9087,17 @@ type components = {
9068
9087
  */
9069
9088
  display_image_url?: string;
9070
9089
  /**
9071
- * @description Custom role definitions (defaults to owner/editor/viewer/public)
9090
+ * @description Whether to merge with default roles (true) or use only provided roles (false). Public role with *:view is always ensured.
9091
+ * @default true
9092
+ * @example true
9093
+ */
9094
+ use_roles_default: boolean;
9095
+ /**
9096
+ * @description Role definitions. When use_roles_default is true (default), these merge with defaults. When false, these replace defaults entirely.
9072
9097
  * @example {
9073
- * "captain": [
9074
- * "*:view",
9075
- * "*:update",
9076
- * "*:create",
9077
- * "collection:manage"
9078
- * ],
9079
- * "harpooner": [
9080
- * "*:view",
9081
- * "*:update",
9082
- * "*:create"
9083
- * ],
9084
- * "crew": [
9085
- * "*:view",
9086
- * "entity:create"
9087
- * ],
9088
9098
  * "public": [
9089
- * "entity:view",
9090
- * "collection:view"
9099
+ * "*:view",
9100
+ * "*:invoke"
9091
9101
  * ]
9092
9102
  * }
9093
9103
  */
@@ -9616,6 +9626,11 @@ type components = {
9616
9626
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
9617
9627
  */
9618
9628
  collection?: string;
9629
+ /**
9630
+ * @description Wait for collection index update before returning. Use when checking for duplicates immediately after creation. Adds ~1-5ms latency per collection.
9631
+ * @default false
9632
+ */
9633
+ sync_index: boolean;
9619
9634
  };
9620
9635
  BatchCreateSuccess: {
9621
9636
  /** @enum {boolean} */
@@ -6,7 +6,7 @@
6
6
  *
7
7
  * Source: Arke v1 API
8
8
  * Version: 1.0.0
9
- * Generated: 2026-02-11T22:34:10.645Z
9
+ * Generated: 2026-02-13T15:33:39.556Z
10
10
  */
11
11
  type paths = {
12
12
  "/ops-reference": {
@@ -931,6 +931,25 @@ type paths = {
931
931
  * Create a new collection
932
932
  * @description Creates a collection with the authenticated user as owner.
933
933
  *
934
+ * **Default Roles:**
935
+ *
936
+ * By default (`use_roles_default: true`), collections include these standard roles:
937
+ * - `owner`: Full control including collection management
938
+ * - `editor`: Can modify entities but not collection settings
939
+ * - `viewer`: Read-only access
940
+ * - `public`: Public read access (`*:view`)
941
+ *
942
+ * **Customizing Roles:**
943
+ *
944
+ * Pass custom `roles` to override specific defaults while keeping others. For example, to make entities publicly invokable (for agents):
945
+ * ```json
946
+ * { "roles": { "public": ["*:view", "*:invoke"] } }
947
+ * ```
948
+ *
949
+ * Set `use_roles_default: false` to define all roles from scratch.
950
+ *
951
+ * **Platform Requirement:** The `public` role with `*:view` is always automatically ensured, guaranteeing all collections are publicly readable.
952
+ *
934
953
  * ---
935
954
  * **Permission:** `collection:create`
936
955
  * **Auth:** required
@@ -1981,13 +2000,13 @@ type paths = {
1981
2000
  };
1982
2001
  /**
1983
2002
  * List entities in a collection
1984
- * @description Returns entities belonging to this collection from the graph database.
2003
+ * @description Returns entities belonging to this collection.
1985
2004
  *
1986
2005
  * Supports pagination and optional type filtering. Results are ordered by creation date (newest first).
1987
2006
  *
1988
2007
  * **Expansion Modes:**
1989
2008
  *
1990
- * By default, returns lightweight summaries from GraphDB (pi, type, label, timestamps).
2009
+ * By default, returns lightweight summaries (pi, type, label, timestamps).
1991
2010
  *
1992
2011
  * Use the `expand` parameter to hydrate entity data from storage:
1993
2012
  *
@@ -2055,7 +2074,7 @@ type paths = {
2055
2074
  "application/json": components["schemas"]["ErrorResponse"];
2056
2075
  };
2057
2076
  };
2058
- /** @description GraphDB service unavailable */
2077
+ /** @description Collection index service unavailable */
2059
2078
  503: {
2060
2079
  headers: {
2061
2080
  [name: string]: unknown;
@@ -9068,26 +9087,17 @@ type components = {
9068
9087
  */
9069
9088
  display_image_url?: string;
9070
9089
  /**
9071
- * @description Custom role definitions (defaults to owner/editor/viewer/public)
9090
+ * @description Whether to merge with default roles (true) or use only provided roles (false). Public role with *:view is always ensured.
9091
+ * @default true
9092
+ * @example true
9093
+ */
9094
+ use_roles_default: boolean;
9095
+ /**
9096
+ * @description Role definitions. When use_roles_default is true (default), these merge with defaults. When false, these replace defaults entirely.
9072
9097
  * @example {
9073
- * "captain": [
9074
- * "*:view",
9075
- * "*:update",
9076
- * "*:create",
9077
- * "collection:manage"
9078
- * ],
9079
- * "harpooner": [
9080
- * "*:view",
9081
- * "*:update",
9082
- * "*:create"
9083
- * ],
9084
- * "crew": [
9085
- * "*:view",
9086
- * "entity:create"
9087
- * ],
9088
9098
  * "public": [
9089
- * "entity:view",
9090
- * "collection:view"
9099
+ * "*:view",
9100
+ * "*:invoke"
9091
9101
  * ]
9092
9102
  * }
9093
9103
  */
@@ -9616,6 +9626,11 @@ type components = {
9616
9626
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
9617
9627
  */
9618
9628
  collection?: string;
9629
+ /**
9630
+ * @description Wait for collection index update before returning. Use when checking for duplicates immediately after creation. Adds ~1-5ms latency per collection.
9631
+ * @default false
9632
+ */
9633
+ sync_index: boolean;
9619
9634
  };
9620
9635
  BatchCreateSuccess: {
9621
9636
  /** @enum {boolean} */