@openvtc/trust-tasks 0.25.0 → 0.25.2

package/src/vtc/vetting/hidden/show/0.1/payload.ts

@@ -3,14 +3,9 @@
  * Source: specs/vtc/vetting/hidden/show/0.1/payload.schema.json
  */
 
-import type { Ext } from "../../../../../_shared/components.js";
+import type { Ext, PublishedConfig, PublishedEvent, StoredConfig, StoredEvent, TickLength, Tier } from "../../../../../_shared/components.js";
 
 
-/**
- * The length of one tick of the drip, as an ISO 8601 duration in days and/or hours — at least `PT1H`. A label's tick `t` is the window starting `t` tick lengths after the label's start (`vtc/vetting/vetters/pcs-tokens`).
- */
-export type TickLength = string;
-
 /**
  * Read one criterion's stored hidden-vetting configuration, what it publishes, and the aggregate counts an administrator needs to run it. The outer document members are owned by the framework — SPEC §6.3.
  */
@@ -48,85 +43,6 @@ export interface VTCVettingHiddenShowResponsePayload {
   requirementsDigest: string | null;
   ext?: Ext;
 }
-/**
- * The parameters exactly as the community stores them, including the helper key it never publishes.
- */
-export interface StoredConfig {
-  /**
-   * The blind-signature suite in force, e.g. ps-ddh-bls12381.
-   */
-  suite: string;
-  /**
-   * The helper verification key, multibase. A public value, published as helperKey.
-   */
-  hvk: string;
-  /**
-   * The token verification key, multibase. Never the same key as hvk.
-   */
-  tvk: string;
-  /**
-   * Live vetter class periods, current first, stored as the bare YYYY-MM period.
-   */
-  livePeriods: string[];
-  liveTokenLabels: string[];
-  dripPerTick: number;
-  tickLength: TickLength;
-  events: StoredEvent[];
-}
-export interface StoredEvent {
-  eventId: string;
-  startDate: string;
-  endDate: string;
-  graceDays: number;
-  groupFloor: number;
-  tiers: Tier[];
-  /**
-   * Who approved the event, or null when nobody has. Recorded in storage only — dropped from the published shape (see published.events).
-   */
-  approvedBy?: string | null;
-}
-export interface Tier {
-  /**
-   * How the menu names it: desk, busy-desk.
-   */
-  name: string;
-  /**
-   * How many tokens a tick under this tier yields.
-   */
-  dripPerTick: number;
-}
-/**
- * The parameters exactly as they now appear in this community's join manifest, under vetting.ext. What an applicant and a vetter read.
- */
-export interface PublishedConfig {
-  suite: string;
-  /**
-   * The helper verification key, multibase — named for its role on the wire rather than for hvk.
-   */
-  helperKey: string;
-  /**
-   * The token verification key, multibase — named for its role on the wire rather than for tvk.
-   */
-  tokenKey: string;
-  /**
-   * Class labels published whole, e.g. vetter/2026-09 — a request names one of these, not the bare period.
-   */
-  vetterLabels: string[];
-  tokenLabels: string[];
-  dripPerTick: number;
-  tickLength: TickLength;
-  events: PublishedEvent[];
-}
-/**
- * The published shape drops approvedBy and graceDays: who approved is the community's own record, and a vetter is told closesAfter when its request is approved rather than being handed the raw grace period here.
- */
-export interface PublishedEvent {
-  eventId: string;
-  startDate: string;
-  endDate: string;
-  groupFloor: number;
-  tiers: Tier[];
-}
 /**
  * How one stored event stands today. Counts only — never which members asked.
  */
@@ -151,7 +67,7 @@ export interface EventStatus {
 }
 
 /** Shared definitions this specification references, re-exported under the names it used to declare them with. */
