@openvtc/trust-tasks 0.28.17 → 0.28.18

package/src/vtn/registry/status/0.1/payload.ts

@@ -0,0 +1,502 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/registry/status/0.1/payload.schema.json
+ */
+
+import type { Did_VtnV0_1 as Did, Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * An administrator's request for how the network's membership stands in its trust registry. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNRegistryStatusPayload {
+  ext?: Ext;
+}
+export interface VTNRegistryStatusResponsePayload {
+  registry: Did;
+  authority: Did;
+  resource: string;
+  actions: {
+    member: string;
+    listed: string;
+  };
+  publishes: "members" | "membersAndListed";
+  writer: string;
+  connected: boolean;
+  lastSync?: Sync;
+  reachable: boolean;
+  records?: Row[];
+  reason?: string;
+  ext?: Ext;
+}
+export interface Sync {
+  /**
+   * When the reconcile ran.
+   */
+  reconciledAt?: string;
+  /**
+   * Records the entries project.
+   */
+  expected: number;
+  /**
+   * Records written, by party.
+   */
+  put: string[];
+  /**
+   * Records deleted, as `party action`.
+   */
+  deleted: string[];
+  /**
+   * Writes that failed, as `party: why`.
+   */
+  failed: string[];
+  /**
+   * Why nothing could be written at all, when so.
+   */
+  blocked?: string;
+}
+export interface Row {
+  did: Did;
+  /**
+   * The action the entries project, if any.
+   */
+  projected?: string;
+  /**
+   * The action the registry holds, if any.
+   */
+  held?: string;
+  result: "ok" | "missing" | "stale" | "wrong";
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Did, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtn/registry/status/0.1" as const;
+
+/**
+ * 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 const EXTENDS: string | null = 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 const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTNRegistryStatusPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtn/registry/status/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNRegistryStatusResponsePayload;
+
+/**
+ * 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/vtn/registry/status/0.1",
+  "title": "VTN Registry — Status — payload",
+  "description": "An administrator's request for how the network's membership stands in its trust registry. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Sync": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "expected",
+        "put",
+        "deleted",
+        "failed"
+      ],
+      "properties": {
+        "reconciledAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the reconcile ran."
+        },
+        "expected": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Records the entries project."
+        },
+        "put": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Records written, by party."
+        },
+        "deleted": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Records deleted, as `party action`."
+        },
+        "failed": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Writes that failed, as `party: why`."
+        },
+        "blocked": {
+          "type": "string",
+          "description": "Why nothing could be written at all, when so."
+        }
+      }
+    },
+    "Row": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "result"
+      ],
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/Did"
+        },
+        "projected": {
+          "type": "string",
+          "description": "The action the entries project, if any."
+        },
+        "held": {
+          "type": "string",
+          "description": "The action the registry holds, if any."
+        },
+        "result": {
+          "enum": [
+            "ok",
+            "missing",
+            "stale",
+            "wrong"
+          ]
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Registry — Status — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registry",
+        "authority",
+        "resource",
+        "actions",
+        "publishes",
+        "writer",
+        "connected",
+        "reachable"
+      ],
+      "properties": {
+        "registry": {
+          "$ref": "#/$defs/Did"
+        },
+        "authority": {
+          "$ref": "#/$defs/Did"
+        },
+        "resource": {
+          "type": "string",
+          "minLength": 1
+        },
+        "actions": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "member",
+            "listed"
+          ],
+          "properties": {
+            "member": {
+              "type": "string",
+              "minLength": 1
+            },
+            "listed": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        "publishes": {
+          "enum": [
+            "members",
+            "membersAndListed"
+          ]
+        },
+        "writer": {
+          "type": "string",
+          "maxLength": 1024
+        },
+        "connected": {
+          "type": "boolean"
+        },
+        "lastSync": {
+          "$ref": "#/$defs/Sync"
+        },
+        "reachable": {
+          "type": "boolean"
+        },
+        "records": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Row"
+          }
+        },
+        "reason": {
+          "type": "string",
+          "maxLength": 1024
+        },
+        "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-]+)+$"
+      }
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    }
+  }
+} 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": {
+    "Sync": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "expected",
+        "put",
+        "deleted",
+        "failed"
+      ],
+      "properties": {
+        "reconciledAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the reconcile ran."
+        },
+        "expected": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Records the entries project."
+        },
+        "put": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Records written, by party."
+        },
+        "deleted": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Records deleted, as `party action`."
+        },
+        "failed": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Writes that failed, as `party: why`."
+        },
+        "blocked": {
+          "type": "string",
+          "description": "Why nothing could be written at all, when so."
+        }
+      }
+    },
+    "Row": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "result"
+      ],
+      "properties": {
+        "did": {
+          "$ref": "#/$defs/Did"
+        },
+        "projected": {
+          "type": "string",
+          "description": "The action the entries project, if any."
+        },
+        "held": {
+          "type": "string",
+          "description": "The action the registry holds, if any."
+        },
+        "result": {
+          "enum": [
+            "ok",
+            "missing",
+            "stale",
+            "wrong"
+          ]
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTN Registry — Status — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registry",
+        "authority",
+        "resource",
+        "actions",
+        "publishes",
+        "writer",
+        "connected",
+        "reachable"
+      ],
+      "properties": {
+        "registry": {
+          "$ref": "#/$defs/Did"
+        },
+        "authority": {
+          "$ref": "#/$defs/Did"
+        },
+        "resource": {
+          "type": "string",
+          "minLength": 1
+        },
+        "actions": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "member",
+            "listed"
+          ],
+          "properties": {
+            "member": {
+              "type": "string",
+              "minLength": 1
+            },
+            "listed": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        "publishes": {
+          "enum": [
+            "members",
+            "membersAndListed"
+          ]
+        },
+        "writer": {
+          "type": "string",
+          "maxLength": 1024
+        },
+        "connected": {
+          "type": "boolean"
+        },
+        "lastSync": {
+          "$ref": "#/$defs/Sync"
+        },
+        "reachable": {
+          "type": "boolean"
+        },
+        "records": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/Row"
+          }
+        },
+        "reason": {
+          "type": "string",
+          "maxLength": 1024
+        },
+        "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-]+)+$"
+      }
+    },
+    "Did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$",
+      "maxLength": 2048,
+      "description": "A DID."
+    }
+  }
+} 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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;