@openvtc/trust-tasks 0.20.2 → 0.20.3

package/dist/git-ns/bridge/result/0.1/payload.d.ts

@@ -0,0 +1,462 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/git-ns/bridge/result/0.1/payload.schema.json
+ */
+import type { Ext, ForgeId, RepoResource } from "../../../../_shared/components.js";
+/**
+ * The bridge reports how a job ended. Exactly one result is sent per job; the VTC updates the repository's state, bootstrap status and forge id from it.
+ */
+export interface GitNamespacesBridgeJobResultPayload {
+    /**
+     * The job, as git-ns/bridge/job named it.
+     */
+    jobId: string;
+    /**
+     * `succeeded` — every step was applied. `failed` — nothing was applied. `partial` — some steps were applied and at least one failed; `steps` says which. Every step is check-then-apply, so the VTC may send the job again.
+     */
+    outcome: "succeeded" | "failed" | "partial";
+    /**
+     * The repository the job touched, as the forge now reports it. Present whenever the job reached a repository.
+     */
+    repo?: {
+        resource: RepoResource;
+        forgeId: ForgeId;
+    };
+    /**
+     * Per-step outcomes, in the order they ran.
+     */
+    steps?: {
+        /**
+         * The step name, from the adapter's plan.
+         */
+        step: string;
+        /**
+         * `applied` — changed the forge. `unchanged` — already as required. `failed` — could not be applied. `skipped` — not attempted because an earlier step failed.
+         */
+        outcome: "applied" | "unchanged" | "failed" | "skipped";
+        /**
+         * Human-readable detail, typically for a failure.
+         */
+        detail?: string;
+    }[];
+    /**
+     * Why the job failed or stopped partway. Present when `outcome` is not `succeeded`.
+     */
+    error?: {
+        /**
+         * Forge-neutral: `nameTaken`, `notFound`, `forbidden` (the bridge's forge credentials lack a permission), `notCapable` (this forge or namespace cannot do it), `rateLimited`, `expired` (a begin* job's person never completed it), `forgeError`. A bridge MAY use others.
+         */
+        code: string;
+        message?: string;
+    };
+    ext?: Ext;
+}
+/**
+ * The VTC has recorded the result.
+ */
+export interface GitNamespacesBridgeJobResultResponsePayload {
+    jobId: string;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, ForgeId, RepoResource };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/git-ns/bridge/result/0.1";
+/** Stable alias for this specification's request payload shape. */
+export type Payload = GitNamespacesBridgeJobResultPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/git-ns/bridge/result/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = GitNamespacesBridgeJobResultResponsePayload;
+/**
+ * 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 declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/git-ns/bridge/result/0.1";
+    readonly title: "Git Namespaces — Bridge Job Result — payload";
+    readonly description: "The bridge reports how a job ended. Exactly one result is sent per job; the VTC updates the repository's state, bootstrap status and forge id from it.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["jobId", "outcome"];
+    readonly properties: {
+        readonly jobId: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 128;
+            readonly description: "The job, as git-ns/bridge/job named it.";
+        };
+        readonly outcome: {
+            readonly type: "string";
+            readonly enum: readonly ["succeeded", "failed", "partial"];
+            readonly description: "`succeeded` — every step was applied. `failed` — nothing was applied. `partial` — some steps were applied and at least one failed; `steps` says which. Every step is check-then-apply, so the VTC may send the job again.";
+        };
+        readonly repo: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["resource", "forgeId"];
+            readonly description: "The repository the job touched, as the forge now reports it. Present whenever the job reached a repository.";
+            readonly properties: {
+                readonly resource: {
+                    readonly $ref: "#/$defs/RepoResource";
+                };
+                readonly forgeId: {
+                    readonly $ref: "#/$defs/ForgeId";
+                };
+            };
+        };
+        readonly steps: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["step", "outcome"];
+                readonly properties: {
+                    readonly step: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 64;
+                        readonly pattern: "^[a-z][A-Za-z0-9]*$";
+                        readonly description: "The step name, from the adapter's plan.";
+                    };
+                    readonly outcome: {
+                        readonly type: "string";
+                        readonly enum: readonly ["applied", "unchanged", "failed", "skipped"];
+                        readonly description: "`applied` — changed the forge. `unchanged` — already as required. `failed` — could not be applied. `skipped` — not attempted because an earlier step failed.";
+                    };
+                    readonly detail: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                        readonly description: "Human-readable detail, typically for a failure.";
+                    };
+                };
+            };
+            readonly description: "Per-step outcomes, in the order they ran.";
+        };
+        readonly error: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["code"];
+            readonly description: "Why the job failed or stopped partway. Present when `outcome` is not `succeeded`.";
+            readonly properties: {
+                readonly code: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 64;
+                    readonly pattern: "^[a-z][A-Za-z0-9]*$";
+                    readonly description: "Forge-neutral: `nameTaken`, `notFound`, `forbidden` (the bridge's forge credentials lack a permission), `notCapable` (this forge or namespace cannot do it), `rateLimited`, `expired` (a begin* job's person never completed it), `forgeError`. A bridge MAY use others.";
+                };
+                readonly message: {
+                    readonly type: "string";
+                    readonly maxLength: 1024;
+                };
+            };
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Git Namespaces — Bridge Job Result — response payload";
+            readonly description: "The VTC has recorded the result.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["jobId"];
+            readonly properties: {
+                readonly jobId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly ForgeId: {
+            readonly title: "ForgeId";
+            readonly description: "An identifier the forge itself assigns — a repository id, a user or organisation id — carried as a string so a forge whose ids are not numbers needs no new version. GitHub and Forgejo ids are decimal integers written as strings (`\"812736451\"`). Unlike a name, it survives renames and transfers, which is why rights and bindings are keyed by it.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+        };
+        readonly RepoResource: {
+            readonly title: "RepoResource";
+            readonly description: "A forge-qualified resource naming exactly one repository: `<forge-host>/<owner>/<repo>`, lowercase.";
+            readonly type: "string";
+            readonly maxLength: 455;
+            readonly pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+/[a-z0-9_-][a-z0-9._-]{0,99}/[a-z0-9_-][a-z0-9._-]{0,99}$";
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "Git Namespaces — Bridge Job Result — response payload";
+            readonly description: "The VTC has recorded the result.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["jobId"];
+            readonly properties: {
+                readonly jobId: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly 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.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly ForgeId: {
+            readonly title: "ForgeId";
+            readonly description: "An identifier the forge itself assigns — a repository id, a user or organisation id — carried as a string so a forge whose ids are not numbers needs no new version. GitHub and Forgejo ids are decimal integers written as strings (`\"812736451\"`). Unlike a name, it survives renames and transfers, which is why rights and bindings are keyed by it.";
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 64;
+        };
+        readonly RepoResource: {
+            readonly title: "RepoResource";
+            readonly description: "A forge-qualified resource naming exactly one repository: `<forge-host>/<owner>/<repo>`, lowercase.";
+            readonly type: "string";
+            readonly maxLength: 455;
+            readonly pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+/[a-z0-9_-][a-z0-9._-]{0,99}/[a-z0-9_-][a-z0-9._-]{0,99}$";
+        };
+    };
+};
+/**
+ * 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 declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/git-ns/bridge/result/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/git-ns/bridge/result/0.1";
+        readonly title: "Git Namespaces — Bridge Job Result — payload";
+        readonly description: "The bridge reports how a job ended. Exactly one result is sent per job; the VTC updates the repository's state, bootstrap status and forge id from it.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["jobId", "outcome"];
+        readonly properties: {
+            readonly jobId: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 128;
+                readonly description: "The job, as git-ns/bridge/job named it.";
+            };
+            readonly outcome: {
+                readonly type: "string";
+                readonly enum: readonly ["succeeded", "failed", "partial"];
+                readonly description: "`succeeded` — every step was applied. `failed` — nothing was applied. `partial` — some steps were applied and at least one failed; `steps` says which. Every step is check-then-apply, so the VTC may send the job again.";
+            };
+            readonly repo: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["resource", "forgeId"];
+                readonly description: "The repository the job touched, as the forge now reports it. Present whenever the job reached a repository.";
+                readonly properties: {
+                    readonly resource: {
+                        readonly $ref: "#/$defs/RepoResource";
+                    };
+                    readonly forgeId: {
+                        readonly $ref: "#/$defs/ForgeId";
+                    };
+                };
+            };
+            readonly steps: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["step", "outcome"];
+                    readonly properties: {
+                        readonly step: {
+                            readonly type: "string";
+                            readonly minLength: 1;
+                            readonly maxLength: 64;
+                            readonly pattern: "^[a-z][A-Za-z0-9]*$";
+                            readonly description: "The step name, from the adapter's plan.";
+                        };
+                        readonly outcome: {
+                            readonly type: "string";
+                            readonly enum: readonly ["applied", "unchanged", "failed", "skipped"];
+                            readonly description: "`applied` — changed the forge. `unchanged` — already as required. `failed` — could not be applied. `skipped` — not attempted because an earlier step failed.";
+                        };
+                        readonly detail: {
+                            readonly type: "string";
+                            readonly maxLength: 1024;
+                            readonly description: "Human-readable detail, typically for a failure.";
+                        };
+                    };
+                };
+                readonly description: "Per-step outcomes, in the order they ran.";
+            };
+            readonly error: {
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["code"];
+                readonly description: "Why the job failed or stopped partway. Present when `outcome` is not `succeeded`.";
+                readonly properties: {
+                    readonly code: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 64;
+                        readonly pattern: "^[a-z][A-Za-z0-9]*$";
+                        readonly description: "Forge-neutral: `nameTaken`, `notFound`, `forbidden` (the bridge's forge credentials lack a permission), `notCapable` (this forge or namespace cannot do it), `rateLimited`, `expired` (a begin* job's person never completed it), `forgeError`. A bridge MAY use others.";
+                    };
+                    readonly message: {
+                        readonly type: "string";
+                        readonly maxLength: 1024;
+                    };
+                };
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Git Namespaces — Bridge Job Result — response payload";
+                readonly description: "The VTC has recorded the result.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["jobId"];
+                readonly properties: {
+                    readonly jobId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly ForgeId: {
+                readonly title: "ForgeId";
+                readonly description: "An identifier the forge itself assigns — a repository id, a user or organisation id — carried as a string so a forge whose ids are not numbers needs no new version. GitHub and Forgejo ids are decimal integers written as strings (`\"812736451\"`). Unlike a name, it survives renames and transfers, which is why rights and bindings are keyed by it.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 64;
+            };
+            readonly RepoResource: {
+                readonly title: "RepoResource";
+                readonly description: "A forge-qualified resource naming exactly one repository: `<forge-host>/<owner>/<repo>`, lowercase.";
+                readonly type: "string";
+                readonly maxLength: 455;
+                readonly pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+/[a-z0-9_-][a-z0-9._-]{0,99}/[a-z0-9_-][a-z0-9._-]{0,99}$";
+            };
+        };
+    };
+};
+/**
+ * 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 declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/git-ns/bridge/result/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "Git Namespaces — Bridge Job Result — response payload";
+                readonly description: "The VTC has recorded the result.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["jobId"];
+                readonly properties: {
+                    readonly jobId: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                        readonly maxLength: 128;
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly 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.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly ForgeId: {
+                readonly title: "ForgeId";
+                readonly description: "An identifier the forge itself assigns — a repository id, a user or organisation id — carried as a string so a forge whose ids are not numbers needs no new version. GitHub and Forgejo ids are decimal integers written as strings (`\"812736451\"`). Unlike a name, it survives renames and transfers, which is why rights and bindings are keyed by it.";
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 64;
+            };
+            readonly RepoResource: {
+                readonly title: "RepoResource";
+                readonly description: "A forge-qualified resource naming exactly one repository: `<forge-host>/<owner>/<repo>`, lowercase.";
+                readonly type: "string";
+                readonly maxLength: 455;
+                readonly pattern: "^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+/[a-z0-9_-][a-z0-9._-]{0,99}/[a-z0-9_-][a-z0-9._-]{0,99}$";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map

package/dist/git-ns/bridge/result/0.1/payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.d.ts","sourceRoot":"","sources":["../../../../../src/git-ns/bridge/result/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AAGpF;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,IAAI,CAAC,EAAE;QACL,QAAQ,EAAE,YAAY,CAAC;QACvB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;IACF;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,OAAO,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAC;QACxD;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,EAAE,CAAC;IACJ;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AACD;;GAEG;AACH,MAAM,WAAW,2CAA2C;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED,kHAAkH;AAClH,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;AAE3C,2BAA2B;AAC3B,eAAO,MAAM,QAAQ,EAAG,sDAA+D,CAAC;AAExF,mEAAmE;AACnE,MAAM,MAAM,OAAO,GAAG,mCAAmC,CAAC;AAE1D,qEAAqE;AACrE,eAAO,MAAM,iBAAiB,EAAG,+DAAwE,CAAC;AAE1G,4EAA4E;AAC5E,MAAM,MAAM,QAAQ,GAAG,2CAA2C,CAAC;AAEnE;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuJjB,CAAC;AAEX,mEAAmE;AACnE,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiD1B,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOP,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOhB,CAAC"}