-export type { Ext };
+export type { Ext, PublishedConfig, PublishedEvent, StoredConfig, StoredEvent, TickLength, Tier };
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vtc/vetting/hidden/show/0.1" as const;
@@ -195,72 +111,182 @@ export const PAYLOAD_SCHEMA = {
     }
   },
   "$defs": {
-    "Tier": {
-      "title": "Tier",
+    "EventStatus": {
+      "title": "EventStatus",
+      "description": "How one stored event stands today. Counts only — never which members asked.",
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "name",
-        "dripPerTick"
+        "eventId",
+        "groupFloor",
+        "groupSize",
+        "approved",
+        "live"
       ],
       "properties": {
-        "name": {
+        "eventId": {
           "type": "string",
-          "minLength": 1,
-          "description": "How the menu names it: desk, busy-desk."
+          "minLength": 1
         },
-        "dripPerTick": {
+        "groupFloor": {
           "type": "integer",
           "minimum": 1,
-          "description": "How many tokens a tick under this tier yields."
+          "description": "The smallest group this community will open the label for, as stored."
+        },
+        "groupSize": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many members have asked to vet at this event through vtc/vetting/vetters/event-mode. The same count event-mode already returns to a vetter."
+        },
+        "approved": {
+          "type": "boolean",
+          "description": "Whether the stored event names an approver."
+        },
+        "live": {
+          "type": "boolean",
+          "description": "Derived: approved, groupSize at least groupFloor, and today no later than endDate plus graceDays."
         }
       }
     },
-    "StoredEvent": {
-      "title": "StoredEvent",
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Vetting — Hidden — Show — response payload",
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "eventId",
-        "startDate",
-        "endDate",
-        "graceDays",
-        "groupFloor",
-        "tiers"
+        "criterionId",
+        "enabled",
+        "requirementsDigest"
       ],
+      "dependentRequired": {
+        "stored": [
+          "published",
+          "enrolledVetters",
+          "eventStatus"
+        ],
+        "published": [
+          "stored"
+        ],
+        "enrolledVetters": [
+          "stored"
+        ],
+        "eventStatus": [
+          "stored"
+        ]
+      },
       "properties": {
-        "eventId": {
+        "criterionId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The criterion read."
+        },
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether the criterion carries hidden-vetting parameters. When false, stored, published, enrolledVetters and eventStatus are absent."
+        },
+        "stored": {
+          "$ref": "#/$defs/StoredConfig"
+        },
+        "published": {
+          "$ref": "#/$defs/PublishedConfig"
+        },
+        "enrolledVetters": {
+          "type": "object",
+          "description": "For each live class label (vetter/<period>), how many members hold an enrolment under it. Counts only.",
+          "propertyNames": {
+            "pattern": "^vetter/[0-9]{4}-(0[1-9]|1[0-2])$"
+          },
+          "additionalProperties": {
+            "type": "integer",
+            "minimum": 0
+          }
+        },
+        "eventStatus": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/EventStatus"
+          },
+          "description": "One entry per stored event, in stored order."
+        },
+        "requirementsDigest": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The criterion's current requirementsDigest. Null only when its manifest entry carries none."
+        },
+        "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-]+)+$"
+      }
+    },
+    "PublishedConfig": {
+      "title": "PublishedConfig",
+      "description": "The parameters exactly as they now appear in this community's join manifest, under vetting.ext. What an applicant and a vetter read.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "suite",
+        "helperKey",
+        "tokenKey",
+        "vetterLabels",
+        "tokenLabels",
+        "dripPerTick",
+        "tickLength",
+        "events"
+      ],
+      "properties": {
+        "suite": {
           "type": "string",
           "minLength": 1
         },
-        "startDate": {
+        "helperKey": {
           "type": "string",
-          "format": "date"
+          "minLength": 1,
+          "description": "The helper verification key, multibase — named for its role on the wire rather than for hvk."
         },
-        "endDate": {
+        "tokenKey": {
           "type": "string",
-          "format": "date"
+          "minLength": 1,
+          "description": "The token verification key, multibase — named for its role on the wire rather than for tvk."
         },
-        "graceDays": {
-          "type": "integer",
-          "minimum": 0
+        "vetterLabels": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Class labels published whole, e.g. vetter/2026-09 — a request names one of these, not the bare period."
         },
-        "groupFloor": {
+        "tokenLabels": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "dripPerTick": {
           "type": "integer",
           "minimum": 1
         },
-        "tiers": {
+        "tickLength": {
+          "$ref": "#/$defs/TickLength"
+        },
+        "events": {
           "type": "array",
           "items": {
-            "$ref": "#/$defs/Tier"
+            "$ref": "#/$defs/PublishedEvent"
           }
-        },
-        "approvedBy": {
-          "type": [
-            "string",
-            "null"
-          ],
-          "description": "Who approved the event, or null when nobody has. Recorded in storage only — dropped from the published shape (see published.events)."
         }
       }
     },
@@ -301,6 +327,33 @@ export const PAYLOAD_SCHEMA = {
         }
       }
     },
+    "Tier": {
+      "title": "Tier",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "dripPerTick"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "How the menu names it: desk, busy-desk."
+        },
+        "dripPerTick": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "How many tokens a tick under this tier yields."
+        }
+      }
+    },
+    "TickLength": {
+      "title": "TickLength",
+      "type": "string",
+      "pattern": "^P(?:\\d+D(?:T\\d+H)?|T\\d+H)$",
+      "description": "The length of one tick of the drip, as an ISO 8601 duration in days and/or hours — at least `PT1H`. A label's tick `t` is the window starting `t` tick lengths after the label's start (`vtc/vetting/vetters/pcs-tokens`)."
+    },
     "StoredConfig": {
       "title": "StoredConfig",
       "description": "The parameters exactly as the community stores them, including the helper key it never publishes.",
@@ -362,66 +415,62 @@ export const PAYLOAD_SCHEMA = {
         }
       }
     },
