@openvtc/trust-tasks 0.27.6 → 0.27.8

package/dist/registry/record/put/0.3/payload.d.ts

@@ -0,0 +1,497 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/registry/record/put/0.3/payload.schema.json
+ */
+import type { Ext, RecordType, TrustRecord_RegistryV0_2 as TrustRecord } from "../../../../_shared/components.js";
+/**
+ * An administrator asks a trust registry to create or replace the trust record at its four-part key (entity+authority+action+resource). Create-or-update in one task, following the vault/upsert precedent; the optional `expectedExisting` assertion recovers the strict create-only / update-only semantics of the superseded registry/record/create and registry/record/update tasks.
+ */
+export interface RegistryRecordPutPayload {
+    record: TrustRecord;
+    /**
+     * Optional existence assertion. When true, the registry MUST reject with `registry/record/put:notFound` if no record exists at the key (strict update). When false, the registry MUST reject with `registry/record/put:alreadyExists` if one does (strict create). Omitted: pure create-or-update.
+     */
+    expectedExisting?: boolean;
+    ext?: Ext;
+}
+export interface RegistryRecordPutResponsePayload {
+    /**
+     * Whether the record was stored.
+     */
+    ok: boolean;
+    /**
+     * True when the put created a new record, false when it replaced an existing one.
+     */
+    wasCreated: 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, RecordType, TrustRecord };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/registry/record/put/0.3";
+/**
+ * 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 = RegistryRecordPutPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/registry/record/put/0.3#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = RegistryRecordPutResponsePayload;
+/**
+ * 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/put/0.3";
+    readonly title: "Registry Record Put — payload";
+    readonly description: "An administrator asks a trust registry to create or replace the trust record at its four-part key (entity+authority+action+resource). Create-or-update in one task, following the vault/upsert precedent; the optional `expectedExisting` assertion recovers the strict create-only / update-only semantics of the superseded registry/record/create and registry/record/update tasks.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["record"];
+    readonly properties: {
+        readonly record: {
+            readonly $ref: "#/$defs/TrustRecord";
+        };
+        readonly expectedExisting: {
+            readonly type: "boolean";
+            readonly description: "Optional existence assertion. When true, the registry MUST reject with `registry/record/put:notFound` if no record exists at the key (strict update). When false, the registry MUST reject with `registry/record/put:alreadyExists` if one does (strict create). Omitted: pure create-or-update.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Registry Record Put — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["ok", "wasCreated"];
+            readonly properties: {
+                readonly ok: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the record was stored.";
+                };
+                readonly wasCreated: {
+                    readonly type: "boolean";
+                    readonly description: "True when the put created a new record, false when it replaced an existing one.";
+                };
+                readonly message: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                    readonly description: "Optional human-readable detail.";
+                };
+                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 ["entityId", "authorityId", "action", "resource", "recordType"];
+            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: "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 recordType: {
+                    readonly $ref: "#/$defs/RecordType";
+                };
+                readonly validFrom: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The first instant at which the authority statement holds (inclusive). Absent: no lower bound.";
+                };
+                readonly validUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The instant at which the authority statement stops holding (exclusive). Absent: no upper bound. When both bounds are present, `validFrom` MUST be earlier than `validUntil`.";
+                };
+            };
+        };
+        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 Put — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["ok", "wasCreated"];
+            readonly properties: {
+                readonly ok: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the record was stored.";
+                };
+                readonly wasCreated: {
+                    readonly type: "boolean";
+                    readonly description: "True when the put created a new record, false when it replaced an existing one.";
+                };
+                readonly message: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                    readonly description: "Optional human-readable detail.";
+                };
+                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 ["entityId", "authorityId", "action", "resource", "recordType"];
+            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: "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 recordType: {
+                    readonly $ref: "#/$defs/RecordType";
+                };
+                readonly validFrom: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The first instant at which the authority statement holds (inclusive). Absent: no lower bound.";
+                };
+                readonly validUntil: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "The instant at which the authority statement stops holding (exclusive). Absent: no upper bound. When both bounds are present, `validFrom` MUST be earlier than `validUntil`.";
+                };
+            };
+        };
+        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/put/0.3";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/registry/record/put/0.3";
+        readonly title: "Registry Record Put — payload";
+        readonly description: "An administrator asks a trust registry to create or replace the trust record at its four-part key (entity+authority+action+resource). Create-or-update in one task, following the vault/upsert precedent; the optional `expectedExisting` assertion recovers the strict create-only / update-only semantics of the superseded registry/record/create and registry/record/update tasks.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["record"];
+        readonly properties: {
+            readonly record: {
+                readonly $ref: "#/$defs/TrustRecord";
+            };
+            readonly expectedExisting: {
+                readonly type: "boolean";
+                readonly description: "Optional existence assertion. When true, the registry MUST reject with `registry/record/put:notFound` if no record exists at the key (strict update). When false, the registry MUST reject with `registry/record/put:alreadyExists` if one does (strict create). Omitted: pure create-or-update.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Registry Record Put — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["ok", "wasCreated"];
+                readonly properties: {
+                    readonly ok: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the record was stored.";
+                    };
+                    readonly wasCreated: {
+                        readonly type: "boolean";
+                        readonly description: "True when the put created a new record, false when it replaced an existing one.";
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                        readonly description: "Optional human-readable detail.";
+                    };
+                    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 ["entityId", "authorityId", "action", "resource", "recordType"];
+                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: "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 recordType: {
+                        readonly $ref: "#/$defs/RecordType";
+                    };
+                    readonly validFrom: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "The first instant at which the authority statement holds (inclusive). Absent: no lower bound.";
+                    };
+                    readonly validUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "The instant at which the authority statement stops holding (exclusive). Absent: no upper bound. When both bounds are present, `validFrom` MUST be earlier than `validUntil`.";
+                    };
+                };
+            };
+            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/put/0.3#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    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 Put — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["ok", "wasCreated"];
+                readonly properties: {
+                    readonly ok: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the record was stored.";
+                    };
+                    readonly wasCreated: {
+                        readonly type: "boolean";
+                        readonly description: "True when the put created a new record, false when it replaced an existing one.";
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                        readonly description: "Optional human-readable detail.";
+                    };
+                    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 ["entityId", "authorityId", "action", "resource", "recordType"];
+                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: "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 recordType: {
+                        readonly $ref: "#/$defs/RecordType";
+                    };
+                    readonly validFrom: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "The first instant at which the authority statement holds (inclusive). Absent: no lower bound.";
+                    };
+                    readonly validUntil: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "The instant at which the authority statement stops holding (exclusive). Absent: no upper bound. When both bounds are present, `validFrom` MUST be earlier than `validUntil`.";
+                    };
+                };
+            };
+            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/put/0.3/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/registry/record/put/0.3/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,wBAAwB,IAAI,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAGlH;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,WAAW,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,EAAE,OAAO,CAAC;IACZ;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,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,qDAA8D,CAAC;AAEvF;;;;;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,wBAAwB,CAAC;AAE/C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,8DAAuE,CAAC;AAEzG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,gCAAgC,CAAC;AAExD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2HjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwG1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}