@openvtc/trust-tasks 0.2.54 → 0.2.56

package/src/vta/contexts/did-templates/list/1.0/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vta/contexts/did-templates/list/1.0/payload.schema.json
  */
 
+/**
+ * Resolved scope of the stored template.
+ */
+export type Scope = Builtin | Global | Context;
+
 /**
  * List the DID templates scoped to a context on a VTA. Gated on context access. The success response is the set of persisted DidTemplateRecords for the context.
  */
@@ -19,9 +24,72 @@ export interface VTAContextDIDTemplateListPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * The templates scoped to the context.
+ */
+export interface VTAContextDIDTemplateListResponsePayload {
+  /**
+   * Templates scoped to the context, sorted by name; empty when none exist.
+   */
+  templates: DidTemplateRecord[];
+  ext?: Ext1;
+}
+/**
+ * A persisted template plus provenance. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata.
+ */
+export interface DidTemplateRecord {
+  schemaVersion: 1;
+  name: string;
+  kind: string;
+  description?: string | null;
+  methods?: string[];
+  requiredVars?: string[];
+  optionalVars?: {
+    [k: string]: unknown | undefined;
+  };
+  defaults?: {
+    [k: string]: unknown | undefined;
+  };
+  document: {};
+  scope: Scope;
+  /**
+   * UTC unix-epoch seconds the template was first stored.
+   */
+  createdAt: number;
+  /**
+   * UTC unix-epoch seconds of the last write.
+   */
+  updatedAt: number;
+  /**
+   * DID of the admin who last wrote the template.
+   */
+  createdBy: string;
+}
+export interface Builtin {
+  type: "builtin";
+}
+export interface Global {
+  type: "global";
+}
+export interface Context {
+  type: "context";
+  contextId: string;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext1 {
+  [k: string]: unknown | undefined;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/contexts/did-templates/list/1.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = Scope;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/contexts/did-templates/list/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAContextDIDTemplateListResponsePayload;

package/src/vta/contexts/did-templates/render/1.0/payload.ts

@@ -29,9 +29,31 @@ export interface VTAContextDIDTemplateRenderPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * The rendered DID document with all placeholders filled.
+ */
+export interface VTAContextDIDTemplateRenderResponsePayload {
+  /**
+   * The rendered DID document.
+   */
+  document: {};
+  ext?: Ext1;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext1 {
+  [k: string]: unknown | undefined;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/contexts/did-templates/render/1.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAContextDIDTemplateRenderPayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/contexts/did-templates/render/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAContextDIDTemplateRenderResponsePayload;

package/src/vta/contexts/did-templates/update/1.0/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vta/contexts/did-templates/update/1.0/payload.schema.json
  */
 
+/**
+ * Resolved scope of the stored template.
+ */
+export type Scope = Builtin | Global | Context;
+
 /**
  * Replace an existing DID template scoped to a context on a VTA. Gated on the context's admin (or super-admin). `name` is the resource id within the context scope and MUST equal `template.name`. The VTA preserves the original createdAt/createdBy and advances updatedAt. The success response is the persisted DidTemplateRecord.
  */
@@ -69,9 +74,56 @@ export interface DidTemplate {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * The persisted DidTemplateRecord after replacement. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by create/get.
+ */
+export interface VTAContextDIDTemplateUpdateResponsePayload {
+  schemaVersion: 1;
+  name: string;
+  kind: string;
+  description?: string | null;
+  methods?: string[];
+  requiredVars?: string[];
+  optionalVars?: {
+    [k: string]: unknown | undefined;
+  };
+  defaults?: {
+    [k: string]: unknown | undefined;
+  };
+  document: {};
+  scope: Scope;
+  /**
+   * UTC unix-epoch seconds the template was first stored. Preserved across an update.
+   */
+  createdAt: number;
+  /**
+   * UTC unix-epoch seconds of the last write. Advanced by this update.
+   */
+  updatedAt: number;
+  /**
+   * DID of the admin who last wrote the template.
+   */
+  createdBy: string;
+}
+export interface Builtin {
+  type: "builtin";
+}
+export interface Global {
+  type: "global";
+}
+export interface Context {
+  type: "context";
+  contextId: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/contexts/did-templates/update/1.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = Scope;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/contexts/did-templates/update/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAContextDIDTemplateUpdateResponsePayload;

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

@@ -3,6 +3,11 @@
  * Source: specs/vta/credentials/issue/0.1/payload.schema.json
  */
 
+/**
+ * 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).
@@ -32,9 +37,40 @@ export interface VTACredentialsIssuePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * 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.
+ */
+export interface VTACredentialsIssueResponsePayload {
+  credentialId: CredentialId;
+  /**
+   * When the credential's validUntil falls due.
+   */
+  expiresAt: string;
+  /**
+   * The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuing context's key.
+   */
+  credential: {};
+  /**
+   * credentialId of the previously-active credential this issuance revoked, for claims profiles with a single-active rule (GovernancePolicyCredential). Mirrors policy/activate's previousPolicyId: it makes the rotation auditable and reversible. Absent when nothing was displaced.
+   */
+  supersedes?: string;
+  ext?: Ext1;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext1 {
+  [k: string]: unknown | undefined;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/credentials/issue/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = CredentialId;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/credentials/issue/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACredentialsIssueResponsePayload;

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

@@ -7,6 +7,10 @@
  * The id of the credential to revoke (as returned by vta/credentials/issue).
  */
 export type CredentialId = string;
+/**
+ * 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 CredentialId1 = string;
 
 export interface VTACredentialsRevokePayload {
   credentialId: CredentialId;
@@ -22,9 +26,36 @@ export interface VTACredentialsRevokePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * The success response to a vta/credentials/revoke request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/credentials/revoke/0.1#response.
+ */
+export interface VTACredentialsRevokeResponsePayload {
+  credentialId: CredentialId1;
+  /**
+   * When the revocation was recorded.
+   */
+  revokedAt: string;
+  /**
+   * When the revoked credential carried a credentialStatus entry (claims-profile credentials such as GovernancePolicyCredential), the published status-list index whose bit was flipped — so the caller can confirm the externally-visible effect. Absent for credentials without published status.
+   */
+  statusListIndex?: number;
+  ext?: Ext1;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext1 {
+  [k: string]: unknown | undefined;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/credentials/revoke/0.1" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = CredentialId;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/credentials/revoke/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTACredentialsRevokeResponsePayload;

package/src/vta/did-templates/create/1.0/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vta/did-templates/create/1.0/payload.schema.json
  */
 
+/**
+ * Resolved scope of the stored template.
+ */
+export type Scope = Builtin | Global | Context;
+
 /**
  * Create a new global DID template on a VTA. Super-admin gated. The template's own `name` is the resource id within the global scope; the VTA refuses duplicates (use update to replace). The success response is the persisted DidTemplateRecord.
  */
@@ -61,9 +66,56 @@ export interface DidTemplate {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * The persisted DidTemplateRecord. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/update.
+ */
+export interface VTADIDTemplateCreateResponsePayload {
+  schemaVersion: 1;
+  name: string;
+  kind: string;
+  description?: string | null;
+  methods?: string[];
+  requiredVars?: string[];
+  optionalVars?: {
+    [k: string]: unknown | undefined;
+  };
+  defaults?: {
+    [k: string]: unknown | undefined;
+  };
+  document: {};
+  scope: Scope;
+  /**
+   * UTC unix-epoch seconds the template was first stored.
+   */
+  createdAt: number;
+  /**
+   * UTC unix-epoch seconds of the last write.
+   */
+  updatedAt: number;
+  /**
+   * DID of the admin who last wrote the template.
+   */
+  createdBy: string;
+}
+export interface Builtin {
+  type: "builtin";
+}
+export interface Global {
+  type: "global";
+}
+export interface Context {
+  type: "context";
+  contextId: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/create/1.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = Scope;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/create/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTADIDTemplateCreateResponsePayload;

package/src/vta/did-templates/create/2.0/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vta/did-templates/create/2.0/payload.schema.json
  */
 
+/**
+ * Resolved scope of the stored template.
+ */
+export type Scope = Builtin | Global | Context;
+
 /**
  * Create a new DID template on a VTA. Omit `contextId` to create in the global scope (super-admin gated); set it to create a template scoped to that context (gated on the context's admin, or a super-admin). The template's own `name` is the resource id within the selected scope; the VTA refuses duplicates (use update to replace). The success response is the persisted DidTemplateRecord.
  */
@@ -65,9 +70,56 @@ export interface DidTemplate {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * A persisted template. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/create/update and carried per-item by list.
+ */
+export interface DidTemplateRecord {
+  schemaVersion: 1;
+  name: string;
+  kind: string;
+  description?: string | null;
+  methods?: string[];
+  requiredVars?: string[];
+  optionalVars?: {
+    [k: string]: unknown | undefined;
+  };
+  defaults?: {
+    [k: string]: unknown | undefined;
+  };
+  document: {};
+  scope: Scope;
+  /**
+   * UTC unix-epoch seconds the template was first stored.
+   */
+  createdAt: number;
+  /**
+   * UTC unix-epoch seconds of the last write.
+   */
+  updatedAt: number;
+  /**
+   * DID of the admin who last wrote the template.
+   */
+  createdBy: string;
+}
+export interface Builtin {
+  type: "builtin";
+}
+export interface Global {
+  type: "global";
+}
+export interface Context {
+  type: "context";
+  contextId: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/create/2.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = Scope;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/create/2.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = DidTemplateRecord;

package/src/vta/did-templates/delete/1.0/payload.ts

@@ -19,9 +19,35 @@ export interface VTADIDTemplateDeletePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * Confirmation that the named global template was removed.
+ */
+export interface VTADIDTemplateDeleteResponsePayload {
+  /**
+   * The deleted template's name, echoed for audit pipelines.
+   */
+  name: string;
+  /**
+   * Always true on success.
+   */
+  deleted: boolean;
+  ext?: Ext1;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext1 {
+  [k: string]: unknown | undefined;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/delete/1.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTADIDTemplateDeletePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/delete/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTADIDTemplateDeleteResponsePayload;

package/src/vta/did-templates/delete/2.0/payload.ts

@@ -23,9 +23,35 @@ export interface VTADIDTemplateDeletePayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * Confirmation that the named template was removed from the selected scope.
+ */
+export interface VTADIDTemplateDeleteResponsePayload {
+  /**
+   * The deleted template's name, echoed for audit pipelines.
+   */
+  name: string;
+  /**
+   * Always true on success.
+   */
+  deleted: boolean;
+  ext?: Ext1;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext1 {
+  [k: string]: unknown | undefined;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/delete/2.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTADIDTemplateDeletePayload;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/delete/2.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTADIDTemplateDeleteResponsePayload;

package/src/vta/did-templates/get/1.0/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vta/did-templates/get/1.0/payload.schema.json
  */
 
+/**
+ * Resolved scope of the stored template.
+ */
+export type Scope = Builtin | Global | Context;
+
 /**
  * Fetch one global DID template on a VTA by name. Open to any authenticated caller. The success response is the persisted DidTemplateRecord.
  */
@@ -19,9 +24,56 @@ export interface VTADIDTemplateGetPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * The persisted DidTemplateRecord. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by create/update.
+ */
+export interface VTADIDTemplateGetResponsePayload {
+  schemaVersion: 1;
+  name: string;
+  kind: string;
+  description?: string | null;
+  methods?: string[];
+  requiredVars?: string[];
+  optionalVars?: {
+    [k: string]: unknown | undefined;
+  };
+  defaults?: {
+    [k: string]: unknown | undefined;
+  };
+  document: {};
+  scope: Scope;
+  /**
+   * UTC unix-epoch seconds the template was first stored.
+   */
+  createdAt: number;
+  /**
+   * UTC unix-epoch seconds of the last write.
+   */
+  updatedAt: number;
+  /**
+   * DID of the admin who last wrote the template.
+   */
+  createdBy: string;
+}
+export interface Builtin {
+  type: "builtin";
+}
+export interface Global {
+  type: "global";
+}
+export interface Context {
+  type: "context";
+  contextId: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/1.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = Scope;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/1.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTADIDTemplateGetResponsePayload;

package/src/vta/did-templates/get/2.0/payload.ts

@@ -3,6 +3,11 @@
  * Source: specs/vta/did-templates/get/2.0/payload.schema.json
  */
 
+/**
+ * Resolved scope of the stored template.
+ */
+export type Scope = Builtin | Global | Context;
+
 /**
  * Fetch one DID template on a VTA by name. Omit `contextId` to read from the global scope (any authenticated caller); set it to read a template scoped to that context (requires access to the context). The success response is the persisted DidTemplateRecord.
  */
@@ -23,9 +28,56 @@ export interface VTADIDTemplateGetPayload {
 export interface Ext {
   [k: string]: unknown | undefined;
 }
+/**
+ * A persisted template. The DidTemplate fields are flattened at the top level alongside the resolved scope and provenance metadata. Same shape returned by get/create/update and carried per-item by list.
+ */
+export interface DidTemplateRecord {
+  schemaVersion: 1;
+  name: string;
+  kind: string;
+  description?: string | null;
+  methods?: string[];
+  requiredVars?: string[];
+  optionalVars?: {
+    [k: string]: unknown | undefined;
+  };
+  defaults?: {
+    [k: string]: unknown | undefined;
+  };
+  document: {};
+  scope: Scope;
+  /**
+   * UTC unix-epoch seconds the template was first stored.
+   */
+  createdAt: number;
+  /**
+   * UTC unix-epoch seconds of the last write.
+   */
+  updatedAt: number;
+  /**
+   * DID of the admin who last wrote the template.
+   */
+  createdBy: string;
+}
+export interface Builtin {
+  type: "builtin";
+}
+export interface Global {
+  type: "global";
+}
+export interface Context {
+  type: "context";
+  contextId: string;
+}
 
 /** Trust Task type URI. */
 export const TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/2.0" as const;
 
+/** Stable alias for this specification's request payload shape. */
+export type Payload = Scope;
+
 /** Trust Task response type URI (request type URI + "#response"). */
 export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/did-templates/get/2.0#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = DidTemplateRecord;