-    "PublishedConfig": {
-      "title": "PublishedConfig",
-      "description": "The parameters exactly as they now appear in this community's join manifest, under vetting.ext. What an applicant and a vetter read.",
+    "StoredEvent": {
+      "title": "StoredEvent",
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "suite",
-        "helperKey",
-        "tokenKey",
-        "vetterLabels",
-        "tokenLabels",
-        "dripPerTick",
-        "tickLength",
-        "events"
+        "eventId",
+        "startDate",
+        "endDate",
+        "graceDays",
+        "groupFloor",
+        "tiers"
       ],
       "properties": {
-        "suite": {
+        "eventId": {
           "type": "string",
           "minLength": 1
         },
-        "helperKey": {
+        "startDate": {
           "type": "string",
-          "minLength": 1,
-          "description": "The helper verification key, multibase — named for its role on the wire rather than for hvk."
+          "format": "date"
         },
-        "tokenKey": {
+        "endDate": {
           "type": "string",
-          "minLength": 1,
-          "description": "The token verification key, multibase — named for its role on the wire rather than for tvk."
-        },
-        "vetterLabels": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "minLength": 1
-          },
-          "description": "Class labels published whole, e.g. vetter/2026-09 — a request names one of these, not the bare period."
+          "format": "date"
         },
-        "tokenLabels": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "minLength": 1
-          }
+        "graceDays": {
+          "type": "integer",
+          "minimum": 0
         },
-        "dripPerTick": {
+        "groupFloor": {
           "type": "integer",
           "minimum": 1
         },
-        "tickLength": {
-          "$ref": "#/$defs/TickLength"
-        },
-        "events": {
+        "tiers": {
           "type": "array",
           "items": {
-            "$ref": "#/$defs/PublishedEvent"
+            "$ref": "#/$defs/Tier"
           }
+        },
+        "approvedBy": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "Who approved the event, or null when nobody has. Recorded in storage only — dropped from the published shape (see published.events)."
         }
       }
-    },
+    }
+  }
+} 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": {
     "EventStatus": {
       "title": "EventStatus",
       "description": "How one stored event stands today. Counts only — never which members asked.",
@@ -531,12 +580,6 @@ export const PAYLOAD_SCHEMA = {
         }
       }
     },
-    "TickLength": {
-      "title": "TickLength",
-      "type": "string",
-      "pattern": "^P(?:\\d+D(?:T\\d+H)?|T\\d+H)$",
-      "description": "The length of one tick of the drip, as an ISO 8601 duration in days and/or hours — at least `PT1H`. A label's tick `t` is the window starting `t` tick lengths after the label's start (`vtc/vetting/vetters/pcs-tokens`)."
-    },
     "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.",
@@ -546,81 +589,64 @@ export const PAYLOAD_SCHEMA = {
       "propertyNames": {
         "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
       }
-    }
-  }
-} 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": {
-    "Tier": {
-      "title": "Tier",
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "name",
-        "dripPerTick"
-      ],
-      "properties": {
-        "name": {
-          "type": "string",
-          "minLength": 1,
-          "description": "How the menu names it: desk, busy-desk."
-        },
-        "dripPerTick": {
-          "type": "integer",
-          "minimum": 1,
-          "description": "How many tokens a tick under this tier yields."
-        }
-      }
     },
