@openvtc/trust-tasks 0.2.60 → 0.4.0

package/src/trust-task-error/0.3/payload.ts

@@ -0,0 +1,80 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/trust-task-error/0.3/payload.schema.json
+ */
+
+/**
+ * The canonical error-response payload per SPEC.md §8.2.
+ */
+export interface TrustTaskErrorPayload {
+  /**
+   * Short identifier for the failure category. MUST be either a framework standard code (SPEC.md §8.3) or an extended code namespaced by the originating spec's slug (SPEC.md §8.5, e.g. 'acl/grant:role_not_recognized').
+   */
+  code: (
+    | (
+        | "malformedRequest"
+        | "unsupportedType"
+        | "unsupportedVersion"
+        | "expired"
+        | "proofRequired"
+        | "proofInvalid"
+        | "permissionDenied"
+        | "wrongRecipient"
+        | "identityMismatch"
+        | "taskFailed"
+        | "unavailable"
+        | "internalError"
+      )
+    | {
+        [k: string]: unknown | undefined;
+      }
+  ) &
+    string;
+  /**
+   * Identifies the Trust Task document this error reports on. RECOMMENDED on every error response, and REQUIRED in practice for any error a third party may later be asked to rely on: threadId correlates the exchange only for a party that saw the request, so without this an error retained as evidence names neither the task it terminated nor the instance.
+   */
+  inResponseTo?: {
+    /**
+     * The Type URI of the document being reported on, including any #request or #response fragment it carried. This is what tells a consumer which specification's semantics apply to an extended code, and which specification declared the requirement that was breached.
+     */
+    typeUri: string;
+    /**
+     * The id of the specific document being reported on (SPEC §4.3). Globally unique and never reused, so it names one instance where threadId names an exchange. Omit only where echoing it would disclose more than the error already does.
+     */
+    id?: string;
+  };
+  /**
+   * Human-readable description of the error. Non-normative; intended for logs and operator UI.
+   */
+  message?: string;
+  /**
+   * true if the producer of the original document MAY retry; false if retrying with the same document is not expected to succeed.
+   */
+  retryable: boolean;
+  /**
+   * RFC 3339 timestamp before which the producer SHOULD NOT retry. Meaningful only when retryable is true.
+   */
+  retryAfter?: string;
+  /**
+   * Optional task-specific extension data. Per-spec error code declarations may pin the shape via a JSON Schema fragment.
+   */
+  details?: {};
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/trust-task-error/0.3" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = TrustTaskErrorPayload;
+
+/**
+ * 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.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: false,
+  isRecipientRequired: true,
+} as const;

package/src/vta/credentials/issue/0.1/payload.ts

@@ -39,6 +39,8 @@ export interface Ext {
 }
 /**
  * The success response to a vta/credentials/issue request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/credentials/issue/0.1#response.
+ *
+ * This is the credentials/_shared IssuedCredential shape — same members, same required set — plus `supersedes` and `ext`. It states them inline rather than `$ref`-ing the shared definition because that definition sets `additionalProperties: false`, which under `allOf` would reject the two extra members. The shared CredentialId is still referenced. Keep the two in step by hand if either changes.
  */
 export interface VTACredentialsIssueResponsePayload {
   credentialId: CredentialId;

package/src/vta/credentials/issue/0.2/payload.ts

@@ -0,0 +1,101 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/credentials/issue/0.2/payload.schema.json
+ */
+
+/**
+ * The success response to a vta/credentials/issue request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/credentials/issue/0.1#response.
+ *
+ * Composed from the shared IssuedCredential rather than restating it: that definition is the issuance receipt every issuer returns, and duplicating it here let the two drift silently. `unevaluatedProperties` closes the object after the `allOf` is applied, which is what makes the composition possible at all — `additionalProperties` is evaluated per-subschema against the whole object and would reject `supersedes` and `ext`.
+ */
+export type VTACredentialsIssueResponsePayload = IssuedCredentialBase;
+/**
+ * Stable identifier for an issued credential — the handle for revocation and audit. Opaque to the holder: it MUST be echoed verbatim when revoking and MUST NOT be parsed.
+ */
+export type CredentialId = string;
+
+export interface VTACredentialsIssuePayload {
+  /**
+   * DID of the credential's subject/holder (becomes credentialSubject.id).
+   */
+  holder: string;
+  /**
+   * The scoped claims to attest — the share's scope. Opaque to the framework; non-empty.
+   */
+  claims: {};
+  /**
+   * Additional credential type beyond VerifiableCredential (e.g. ScopedShareCredential). Some values name a claims profile defined by this specification (e.g. GovernancePolicyCredential), which constrains the shape of `claims`.
+   */
+  credentialType?: string;
+  /**
+   * Credential lifetime in seconds from issuance. The issuer MAY cap this.
+   */
+  validitySeconds: number;
+  /**
+   * Optional human-readable rationale, recorded for audit.
+   */
+  purpose?: string;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * The members of an issuance receipt, deliberately left **open** so a consuming specification can `$ref` it under `allOf` and add its own, then close the result with `unevaluatedProperties: false`.
+ *
+ * A closure inside this definition would defeat that. Both `additionalProperties` and `unevaluatedProperties` are evaluated against the whole instance from within the subschema that declares them, and neither can see members the *outer* schema matched — so either one here rejects the consumer's extras. Only an `unevaluatedProperties` at the outer level sees everything the composition matched. Use `IssuedCredential` where a closed standalone shape is wanted.
+ */
+export interface IssuedCredentialBase {
+  credentialId: CredentialId;
+  /**
+   * The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuer's key. Opaque to the framework.
+   */
+  credential: {};
+  /**
+   * When the credential was minted.
+   */
+  issuedAt?: string;
+  /**
+   * When the credential's validUntil falls due.
+   */
+  expiresAt: string;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/credentials/issue/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTACredentialsIssueResponsePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/credentials/issue/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACredentialsIssueResponsePayload;
+
+/**
+ * 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.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+} 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,
+} as const;

package/src/vtc/relationships/request/0.1/payload.ts

@@ -0,0 +1,71 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/relationships/request/0.1/payload.schema.json
+ */
+
+/**
+ * A member asks another member to issue them a Verifiable Relationship Credential. Everything here is a hint: the issuing member decides, and declines with a trust-task-error carrying `vtc/relationships/request:declined` rather than a bespoke rejection message.
+ */
+export interface VTCRelationshipsRequestPayload {
+  /**
+   * Why the requester is asking, in their own words, for the issuing member to weigh. A hint and not a term — the issuing member is under no obligation to honour it, and MUST NOT treat its absence as a defect. Free text reaching a human, so a producer SHOULD keep it to what it is willing to have quoted back.
+   */
+  reason?: string;
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+/**
+ * The issued credential. Returned only where the issuing member agreed; a decline is a trust-task-error, not a response with an empty field.
+ */
+export interface VTCRelationshipsRequestResponsePayload {
+  /**
+   * A signed W3C Verifiable Relationship Credential (opaque here). Its issuer MUST be the issuing member — the party that signed this response — and its credentialSubject.id MUST name the requester. The same shape `vtc/relationships/publish` accepts, so a requester can lodge it with the community unchanged.
+   */
+  vrc: {};
+  /**
+   * SHA-256 of the returned VRC, for out-of-band integrity checks. Matches the digest `vtc/relationships/publish` reports once the credential is lodged, so the two can be tied together without re-hashing.
+   */
+  vrcSha256?: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/request/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCRelationshipsRequestPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/relationships/request/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCRelationshipsRequestResponsePayload;
+
+/**
+ * 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.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+} 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,
+} as const;