@openvtc/trust-tasks 0.27.6 → 0.27.7

package/dist/registry/recognition/0.2/payload.d.ts

@@ -0,0 +1,494 @@
+/**
+ * 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 declare const TYPE_URI: "https://trusttasks.org/spec/registry/recognition/0.2";
+/**
+ * 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 declare const EXTENDS: string | 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 declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RegistryRecognitionPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/registry/recognition/0.2#response";
+/** 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/registry/recognition/0.2";
+    readonly title: "Registry Recognition — payload";
+    readonly 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.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["entityId", "authorityId", "action", "resource"];
+    readonly properties: {
+        readonly entityId: {
+            readonly type: "string";
+            readonly description: "Identifier of the entity being tested for recognition.";
+        };
+        readonly authorityId: {
+            readonly type: "string";
+            readonly description: "Identifier of the authority being queried to recognise the entity.";
+        };
+        readonly action: {
+            readonly type: "string";
+            readonly description: "The action the query is checking recognition for.";
+        };
+        readonly resource: {
+            readonly type: "string";
+            readonly description: "The resource the query is checking recognition for.";
+        };
+        readonly context: {
+            readonly $ref: "#/$defs/QueryContext";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Registry Recognition — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["entityId", "authorityId", "action", "resource", "recognized", "evaluatedAt"];
+            readonly properties: {
+                readonly entityId: {
+                    readonly type: "string";
+                };
+                readonly authorityId: {
+                    readonly type: "string";
+                };
+                readonly action: {
+                    readonly type: "string";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                };
+                readonly recognized: {
+                    readonly type: "boolean";
+                    readonly description: "True if the action+resource has been recognised, false otherwise.";
+                };
+                readonly evaluatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Server time the query was evaluated at, per the endpoint clock.";
+                };
+                readonly asOf: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The requested server time, echoed from the request `context.time` when supplied.";
+                };
+                readonly message: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                    readonly description: "Additional human-readable detail about the recognition response.";
+                };
+                readonly context: {
+                    readonly $ref: "#/$defs/QueryContext";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly QueryContext: {
+            readonly title: "QueryContext";
+            readonly type: "object";
+            readonly description: "Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.";
+            readonly properties: {
+                readonly time: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time.";
+                };
+                readonly locator: {
+                    readonly type: "string";
+                    readonly description: "Optional hint for systems that need extra information to locate the records in question (authorization queries).";
+                };
+            };
+            readonly additionalProperties: {
+                readonly type: "string";
+            };
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Registry Recognition — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["entityId", "authorityId", "action", "resource", "recognized", "evaluatedAt"];
+            readonly properties: {
+                readonly entityId: {
+                    readonly type: "string";
+                };
+                readonly authorityId: {
+                    readonly type: "string";
+                };
+                readonly action: {
+                    readonly type: "string";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                };
+                readonly recognized: {
+                    readonly type: "boolean";
+                    readonly description: "True if the action+resource has been recognised, false otherwise.";
+                };
+                readonly evaluatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Server time the query was evaluated at, per the endpoint clock.";
+                };
+                readonly asOf: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The requested server time, echoed from the request `context.time` when supplied.";
+                };
+                readonly message: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                    readonly description: "Additional human-readable detail about the recognition response.";
+                };
+                readonly context: {
+                    readonly $ref: "#/$defs/QueryContext";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly QueryContext: {
+            readonly title: "QueryContext";
+            readonly type: "object";
+            readonly description: "Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.";
+            readonly properties: {
+                readonly time: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time.";
+                };
+                readonly locator: {
+                    readonly type: "string";
+                    readonly description: "Optional hint for systems that need extra information to locate the records in question (authorization queries).";
+                };
+            };
+            readonly additionalProperties: {
+                readonly type: "string";
+            };
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/registry/recognition/0.2";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/registry/recognition/0.2";
+        readonly title: "Registry Recognition — payload";
+        readonly 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.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["entityId", "authorityId", "action", "resource"];
+        readonly properties: {
+            readonly entityId: {
+                readonly type: "string";
+                readonly description: "Identifier of the entity being tested for recognition.";
+            };
+            readonly authorityId: {
+                readonly type: "string";
+                readonly description: "Identifier of the authority being queried to recognise the entity.";
+            };
+            readonly action: {
+                readonly type: "string";
+                readonly description: "The action the query is checking recognition for.";
+            };
+            readonly resource: {
+                readonly type: "string";
+                readonly description: "The resource the query is checking recognition for.";
+            };
+            readonly context: {
+                readonly $ref: "#/$defs/QueryContext";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Registry Recognition — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["entityId", "authorityId", "action", "resource", "recognized", "evaluatedAt"];
+                readonly properties: {
+                    readonly entityId: {
+                        readonly type: "string";
+                    };
+                    readonly authorityId: {
+                        readonly type: "string";
+                    };
+                    readonly action: {
+                        readonly type: "string";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                    };
+                    readonly recognized: {
+                        readonly type: "boolean";
+                        readonly description: "True if the action+resource has been recognised, false otherwise.";
+                    };
+                    readonly evaluatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Server time the query was evaluated at, per the endpoint clock.";
+                    };
+                    readonly asOf: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "The requested server time, echoed from the request `context.time` when supplied.";
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                        readonly description: "Additional human-readable detail about the recognition response.";
+                    };
+                    readonly context: {
+                        readonly $ref: "#/$defs/QueryContext";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly QueryContext: {
+                readonly title: "QueryContext";
+                readonly type: "object";
+                readonly description: "Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.";
+                readonly properties: {
+                    readonly time: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time.";
+                    };
+                    readonly locator: {
+                        readonly type: "string";
+                        readonly description: "Optional hint for systems that need extra information to locate the records in question (authorization queries).";
+                    };
+                };
+                readonly additionalProperties: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/registry/recognition/0.2#response";
+    readonly isBearer: false;
+    readonly isProofRequired: false;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: false;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Registry Recognition — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["entityId", "authorityId", "action", "resource", "recognized", "evaluatedAt"];
+                readonly properties: {
+                    readonly entityId: {
+                        readonly type: "string";
+                    };
+                    readonly authorityId: {
+                        readonly type: "string";
+                    };
+                    readonly action: {
+                        readonly type: "string";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                    };
+                    readonly recognized: {
+                        readonly type: "boolean";
+                        readonly description: "True if the action+resource has been recognised, false otherwise.";
+                    };
+                    readonly evaluatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Server time the query was evaluated at, per the endpoint clock.";
+                    };
+                    readonly asOf: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "The requested server time, echoed from the request `context.time` when supplied.";
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                        readonly description: "Additional human-readable detail about the recognition response.";
+                    };
+                    readonly context: {
+                        readonly $ref: "#/$defs/QueryContext";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly QueryContext: {
+                readonly title: "QueryContext";
+                readonly type: "object";
+                readonly description: "Optional TRQP query context. `time` requests evaluation as of a given instant; `locator` is an authority-defined hint for locating records.";
+                readonly properties: {
+                    readonly time: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "Evaluate the query as of this RFC3339 (Z offset) instant. Blank/absent uses current server time.";
+                    };
+                    readonly locator: {
+                        readonly type: "string";
+                        readonly description: "Optional hint for systems that need extra information to locate the records in question (authorization queries).";
+                    };
+                };
+                readonly additionalProperties: {
+                    readonly type: "string";
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/registry/recognition/0.2/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../src/registry/recognition/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAGxE;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,kCAAkC;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;AAElC,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,sDAA+D,CAAC;AAExF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE,MAAM,GAAG,IAAW,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,GAAG,IAAW,CAAC;AAE/C,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAEjD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,+DAAwE,CAAC;AAE1G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyHjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuF1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}