-    "StoredEvent": {
-      "title": "StoredEvent",
+    "PublishedConfig": {
+      "title": "PublishedConfig",
+      "description": "The parameters exactly as they now appear in this community's join manifest, under vetting.ext. What an applicant and a vetter read.",
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "eventId",
-        "startDate",
-        "endDate",
-        "graceDays",
-        "groupFloor",
-        "tiers"
+        "suite",
+        "helperKey",
+        "tokenKey",
+        "vetterLabels",
+        "tokenLabels",
+        "dripPerTick",
+        "tickLength",
+        "events"
       ],
       "properties": {
-        "eventId": {
+        "suite": {
           "type": "string",
           "minLength": 1
         },
-        "startDate": {
+        "helperKey": {
           "type": "string",
-          "format": "date"
+          "minLength": 1,
+          "description": "The helper verification key, multibase — named for its role on the wire rather than for hvk."
         },
-        "endDate": {
+        "tokenKey": {
           "type": "string",
-          "format": "date"
+          "minLength": 1,
+          "description": "The token verification key, multibase — named for its role on the wire rather than for tvk."
         },
-        "graceDays": {
-          "type": "integer",
-          "minimum": 0
+        "vetterLabels": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Class labels published whole, e.g. vetter/2026-09 — a request names one of these, not the bare period."
         },
-        "groupFloor": {
+        "tokenLabels": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "dripPerTick": {
           "type": "integer",
           "minimum": 1
         },
-        "tiers": {
+        "tickLength": {
+          "$ref": "#/$defs/TickLength"
+        },
+        "events": {
           "type": "array",
           "items": {
-            "$ref": "#/$defs/Tier"
+            "$ref": "#/$defs/PublishedEvent"
           }
-        },
-        "approvedBy": {
-          "type": [
-            "string",
-            "null"
-          ],
-          "description": "Who approved the event, or null when nobody has. Recorded in storage only — dropped from the published shape (see published.events)."
         }
       }
     },
@@ -661,6 +687,33 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         }
       }
     },
+    "Tier": {
+      "title": "Tier",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "dripPerTick"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "description": "How the menu names it: desk, busy-desk."
+        },
+        "dripPerTick": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "How many tokens a tick under this tier yields."
+        }
+      }
+    },
+    "TickLength": {
+      "title": "TickLength",
+      "type": "string",
+      "pattern": "^P(?:\\d+D(?:T\\d+H)?|T\\d+H)$",
+      "description": "The length of one tick of the drip, as an ISO 8601 duration in days and/or hours — at least `PT1H`. A label's tick `t` is the window starting `t` tick lengths after the label's start (`vtc/vetting/vetters/pcs-tokens`)."
+    },
     "StoredConfig": {
       "title": "StoredConfig",
       "description": "The parameters exactly as the community stores them, including the helper key it never publishes.",
@@ -722,190 +775,53 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         }
       }
     },
