@openvtc/trust-tasks 0.27.3 → 0.27.4

package/dist/policy/upsert/0.3/payload.d.ts

@@ -0,0 +1,540 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/policy/upsert/0.3/payload.schema.json
+ */
+import type { Ext, PolicyModule } from "../../../_shared/components.js";
+export interface PolicyUpsertPayload {
+    id?: string;
+    expectedVersion?: number;
+    name: string;
+    description?: string;
+    /**
+     * Rego source. The maintainer parses and validates against its evaluator before persisting; a syntactically invalid module is rejected.
+     */
+    module: string;
+    appliesTo?: string[];
+    priority?: number;
+    enabled?: boolean;
+    ext?: Ext;
+}
+export interface PolicyUpsertResponsePayload {
+    policy: PolicyModule;
+    wasCreated: boolean;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, PolicyModule };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/policy/upsert/0.3";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PolicyUpsertPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/policy/upsert/0.3#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = PolicyUpsertResponsePayload;
+/**
+ * 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/policy/upsert/0.3";
+    readonly title: "Policy Upsert — payload";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["name", "module"];
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly expectedVersion: {
+            readonly type: "integer";
+            readonly minimum: 0;
+        };
+        readonly name: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 128;
+        };
+        readonly description: {
+            readonly type: "string";
+            readonly maxLength: 1024;
+        };
+        readonly module: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly description: "Rego source. The maintainer parses and validates against its evaluator before persisting; a syntactically invalid module is rejected.";
+        };
+        readonly appliesTo: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly uniqueItems: true;
+        };
+        readonly priority: {
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly maximum: 1000;
+        };
+        readonly enabled: {
+            readonly type: "boolean";
+            readonly default: true;
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Policy Upsert — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["policy", "wasCreated"];
+            readonly properties: {
+                readonly policy: {
+                    readonly $ref: "#/$defs/PolicyModule";
+                };
+                readonly wasCreated: {
+                    readonly type: "boolean";
+                };
+                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 PolicyModule: {
+            readonly title: "PolicyModule";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "name", "module", "version", "createdAt", "updatedAt"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly name: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                    readonly description: "Human-readable name (e.g. \"default vault policy\", \"bank-site step-up\").";
+                };
+                readonly description: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                };
+                readonly module: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Rego source code. The maintainer's evaluator entry point is the package's `decision` rule, returning a PolicyDecision.";
+                };
+                readonly appliesTo: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly uniqueItems: true;
+                    readonly description: "List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy).";
+                };
+                readonly priority: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly maximum: 1000;
+                    readonly description: "When multiple policies match a request, evaluation order is by priority descending. The first to return a non-`null` decision wins.";
+                };
+                readonly enabled: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                };
+                readonly version: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+    };
+};
+/** 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: "Policy Upsert — response payload";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["policy", "wasCreated"];
+            readonly properties: {
+                readonly policy: {
+                    readonly $ref: "#/$defs/PolicyModule";
+                };
+                readonly wasCreated: {
+                    readonly type: "boolean";
+                };
+                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 PolicyModule: {
+            readonly title: "PolicyModule";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "name", "module", "version", "createdAt", "updatedAt"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                };
+                readonly name: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                    readonly description: "Human-readable name (e.g. \"default vault policy\", \"bank-site step-up\").";
+                };
+                readonly description: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                };
+                readonly module: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly description: "Rego source code. The maintainer's evaluator entry point is the package's `decision` rule, returning a PolicyDecision.";
+                };
+                readonly appliesTo: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                    readonly uniqueItems: true;
+                    readonly description: "List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy).";
+                };
+                readonly priority: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly maximum: 1000;
+                    readonly description: "When multiple policies match a request, evaluation order is by priority descending. The first to return a non-`null` decision wins.";
+                };
+                readonly enabled: {
+                    readonly type: "boolean";
+                    readonly default: true;
+                };
+                readonly version: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly createdAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly updatedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+    };
+};
+/**
+ * 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/policy/upsert/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/policy/upsert/0.3";
+        readonly title: "Policy Upsert — payload";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["name", "module"];
+        readonly properties: {
+            readonly id: {
+                readonly type: "string";
+                readonly minLength: 1;
+            };
+            readonly expectedVersion: {
+                readonly type: "integer";
+                readonly minimum: 0;
+            };
+            readonly name: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 128;
+            };
+            readonly description: {
+                readonly type: "string";
+                readonly maxLength: 1024;
+            };
+            readonly module: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly description: "Rego source. The maintainer parses and validates against its evaluator before persisting; a syntactically invalid module is rejected.";
+            };
+            readonly appliesTo: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "string";
+                };
+                readonly uniqueItems: true;
+            };
+            readonly priority: {
+                readonly type: "integer";
+                readonly minimum: 0;
+                readonly maximum: 1000;
+            };
+            readonly enabled: {
+                readonly type: "boolean";
+                readonly default: true;
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Policy Upsert — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["policy", "wasCreated"];
+                readonly properties: {
+                    readonly policy: {
+                        readonly $ref: "#/$defs/PolicyModule";
+                    };
+                    readonly wasCreated: {
+                        readonly type: "boolean";
+                    };
+                    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 PolicyModule: {
+                readonly title: "PolicyModule";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "name", "module", "version", "createdAt", "updatedAt"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                        readonly description: "Human-readable name (e.g. \"default vault policy\", \"bank-site step-up\").";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                    };
+                    readonly module: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Rego source code. The maintainer's evaluator entry point is the package's `decision` rule, returning a PolicyDecision.";
+                    };
+                    readonly appliesTo: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly uniqueItems: true;
+                        readonly description: "List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy).";
+                    };
+                    readonly priority: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly maximum: 1000;
+                        readonly description: "When multiple policies match a request, evaluation order is by priority descending. The first to return a non-`null` decision wins.";
+                    };
+                    readonly enabled: {
+                        readonly type: "boolean";
+                        readonly default: true;
+                    };
+                    readonly version: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+        };
+    };
+};
+/**
+ * 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/policy/upsert/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: "Policy Upsert — response payload";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["policy", "wasCreated"];
+                readonly properties: {
+                    readonly policy: {
+                        readonly $ref: "#/$defs/PolicyModule";
+                    };
+                    readonly wasCreated: {
+                        readonly type: "boolean";
+                    };
+                    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 PolicyModule: {
+                readonly title: "PolicyModule";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "name", "module", "version", "createdAt", "updatedAt"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                        readonly description: "Human-readable name (e.g. \"default vault policy\", \"bank-site step-up\").";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                    };
+                    readonly module: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly description: "Rego source code. The maintainer's evaluator entry point is the package's `decision` rule, returning a PolicyDecision.";
+                    };
+                    readonly appliesTo: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly uniqueItems: true;
+                        readonly description: "List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy).";
+                    };
+                    readonly priority: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly maximum: 1000;
+                        readonly description: "When multiple policies match a request, evaluation order is by priority descending. The first to return a non-`null` decision wins.";
+                    };
+                    readonly enabled: {
+                        readonly type: "boolean";
+                        readonly default: true;
+                    };
+                    readonly version: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly updatedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/policy/upsert/0.3/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../src/policy/upsert/0.3/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAGxE,MAAM,WAAW,mBAAmB;IAClC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;AAElC,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,+CAAwD,CAAC;AAEjF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC;AAE1C,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,wDAAiE,CAAC;AAEnG,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,2BAA2B,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyJjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuG1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}