@openvtc/trust-tasks 0.21.3 → 0.21.5

package/src/did-management/stats/get/0.1/payload.ts

@@ -0,0 +1,237 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/stats/get/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface StatsGetPayload {
+  /**
+   * The slot whose counters are read. Absent means the hosting service's server-wide aggregate, which only an administrator may read.
+   */
+  mnemonic?: string;
+  /**
+   * Disambiguates `mnemonic` per the category conventions. Absent means the domain is resolved by the category's chain. MUST NOT be present without `mnemonic`: this task has no per-domain aggregate (did-management/stats/timeseries does).
+   */
+  domain?: string;
+  ext?: Ext;
+}
+export interface StatsGetResponsePayload {
+  /**
+   * Echo of the slot read. Absent on the server-wide aggregate.
+   */
+  mnemonic?: string;
+  /**
+   * Slots the hosting service holds. Present only on the server-wide aggregate.
+   */
+  totalDids?: number;
+  totalResolves: number;
+  totalUpdates: number;
+  /**
+   * Absent when the scope has never been resolved.
+   */
+  lastResolvedAt?: string;
+  /**
+   * Absent when the scope has never been updated.
+   */
+  lastUpdatedAt?: string;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/stats/get/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = StatsGetPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/stats/get/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = StatsGetResponsePayload;
+
+/**
+ * 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/did-management/stats/get/0.1",
+  "title": "Stats Get — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "mnemonic": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "The slot whose counters are read. Absent means the hosting service's server-wide aggregate, which only an administrator may read."
+    },
+    "domain": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 253,
+      "description": "Disambiguates `mnemonic` per the category conventions. Absent means the domain is resolved by the category's chain. MUST NOT be present without `mnemonic`: this task has no per-domain aggregate (did-management/stats/timeseries does)."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "dependentRequired": {
+    "domain": [
+      "mnemonic"
+    ]
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Stats Get — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "totalResolves",
+        "totalUpdates"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "description": "Echo of the slot read. Absent on the server-wide aggregate."
+        },
+        "totalDids": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Slots the hosting service holds. Present only on the server-wide aggregate."
+        },
+        "totalResolves": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalUpdates": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "lastResolvedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Absent when the scope has never been resolved."
+        },
+        "lastUpdatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Absent when the scope has never been updated."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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": "Stats Get — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "totalResolves",
+        "totalUpdates"
+      ],
+      "properties": {
+        "mnemonic": {
+          "type": "string",
+          "description": "Echo of the slot read. Absent on the server-wide aggregate."
+        },
+        "totalDids": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Slots the hosting service holds. Present only on the server-wide aggregate."
+        },
+        "totalResolves": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "totalUpdates": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "lastResolvedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Absent when the scope has never been resolved."
+        },
+        "lastUpdatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Absent when the scope has never been updated."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/did-management/stats/timeseries/0.1/payload.ts

@@ -0,0 +1,279 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/did-management/stats/timeseries/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+export interface StatsTimeseriesPayload {
+  /**
+   * The window ending now. The consumer chooses the bucket width and reports it as `bucketSeconds`.
+   */
+  range: "lastHour" | "lastDay" | "lastWeek" | "last30Days";
+  /**
+   * One slot's series. Absent means a domain's series when `domain` is present, else the server-wide series.
+   */
+  mnemonic?: string;
+  /**
+   * With `mnemonic`, disambiguates it per the category conventions. Without it, selects the sum over every slot on that domain. Absent with `mnemonic` absent means the server-wide series, which only an administrator may read.
+   */
+  domain?: string;
+  ext?: Ext;
+}
+export interface StatsTimeseriesResponsePayload {
+  range: "lastHour" | "lastDay" | "lastWeek" | "last30Days";
+  /**
+   * Width of each bucket.
+   */
+  bucketSeconds: number;
+  /**
+   * One point per bucket in the window, oldest first, including buckets with no activity.
+   */
+  points: {
+    /**
+     * Start of the bucket.
+     */
+    at: string;
+    resolves: number;
+    updates: number;
+  }[];
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/did-management/stats/timeseries/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = StatsTimeseriesPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/did-management/stats/timeseries/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = StatsTimeseriesResponsePayload;
+
+/**
+ * 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/did-management/stats/timeseries/0.1",
+  "title": "Stats Timeseries — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "range"
+  ],
+  "properties": {
+    "range": {
+      "type": "string",
+      "enum": [
+        "lastHour",
+        "lastDay",
+        "lastWeek",
+        "last30Days"
+      ],
+      "description": "The window ending now. The consumer chooses the bucket width and reports it as `bucketSeconds`."
+    },
+    "mnemonic": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "description": "One slot's series. Absent means a domain's series when `domain` is present, else the server-wide series."
+    },
+    "domain": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 253,
+      "description": "With `mnemonic`, disambiguates it per the category conventions. Without it, selects the sum over every slot on that domain. Absent with `mnemonic` absent means the server-wide series, which only an administrator may read."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Stats Timeseries — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "range",
+        "bucketSeconds",
+        "points"
+      ],
+      "properties": {
+        "range": {
+          "type": "string",
+          "enum": [
+            "lastHour",
+            "lastDay",
+            "lastWeek",
+            "last30Days"
+          ]
+        },
+        "bucketSeconds": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Width of each bucket."
+        },
+        "points": {
+          "type": "array",
+          "description": "One point per bucket in the window, oldest first, including buckets with no activity.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "at",
+              "resolves",
+              "updates"
+            ],
+            "properties": {
+              "at": {
+                "type": "string",
+                "format": "date-time",
+                "description": "Start of the bucket."
+              },
+              "resolves": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "updates": {
+                "type": "integer",
+                "minimum": 0
+              }
+            }
+          }
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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": "Stats Timeseries — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "range",
+        "bucketSeconds",
+        "points"
+      ],
+      "properties": {
+        "range": {
+          "type": "string",
+          "enum": [
+            "lastHour",
+            "lastDay",
+            "lastWeek",
+            "last30Days"
+          ]
+        },
+        "bucketSeconds": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Width of each bucket."
+        },
+        "points": {
+          "type": "array",
+          "description": "One point per bucket in the window, oldest first, including buckets with no activity.",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "at",
+              "resolves",
+              "updates"
+            ],
+            "properties": {
+              "at": {
+                "type": "string",
+                "format": "date-time",
+                "description": "Start of the bucket."
+              },
+              "resolves": {
+                "type": "integer",
+                "minimum": 0
+              },
+              "updates": {
+                "type": "integer",
+                "minimum": 0
+              }
+            }
+          }
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;