@openvtc/trust-tasks 0.2.7 → 0.2.8

package/src/messaging/access-list/list/0.1/payload.ts

@@ -0,0 +1,34 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/access-list/list/0.1/payload.schema.json
+ */
+
+/**
+ * The target account's DID whose access list is being enumerated.
+ */
+export type Vid = string;
+
+export interface MessagingListAccessListPayload {
+  did: Vid;
+  /**
+   * Opaque pagination cursor from a previous page's nextCursor. Omitted on the first request; echoed verbatim thereafter. Opaque to the requester.
+   */
+  cursor?: string;
+  /**
+   * Maximum number of entries to return in this page. The mediator MAY apply a smaller server-side bound.
+   */
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/access-list/list/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/access-list/list/0.1#response" as const;

package/src/messaging/access-list/remove/0.1/payload.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/access-list/remove/0.1/payload.schema.json
+ */
+
+/**
+ * The target account's DID whose access list is being modified.
+ */
+export type Vid = string;
+/**
+ * A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID; carried verbatim and compared by exact string equality.
+ */
+export type Vid1 = string;
+
+export interface MessagingRemoveFromAccessListPayload {
+  did: Vid;
+  /**
+   * The DIDs to remove from the account's access list. Entries not present are ignored.
+   *
+   * @minItems 1
+   */
+  entries: [Vid1, ...Vid1[]];
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/access-list/remove/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/access-list/remove/0.1#response" as const;

package/src/messaging/account/add/0.1/payload.ts

@@ -0,0 +1,107 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/account/add/0.1/payload.schema.json
+ */
+
+/**
+ * The DID of the account to register.
+ */
+export type Vid = string;
+/**
+ * The role to assign the new account. Defaults to `standard`; assigning a non-standard role requires administrative standing (only a rootAdmin may assign rootAdmin).
+ */
+export type AccountType = "standard" | "admin" | "rootAdmin" | "mediator";
+
+export interface MessagingAddAccountPayload {
+  did: Vid;
+  accountType?: AccountType;
+  acl?: MediatorAcl;
+  queueLimits?: QueueLimits;
+  ext?: Ext;
+}
+/**
+ * Initial access-control capabilities. Members omitted take the mediator's configured defaults.
+ */
+export interface MediatorAcl {
+  /**
+   * How the account's access list is interpreted. `explicitAllow` = an allowlist (empty denies everyone); `explicitDeny` = a denylist (empty allows everyone).
+   */
+  accessListMode?: "explicitAllow" | "explicitDeny";
+  /**
+   * The account is blocked from authenticating and transacting.
+   */
+  blocked?: boolean;
+  /**
+   * Messages for this account may be stored locally at this mediator for pickup.
+   */
+  local?: boolean;
+  /**
+   * May send direct messages through the mediator.
+   */
+  sendMessages?: boolean;
+  /**
+   * May receive direct messages.
+   */
+  receiveMessages?: boolean;
+  /**
+   * May send routing/forward (relay) messages.
+   */
+  sendForwarded?: boolean;
+  /**
+   * May be the next hop of a forwarded message.
+   */
+  receiveForwarded?: boolean;
+  /**
+   * May create out-of-band invitations.
+   */
+  createInvites?: boolean;
+  /**
+   * Accepts anonymous (no authenticated sender) messages.
+   */
+  anonReceive?: boolean;
+  /**
+   * May self-manage its own access list.
+   */
+  selfManageList?: boolean;
+  /**
+   * May self-manage its own send-queue limit.
+   */
+  selfManageSendQueueLimit?: boolean;
+  /**
+   * May self-manage its own receive-queue limit.
+   */
+  selfManageReceiveQueueLimit?: boolean;
+  /**
+   * The account accepts DIDComm-protocol delivery. Default true; set false for a TSP-only node.
+   */
+  didcommEnabled?: boolean;
+  /**
+   * The account accepts TSP-protocol delivery. Default true; set false for a DIDComm-only node.
+   */
+  tspEnabled?: boolean;
+}
+/**
+ * Initial queued-message limits. Members omitted take the mediator's configured defaults.
+ */
+export interface QueueLimits {
+  /**
+   * Maximum queued send messages; -1 = unlimited.
+   */
+  sendQueueLimit?: number;
+  /**
+   * Maximum queued receive messages; -1 = unlimited.
+   */
+  receiveQueueLimit?: number;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/account/add/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/account/add/0.1#response" as const;

package/src/messaging/account/change-queue-limits/0.1/payload.ts

@@ -0,0 +1,40 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/account/change-queue-limits/0.1/payload.schema.json
+ */
+
+/**
+ * The DID of the account whose queue limits are being changed.
+ */
+export type Vid = string;
+
+export interface MessagingChangeAccountQueueLimitsPayload {
+  did: Vid;
+  queueLimits: QueueLimits;
+  ext?: Ext;
+}
+/**
+ * The limit members to apply. A member present is set; a member omitted is left unchanged (partial update). A value of -1 means unlimited.
+ */
+export interface QueueLimits {
+  /**
+   * Maximum queued send messages; -1 = unlimited.
+   */
+  sendQueueLimit?: number;
+  /**
+   * Maximum queued receive messages; -1 = unlimited.
+   */
+  receiveQueueLimit?: number;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/account/change-queue-limits/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/account/change-queue-limits/0.1#response" as const;

package/src/messaging/account/change-type/0.1/payload.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/account/change-type/0.1/payload.schema.json
+ */
+
+/**
+ * The DID of the account whose role is being changed.
+ */
+export type Vid = string;
+/**
+ * The role to assign. Assigning or modifying the rootAdmin role requires the requester to be a rootAdmin.
+ */
+export type AccountType = "standard" | "admin" | "rootAdmin" | "mediator";
+
+export interface MessagingChangeAccountTypePayload {
+  did: Vid;
+  accountType: AccountType;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/account/change-type/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/account/change-type/0.1#response" as const;

package/src/messaging/account/get/0.1/payload.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/account/get/0.1/payload.schema.json
+ */
+
+/**
+ * The DID of the account to fetch.
+ */
+export type Vid = string;
+
+export interface MessagingGetAccountPayload {
+  did: Vid;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/account/get/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/account/get/0.1#response" as const;

package/src/messaging/account/list/0.1/payload.ts

@@ -0,0 +1,28 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/account/list/0.1/payload.schema.json
+ */
+
+export interface MessagingListAccountsPayload {
+  /**
+   * Opaque continuation token from a prior page's nextCursor. Echoed verbatim; treated as unstructured by the requester.
+   */
+  cursor?: string;
+  /**
+   * Maximum number of accounts to return in this page. The mediator chooses a default when omitted.
+   */
+  limit?: number;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/account/list/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/account/list/0.1#response" as const;

package/src/messaging/account/remove/0.1/payload.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/account/remove/0.1/payload.schema.json
+ */
+
+/**
+ * The DID of the account to remove.
+ */
+export type Vid = string;
+
+export interface MessagingRemoveAccountPayload {
+  did: Vid;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/account/remove/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/account/remove/0.1#response" as const;

package/src/messaging/acl/get/0.1/payload.ts

@@ -0,0 +1,31 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/acl/get/0.1/payload.schema.json
+ */
+
+/**
+ * A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID; carried verbatim and compared by exact string equality.
+ */
+export type Vid = string;
+
+export interface MessagingGetACLPayload {
+  /**
+   * The accounts to query. One or more controlling DIDs whose ACLs are being read.
+   *
+   * @minItems 1
+   */
+  dids: [Vid, ...Vid[]];
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/acl/get/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/acl/get/0.1#response" as const;

package/src/messaging/acl/set/0.1/payload.ts

@@ -0,0 +1,88 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/acl/set/0.1/payload.schema.json
+ */
+
+/**
+ * The target account's DID whose capabilities are being set.
+ */
+export type Vid = string;
+
+export interface MessagingSetACLPayload {
+  did: Vid;
+  acl: MediatorAcl;
+  ext?: Ext;
+}
+/**
+ * The capability members to apply. Members present are set; members omitted are left unchanged (partial update).
+ */
+export interface MediatorAcl {
+  /**
+   * How the account's access list is interpreted. `explicitAllow` = an allowlist (empty denies everyone); `explicitDeny` = a denylist (empty allows everyone).
+   */
+  accessListMode?: "explicitAllow" | "explicitDeny";
+  /**
+   * The account is blocked from authenticating and transacting.
+   */
+  blocked?: boolean;
+  /**
+   * Messages for this account may be stored locally at this mediator for pickup.
+   */
+  local?: boolean;
+  /**
+   * May send direct messages through the mediator.
+   */
+  sendMessages?: boolean;
+  /**
+   * May receive direct messages.
+   */
+  receiveMessages?: boolean;
+  /**
+   * May send routing/forward (relay) messages.
+   */
+  sendForwarded?: boolean;
+  /**
+   * May be the next hop of a forwarded message.
+   */
+  receiveForwarded?: boolean;
+  /**
+   * May create out-of-band invitations.
+   */
+  createInvites?: boolean;
+  /**
+   * Accepts anonymous (no authenticated sender) messages.
+   */
+  anonReceive?: boolean;
+  /**
+   * May self-manage its own access list.
+   */
+  selfManageList?: boolean;
+  /**
+   * May self-manage its own send-queue limit.
+   */
+  selfManageSendQueueLimit?: boolean;
+  /**
+   * May self-manage its own receive-queue limit.
+   */
+  selfManageReceiveQueueLimit?: boolean;
+  /**
+   * The account accepts DIDComm-protocol delivery. Default true; set false for a TSP-only node.
+   */
+  didcommEnabled?: boolean;
+  /**
+   * The account accepts TSP-protocol delivery. Default true; set false for a DIDComm-only node.
+   */
+  tspEnabled?: boolean;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/acl/set/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/acl/set/0.1#response" as const;

package/src/messaging/ping/0.1/payload.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/messaging/ping/0.1/payload.schema.json
+ */
+
+export interface MessagingPingPayload {
+  /**
+   * Optional opaque value the requester may supply to correlate the response to this probe. The mediator echoes it verbatim in the response.
+   */
+  nonce?: string;
+  ext?: Ext;
+}
+/**
+ * Ecosystem-defined extension members per SPEC.md §4.5.1.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/messaging/ping/0.1" as const;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/messaging/ping/0.1#response" as const;