@openvtc/trust-tasks 0.27.3 → 0.27.5

package/src/policy/upsert/0.3/payload.ts

@@ -0,0 +1,341 @@
+/**
+ * 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 const TYPE_URI = "https://trusttasks.org/spec/policy/upsert/0.3" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = PolicyUpsertPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/policy/upsert/0.3#response" as const;
+
+/** 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 const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/policy/upsert/0.3",
+  "title": "Policy Upsert — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "name",
+    "module"
+  ],
+  "properties": {
+    "id": {
+      "type": "string",
+      "minLength": 1
+    },
+    "expectedVersion": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "description": {
+      "type": "string",
+      "maxLength": 1024
+    },
+    "module": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Rego source. The maintainer parses and validates against its evaluator before persisting; a syntactically invalid module is rejected."
+    },
+    "appliesTo": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true
+    },
+    "priority": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 1000
+    },
+    "enabled": {
+      "type": "boolean",
+      "default": true
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Policy Upsert — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "policy",
+        "wasCreated"
+      ],
+      "properties": {
+        "policy": {
+          "$ref": "#/$defs/PolicyModule"
+        },
+        "wasCreated": {
+          "type": "boolean"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "PolicyModule": {
+      "title": "PolicyModule",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "module",
+        "version",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Human-readable name (e.g. \"default vault policy\", \"bank-site step-up\")."
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 1024
+        },
+        "module": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Rego source code. The maintainer's evaluator entry point is the package's `decision` rule, returning a PolicyDecision."
+        },
+        "appliesTo": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "uniqueItems": true,
+          "description": "List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy)."
+        },
+        "priority": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000,
+          "description": "When multiple policies match a request, evaluation order is by priority descending. The first to return a non-`null` decision wins."
+        },
+        "enabled": {
+          "type": "boolean",
+          "default": true
+        },
+        "version": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Policy Upsert — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "policy",
+        "wasCreated"
+      ],
+      "properties": {
+        "policy": {
+          "$ref": "#/$defs/PolicyModule"
+        },
+        "wasCreated": {
+          "type": "boolean"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "PolicyModule": {
+      "title": "PolicyModule",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "name",
+        "module",
+        "version",
+        "createdAt",
+        "updatedAt"
+      ],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "Human-readable name (e.g. \"default vault policy\", \"bank-site step-up\")."
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 1024
+        },
+        "module": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Rego source code. The maintainer's evaluator entry point is the package's `decision` rule, returning a PolicyDecision."
+        },
+        "appliesTo": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "uniqueItems": true,
+          "description": "List of trust contexts this policy applies to. Empty array = applies to all contexts (the default policy)."
+        },
+        "priority": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 1000,
+          "description": "When multiple policies match a request, evaluation order is by priority descending. The first to return a non-`null` decision wins."
+        },
+        "enabled": {
+          "type": "boolean",
+          "default": true
+        },
+        "version": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

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

@@ -0,0 +1,299 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/registry/record/put/0.2/payload.schema.json
+ */
+
+import type { Ext, RecordType, 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 const TYPE_URI = "https://trusttasks.org/spec/registry/record/put/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = RegistryRecordPutPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/registry/record/put/0.2#response" as const;
+
+/** 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 const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/registry/record/put/0.2",
+  "title": "Registry Record Put — payload",
+  "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.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "record"
+  ],
+  "properties": {
+    "record": {
+      "$ref": "#/$defs/TrustRecord"
+    },
+    "expectedExisting": {
+      "type": "boolean",
+      "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."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Registry Record Put — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ok",
+        "wasCreated"
+      ],
+      "properties": {
+        "ok": {
+          "type": "boolean",
+          "description": "Whether the record was stored."
+        },
+        "wasCreated": {
+          "type": "boolean",
+          "description": "True when the put created a new record, false when it replaced an existing one."
+        },
+        "message": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Optional human-readable detail."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "TrustRecord": {
+      "title": "TrustRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entity_id",
+        "authority_id",
+        "action",
+        "resource",
+        "record_type"
+      ],
+      "properties": {
+        "entity_id": {
+          "type": "string"
+        },
+        "authority_id": {
+          "type": "string"
+        },
+        "action": {
+          "type": "string"
+        },
+        "resource": {
+          "type": "string"
+        },
+        "recognized": {
+          "type": "boolean",
+          "description": "Present on recognition records: whether the action+resource is recognised."
+        },
+        "authorized": {
+          "type": "boolean",
+          "description": "Present on authorization records: whether the action+resource authorization is confirmed."
+        },
+        "context": {
+          "type": "object",
+          "description": "Opaque governance context attached to the record.",
+          "additionalProperties": true
+        },
+        "record_type": {
+          "$ref": "#/$defs/RecordType"
+        }
+      }
+    },
+    "RecordType": {
+      "title": "RecordType",
+      "type": "string",
+      "enum": [
+        "authorization",
+        "recognition"
+      ],
+      "description": "Whether the record asserts an authorization or a recognition relationship."
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Registry Record Put — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ok",
+        "wasCreated"
+      ],
+      "properties": {
+        "ok": {
+          "type": "boolean",
+          "description": "Whether the record was stored."
+        },
+        "wasCreated": {
+          "type": "boolean",
+          "description": "True when the put created a new record, false when it replaced an existing one."
+        },
+        "message": {
+          "type": "string",
+          "maxLength": 1024,
+          "description": "Optional human-readable detail."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "TrustRecord": {
+      "title": "TrustRecord",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "entity_id",
+        "authority_id",
+        "action",
+        "resource",
+        "record_type"
+      ],
+      "properties": {
+        "entity_id": {
+          "type": "string"
+        },
+        "authority_id": {
+          "type": "string"
+        },
+        "action": {
+          "type": "string"
+        },
+        "resource": {
+          "type": "string"
+        },
+        "recognized": {
+          "type": "boolean",
+          "description": "Present on recognition records: whether the action+resource is recognised."
+        },
+        "authorized": {
+          "type": "boolean",
+          "description": "Present on authorization records: whether the action+resource authorization is confirmed."
+        },
+        "context": {
+          "type": "object",
+          "description": "Opaque governance context attached to the record.",
+          "additionalProperties": true
+        },
+        "record_type": {
+          "$ref": "#/$defs/RecordType"
+        }
+      }
+    },
+    "RecordType": {
+      "title": "RecordType",
+      "type": "string",
+      "enum": [
+        "authorization",
+        "recognition"
+      ],
+      "description": "Whether the record asserts an authorization or a recognition relationship."
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;