@openvtc/trust-tasks 0.27.3 → 0.27.5

package/dist/registry/record/query/0.2/payload.d.ts

@@ -0,0 +1,486 @@
+/**
+ * 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 declare const TYPE_URI: "https://trusttasks.org/spec/registry/record/query/0.2";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RegistryRecordQueryPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/registry/record/query/0.2#response";
+/** 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/registry/record/query/0.2";
+    readonly title: "Registry Record Query — payload";
+    readonly 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.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly properties: {
+        readonly entity_id: {
+            readonly type: "string";
+            readonly description: "Filter to records for this entity.";
+        };
+        readonly authority_id: {
+            readonly type: "string";
+            readonly description: "Filter to records asserted by this authority.";
+        };
+        readonly action: {
+            readonly type: "string";
+            readonly description: "Filter to records for this action.";
+        };
+        readonly resource: {
+            readonly type: "string";
+            readonly description: "Filter to records for this resource.";
+        };
+        readonly cursor: {
+            readonly type: "string";
+            readonly description: "Opaque continuation token from a previous page's `nextCursor`.";
+        };
+        readonly limit: {
+            readonly type: "integer";
+            readonly minimum: 1;
+            readonly maximum: 200;
+            readonly description: "Page size; the registry clamps to 1..=200 (default 50). Ignored on a fully keyed exact fetch.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Registry Record Query — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["records"];
+            readonly properties: {
+                readonly records: {
+                    readonly type: "array";
+                    readonly description: "The matching trust records. Exactly one entry on a fully keyed fetch; zero or more per page on an enumeration.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrustRecord";
+                    };
+                };
+                readonly nextCursor: {
+                    readonly type: "string";
+                    readonly 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.";
+                };
+                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 TrustRecord: {
+            readonly title: "TrustRecord";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["entity_id", "authority_id", "action", "resource", "record_type"];
+            readonly properties: {
+                readonly entity_id: {
+                    readonly type: "string";
+                };
+                readonly authority_id: {
+                    readonly type: "string";
+                };
+                readonly action: {
+                    readonly type: "string";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                };
+                readonly recognized: {
+                    readonly type: "boolean";
+                    readonly description: "Present on recognition records: whether the action+resource is recognised.";
+                };
+                readonly authorized: {
+                    readonly type: "boolean";
+                    readonly description: "Present on authorization records: whether the action+resource authorization is confirmed.";
+                };
+                readonly context: {
+                    readonly type: "object";
+                    readonly description: "Opaque governance context attached to the record.";
+                    readonly additionalProperties: true;
+                };
+                readonly record_type: {
+                    readonly $ref: "#/$defs/RecordType";
+                };
+            };
+        };
+        readonly RecordType: {
+            readonly title: "RecordType";
+            readonly type: "string";
+            readonly enum: readonly ["authorization", "recognition"];
+            readonly description: "Whether the record asserts an authorization or a recognition relationship.";
+        };
+    };
+};
+/** 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 Record Query — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["records"];
+            readonly properties: {
+                readonly records: {
+                    readonly type: "array";
+                    readonly description: "The matching trust records. Exactly one entry on a fully keyed fetch; zero or more per page on an enumeration.";
+                    readonly items: {
+                        readonly $ref: "#/$defs/TrustRecord";
+                    };
+                };
+                readonly nextCursor: {
+                    readonly type: "string";
+                    readonly 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.";
+                };
+                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 TrustRecord: {
+            readonly title: "TrustRecord";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["entity_id", "authority_id", "action", "resource", "record_type"];
+            readonly properties: {
+                readonly entity_id: {
+                    readonly type: "string";
+                };
+                readonly authority_id: {
+                    readonly type: "string";
+                };
+                readonly action: {
+                    readonly type: "string";
+                };
+                readonly resource: {
+                    readonly type: "string";
+                };
+                readonly recognized: {
+                    readonly type: "boolean";
+                    readonly description: "Present on recognition records: whether the action+resource is recognised.";
+                };
+                readonly authorized: {
+                    readonly type: "boolean";
+                    readonly description: "Present on authorization records: whether the action+resource authorization is confirmed.";
+                };
+                readonly context: {
+                    readonly type: "object";
+                    readonly description: "Opaque governance context attached to the record.";
+                    readonly additionalProperties: true;
+                };
+                readonly record_type: {
+                    readonly $ref: "#/$defs/RecordType";
+                };
+            };
+        };
+        readonly RecordType: {
+            readonly title: "RecordType";
+            readonly type: "string";
+            readonly enum: readonly ["authorization", "recognition"];
+            readonly description: "Whether the record asserts an authorization or a recognition relationship.";
+        };
+    };
+};
+/**
+ * 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/record/query/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/record/query/0.2";
+        readonly title: "Registry Record Query — payload";
+        readonly 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.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly properties: {
+            readonly entity_id: {
+                readonly type: "string";
+                readonly description: "Filter to records for this entity.";
+            };
+            readonly authority_id: {
+                readonly type: "string";
+                readonly description: "Filter to records asserted by this authority.";
+            };
+            readonly action: {
+                readonly type: "string";
+                readonly description: "Filter to records for this action.";
+            };
+            readonly resource: {
+                readonly type: "string";
+                readonly description: "Filter to records for this resource.";
+            };
+            readonly cursor: {
+                readonly type: "string";
+                readonly description: "Opaque continuation token from a previous page's `nextCursor`.";
+            };
+            readonly limit: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 200;
+                readonly description: "Page size; the registry clamps to 1..=200 (default 50). Ignored on a fully keyed exact fetch.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Registry Record Query — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["records"];
+                readonly properties: {
+                    readonly records: {
+                        readonly type: "array";
+                        readonly description: "The matching trust records. Exactly one entry on a fully keyed fetch; zero or more per page on an enumeration.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrustRecord";
+                        };
+                    };
+                    readonly nextCursor: {
+                        readonly type: "string";
+                        readonly 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.";
+                    };
+                    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 TrustRecord: {
+                readonly title: "TrustRecord";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["entity_id", "authority_id", "action", "resource", "record_type"];
+                readonly properties: {
+                    readonly entity_id: {
+                        readonly type: "string";
+                    };
+                    readonly authority_id: {
+                        readonly type: "string";
+                    };
+                    readonly action: {
+                        readonly type: "string";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                    };
+                    readonly recognized: {
+                        readonly type: "boolean";
+                        readonly description: "Present on recognition records: whether the action+resource is recognised.";
+                    };
+                    readonly authorized: {
+                        readonly type: "boolean";
+                        readonly description: "Present on authorization records: whether the action+resource authorization is confirmed.";
+                    };
+                    readonly context: {
+                        readonly type: "object";
+                        readonly description: "Opaque governance context attached to the record.";
+                        readonly additionalProperties: true;
+                    };
+                    readonly record_type: {
+                        readonly $ref: "#/$defs/RecordType";
+                    };
+                };
+            };
+            readonly RecordType: {
+                readonly title: "RecordType";
+                readonly type: "string";
+                readonly enum: readonly ["authorization", "recognition"];
+                readonly description: "Whether the record asserts an authorization or a recognition relationship.";
+            };
+        };
+    };
+};
+/**
+ * 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/record/query/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 Record Query — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["records"];
+                readonly properties: {
+                    readonly records: {
+                        readonly type: "array";
+                        readonly description: "The matching trust records. Exactly one entry on a fully keyed fetch; zero or more per page on an enumeration.";
+                        readonly items: {
+                            readonly $ref: "#/$defs/TrustRecord";
+                        };
+                    };
+                    readonly nextCursor: {
+                        readonly type: "string";
+                        readonly 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.";
+                    };
+                    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 TrustRecord: {
+                readonly title: "TrustRecord";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["entity_id", "authority_id", "action", "resource", "record_type"];
+                readonly properties: {
+                    readonly entity_id: {
+                        readonly type: "string";
+                    };
+                    readonly authority_id: {
+                        readonly type: "string";
+                    };
+                    readonly action: {
+                        readonly type: "string";
+                    };
+                    readonly resource: {
+                        readonly type: "string";
+                    };
+                    readonly recognized: {
+                        readonly type: "boolean";
+                        readonly description: "Present on recognition records: whether the action+resource is recognised.";
+                    };
+                    readonly authorized: {
+                        readonly type: "boolean";
+                        readonly description: "Present on authorization records: whether the action+resource authorization is confirmed.";
+                    };
+                    readonly context: {
+                        readonly type: "object";
+                        readonly description: "Opaque governance context attached to the record.";
+                        readonly additionalProperties: true;
+                    };
+                    readonly record_type: {
+                        readonly $ref: "#/$defs/RecordType";
+                    };
+                };
+            };
+            readonly RecordType: {
+                readonly title: "RecordType";
+                readonly type: "string";
+                readonly enum: readonly ["authorization", "recognition"];
+                readonly description: "Whether the record asserts an authorization or a recognition relationship.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/registry/record/query/0.2/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/registry/record/query/0.2/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAGtF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC;AAE7C,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,uDAAgE,CAAC;AAEzF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAEjD,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,gEAAyE,CAAC;AAE3G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,kCAAkC,CAAC;AAE1D;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8HjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2F1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}