-    "PublishedConfig": {
-      "title": "PublishedConfig",
-      "description": "The parameters exactly as they now appear in this community's join manifest, under vetting.ext. What an applicant and a vetter read.",
+    "StoredEvent": {
+      "title": "StoredEvent",
       "type": "object",
       "additionalProperties": false,
       "required": [
-        "suite",
-        "helperKey",
-        "tokenKey",
-        "vetterLabels",
-        "tokenLabels",
-        "dripPerTick",
-        "tickLength",
-        "events"
+        "eventId",
+        "startDate",
+        "endDate",
+        "graceDays",
+        "groupFloor",
+        "tiers"
       ],
       "properties": {
-        "suite": {
+        "eventId": {
           "type": "string",
           "minLength": 1
         },
-        "helperKey": {
+        "startDate": {
           "type": "string",
-          "minLength": 1,
-          "description": "The helper verification key, multibase — named for its role on the wire rather than for hvk."
+          "format": "date"
         },
-        "tokenKey": {
+        "endDate": {
           "type": "string",
-          "minLength": 1,
-          "description": "The token verification key, multibase — named for its role on the wire rather than for tvk."
-        },
-        "vetterLabels": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "minLength": 1
-          },
-          "description": "Class labels published whole, e.g. vetter/2026-09 — a request names one of these, not the bare period."
-        },
-        "tokenLabels": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "minLength": 1
-          }
+          "format": "date"
         },
-        "dripPerTick": {
+        "graceDays": {
           "type": "integer",
-          "minimum": 1
-        },
-        "tickLength": {
-          "$ref": "#/$defs/TickLength"
-        },
-        "events": {
-          "type": "array",
-          "items": {
-            "$ref": "#/$defs/PublishedEvent"
-          }
-        }
-      }
-    },
-    "EventStatus": {
-      "title": "EventStatus",
-      "description": "How one stored event stands today. Counts only — never which members asked.",
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "eventId",
-        "groupFloor",
-        "groupSize",
-        "approved",
-        "live"
-      ],
-      "properties": {
-        "eventId": {
-          "type": "string",
-          "minLength": 1
+          "minimum": 0
         },
         "groupFloor": {
           "type": "integer",
-          "minimum": 1,
-          "description": "The smallest group this community will open the label for, as stored."
-        },
-        "groupSize": {
-          "type": "integer",
-          "minimum": 0,
-          "description": "How many members have asked to vet at this event through vtc/vetting/vetters/event-mode. The same count event-mode already returns to a vetter."
-        },
-        "approved": {
-          "type": "boolean",
-          "description": "Whether the stored event names an approver."
-        },
-        "live": {
-          "type": "boolean",
-          "description": "Derived: approved, groupSize at least groupFloor, and today no later than endDate plus graceDays."
-        }
-      }
-    },
-    "Response": {
-      "$anchor": "response",
-      "title": "VTC Vetting — Hidden — Show — response payload",
-      "type": "object",
-      "additionalProperties": false,
-      "required": [
-        "criterionId",
-        "enabled",
-        "requirementsDigest"
-      ],
-      "dependentRequired": {
-        "stored": [
-          "published",
-          "enrolledVetters",
-          "eventStatus"
-        ],
-        "published": [
-          "stored"
-        ],
-        "enrolledVetters": [
-          "stored"
-        ],
-        "eventStatus": [
-          "stored"
-        ]
-      },
-      "properties": {
-        "criterionId": {
-          "type": "string",
-          "minLength": 1,
-          "description": "The criterion read."
-        },
-        "enabled": {
-          "type": "boolean",
-          "description": "Whether the criterion carries hidden-vetting parameters. When false, stored, published, enrolledVetters and eventStatus are absent."
-        },
-        "stored": {
-          "$ref": "#/$defs/StoredConfig"
-        },
-        "published": {
-          "$ref": "#/$defs/PublishedConfig"
-        },
-        "enrolledVetters": {
-          "type": "object",
-          "description": "For each live class label (vetter/<period>), how many members hold an enrolment under it. Counts only.",
-          "propertyNames": {
-            "pattern": "^vetter/[0-9]{4}-(0[1-9]|1[0-2])$"
-          },
-          "additionalProperties": {
-            "type": "integer",
-            "minimum": 0
-          }
+          "minimum": 1
         },
-        "eventStatus": {
+        "tiers": {
           "type": "array",
           "items": {
-            "$ref": "#/$defs/EventStatus"
-          },
-          "description": "One entry per stored event, in stored order."
+            "$ref": "#/$defs/Tier"
+          }
         },
-        "requirementsDigest": {
+        "approvedBy": {
           "type": [
             "string",
             "null"
           ],
-          "description": "The criterion's current requirementsDigest. Null only when its manifest entry carries none."
-        },
-        "ext": {
-          "$ref": "#/$defs/Ext"
+          "description": "Who approved the event, or null when nobody has. Recorded in storage only — dropped from the published shape (see published.events)."
         }
       }
-    },
-    "TickLength": {
-      "title": "TickLength",
-      "type": "string",
-      "pattern": "^P(?:\\d+D(?:T\\d+H)?|T\\d+H)$",
-      "description": "The length of one tick of the drip, as an ISO 8601 duration in days and/or hours — at least `PT1H`. A label's tick `t` is the window starting `t` tick lengths after the label's start (`vtc/vetting/vetters/pcs-tokens`)."
-    },
-    "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-]+)+$"
-      }
     }
   }
 } as const;