@openvtc/trust-tasks 0.21.11 → 0.21.13

package/src/vtc/vetting/auto-grant/show/0.1/payload.ts

@@ -0,0 +1,297 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/vetting/auto-grant/show/0.1/payload.schema.json
+ */
+
+import type { AutoGrantStatus, AutoGrantSweep, Ext, GrantValiditySeconds, SweepMinutes } from "../../../../../_shared/components.js";
+
+
+/**
+ * An empty request. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCVettingAutoGrantShowPayload {
+  ext?: Ext;
+}
+export interface VTCVettingAutoGrantShowResponsePayload {
+  autoGrant: AutoGrantStatus;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AutoGrantStatus, AutoGrantSweep, Ext, GrantValiditySeconds, SweepMinutes };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/auto-grant/show/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCVettingAutoGrantShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/auto-grant/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCVettingAutoGrantShowResponsePayload;
+
+/**
+ * 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/vtc/vetting/auto-grant/show/0.1",
+  "title": "VTC Vetting — Auto-Grant — Show — payload",
+  "description": "An empty request. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting — Auto-Grant — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "autoGrant"
+      ],
+      "properties": {
+        "autoGrant": {
+          "$ref": "#/$defs/AutoGrantStatus"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AutoGrantStatus": {
+      "title": "AutoGrantStatus",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "enabled",
+        "sweepMinutes",
+        "validitySeconds"
+      ],
+      "description": "The effective configuration — defaults filled in — and the last sweep.",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the sweep runs."
+        },
+        "sweepMinutes": {
+          "$ref": "#/$defs/SweepMinutes"
+        },
+        "validitySeconds": {
+          "$ref": "#/$defs/GrantValiditySeconds"
+        },
+        "lastSweep": {
+          "$ref": "#/$defs/AutoGrantSweep"
+        }
+      }
+    },
+    "AutoGrantSweep": {
+      "title": "AutoGrantSweep",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ranAt",
+        "granted",
+        "revoked",
+        "errors"
+      ],
+      "description": "What one sweep did.",
+      "properties": {
+        "ranAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the sweep finished."
+        },
+        "granted": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Grants issued."
+        },
+        "revoked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Automatic grants revoked. The sweep revokes only grants it issued."
+        },
+        "errors": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Members the sweep could not decide or act on."
+        }
+      }
+    },
+    "GrantValiditySeconds": {
+      "title": "GrantValiditySeconds",
+      "type": "integer",
+      "minimum": 86400,
+      "maximum": 63072000,
+      "description": "Validity of a grant the sweep issues, in seconds: between one day and two years, the bounds vtc/vetting/vetters/grant applies to an administrator's grants."
+    },
+    "SweepMinutes": {
+      "title": "SweepMinutes",
+      "type": "integer",
+      "minimum": 5,
+      "maximum": 1440,
+      "description": "Minutes between sweeps: at most every five minutes, at least once a day."
+    }
+  }
+} 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": "VTC Vetting — Auto-Grant — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "autoGrant"
+      ],
+      "properties": {
+        "autoGrant": {
+          "$ref": "#/$defs/AutoGrantStatus"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AutoGrantStatus": {
+      "title": "AutoGrantStatus",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "enabled",
+        "sweepMinutes",
+        "validitySeconds"
+      ],
+      "description": "The effective configuration — defaults filled in — and the last sweep.",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the sweep runs."
+        },
+        "sweepMinutes": {
+          "$ref": "#/$defs/SweepMinutes"
+        },
+        "validitySeconds": {
+          "$ref": "#/$defs/GrantValiditySeconds"
+        },
+        "lastSweep": {
+          "$ref": "#/$defs/AutoGrantSweep"
+        }
+      }
+    },
+    "AutoGrantSweep": {
+      "title": "AutoGrantSweep",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ranAt",
+        "granted",
+        "revoked",
+        "errors"
+      ],
+      "description": "What one sweep did.",
+      "properties": {
+        "ranAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the sweep finished."
+        },
+        "granted": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Grants issued."
+        },
+        "revoked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Automatic grants revoked. The sweep revokes only grants it issued."
+        },
+        "errors": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Members the sweep could not decide or act on."
+        }
+      }
+    },
+    "GrantValiditySeconds": {
+      "title": "GrantValiditySeconds",
+      "type": "integer",
+      "minimum": 86400,
+      "maximum": 63072000,
+      "description": "Validity of a grant the sweep issues, in seconds: between one day and two years, the bounds vtc/vetting/vetters/grant applies to an administrator's grants."
+    },
+    "SweepMinutes": {
+      "title": "SweepMinutes",
+      "type": "integer",
+      "minimum": 5,
+      "maximum": 1440,
+      "description": "Minutes between sweeps: at most every five minutes, at least once a day."
+    }
+  }
+} 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vtc/vetting/auto-grant/update/0.1/payload.ts

@@ -0,0 +1,316 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/vetting/auto-grant/update/0.1/payload.schema.json
+ */
+
+import type { AutoGrantStatus, AutoGrantSweep, Ext, GrantValiditySeconds, SweepMinutes } from "../../../../../_shared/components.js";
+
+
+/**
+ * The whole configuration; an absent member takes its default. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCVettingAutoGrantUpdatePayload {
+  /**
+   * Whether the sweep runs.
+   */
+  enabled: boolean;
+  sweepMinutes?: SweepMinutes;
+  validitySeconds?: GrantValiditySeconds;
+  ext?: Ext;
+}
+export interface VTCVettingAutoGrantUpdateResponsePayload {
+  autoGrant: AutoGrantStatus;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AutoGrantStatus, AutoGrantSweep, Ext, GrantValiditySeconds, SweepMinutes };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/auto-grant/update/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCVettingAutoGrantUpdatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/auto-grant/update/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCVettingAutoGrantUpdateResponsePayload;
+
+/**
+ * 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/vtc/vetting/auto-grant/update/0.1",
+  "title": "VTC Vetting — Auto-Grant — Update — payload",
+  "description": "The whole configuration; an absent member takes its default. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "enabled"
+  ],
+  "properties": {
+    "enabled": {
+      "type": "boolean",
+      "description": "Whether the sweep runs."
+    },
+    "sweepMinutes": {
+      "$ref": "#/$defs/SweepMinutes"
+    },
+    "validitySeconds": {
+      "$ref": "#/$defs/GrantValiditySeconds"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting — Auto-Grant — Update — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "autoGrant"
+      ],
+      "properties": {
+        "autoGrant": {
+          "$ref": "#/$defs/AutoGrantStatus"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AutoGrantStatus": {
+      "title": "AutoGrantStatus",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "enabled",
+        "sweepMinutes",
+        "validitySeconds"
+      ],
+      "description": "The effective configuration — defaults filled in — and the last sweep.",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the sweep runs."
+        },
+        "sweepMinutes": {
+          "$ref": "#/$defs/SweepMinutes"
+        },
+        "validitySeconds": {
+          "$ref": "#/$defs/GrantValiditySeconds"
+        },
+        "lastSweep": {
+          "$ref": "#/$defs/AutoGrantSweep"
+        }
+      }
+    },
+    "AutoGrantSweep": {
+      "title": "AutoGrantSweep",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ranAt",
+        "granted",
+        "revoked",
+        "errors"
+      ],
+      "description": "What one sweep did.",
+      "properties": {
+        "ranAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the sweep finished."
+        },
+        "granted": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Grants issued."
+        },
+        "revoked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Automatic grants revoked. The sweep revokes only grants it issued."
+        },
+        "errors": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Members the sweep could not decide or act on."
+        }
+      }
+    },
+    "GrantValiditySeconds": {
+      "title": "GrantValiditySeconds",
+      "type": "integer",
+      "minimum": 86400,
+      "maximum": 63072000,
+      "description": "Validity of a grant the sweep issues, in seconds: between one day and two years, the bounds vtc/vetting/vetters/grant applies to an administrator's grants."
+    },
+    "SweepMinutes": {
+      "title": "SweepMinutes",
+      "type": "integer",
+      "minimum": 5,
+      "maximum": 1440,
+      "description": "Minutes between sweeps: at most every five minutes, at least once a day."
+    }
+  }
+} 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": "VTC Vetting — Auto-Grant — Update — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "autoGrant"
+      ],
+      "properties": {
+        "autoGrant": {
+          "$ref": "#/$defs/AutoGrantStatus"
+        },
+        "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-]+)+$"
+      }
+    },
+    "AutoGrantStatus": {
+      "title": "AutoGrantStatus",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "enabled",
+        "sweepMinutes",
+        "validitySeconds"
+      ],
+      "description": "The effective configuration — defaults filled in — and the last sweep.",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the sweep runs."
+        },
+        "sweepMinutes": {
+          "$ref": "#/$defs/SweepMinutes"
+        },
+        "validitySeconds": {
+          "$ref": "#/$defs/GrantValiditySeconds"
+        },
+        "lastSweep": {
+          "$ref": "#/$defs/AutoGrantSweep"
+        }
+      }
+    },
+    "AutoGrantSweep": {
+      "title": "AutoGrantSweep",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "ranAt",
+        "granted",
+        "revoked",
+        "errors"
+      ],
+      "description": "What one sweep did.",
+      "properties": {
+        "ranAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the sweep finished."
+        },
+        "granted": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Grants issued."
+        },
+        "revoked": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Automatic grants revoked. The sweep revokes only grants it issued."
+        },
+        "errors": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Members the sweep could not decide or act on."
+        }
+      }
+    },
+    "GrantValiditySeconds": {
+      "title": "GrantValiditySeconds",
+      "type": "integer",
+      "minimum": 86400,
+      "maximum": 63072000,
+      "description": "Validity of a grant the sweep issues, in seconds: between one day and two years, the bounds vtc/vetting/vetters/grant applies to an administrator's grants."
+    },
+    "SweepMinutes": {
+      "title": "SweepMinutes",
+      "type": "integer",
+      "minimum": 5,
+      "maximum": 1440,
+      "description": "Minutes between sweeps: at most every five minutes, at least once a day."
+    }
+  }
+} 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;