@bridgebrew/storage 0.0.0-stage → 0.0.1

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/package.json CHANGED
@@ -1,6 +1,56 @@
1
1
  {
2
2
  "name": "@bridgebrew/storage",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.0.1",
4
+ "license": "MIT",
5
+ "description": "Stores every plugin's data in the workspace, with its history; the audit trail is storage-tools-audit's.",
6
+ "keywords": [
7
+ "bridge-plugin"
8
+ ],
9
+ "type": "module",
10
+ "files": [
11
+ "*.json",
12
+ "*.ts",
13
+ "browser/",
14
+ "!**/*.test.ts",
15
+ "!**/*.test.tsx"
16
+ ],
17
+ "bridge": {
18
+ "kind": "service",
19
+ "category": "foundation",
20
+ "title": "Storage",
21
+ "icon": "database",
22
+ "domain": "data",
23
+ "server": "./server.ts",
24
+ "browser": "./browser/browser.tsx",
25
+ "settingsPage": true,
26
+ "implements": [
27
+ "storage"
28
+ ],
29
+ "requires": {
30
+ "storageBackend": {}
31
+ },
32
+ "exposes": {
33
+ "storage": "1.0.0"
34
+ },
35
+ "provenance": "official"
36
+ },
37
+ "dependencies": {
38
+ "zod": "4.6.5"
39
+ },
40
+ "peerDependencies": {
41
+ "@bridge/plugin-manager": ">=0.0.1",
42
+ "@bridge/storage": ">=0.0.1",
43
+ "@bridge/ui": ">=0.0.1",
44
+ "@bridge/worker-runtime": ">=0.0.1",
45
+ "cordis": "4.0.0-rc.11",
46
+ "react": "19.3.0"
47
+ },
48
+ "releaseStage": "dev",
49
+ "scripts": {
50
+ "test": "node ../bridge/node_modules/vitest/vitest.mjs run --config ../scripts/vitest.config.ts",
51
+ "typecheck": "bridge plugin check ."
52
+ },
53
+ "engines": {
54
+ "bridge": ">=0.0.1-nightly.20261117.1"
55
+ }
56
+ }
package/references.ts ADDED
@@ -0,0 +1,97 @@
1
+ // References (AD-24): a reference is `{ domain, id }`, declared per top-level field of a domain's values
2
+ // (`references: { [field]: domainId }`); the storage plugin keeps, in memory, the "used by" index of every reference
3
+ // held by a declared domain.
4
+ import { z } from 'zod';
5
+
6
+ /** The reserved domain of the workspace's nodes (the worker's `nodes` service): a facet or reference target. */
7
+ export const nodeDomain = 'bridge/node';
8
+
9
+ export interface Reference {
10
+ domain: string;
11
+ id: string;
12
+ }
13
+
14
+ /** Who holds a reference: the referrer's domain and id (a facet's id is its target's), and the field. */
15
+ export interface Referrer extends Reference {
16
+ field: string;
17
+ }
18
+
19
+ /** Per top-level field of a value, the domain id its reference(s) point to. */
20
+ export type References = Record<string, string>;
21
+
22
+ /** The schema of a reference to `domain`: `{ domain, id }`, with exactly that domain. */
23
+ export const reference = (domain: string) =>
24
+ z.strictObject({ domain: z.literal(domain), id: z.string().min(1) });
25
+
26
+ /** The values of a domain declaring `references`: each such field, when present, holds a reference to its declared
27
+ * domain or an array of them (a reference to another domain fails validation). */
28
+ export const referencesSchema = (references: References) =>
29
+ z.looseObject(
30
+ Object.fromEntries(
31
+ Object.entries(references).map(([field, domain]) => [
32
+ field,
33
+ z.union([reference(domain), z.array(reference(domain))]).optional(),
34
+ ]),
35
+ ),
36
+ );
37
+
38
+ /** The well-formed references `value` holds in its declared fields (validation refuses the others). */
39
+ export const referencesIn = (value: unknown, references: References): Referrer[] =>
40
+ Object.entries(references).flatMap(([field, domain]) => {
41
+ const held =
42
+ typeof value === 'object' && value !== null
43
+ ? (value as Record<string, unknown>)[field]
44
+ : undefined;
45
+ return (Array.isArray(held) ? held : [held])
46
+ .filter((each) => reference(domain).safeParse(each).success)
47
+ .map((each) => ({ domain, id: (each as Reference).id, field }));
48
+ });
49
+
50
+ /** The reverse index: per referenced `{ domain, id }`, who references it. Rebuilt from records, never persisted. */
51
+ export function referenceIndex() {
52
+ const key = (...parts: string[]) => parts.join('\0');
53
+ /** Per referrer domain, per referrer id: the references it holds. */
54
+ const held = new Map<string, Map<string, Referrer[]>>();
55
+ /** Per referenced `domain\0id`: its referrers as `domain\0id\0field`. */
56
+ const users = new Map<string, Set<string>>();
57
+ const drop = (domain: string, id: string) => {
58
+ for (const ref of held.get(domain)?.get(id) ?? []) {
59
+ const set = users.get(key(ref.domain, ref.id));
60
+ set?.delete(key(domain, id, ref.field));
61
+ if (set?.size === 0) users.delete(key(ref.domain, ref.id));
62
+ }
63
+ held.get(domain)?.delete(id);
64
+ };
65
+ return {
66
+ /** Replaces what referrer `{ domain, id }` holds by `refs`. */
67
+ set(domain: string, id: string, refs: Referrer[]) {
68
+ drop(domain, id);
69
+ if (refs.length === 0) return;
70
+ if (!held.has(domain)) held.set(domain, new Map());
71
+ held.get(domain)!.set(id, refs);
72
+ for (const ref of refs) {
73
+ const target = key(ref.domain, ref.id);
74
+ if (!users.has(target)) users.set(target, new Set());
75
+ users.get(target)!.add(key(domain, id, ref.field));
76
+ }
77
+ },
78
+ /** Forgets every reference domain `domain` holds (released: its plugin is not loaded). */
79
+ release(domain: string) {
80
+ for (const id of [...(held.get(domain)?.keys() ?? [])]) drop(domain, id);
81
+ held.delete(domain);
82
+ },
83
+ /** Every referenced `{ domain, id }`. */
84
+ targets(): Reference[] {
85
+ return [...users.keys()].map((each) => {
86
+ const [domain, id] = each.split('\0') as [string, string];
87
+ return { domain, id };
88
+ });
89
+ },
90
+ usedBy({ domain, id }: Reference): Referrer[] {
91
+ return [...(users.get(key(domain, id)) ?? [])].sort().map((each) => {
92
+ const [referrer, referrerId, field] = each.split('\0') as [string, string, string];
93
+ return { domain: referrer, id: referrerId, field };
94
+ });
95
+ },
96
+ };
97
+ }