@gate-forge/pack-workflow 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/dist/adapter-schema.d.ts +145 -0
- package/dist/adapter-schema.d.ts.map +1 -0
- package/dist/adapter-schema.js +125 -0
- package/dist/adapter-schema.js.map +1 -0
- package/dist/detector.d.ts +47 -0
- package/dist/detector.d.ts.map +1 -0
- package/dist/detector.js +514 -0
- package/dist/detector.js.map +1 -0
- package/dist/index.d.ts +8 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +31 -0
- package/dist/index.js.map +1 -0
- package/dist/obligations.d.ts +58 -0
- package/dist/obligations.d.ts.map +1 -0
- package/dist/obligations.js +69 -0
- package/dist/obligations.js.map +1 -0
- package/dist/version.d.ts +11 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/version.js +11 -0
- package/dist/version.js.map +1 -0
- package/package.json +42 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 UKD
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Entity-adapter schema (pack deliverable: "entity-adapter schema doc").
|
|
3
|
+
*
|
|
4
|
+
* Mirrors the pack-sqlalchemy posture: an adapter is a reviewed,
|
|
5
|
+
* engine-side module whose default export implements GET-only reads
|
|
6
|
+
* against a workflow resource plus the three transition/audit
|
|
7
|
+
* operations the five workflow contracts need. The witness service
|
|
8
|
+
* loads `.gateforge/adapters/<resourceId>.mjs` and calls
|
|
9
|
+
* `attemptTransition` / `allowedTransition` / `readEntity` /
|
|
10
|
+
* `readAuditLog` when a test asks for evidence; the raw adapter
|
|
11
|
+
* response is never returned to the test process — only the
|
|
12
|
+
* `verdictRelevant` projection is.
|
|
13
|
+
*
|
|
14
|
+
* Adapter responsibilities (enforced by {@link WorkflowAdapterSchema} +
|
|
15
|
+
* {@link validateWorkflowAdapter}):
|
|
16
|
+
* - `resourceId` — the resource this adapter proves; must match the
|
|
17
|
+
* file name (`<resourceId>.mjs`) so the registry binds by filename.
|
|
18
|
+
* - `readEntity(ctx, id)` — GET-only fetch of one entity; returns the
|
|
19
|
+
* raw response body. Implementations MUST NOT mutate anything.
|
|
20
|
+
* - `readAuditLog(ctx)` — GET-only fetch of the append-only audit log.
|
|
21
|
+
* - `attemptTransition(ctx, args)` — return whether the transition is
|
|
22
|
+
* accepted; reject terminal writes; NEVER persist or append.
|
|
23
|
+
* - `allowedTransition(ctx, args)` — apply a valid transition; append
|
|
24
|
+
* one audit row; return the new final state.
|
|
25
|
+
* - `deletion: 'hard' | 'archive'` — how removal manifests (workflow
|
|
26
|
+
* resources are state machines; `archive` matches the contract
|
|
27
|
+
* semantics where terminals are reached, never deleted).
|
|
28
|
+
* - `environmentFingerprint` — the target-environment marker; a
|
|
29
|
+
* mismatch rejects the record.
|
|
30
|
+
*/
|
|
31
|
+
import { z } from 'zod';
|
|
32
|
+
/** Raw entity body the adapter returns; detector-defined open payload. */
|
|
33
|
+
export type RawEntity = unknown;
|
|
34
|
+
/** Raw audit-log body the adapter returns. */
|
|
35
|
+
export type RawAuditLog = unknown;
|
|
36
|
+
/** Arguments the adapter's transition methods receive. */
|
|
37
|
+
export interface TransitionRequest {
|
|
38
|
+
/** Identifier of the entity being transitioned (matches `readEntity` id). */
|
|
39
|
+
entityId: string;
|
|
40
|
+
/** Logical event the actor is attempting (e.g. `submit`, `sign`, `terminate`). */
|
|
41
|
+
event: string;
|
|
42
|
+
/** Identifier of the actor; recorded in the audit row. */
|
|
43
|
+
actor: string;
|
|
44
|
+
/** Caller-supplied adapter context (headers, run token, etc.). */
|
|
45
|
+
ctx: WorkflowAdapterContext;
|
|
46
|
+
}
|
|
47
|
+
/** The outcome a transition attempt produces. */
|
|
48
|
+
export interface TransitionOutcome {
|
|
49
|
+
/** True when the transition was accepted and persisted. */
|
|
50
|
+
accepted: boolean;
|
|
51
|
+
/** When `accepted` is true, the new persisted state id. */
|
|
52
|
+
finalState?: string;
|
|
53
|
+
/** When `accepted` is false, the machine-readable rejection reason. */
|
|
54
|
+
reason?: string;
|
|
55
|
+
/** When `accepted` is true, the audit row that was appended. */
|
|
56
|
+
auditRow?: {
|
|
57
|
+
actor: string;
|
|
58
|
+
from: string;
|
|
59
|
+
to: string;
|
|
60
|
+
at: string;
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
/** Context handed to every adapter method by the witness service. */
|
|
64
|
+
export interface WorkflowAdapterContext {
|
|
65
|
+
/** Base URL of the target environment (loopback, trusted). */
|
|
66
|
+
baseUrl: string;
|
|
67
|
+
/** Per-request headers (e.g. the run token for authenticity). */
|
|
68
|
+
headers?: Record<string, string>;
|
|
69
|
+
}
|
|
70
|
+
/** The frozen adapter module contract. */
|
|
71
|
+
export interface WorkflowAdapter {
|
|
72
|
+
resourceId: string;
|
|
73
|
+
readEntity(ctx: WorkflowAdapterContext, id: string): Promise<RawEntity>;
|
|
74
|
+
readAuditLog(ctx: WorkflowAdapterContext): Promise<RawAuditLog>;
|
|
75
|
+
attemptTransition(req: TransitionRequest): Promise<TransitionOutcome>;
|
|
76
|
+
allowedTransition(req: TransitionRequest): Promise<TransitionOutcome>;
|
|
77
|
+
deletion: 'hard' | 'archive';
|
|
78
|
+
environmentFingerprint: string;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Zod schema for the data fields of an adapter module. Function fields
|
|
82
|
+
* are accepted as `unknown` so zod does not blur the diagnostic
|
|
83
|
+
* message; {@link validateWorkflowAdapter} enforces the type after the
|
|
84
|
+
* data-fields pass.
|
|
85
|
+
*/
|
|
86
|
+
export declare const WorkflowAdapterSchema: z.ZodObject<{
|
|
87
|
+
resourceId: z.ZodString;
|
|
88
|
+
deletion: z.ZodEnum<{
|
|
89
|
+
hard: "hard";
|
|
90
|
+
archive: "archive";
|
|
91
|
+
}>;
|
|
92
|
+
environmentFingerprint: z.ZodString;
|
|
93
|
+
readEntity: z.ZodUnknown;
|
|
94
|
+
readAuditLog: z.ZodUnknown;
|
|
95
|
+
attemptTransition: z.ZodUnknown;
|
|
96
|
+
allowedTransition: z.ZodUnknown;
|
|
97
|
+
}, z.core.$strict>;
|
|
98
|
+
/** Outcome of {@link validateWorkflowAdapter}. */
|
|
99
|
+
export type WorkflowAdapterValidation = {
|
|
100
|
+
ok: true;
|
|
101
|
+
adapter: WorkflowAdapter;
|
|
102
|
+
} | {
|
|
103
|
+
ok: false;
|
|
104
|
+
issues: string[];
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* Validates an adapter module against the frozen contract, failing
|
|
108
|
+
* closed with one issue per violated field.
|
|
109
|
+
*
|
|
110
|
+
* Args:
|
|
111
|
+
* value: The default export of an `.mjs` adapter module.
|
|
112
|
+
*
|
|
113
|
+
* Returns:
|
|
114
|
+
* WorkflowAdapterValidation: The typed adapter, or every issue found.
|
|
115
|
+
*/
|
|
116
|
+
export declare function validateWorkflowAdapter(value: unknown): WorkflowAdapterValidation;
|
|
117
|
+
/**
|
|
118
|
+
* Projects an audit-log body onto the row shape the verdict engine
|
|
119
|
+
* expects. The adapter's raw body is its own (often string-keyed JSON);
|
|
120
|
+
* the witness service projects each row to `{ actor, from, to, at }`.
|
|
121
|
+
*/
|
|
122
|
+
export interface AuditRow {
|
|
123
|
+
actor: string;
|
|
124
|
+
from: string;
|
|
125
|
+
to: string;
|
|
126
|
+
at: string;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* The default audit-row projection. Recognises the canonical
|
|
130
|
+
* `{ actor, from, to, at }` body and returns it as an `AuditRow`;
|
|
131
|
+
* anything else is left as-is so the verdict engine can flag it.
|
|
132
|
+
*/
|
|
133
|
+
export declare function projectAuditRow(raw: unknown): AuditRow | null;
|
|
134
|
+
/**
|
|
135
|
+
* Returns true when `rows` contains an entry whose `{ actor, from, to }`
|
|
136
|
+
* equals the target triple. Used by the `workflow:audit-emitted`
|
|
137
|
+
* contract; the timestamp is intentionally NOT compared so callers can
|
|
138
|
+
* pass a projected audit log without normalising timestamps first.
|
|
139
|
+
*/
|
|
140
|
+
export declare function auditLogContainsTransition(rows: readonly unknown[], target: {
|
|
141
|
+
actor: string;
|
|
142
|
+
from: string;
|
|
143
|
+
to: string;
|
|
144
|
+
}): boolean;
|
|
145
|
+
//# sourceMappingURL=adapter-schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter-schema.d.ts","sourceRoot":"","sources":["../src/adapter-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,0EAA0E;AAC1E,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC;AAEhC,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC;AAElC,0DAA0D;AAC1D,MAAM,WAAW,iBAAiB;IAChC,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,CAAC;IACjB,kFAAkF;IAClF,KAAK,EAAE,MAAM,CAAC;IACd,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,GAAG,EAAE,sBAAsB,CAAC;CAC7B;AAED,iDAAiD;AACjD,MAAM,WAAW,iBAAiB;IAChC,2DAA2D;IAC3D,QAAQ,EAAE,OAAO,CAAC;IAClB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,QAAQ,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC;CACpE;AAED,qEAAqE;AACrE,MAAM,WAAW,sBAAsB;IACrC,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,0CAA0C;AAC1C,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,GAAG,EAAE,sBAAsB,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACxE,YAAY,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChE,iBAAiB,CAAC,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACtE,iBAAiB,CAAC,GAAG,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACtE,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;kBAUvB,CAAC;AAEZ,kDAAkD;AAClD,MAAM,MAAM,yBAAyB,GACjC;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,OAAO,EAAE,eAAe,CAAA;CAAE,GACtC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAEpC;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,yBAAyB,CA0BjF;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,QAAQ,GAAG,IAAI,CAiB7D;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,SAAS,OAAO,EAAE,EACxB,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAClD,OAAO,CAaT"}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Entity-adapter schema (pack deliverable: "entity-adapter schema doc").
|
|
3
|
+
*
|
|
4
|
+
* Mirrors the pack-sqlalchemy posture: an adapter is a reviewed,
|
|
5
|
+
* engine-side module whose default export implements GET-only reads
|
|
6
|
+
* against a workflow resource plus the three transition/audit
|
|
7
|
+
* operations the five workflow contracts need. The witness service
|
|
8
|
+
* loads `.gateforge/adapters/<resourceId>.mjs` and calls
|
|
9
|
+
* `attemptTransition` / `allowedTransition` / `readEntity` /
|
|
10
|
+
* `readAuditLog` when a test asks for evidence; the raw adapter
|
|
11
|
+
* response is never returned to the test process — only the
|
|
12
|
+
* `verdictRelevant` projection is.
|
|
13
|
+
*
|
|
14
|
+
* Adapter responsibilities (enforced by {@link WorkflowAdapterSchema} +
|
|
15
|
+
* {@link validateWorkflowAdapter}):
|
|
16
|
+
* - `resourceId` — the resource this adapter proves; must match the
|
|
17
|
+
* file name (`<resourceId>.mjs`) so the registry binds by filename.
|
|
18
|
+
* - `readEntity(ctx, id)` — GET-only fetch of one entity; returns the
|
|
19
|
+
* raw response body. Implementations MUST NOT mutate anything.
|
|
20
|
+
* - `readAuditLog(ctx)` — GET-only fetch of the append-only audit log.
|
|
21
|
+
* - `attemptTransition(ctx, args)` — return whether the transition is
|
|
22
|
+
* accepted; reject terminal writes; NEVER persist or append.
|
|
23
|
+
* - `allowedTransition(ctx, args)` — apply a valid transition; append
|
|
24
|
+
* one audit row; return the new final state.
|
|
25
|
+
* - `deletion: 'hard' | 'archive'` — how removal manifests (workflow
|
|
26
|
+
* resources are state machines; `archive` matches the contract
|
|
27
|
+
* semantics where terminals are reached, never deleted).
|
|
28
|
+
* - `environmentFingerprint` — the target-environment marker; a
|
|
29
|
+
* mismatch rejects the record.
|
|
30
|
+
*/
|
|
31
|
+
import { z } from 'zod';
|
|
32
|
+
/**
|
|
33
|
+
* Zod schema for the data fields of an adapter module. Function fields
|
|
34
|
+
* are accepted as `unknown` so zod does not blur the diagnostic
|
|
35
|
+
* message; {@link validateWorkflowAdapter} enforces the type after the
|
|
36
|
+
* data-fields pass.
|
|
37
|
+
*/
|
|
38
|
+
export const WorkflowAdapterSchema = z
|
|
39
|
+
.object({
|
|
40
|
+
resourceId: z.string().min(1),
|
|
41
|
+
deletion: z.enum(['hard', 'archive']),
|
|
42
|
+
environmentFingerprint: z.string().min(1),
|
|
43
|
+
readEntity: z.unknown(),
|
|
44
|
+
readAuditLog: z.unknown(),
|
|
45
|
+
attemptTransition: z.unknown(),
|
|
46
|
+
allowedTransition: z.unknown(),
|
|
47
|
+
})
|
|
48
|
+
.strict();
|
|
49
|
+
/**
|
|
50
|
+
* Validates an adapter module against the frozen contract, failing
|
|
51
|
+
* closed with one issue per violated field.
|
|
52
|
+
*
|
|
53
|
+
* Args:
|
|
54
|
+
* value: The default export of an `.mjs` adapter module.
|
|
55
|
+
*
|
|
56
|
+
* Returns:
|
|
57
|
+
* WorkflowAdapterValidation: The typed adapter, or every issue found.
|
|
58
|
+
*/
|
|
59
|
+
export function validateWorkflowAdapter(value) {
|
|
60
|
+
const parsed = WorkflowAdapterSchema.safeParse(value);
|
|
61
|
+
if (!parsed.success) {
|
|
62
|
+
return {
|
|
63
|
+
ok: false,
|
|
64
|
+
issues: parsed.error.issues.map((issue) => `${issue.path.join('.')}: ${issue.message}`),
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
const candidate = value;
|
|
68
|
+
const issues = [];
|
|
69
|
+
if (typeof candidate.readEntity !== 'function') {
|
|
70
|
+
issues.push('readEntity: must be a function (ctx, id) => Promise<unknown>');
|
|
71
|
+
}
|
|
72
|
+
if (typeof candidate.readAuditLog !== 'function') {
|
|
73
|
+
issues.push('readAuditLog: must be a function (ctx) => Promise<unknown>');
|
|
74
|
+
}
|
|
75
|
+
if (typeof candidate.attemptTransition !== 'function') {
|
|
76
|
+
issues.push('attemptTransition: must be a function (req) => Promise<TransitionOutcome>');
|
|
77
|
+
}
|
|
78
|
+
if (typeof candidate.allowedTransition !== 'function') {
|
|
79
|
+
issues.push('allowedTransition: must be a function (req) => Promise<TransitionOutcome>');
|
|
80
|
+
}
|
|
81
|
+
if (issues.length > 0)
|
|
82
|
+
return { ok: false, issues };
|
|
83
|
+
return { ok: true, adapter: value };
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* The default audit-row projection. Recognises the canonical
|
|
87
|
+
* `{ actor, from, to, at }` body and returns it as an `AuditRow`;
|
|
88
|
+
* anything else is left as-is so the verdict engine can flag it.
|
|
89
|
+
*/
|
|
90
|
+
export function projectAuditRow(raw) {
|
|
91
|
+
if (raw === null || typeof raw !== 'object')
|
|
92
|
+
return null;
|
|
93
|
+
const obj = raw;
|
|
94
|
+
if (typeof obj['actor'] === 'string' &&
|
|
95
|
+
typeof obj['from'] === 'string' &&
|
|
96
|
+
typeof obj['to'] === 'string' &&
|
|
97
|
+
typeof obj['at'] === 'string') {
|
|
98
|
+
return {
|
|
99
|
+
actor: obj['actor'],
|
|
100
|
+
from: obj['from'],
|
|
101
|
+
to: obj['to'],
|
|
102
|
+
at: obj['at'],
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
return null;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Returns true when `rows` contains an entry whose `{ actor, from, to }`
|
|
109
|
+
* equals the target triple. Used by the `workflow:audit-emitted`
|
|
110
|
+
* contract; the timestamp is intentionally NOT compared so callers can
|
|
111
|
+
* pass a projected audit log without normalising timestamps first.
|
|
112
|
+
*/
|
|
113
|
+
export function auditLogContainsTransition(rows, target) {
|
|
114
|
+
for (const raw of rows) {
|
|
115
|
+
const row = projectAuditRow(raw);
|
|
116
|
+
if (row !== null &&
|
|
117
|
+
row.actor === target.actor &&
|
|
118
|
+
row.from === target.from &&
|
|
119
|
+
row.to === target.to) {
|
|
120
|
+
return true;
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
return false;
|
|
124
|
+
}
|
|
125
|
+
//# sourceMappingURL=adapter-schema.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"adapter-schema.js","sourceRoot":"","sources":["../src/adapter-schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAmDxB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,MAAM,CAAC;IACN,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7B,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,sBAAsB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;IACzB,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC9B,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE;CAC/B,CAAC;KACD,MAAM,EAAE,CAAC;AAOZ;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,MAAM,MAAM,GAAG,qBAAqB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO;YACL,EAAE,EAAE,KAAK;YACT,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAC7B,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CACvD;SACF,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,KAAiC,CAAC;IACpD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,OAAO,SAAS,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,8DAA8D,CAAC,CAAC;IAC9E,CAAC;IACD,IAAI,OAAO,SAAS,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAC;IAC5E,CAAC;IACD,IAAI,OAAO,SAAS,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,OAAO,SAAS,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACpD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAwB,EAAE,CAAC;AACzD,CAAC;AAcD;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,GAAY;IAC1C,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACzD,MAAM,GAAG,GAAG,GAA8B,CAAC;IAC3C,IACE,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ;QAChC,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ;QAC/B,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ;QAC7B,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,EAC7B,CAAC;QACD,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC;YACnB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC;YACjB,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC;YACb,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC;SACd,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,IAAwB,EACxB,MAAmD;IAEnD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QACjC,IACE,GAAG,KAAK,IAAI;YACZ,GAAG,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK;YAC1B,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI;YACxB,GAAG,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,EACpB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { DiscoveryOutcome } from '@gate-forge/plugin-protocol';
|
|
2
|
+
/** Stable detector kind for every workflow resource this pack emits. */
|
|
3
|
+
export declare const WORKFLOW_CONTRACT_KIND = "workflow.contract";
|
|
4
|
+
/** FSM style enumeration; one per detected machine. */
|
|
5
|
+
export type FsmStyle = 'xstate' | 'fsm' | 'enum-switch' | 'zustand-slice';
|
|
6
|
+
/** One transition extracted from an FSM source. */
|
|
7
|
+
export interface WorkflowTransition {
|
|
8
|
+
from: string;
|
|
9
|
+
to: string;
|
|
10
|
+
/** Logical event name (XState `on.<event>` / switch `case` key / Zustand action). */
|
|
11
|
+
action: string;
|
|
12
|
+
}
|
|
13
|
+
/** Attribute payload of a {@link WORKFLOW_CONTRACT_KIND} resource. */
|
|
14
|
+
export interface WorkflowContractAttributes {
|
|
15
|
+
resourceName: string;
|
|
16
|
+
states: string[];
|
|
17
|
+
transitions: WorkflowTransition[];
|
|
18
|
+
terminal: string[];
|
|
19
|
+
auditEvent: boolean;
|
|
20
|
+
style: FsmStyle;
|
|
21
|
+
domain: string;
|
|
22
|
+
}
|
|
23
|
+
/** Options for {@link createWorkflowDetector}. */
|
|
24
|
+
export interface WorkflowDetectorOptions {
|
|
25
|
+
/** Repo root used to compute repo-root-relative `source` paths. */
|
|
26
|
+
cwd?: string;
|
|
27
|
+
/** Detector version override; primarily tests. */
|
|
28
|
+
detectorVersion?: string;
|
|
29
|
+
/** Detector id override; primarily tests. */
|
|
30
|
+
detectorId?: string;
|
|
31
|
+
}
|
|
32
|
+
/** The pinned in-process plugin contract: `{ discover(paths) }`. */
|
|
33
|
+
export interface WorkflowDetector {
|
|
34
|
+
discover(paths: readonly string[]): Promise<DiscoveryOutcome>;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Creates a discover-capable detector module. The default export of the
|
|
38
|
+
* pack is `createWorkflowDetector()` — the CLI in-process contract.
|
|
39
|
+
*
|
|
40
|
+
* Args:
|
|
41
|
+
* options: Detector configuration (cwd, identity overrides).
|
|
42
|
+
*
|
|
43
|
+
* Returns:
|
|
44
|
+
* WorkflowDetector: the pinned `{ discover(paths) }` module.
|
|
45
|
+
*/
|
|
46
|
+
export declare function createWorkflowDetector(options?: WorkflowDetectorOptions): WorkflowDetector;
|
|
47
|
+
//# sourceMappingURL=detector.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"detector.d.ts","sourceRoot":"","sources":["../src/detector.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAA8B,MAAM,6BAA6B,CAAC;AAKhG,wEAAwE;AACxE,eAAO,MAAM,sBAAsB,sBAAsB,CAAC;AAC1D,uDAAuD;AACvD,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,aAAa,GAAG,eAAe,CAAC;AAE1E,mDAAmD;AACnD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,qFAAqF;IACrF,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,sEAAsE;AACtE,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAClC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE,QAAQ,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,kDAAkD;AAClD,MAAM,WAAW,uBAAuB;IACtC,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,oEAAoE;AACpE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC/D;AAgCD;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,GAAE,uBAA4B,GACpC,gBAAgB,CA+DlB"}
|