@openvtc/trust-tasks 0.16.9 → 0.16.11

package/src/persona/local/profile/get/1.0/payload.ts

@@ -0,0 +1,251 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/local/profile/get/1.0/payload.schema.json
+ */
+
+import type { Ext, Ulid, Version_PersonaV0_1 as Version } from "../../../../../_shared/components.js";
+
+
+/**
+ * Read one context-local profile.
+ */
+export interface PersonaLocalProfileGetPayload {
+  contextId: string;
+  profileId: Ulid;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/local/profile/get. Type https://trusttasks.org/spec/persona/local/profile/get/1.0#response.
+ */
+export interface PersonaLocalProfileGetResponsePayload {
+  profile: {
+    profileId: Ulid;
+    name: string;
+    /**
+     * @maxItems 64
+     */
+    entries: {}[];
+    version: Version;
+  };
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Ulid, Version };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/local/profile/get/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaLocalProfileGetPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/local/profile/get/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaLocalProfileGetResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/persona/local/profile/get/1.0",
+  "title": "Persona Local Profile Get — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "profileId": {
+      "$ref": "#/$defs/Ulid"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "required": [
+        "profile"
+      ],
+      "properties": {
+        "profile": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "profileId",
+            "name",
+            "entries",
+            "version"
+          ],
+          "properties": {
+            "profileId": {
+              "$ref": "#/$defs/Ulid"
+            },
+            "name": {
+              "type": "string",
+              "maxLength": 128
+            },
+            "entries": {
+              "type": "array",
+              "maxItems": 64,
+              "items": {
+                "type": "object"
+              }
+            },
+            "version": {
+              "$ref": "#/$defs/Version"
+            }
+          }
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      },
+      "$anchor": "response",
+      "title": "Persona Local Profile Get — response payload",
+      "description": "Success response to persona/local/profile/get. Type https://trusttasks.org/spec/persona/local/profile/get/1.0#response.",
+      "type": "object",
+      "additionalProperties": false
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "Version": {
+      "title": "Version",
+      "description": "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    }
+  },
+  "description": "Read one context-local profile.",
+  "required": [
+    "contextId",
+    "profileId"
+  ]
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "required": [
+        "profile"
+      ],
+      "properties": {
+        "profile": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "profileId",
+            "name",
+            "entries",
+            "version"
+          ],
+          "properties": {
+            "profileId": {
+              "$ref": "#/$defs/Ulid"
+            },
+            "name": {
+              "type": "string",
+              "maxLength": 128
+            },
+            "entries": {
+              "type": "array",
+              "maxItems": 64,
+              "items": {
+                "type": "object"
+              }
+            },
+            "version": {
+              "$ref": "#/$defs/Version"
+            }
+          }
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      },
+      "$anchor": "response",
+      "title": "Persona Local Profile Get — response payload",
+      "description": "Success response to persona/local/profile/get. Type https://trusttasks.org/spec/persona/local/profile/get/1.0#response.",
+      "type": "object",
+      "additionalProperties": false
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "Version": {
+      "title": "Version",
+      "description": "A value of the store's monotonic write counter. Server-assigned; a producer never chooses one.",
+      "type": "integer",
+      "minimum": 1
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/persona/local/profile/list/1.0/payload.ts

@@ -0,0 +1,260 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/persona/local/profile/list/1.0/payload.schema.json
+ */
+
+import type { Ext, Ulid } from "../../../../../_shared/components.js";
+
+
+/**
+ * Enumerate this context's local profiles. A separate keyspace from the holder's pool, so the scan structurally cannot return a pool profile — the isolation is in the address, not in a filter that could be got wrong.
+ */
+export interface PersonaLocalProfileListPayload {
+  contextId: string;
+  cursor?: string;
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * Success response to persona/local/profile/list. Type https://trusttasks.org/spec/persona/local/profile/list/1.0#response.
+ */
+export interface PersonaLocalProfileListResponsePayload {
+  /**
+   * @maxItems 500
+   */
+  profiles: {
+    profileId: Ulid;
+    name: string;
+    entryCount: number;
+    /**
+     * Whether a persona in this context is bound to it.
+     */
+    bound?: boolean;
+  }[];
+  nextCursor?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, Ulid };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/persona/local/profile/list/1.0" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PersonaLocalProfileListPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/persona/local/profile/list/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PersonaLocalProfileListResponsePayload;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/persona/local/profile/list/1.0",
+  "title": "Persona Local Profile List — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "contextId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "cursor": {
+      "type": "string",
+      "maxLength": 4096
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 500,
+      "default": 100
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "required": [
+        "profiles"
+      ],
+      "properties": {
+        "profiles": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "profileId",
+              "name",
+              "entryCount"
+            ],
+            "properties": {
+              "profileId": {
+                "$ref": "#/$defs/Ulid"
+              },
+              "name": {
+                "type": "string",
+                "maxLength": 128
+              },
+              "entryCount": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "bound": {
+                "type": "boolean",
+                "description": "Whether a persona in this context is bound to it."
+              }
+            }
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      },
+      "$anchor": "response",
+      "title": "Persona Local Profile List — response payload",
+      "description": "Success response to persona/local/profile/list. Type https://trusttasks.org/spec/persona/local/profile/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    }
+  },
+  "description": "Enumerate this context's local profiles. A separate keyspace from the holder's pool, so the scan structurally cannot return a pool profile — the isolation is in the address, not in a filter that could be got wrong.",
+  "required": [
+    "contextId"
+  ]
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "required": [
+        "profiles"
+      ],
+      "properties": {
+        "profiles": {
+          "type": "array",
+          "maxItems": 500,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "profileId",
+              "name",
+              "entryCount"
+            ],
+            "properties": {
+              "profileId": {
+                "$ref": "#/$defs/Ulid"
+              },
+              "name": {
+                "type": "string",
+                "maxLength": 128
+              },
+              "entryCount": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "bound": {
+                "type": "boolean",
+                "description": "Whether a persona in this context is bound to it."
+              }
+            }
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "maxLength": 4096
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      },
+      "$anchor": "response",
+      "title": "Persona Local Profile List — response payload",
+      "description": "Success response to persona/local/profile/list. Type https://trusttasks.org/spec/persona/local/profile/list/1.0#response.",
+      "type": "object",
+      "additionalProperties": false
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "Ulid": {
+      "title": "Ulid",
+      "description": "A ULID in Crockford base32, uppercase. Used for `attributeId` and `profileId`. Chosen over a UUID because the leading 48 bits are a timestamp, so a key-ordered scan of the store is also creation-ordered and a `list` needs no secondary sort. Server-assigned on create; a producer MAY supply one to make a create idempotent, and a maintainer MUST reject a supplied value that already exists rather than silently overwriting.",
+      "type": "string",
+      "pattern": "^[0-9A-HJKMNP-TV-Z]{26}$"
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;