@openvtc/trust-tasks 0.27.6 → 0.27.7

package/src/registry/recognition/0.2/payload.ts

@@ -0,0 +1,337 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/registry/recognition/0.2/payload.schema.json
+ */
+
+import type { Ext, QueryContext } from "../../../_shared/components.js";
+
+
+/**
+ * TRQP v2.0 recognition query: ask a trust registry whether an entity is recognised by an authority for a given action+resource, evaluated as of `context.time` (or the registry's current time) against the matching record's validity window. Members are lowerCamelCase per the registry naming convention; a registry serving the plain HTTP TRQP binding maps them to TRQP's snake_case field names (`entityId` ↔ `entity_id`, `evaluatedAt` ↔ `time_evaluated`, and so on) at that binding.
+ */
+export interface RegistryRecognitionPayload {
+  /**
+   * Identifier of the entity being tested for recognition.
+   */
+  entityId: string;
+  /**
+   * Identifier of the authority being queried to recognise the entity.
+   */
+  authorityId: string;
+  /**
+   * The action the query is checking recognition for.
+   */
+  action: string;
+  /**
+   * The resource the query is checking recognition for.
+   */
+  resource: string;
+  context?: QueryContext;
+  ext?: Ext;
+}
+export interface RegistryRecognitionResponsePayload {
+  entityId: string;
+  authorityId: string;
+  action: string;
+  resource: string;
+  /**
+   * True if the action+resource has been recognised, false otherwise.
+   */
+  recognized: boolean;
+  /**
+   * Server time the query was evaluated at, per the endpoint clock.
+   */
+  evaluatedAt: string;
+  /**
+   * The requested server time, echoed from the request `context.time` when supplied.
+   */
+  asOf?: string;
+  /**
+   * Additional human-readable detail about the recognition response.
+   */
+  message?: string;
+  context?: QueryContext;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, QueryContext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/registry/recognition/0.2" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RegistryRecognitionPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/registry/recognition/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RegistryRecognitionResponsePayload;
+
+/**
+ * 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/recognition/0.2",
+  "title": "Registry Recognition — payload",
+  "description": "TRQP v2.0 recognition query: ask a trust registry whether an entity is recognised by an authority for a given action+resource, evaluated as of `context.time` (or the registry's current time) against the matching record's validity window. Members are lowerCamelCase per the registry naming convention; a registry serving the plain HTTP TRQP binding maps them to TRQP's snake_case field names (`entityId` ↔ `entity_id`, `evaluatedAt` ↔ `time_evaluated`, and so on) at that binding.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "entityId",
+    "authorityId",
+    "action",
+    "resource"
+  ],
+  "properties": {
+    "entityId": {
+      "type": "string",
+      "description": "Identifier of the entity being tested for recognition."
+    },
+    "authorityId": {
+      "type": "string",
+      "description": "Identifier of the authority being queried to recognise the entity."
+    },
+    "action": {
+      "type": "string",
+      "description": "The action the query is checking recognition for."
+    },
+    "resource": {
+      "type": "string",
+      "description": "The resource the query is checking recognition for."
+    },
+    "context": {
+      "$ref": "#/$defs/QueryContext"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Registry Recognition — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entityId",
+        "authorityId",
+        "action",
+        "resource",
+        "recognized",
+        "evaluatedAt"
+      ],
+      "properties": {
+        "entityId": {
+          "type": "string"
+        },
+        "authorityId": {
+          "type": "string"
+        },
+        "action": {
+          "type": "string"
+        },
+        "resource": {
+          "type": "string"
+        },
+        "recognized": {
+          "type": "boolean",
+          "description": "True if the action+resource has been recognised, false otherwise."
+        },
+        "evaluatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Server time the query was evaluated at, per the endpoint clock."
+        },
+        "asOf": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The requested server time, echoed from the request `context.time` when supplied."
+        },
+        "message": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Additional human-readable detail about the recognition response."
+        },
+        "context": {
+          "$ref": "#/$defs/QueryContext"
+        },
+        "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-]+)+$"
+      }
+    },
+    "QueryContext": {
+      "title": "QueryContext",
+      "type": "object",
+      "description": "Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.",
+      "properties": {
+        "time": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time."
+        },
+        "locator": {
+          "type": "string",
+          "description": "Optional hint for systems that need extra information to locate the records in question (authorization queries)."
+        }
+      },
+      "additionalProperties": {
+        "type": "string"
+      }
+    }
+  }
+} 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 Recognition — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entityId",
+        "authorityId",
+        "action",
+        "resource",
+        "recognized",
+        "evaluatedAt"
+      ],
+      "properties": {
+        "entityId": {
+          "type": "string"
+        },
+        "authorityId": {
+          "type": "string"
+        },
+        "action": {
+          "type": "string"
+        },
+        "resource": {
+          "type": "string"
+        },
+        "recognized": {
+          "type": "boolean",
+          "description": "True if the action+resource has been recognised, false otherwise."
+        },
+        "evaluatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Server time the query was evaluated at, per the endpoint clock."
+        },
+        "asOf": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The requested server time, echoed from the request `context.time` when supplied."
+        },
+        "message": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Additional human-readable detail about the recognition response."
+        },
+        "context": {
+          "$ref": "#/$defs/QueryContext"
+        },
+        "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-]+)+$"
+      }
+    },
+    "QueryContext": {
+      "title": "QueryContext",
+      "type": "object",
+      "description": "Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.",
+      "properties": {
+        "time": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time."
+        },
+        "locator": {
+          "type": "string",
+          "description": "Optional hint for systems that need extra information to locate the records in question (authorization queries)."
+        }
+      },
+      "additionalProperties": {
+        "type": "string"
+      }
+    }
+  }
+} 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;

package/src/registry/record/create/0.1/payload.ts

@@ -9,13 +9,13 @@ import type { Ext, RecordType, TrustRecord } from "../../../../_shared/component
 /**
  * An administrator asks a trust registry to create a new trust record (a recognition or authorization assertion). Idempotent per record key (entity+authority+action+resource); creating an existing key is an error.
  *
- * @deprecated retired; use registry/record/put/0.2
+ * @deprecated retired; use registry/record/put/0.3
  */
 export interface RegistryRecordCreatePayload {
   record: TrustRecord;
   ext?: Ext;
 }
-/** @deprecated retired; use registry/record/put/0.2 */
+/** @deprecated retired; use registry/record/put/0.3 */
 export interface RegistryRecordCreateResponsePayload {
   /**
    * Whether the record was created.
@@ -48,12 +48,12 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = "retired; use registry/record/put/0.2";
+export const DEPRECATION: string | null = "retired; use registry/record/put/0.3";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated retired; use registry/record/put/0.2
+ * @deprecated retired; use registry/record/put/0.3
  */
 export type Payload = RegistryRecordCreatePayload;
 
@@ -63,7 +63,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/registry/record/cr
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated retired; use registry/record/put/0.2
+ * @deprecated retired; use registry/record/put/0.3
  */
 export type Response = RegistryRecordCreateResponsePayload;
 

package/src/registry/record/delete/0.1/payload.ts

@@ -8,6 +8,8 @@ import type { Ext } from "../../../../_shared/components.js";
 
 /**
  * An administrator asks a trust registry to delete the trust record identified by the four TRQP identifiers.
+ *
+ * @deprecated superseded by registry/record/delete/0.2
  */
 export interface RegistryRecordDeletePayload {
   entity_id: string;
@@ -16,6 +18,7 @@ export interface RegistryRecordDeletePayload {
   resource: string;
   ext?: Ext;
 }
+/** @deprecated superseded by registry/record/delete/0.2 */
 export interface RegistryRecordDeleteResponsePayload {
   /**
    * Whether the record was deleted.
@@ -48,15 +51,23 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = null;
+export const DEPRECATION: string | null = "superseded by registry/record/delete/0.2";
 
-/** Stable alias for this specification's request payload shape. */
+/**
+ * Stable alias for this specification's request payload shape.
+ *
+ * @deprecated superseded by registry/record/delete/0.2
+ */
 export type Payload = RegistryRecordDeletePayload;
 
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/registry/record/delete/0.1#response" as const;
 
-/** Stable alias for this specification's success-response payload shape. */
+/**
+ * Stable alias for this specification's success-response payload shape.
+ *
+ * @deprecated superseded by registry/record/delete/0.2
+ */
 export type Response = RegistryRecordDeleteResponsePayload;
 
 /**

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

@@ -0,0 +1,206 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/registry/record/delete/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * An administrator asks a trust registry to delete the trust record identified by the four TRQP identifiers.
+ */
+export interface RegistryRecordDeletePayload {
+  entityId: string;
+  authorityId: string;
+  action: string;
+  resource: string;
+  ext?: Ext;
+}
+export interface RegistryRecordDeleteResponsePayload {
+  /**
+   * Whether the record was deleted.
+   */
+  ok: boolean;
+  /**
+   * Optional human-readable detail.
+   */
+  message?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/registry/record/delete/0.2" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RegistryRecordDeletePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/registry/record/delete/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RegistryRecordDeleteResponsePayload;
+
+/**
+ * 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/delete/0.2",
+  "title": "Registry Record Delete — payload",
+  "description": "An administrator asks a trust registry to delete the trust record identified by the four TRQP identifiers.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "entityId",
+    "authorityId",
+    "action",
+    "resource"
+  ],
+  "properties": {
+    "entityId": {
+      "type": "string"
+    },
+    "authorityId": {
+      "type": "string"
+    },
+    "action": {
+      "type": "string"
+    },
+    "resource": {
+      "type": "string"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Registry Record Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ok"
+      ],
+      "properties": {
+        "ok": {
+          "type": "boolean",
+          "description": "Whether the record was deleted."
+        },
+        "message": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Optional human-readable detail."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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 Delete — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ok"
+      ],
+      "properties": {
+        "ok": {
+          "type": "boolean",
+          "description": "Whether the record was deleted."
+        },
+        "message": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Optional human-readable detail."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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: true,
+  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: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/registry/record/list/0.1/payload.ts

@@ -9,12 +9,12 @@ import type { Ext, RecordType, TrustRecord } from "../../../../_shared/component
 /**
  * An administrator lists all trust records held by the registry.
  *
- * @deprecated retired; use registry/record/query/0.2
+ * @deprecated retired; use registry/record/query/0.3
  */
 export interface RegistryRecordListPayload {
   ext?: Ext;
 }
-/** @deprecated retired; use registry/record/query/0.2 */
+/** @deprecated retired; use registry/record/query/0.3 */
 export interface RegistryRecordListResponsePayload {
   /**
    * All trust records held by the registry.
@@ -43,12 +43,12 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = "retired; use registry/record/query/0.2";
+export const DEPRECATION: string | null = "retired; use registry/record/query/0.3";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated retired; use registry/record/query/0.2
+ * @deprecated retired; use registry/record/query/0.3
  */
 export type Payload = RegistryRecordListPayload;
 
@@ -58,7 +58,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/registry/record/li
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated retired; use registry/record/query/0.2
+ * @deprecated retired; use registry/record/query/0.3
  */
 export type Response = RegistryRecordListResponsePayload;