@geonosis/policy 1.0.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 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 [yyyy] [name of copyright owner]
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.
package/README.md ADDED
@@ -0,0 +1,107 @@
1
+ # `@geonosis/policy`
2
+
3
+ A threshold is not a number. It is a number, plus the authority that set it, the subject it reaches
4
+ and the reason it exists — and that difference is what lets the person who was just blocked learn
5
+ something instead of filing a ticket.
6
+
7
+ This is the kernel two repos arrived at independently: a precedence lattice with a full trace, a read
8
+ that resolves **authored rule → config row → the caller's own constant** and RECORDS the third case,
9
+ the learning loop that reads those recordings back, and a permission lattice with the runtime lifted
10
+ out of it.
11
+
12
+ ```ts
13
+ import { definePolicy, readPolicy } from '@geonosis/policy'
14
+
15
+ const policy = definePolicy({
16
+ tiers: [
17
+ 'regulatory',
18
+ 'contract',
19
+ { name: 'tenant', overridable: true },
20
+ { name: 'command', overrides: true },
21
+ { name: 'learned', advisory: true },
22
+ ],
23
+ kinds: [{ kind: 'quoteExpiryDays', schema: z.number().positive() }],
24
+ scopeKeys: ['region', 'customerGroup', 'companyId', 'orderId'], // VAGUEST first
25
+ })
26
+
27
+ const { value, usedFallback } = await readPolicy(policy, 'quoteExpiryDays', { companyId }, {
28
+ fallback: DEFAULT_QUOTE_EXPIRY_DAYS,
29
+ rule,
30
+ config,
31
+ journal,
32
+ op: 'create-quote',
33
+ })
34
+ ```
35
+
36
+ **The kernel is inert until the data arrives.** Not one tier, kind, scope key or rule is built in: the
37
+ two consumers disagreed on every one of them — one's strongest authority is `regulatory`, the other's
38
+ is `physics`, and they share not a single scope key — so all four are declared. A policy with no
39
+ rules decides nothing, every read falls through to the caller's constant, and each of those is
40
+ recorded exactly **once per boot**: the honest unit of evidence for "nobody has set this knob" is a
41
+ deployment, not a request, and a constraint read once per cart would otherwise write a row per cart
42
+ and drown the one signal anybody is looking for.
43
+
44
+ ## What is in it
45
+
46
+ | Export | What it does |
47
+ |---|---|
48
+ | `definePolicy({ tiers, kinds, scopeKeys, rules })` | The lattice as data. Refuses two escape hatches, a duplicate tier or kind, and an advisory tier declared stronger than an authority. |
49
+ | `policy.resolve(kind, query, rules)` | The decision plus the whole trace: `winner`, `suppressed`, `overrode`, `conflicts`, `explain`. |
50
+ | `policy.unusableRules()` · `unsupportedScopes()` · `unsetKinds()` | The three honesty reports. A rule this build cannot honour is NAMED, never silently dropped; a kind a reader asks for that no rule sets is named too, because a reader falling back forever looks identical to one that is working. |
51
+ | `readPolicy(policy, kind, scope, opts)` | rule → config → constant, through injected `rule` / `config` / `journal` ports. |
52
+ | `policyOrDefault(policy, input, apply)` | A resolved value that cannot be APPLIED is the same kind of gap: recorded, and the default takes over. A default that also fails still throws — that is our bug, not a misconfiguration. |
53
+ | `generatePolicyMarkdown` · `describePolicy` | The policy as committed prose, and as the bounded instructions an agent gets at connect. Every count and the precedence sentence are derived. |
54
+ | `observeJournal` / `reflect` / `curate` / `promote` / `demote` / `playbookRules` | The learning loop. A promoted learning enters at whatever tier the policy calls **advisory**, so it can only ever fill silence. |
55
+ | `journalRowForEvent` | The other three signals' missing input: real lifecycle events as countable rows. |
56
+ | `rulesToSeed(seed, existing)` | Seeding idempotent by id AND by coverage. |
57
+ | `runPolicyAdapterConformance(harness)` | The suite every storage adapter passes, answering with a report rather than an exit code. |
58
+ | `@geonosis/policy/permissions` | `definePolicies` / `hasPermission` / `resolvePermissions` / `checkPermissions` / `createPolicyCatalog` / `expandPolicies`. |
59
+ | `@geonosis/policy/medusa` · `/drizzle` | Two stores behind the same ports. Neither imports the store it adapts. |
60
+
61
+ ## Migrating dielime's rules engine, in five lines
62
+
63
+ 1. `lib/rules.ts` → `definePolicy({ tiers: POLICY_TIERS, kinds: …, scopeKeys: … })`; the twelve
64
+ `PolicyConstraint` members become twelve `{ kind, schema }`, and `KNOWN_SCOPE_KEYS` +
65
+ `scopeSpecificity` both disappear into `scopeKeys` (vaguest first — the weight is the position).
66
+ 2. `lib/read-policy.ts` → `readPolicy(policy, kind, query, { fallback, …adapter })`; the SLA tier
67
+ dereference becomes `isReference` + `dereference` on the `approvalSlaHours` kind.
68
+ 3. `lib/config-store-binding.ts` → `createMedusaPolicyAdapter({ container, moduleKey, bindings })`
69
+ with `configRow(namespace, key)`; drop `positive()` from every binding — the kind's schema now
70
+ refuses junk once, for the rule layer too.
71
+ 4. `lib/learning.ts` → the same functions; `playbookRules(policy, playbook)` takes the policy, and
72
+ `journalRowForEvent(name, data, { subjectKeys, actorKeys })` takes the fifteen event names' keys.
73
+ 5. `modules/rules-engine/service.ts` keeps `MedusaService` and its three models, and loses the
74
+ mapping: `listActiveRules()` is the adapter's `rule.rules()`, and `resolve()` is `policy.resolve`.
75
+
76
+ `proofs/022-W7-parity/` lists every one of its 65 kernel cases against this package, the ten that
77
+ stay consumer-side, and the seven behaviours that deliberately differ.
78
+
79
+ ## during.day does not adopt this, and here is the measurement
80
+
81
+ Its thresholds are lint-enforced constants (`ARTICLE XIII §13.3`, `constants-in-constants-file`), so
82
+ the obvious reading is that they are policy waiting for a home. They are not. All 34 `constants.ts`
83
+ files under `packages/` and `apps/` were enumerated: every `SCREAMING_SNAKE` export is a Tailwind
84
+ class, a cache TTL or KV prefix (`SESSION_COOKIE_CACHE_SECONDS`, `PLACEMENT_CACHE_SECONDS`), a regex,
85
+ a literal defaults record (`INVOICE_DEFAULTS = { title: 'INVOICE' }`), or a UI enum.
86
+ `grep -E '_LIMIT|_THRESHOLD|MAX_|_CAP'` across all 34 returns nothing.
87
+
88
+ None of them carries an authority, a subject or a reason, which is exactly what separates a policy
89
+ rule from a constant. §13.3 is a law about WHERE a constant lives, not about thresholds a tenant may
90
+ set. What that repo could adopt today, without changing a line of behaviour, is the shape of the
91
+ call — its constant passed as `fallback`, so the gap becomes countable — and that is worth precisely
92
+ as much as its journal is fed, which today is not at all.
93
+
94
+ **D-027 status: one consumer with pull.** C3 of `docs/challenge-2026-08-30.md` ranked this behind
95
+ `@geonosis/integrations` for that reason and it was right to; this package ships inside 1.0.0 with
96
+ dielime's kernel as its only live consumer and musa's lattice as a second fixture, not a second
97
+ consumer. It is DONE when dielime depends on the published version and has deleted its `lib/`.
98
+
99
+ ## What it deliberately does NOT do
100
+
101
+ - **No global registry.** Upstream's `definePolicies` writes into three `globalThis` objects keyed by
102
+ name with no duplicate check, and rewrites the caller's objects in place. `createPolicyCatalog`
103
+ is local and refuses a name already taken.
104
+ - **No store.** Rules, config rows and journal entries all arrive through ports. That is what lets
105
+ every check in the conformance suite run without a booted server.
106
+ - **No opinion about your tiers.** Including the one that looks universal: whether an unmarked rule
107
+ may be overridden is `overridableByDefault`, because the two consumers answer it oppositely.
@@ -0,0 +1,17 @@
1
+ // src/rows.ts
2
+ var toPolicyRule = (row) => ({
3
+ constraint: { kind: row.constraint_kind, value: row.constraint_value },
4
+ id: row.rule_key,
5
+ // Only `false` is worth carrying: `true` is the default a policy declares, and writing it back
6
+ // would make a rule that never said anything indistinguishable from one that agreed.
7
+ ...row.overridable === false ? { overridable: false } : {},
8
+ reason: row.reason,
9
+ ...row.scope ? { scope: row.scope } : {},
10
+ tier: row.tier
11
+ });
12
+ var toPolicyRules = (rows) => rows.filter((row) => (row.status ?? "active") === "active").map(toPolicyRule);
13
+
14
+ export {
15
+ toPolicyRule,
16
+ toPolicyRules
17
+ };
@@ -0,0 +1,43 @@
1
+ import { P as PolicyQuery, A as Awaitable, a as PolicyRuleRow, b as PolicyAdapter } from '../types-DzC5zTZ8.js';
2
+
3
+ /**
4
+ * A drizzle table, behind the ports the kernel reads.
5
+ *
6
+ * Nothing here imports `drizzle-orm`. The query is the store's — a repo whose law says queries are
7
+ * builders living in its own data layer would not accept one written in a dependency, and a package
8
+ * that carried the ORM would be unusable in the other consumer's runtime. What this contributes is
9
+ * the column contract, the mapping, and the posture: a store that is down answers with nothing and
10
+ * changes no decision.
11
+ */
12
+ /** The columns the kernel reads. Declared once, so a table and a mapper cannot drift apart. */
13
+ declare const policyRuleColumns: {
14
+ readonly constraint_kind: "text";
15
+ readonly constraint_value: "json";
16
+ readonly overridable: "boolean";
17
+ readonly reason: "text";
18
+ readonly rule_key: "text";
19
+ readonly scope: "json";
20
+ readonly status: "text";
21
+ readonly tier: "text";
22
+ };
23
+ /** The journal's columns. There is no `rejected` one: a rejection is written into `error`. */
24
+ declare const policyJournalColumns: {
25
+ readonly actor_id: "text";
26
+ readonly actor_kind: "text";
27
+ readonly error: "text";
28
+ readonly event_name: "text";
29
+ readonly fell_back_to: "json";
30
+ readonly op: "text";
31
+ readonly subject: "text";
32
+ };
33
+ type DrizzlePolicyAdapterOptions = {
34
+ config?: (kind: string, query: PolicyQuery) => Awaitable<unknown>;
35
+ /** Absent when the store has no journal table. Half an adapter is honest; a silent drop is not. */
36
+ journal?: (row: Record<string, unknown>) => Awaitable<unknown>;
37
+ rules: (filter: {
38
+ status: string;
39
+ }) => Awaitable<readonly PolicyRuleRow[]>;
40
+ };
41
+ declare const createDrizzlePolicyAdapter: (options: DrizzlePolicyAdapterOptions) => PolicyAdapter;
42
+
43
+ export { type DrizzlePolicyAdapterOptions, createDrizzlePolicyAdapter, policyJournalColumns, policyRuleColumns };
@@ -0,0 +1,54 @@
1
+ import {
2
+ toPolicyRules
3
+ } from "../chunk-JICJ4XEX.js";
4
+
5
+ // src/drizzle/index.ts
6
+ var policyRuleColumns = {
7
+ constraint_kind: "text",
8
+ constraint_value: "json",
9
+ overridable: "boolean",
10
+ reason: "text",
11
+ rule_key: "text",
12
+ scope: "json",
13
+ status: "text",
14
+ tier: "text"
15
+ };
16
+ var policyJournalColumns = {
17
+ actor_id: "text",
18
+ actor_kind: "text",
19
+ error: "text",
20
+ event_name: "text",
21
+ fell_back_to: "json",
22
+ op: "text",
23
+ subject: "text"
24
+ };
25
+ var attempt = async (what) => {
26
+ try {
27
+ return await what();
28
+ } catch {
29
+ return void 0;
30
+ }
31
+ };
32
+ var toRow = (entry) => ({
33
+ actor_kind: "system",
34
+ ...entry.rejected ? { error: `rejected ${JSON.stringify(entry.rejected.value)}: ${entry.rejected.reason}` } : {},
35
+ event_name: entry.event,
36
+ fell_back_to: { constraintKind: entry.kind, value: entry.fellBackTo },
37
+ ...entry.op ? { op: entry.op } : {},
38
+ ...entry.subject ? { subject: entry.subject } : {}
39
+ });
40
+ var createDrizzlePolicyAdapter = (options) => ({
41
+ ...options.config ? { config: { get: async (kind, query) => attempt(() => options.config?.(kind, query)) } } : {},
42
+ ...options.journal ? {
43
+ journal: {
44
+ write: async (entry) => void await attempt(() => options.journal?.(toRow(entry)))
45
+ }
46
+ } : {},
47
+ name: "drizzle",
48
+ rule: { rules: async () => toPolicyRules(await options.rules({ status: "active" }) ?? []) }
49
+ });
50
+ export {
51
+ createDrizzlePolicyAdapter,
52
+ policyJournalColumns,
53
+ policyRuleColumns
54
+ };