@openvtc/trust-tasks 0.21.11 → 0.21.13

package/src/vtc/_shared/0.1/website-transfer.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/_shared/0.1/website-transfer.schema.json
+ */
+
+/**
+ * Shared types for the vtc/website/upload/*, vtc/website/deploy and vtc/website/files/show tasks: how bytes of a community's website move as Trust Task documents. Chunking reuses, by reference from each task, the node-neutral chunked-transfer vocabulary of vta/_shared/0.1/backup-transfer (ChunkManifest, ChunkIndex, ChunkData, ExpectedSha256, ExpectedSizeBytes, ExpiresAt), so a producer that implements backup/put-chunk implements these chunks the same way. Not itself a Trust Task specification (the `_shared` folder is skipped by the registry build and the codegen).
+ */
+export interface VTCSharedWebsiteTransferDefinitions {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { FileData, UploadId, UploadTarget, WebsiteEtag, WebsitePath } from "../../../_shared/components.js";

package/src/vtc/community/branding/show/0.1/payload.ts

@@ -0,0 +1,207 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/community/branding/show/0.1/payload.schema.json
+ */
+
+import type { CommunityBranding, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * An empty request: the community has one such setting. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCCommunityBrandingShowPayload {
+  ext?: Ext;
+}
+export interface VTCCommunityBrandingShowResponsePayload {
+  branding: CommunityBranding;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CommunityBranding, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/community/branding/show/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCCommunityBrandingShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/community/branding/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCCommunityBrandingShowResponsePayload;
+
+/**
+ * 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/community/branding/show/0.1",
+  "title": "VTC Community — Branding — Show — payload",
+  "description": "An empty request: the community has one such setting. 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 Community — Branding — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "branding"
+      ],
+      "properties": {
+        "branding": {
+          "$ref": "#/$defs/CommunityBranding"
+        },
+        "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-]+)+$"
+      }
+    },
+    "CommunityBranding": {
+      "title": "CommunityBranding",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "OPTIONAL. How the community asks to be shown to a prospective applicant: a name, an accent colour and a logo. Presentation only, self-asserted and unverified — `communityDid` identifies the community, never `branding`. Not part of any criterion, so not covered by a `requirementsDigest`. Every member is optional.",
+      "properties": {
+        "displayName": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community's name as it asks to be shown."
+        },
+        "accentColor": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$",
+          "description": "An sRGB colour as `#rrggbb`, compared case-insensitively. A community SHOULD write it in lower case."
+        },
+        "logoUrl": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://",
+          "maxLength": 2048,
+          "description": "An https URL of the community's logo. Fetched by the client, so an untrusted image from wherever it points."
+        },
+        "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": "VTC Community — Branding — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "branding"
+      ],
+      "properties": {
+        "branding": {
+          "$ref": "#/$defs/CommunityBranding"
+        },
+        "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-]+)+$"
+      }
+    },
+    "CommunityBranding": {
+      "title": "CommunityBranding",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "OPTIONAL. How the community asks to be shown to a prospective applicant: a name, an accent colour and a logo. Presentation only, self-asserted and unverified — `communityDid` identifies the community, never `branding`. Not part of any criterion, so not covered by a `requirementsDigest`. Every member is optional.",
+      "properties": {
+        "displayName": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community's name as it asks to be shown."
+        },
+        "accentColor": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$",
+          "description": "An sRGB colour as `#rrggbb`, compared case-insensitively. A community SHOULD write it in lower case."
+        },
+        "logoUrl": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://",
+          "maxLength": 2048,
+          "description": "An https URL of the community's logo. Fetched by the client, so an untrusted image from wherever it points."
+        },
+        "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: 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/community/branding/update/0.1/payload.ts

@@ -0,0 +1,214 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/community/branding/update/0.1/payload.schema.json
+ */
+
+import type { CommunityBranding, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * The whole new value, which replaces the stored one. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCCommunityBrandingUpdatePayload {
+  branding: CommunityBranding;
+  ext?: Ext;
+}
+export interface VTCCommunityBrandingUpdateResponsePayload {
+  branding: CommunityBranding;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { CommunityBranding, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/community/branding/update/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCCommunityBrandingUpdatePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/community/branding/update/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCCommunityBrandingUpdateResponsePayload;
+
+/**
+ * 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/community/branding/update/0.1",
+  "title": "VTC Community — Branding — Update — payload",
+  "description": "The whole new value, which replaces the stored one. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "branding"
+  ],
+  "properties": {
+    "branding": {
+      "$ref": "#/$defs/CommunityBranding"
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Community — Branding — Update — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "branding"
+      ],
+      "properties": {
+        "branding": {
+          "$ref": "#/$defs/CommunityBranding"
+        },
+        "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-]+)+$"
+      }
+    },
+    "CommunityBranding": {
+      "title": "CommunityBranding",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "OPTIONAL. How the community asks to be shown to a prospective applicant: a name, an accent colour and a logo. Presentation only, self-asserted and unverified — `communityDid` identifies the community, never `branding`. Not part of any criterion, so not covered by a `requirementsDigest`. Every member is optional.",
+      "properties": {
+        "displayName": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community's name as it asks to be shown."
+        },
+        "accentColor": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$",
+          "description": "An sRGB colour as `#rrggbb`, compared case-insensitively. A community SHOULD write it in lower case."
+        },
+        "logoUrl": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://",
+          "maxLength": 2048,
+          "description": "An https URL of the community's logo. Fetched by the client, so an untrusted image from wherever it points."
+        },
+        "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": "VTC Community — Branding — Update — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "branding"
+      ],
+      "properties": {
+        "branding": {
+          "$ref": "#/$defs/CommunityBranding"
+        },
+        "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-]+)+$"
+      }
+    },
+    "CommunityBranding": {
+      "title": "CommunityBranding",
+      "type": "object",
+      "additionalProperties": false,
+      "description": "OPTIONAL. How the community asks to be shown to a prospective applicant: a name, an accent colour and a logo. Presentation only, self-asserted and unverified — `communityDid` identifies the community, never `branding`. Not part of any criterion, so not covered by a `requirementsDigest`. Every member is optional.",
+      "properties": {
+        "displayName": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The community's name as it asks to be shown."
+        },
+        "accentColor": {
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$",
+          "description": "An sRGB colour as `#rrggbb`, compared case-insensitively. A community SHOULD write it in lower case."
+        },
+        "logoUrl": {
+          "type": "string",
+          "format": "uri",
+          "pattern": "^https://",
+          "maxLength": 2048,
+          "description": "An https URL of the community's logo. Fetched by the client, so an untrusted image from wherever it points."
+        },
+        "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/vtc/community/join-discovery/show/0.1/payload.ts

@@ -0,0 +1,185 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/community/join-discovery/show/0.1/payload.schema.json
+ */
+
+import type { Ext, JoinDiscovery } from "../../../../../_shared/components.js";
+
+
+/**
+ * An empty request: the community has one such setting. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTCCommunityJoinDiscoveryShowPayload {
+  ext?: Ext;
+}
+export interface VTCCommunityJoinDiscoveryShowResponsePayload {
+  joinDiscovery: JoinDiscovery;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, JoinDiscovery };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/community/join-discovery/show/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCCommunityJoinDiscoveryShowPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/community/join-discovery/show/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCCommunityJoinDiscoveryShowResponsePayload;
+
+/**
+ * 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/community/join-discovery/show/0.1",
+  "title": "VTC Community — Join Discovery — Show — payload",
+  "description": "An empty request: the community has one such setting. 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 Community — Join Discovery — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "joinDiscovery"
+      ],
+      "properties": {
+        "joinDiscovery": {
+          "$ref": "#/$defs/JoinDiscovery"
+        },
+        "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-]+)+$"
+      }
+    },
+    "JoinDiscovery": {
+      "title": "JoinDiscovery",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "public"
+      ],
+      "description": "Whether this community answers vtc/join-requests/manifest to a caller it cannot identify.",
+      "properties": {
+        "public": {
+          "type": "boolean",
+          "description": "True: the manifest is answered to any caller, identified or not — the setting of every community that never chose, because the manifest is a public read by design (an applicant has to know what is asked of them before they disclose anything). False: the manifest is answered only to a caller the community can identify — one with a verified proof or a transport-authenticated sender. Not secrecy: an identified caller is answered either way. False makes the answer attributable, which is what a closed or invite-only community wants rather than a crawler enumerating its criteria."
+        },
+        "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": "VTC Community — Join Discovery — Show — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "joinDiscovery"
+      ],
+      "properties": {
+        "joinDiscovery": {
+          "$ref": "#/$defs/JoinDiscovery"
+        },
+        "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-]+)+$"
+      }
+    },
+    "JoinDiscovery": {
+      "title": "JoinDiscovery",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "public"
+      ],
+      "description": "Whether this community answers vtc/join-requests/manifest to a caller it cannot identify.",
+      "properties": {
+        "public": {
+          "type": "boolean",
+          "description": "True: the manifest is answered to any caller, identified or not — the setting of every community that never chose, because the manifest is a public read by design (an applicant has to know what is asked of them before they disclose anything). False: the manifest is answered only to a caller the community can identify — one with a verified proof or a transport-authenticated sender. Not secrecy: an identified caller is answered either way. False makes the answer attributable, which is what a closed or invite-only community wants rather than a crawler enumerating its criteria."
+        },
+        "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: 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;