@openvtc/trust-tasks 0.27.2 → 0.27.4

package/src/registry/record/query/0.2/payload.ts

@@ -0,0 +1,324 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/registry/record/query/0.2/payload.schema.json
+ */
+
+import type { Ext, RecordType, TrustRecord } from "../../../../_shared/components.js";
+
+
+/**
+ * An administrator queries a trust registry's stored records by an optional four-part key. All four parts supplied: an exact fetch of one record (notFound on a miss). Fewer parts: a filtered, cursor-paginated enumeration — fixing the pagination gap the superseded registry/record/list conceded. Key field names are verbatim TRQP (snake_case), matching the registry/* family.
+ */
+export interface RegistryRecordQueryPayload {
+  /**
+   * Filter to records for this entity.
+   */
+  entity_id?: string;
+  /**
+   * Filter to records asserted by this authority.
+   */
+  authority_id?: string;
+  /**
+   * Filter to records for this action.
+   */
+  action?: string;
+  /**
+   * Filter to records for this resource.
+   */
+  resource?: string;
+  /**
+   * Opaque continuation token from a previous page's `nextCursor`.
+   */
+  cursor?: string;
+  /**
+   * Page size; the registry clamps to 1..=200 (default 50). Ignored on a fully keyed exact fetch.
+   */
+  limit?: number;
+  ext?: Ext;
+}
+export interface RegistryRecordQueryResponsePayload {
+  /**
+   * The matching trust records. Exactly one entry on a fully keyed fetch; zero or more per page on an enumeration.
+   */
+  records: TrustRecord[];
+  /**
+   * Continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page and on a fully keyed fetch — never null.
+   */
+  nextCursor?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, RecordType, TrustRecord };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/registry/record/query/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RegistryRecordQueryPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/registry/record/query/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RegistryRecordQueryResponsePayload;
+
+/**
+ * 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/registry/record/query/0.2",
+  "title": "Registry Record Query — payload",
+  "description": "An administrator queries a trust registry's stored records by an optional four-part key. All four parts supplied: an exact fetch of one record (notFound on a miss). Fewer parts: a filtered, cursor-paginated enumeration — fixing the pagination gap the superseded registry/record/list conceded. Key field names are verbatim TRQP (snake_case), matching the registry/* family.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "entity_id": {
+      "type": "string",
+      "description": "Filter to records for this entity."
+    },
+    "authority_id": {
+      "type": "string",
+      "description": "Filter to records asserted by this authority."
+    },
+    "action": {
+      "type": "string",
+      "description": "Filter to records for this action."
+    },
+    "resource": {
+      "type": "string",
+      "description": "Filter to records for this resource."
+    },
+    "cursor": {
+      "type": "string",
+      "description": "Opaque continuation token from a previous page's `nextCursor`."
+    },
+    "limit": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 200,
+      "description": "Page size; the registry clamps to 1..=200 (default 50). Ignored on a fully keyed exact fetch."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Registry Record Query — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "records"
+      ],
+      "properties": {
+        "records": {
+          "type": "array",
+          "description": "The matching trust records. Exactly one entry on a fully keyed fetch; zero or more per page on an enumeration.",
+          "items": {
+            "$ref": "#/$defs/TrustRecord"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "description": "Continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page and on a fully keyed fetch — never null."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "TrustRecord": {
+      "title": "TrustRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entity_id",
+        "authority_id",
+        "action",
+        "resource",
+        "record_type"
+      ],
+      "properties": {
+        "entity_id": {
+          "type": "string"
+        },
+        "authority_id": {
+          "type": "string"
+        },
+        "action": {
+          "type": "string"
+        },
+        "resource": {
+          "type": "string"
+        },
+        "recognized": {
+          "type": "boolean",
+          "description": "Present on recognition records: whether the action+resource is recognised."
+        },
+        "authorized": {
+          "type": "boolean",
+          "description": "Present on authorization records: whether the action+resource authorization is confirmed."
+        },
+        "context": {
+          "type": "object",
+          "description": "Opaque governance context attached to the record.",
+          "additionalProperties": true
+        },
+        "record_type": {
+          "$ref": "#/$defs/RecordType"
+        }
+      }
+    },
+    "RecordType": {
+      "title": "RecordType",
+      "type": "string",
+      "enum": [
+        "authorization",
+        "recognition"
+      ],
+      "description": "Whether the record asserts an authorization or a recognition relationship."
+    }
+  }
+} 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": {
+      "$anchor": "response",
+      "title": "Registry Record Query — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "records"
+      ],
+      "properties": {
+        "records": {
+          "type": "array",
+          "description": "The matching trust records. Exactly one entry on a fully keyed fetch; zero or more per page on an enumeration.",
+          "items": {
+            "$ref": "#/$defs/TrustRecord"
+          }
+        },
+        "nextCursor": {
+          "type": "string",
+          "description": "Continuation token for the next page; pass it back as the request's `cursor`. Absent on the last page and on a fully keyed fetch — never null."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "TrustRecord": {
+      "title": "TrustRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entity_id",
+        "authority_id",
+        "action",
+        "resource",
+        "record_type"
+      ],
+      "properties": {
+        "entity_id": {
+          "type": "string"
+        },
+        "authority_id": {
+          "type": "string"
+        },
+        "action": {
+          "type": "string"
+        },
+        "resource": {
+          "type": "string"
+        },
+        "recognized": {
+          "type": "boolean",
+          "description": "Present on recognition records: whether the action+resource is recognised."
+        },
+        "authorized": {
+          "type": "boolean",
+          "description": "Present on authorization records: whether the action+resource authorization is confirmed."
+        },
+        "context": {
+          "type": "object",
+          "description": "Opaque governance context attached to the record.",
+          "additionalProperties": true
+        },
+        "record_type": {
+          "$ref": "#/$defs/RecordType"
+        }
+      }
+    },
+    "RecordType": {
+      "title": "RecordType",
+      "type": "string",
+      "enum": [
+        "authorization",
+        "recognition"
+      ],
+      "description": "Whether the record asserts an authorization or a recognition relationship."
+    }
+  }
+} 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: false,
+  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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;