@marktiderman/genesis-core 2.1.0 → 2.2.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.
@@ -0,0 +1,130 @@
1
+ import { R as ResourceScope, G as GenesisViewerRoles } from './viewer-scope-bthEYSOB.js';
2
+ import 'react';
3
+ import '@tanstack/react-query';
4
+ import './dates.js';
5
+
6
+ /**
7
+ * Workspaces (docs/adr/0004-workspaces.md): where the viewer is working, chosen first and kept in
8
+ * the URL. A workspace is one tenant (an organization), the roll-up across them, or the viewer's
9
+ * own personal space. Everything inside it is scoped to it: its `scope` is the `ResourceScope`
10
+ * every view reads, and its path prefixes every URL inside it.
11
+ *
12
+ * Router-free and DOM-free, like `navigation`: web and native shells share it.
13
+ */
14
+
15
+ /**
16
+ * The kinds of workspace. Genesis ships three; an app adds its own by module augmentation, and
17
+ * the switcher groups and orders them like the built-in ones:
18
+ *
19
+ * ```ts
20
+ * declare module "@marktiderman/genesis-core/workspaces" {
21
+ * interface GenesisWorkspaceKinds {
22
+ * location: true;
23
+ * }
24
+ * }
25
+ * ```
26
+ *
27
+ * @stability Beta
28
+ */
29
+ interface GenesisWorkspaceKinds {
30
+ /** One tenant: an organization the viewer is a member or staff of. */
31
+ tenant: true;
32
+ /** The roll-up across every tenant the viewer works in. */
33
+ rollup: true;
34
+ /** The viewer's own things, belonging to no tenant. */
35
+ personal: true;
36
+ }
37
+ /** @stability Beta */
38
+ type WorkspaceKind = keyof GenesisWorkspaceKinds;
39
+ /**
40
+ * One place the viewer can work in.
41
+ *
42
+ * @stability Beta
43
+ */
44
+ interface Workspace {
45
+ /** Unique among the viewer's workspaces. For a tenant, usually its URL segment. */
46
+ id: string;
47
+ kind: WorkspaceKind;
48
+ /** Its name: the organization's name, "All organizations", "Personal". */
49
+ label: string;
50
+ /** A second line in the switcher: the viewer's role there, a location. */
51
+ description?: string;
52
+ /**
53
+ * Where it starts, and the prefix of every URL inside it: `/o/acme`, `/all`, `/me`. Matched at
54
+ * segment boundaries, so `/o/acme` never matches `/o/acme-west`.
55
+ */
56
+ path: string;
57
+ /** What views read inside it: `{ orgId }`, `{ orgId: [...] }`, `{ personId }`. */
58
+ scope: ResourceScope;
59
+ /** The viewer's roles here, for view guards (see `GenesisViewerRoles`). */
60
+ roles?: GenesisViewerRoles;
61
+ /** The workspace's IANA time zone, for columns read on the scope's clock. */
62
+ timeZone?: string | null;
63
+ /** Its picture: a logo URL, else initials made from `label`. */
64
+ image?: string;
65
+ /** Anything else the app needs; Genesis never reads it. */
66
+ meta?: Readonly<Record<string, unknown>>;
67
+ }
68
+ /** The kinds in their default order: personal, roll-up, then each tenant. */
69
+ declare const WORKSPACE_KIND_ORDER: readonly WorkspaceKind[];
70
+ /**
71
+ * The workspace a URL is in: the one whose `path` is the longest prefix of `pathname`, or
72
+ * undefined when the URL is in none (a sign-in page, the app's front door).
73
+ *
74
+ * @stability Beta
75
+ */
76
+ declare function workspaceAt<W extends Workspace>(workspaces: readonly W[], pathname: string): W | undefined;
77
+ /**
78
+ * The path inside a workspace: `/o/acme/clients/42` in `/o/acme` is `/clients/42`; the workspace's
79
+ * own landing page is `/`.
80
+ *
81
+ * @stability Beta
82
+ */
83
+ declare function pathInWorkspace(workspace: Pick<Workspace, "path">, pathname: string): string;
84
+ /** @stability Beta */
85
+ interface WorkspaceHrefOptions {
86
+ /**
87
+ * Whether to keep the viewer's place when switching: given the path inside the current
88
+ * workspace (`/clients`) and the two workspaces, return the path to open in the target, or
89
+ * false for its landing page. By default the place is kept between workspaces of the same kind,
90
+ * up to the first segment (a list, not one record that belongs to the old workspace):
91
+ * `/o/acme/clients/42` switches to `/o/globex/clients`.
92
+ */
93
+ keep?: (rest: string, from: Workspace, to: Workspace) => string | false;
94
+ }
95
+ /** The default `keep`: the same kind keeps the section (the first segment), never a record. */
96
+ declare function keepSection(rest: string, from: Workspace, to: Workspace): string | false;
97
+ /**
98
+ * Where switching to `to` goes from `pathname`. The URL moves with the viewer: it lands in the same
99
+ * section of the new workspace when that makes sense (see `keep`), else on its landing page.
100
+ *
101
+ * @stability Beta
102
+ */
103
+ declare function workspaceHref(workspaces: readonly Workspace[], to: Workspace, pathname: string | undefined, options?: WorkspaceHrefOptions): string;
104
+ /** @stability Beta */
105
+ interface WorkspaceGroup<W extends Workspace = Workspace> {
106
+ kind: WorkspaceKind;
107
+ workspaces: W[];
108
+ }
109
+ /**
110
+ * The workspaces grouped by kind, in `order` (default {@link WORKSPACE_KIND_ORDER}, then any kind
111
+ * an app added), each group in the order given. Empty groups are left out.
112
+ *
113
+ * @stability Beta
114
+ */
115
+ declare function groupWorkspaces<W extends Workspace>(workspaces: readonly W[], order?: readonly WorkspaceKind[]): WorkspaceGroup<W>[];
116
+ /**
117
+ * The workspace to open when the URL names none (the app's front door): the remembered one if the
118
+ * viewer still has it, else the first tenant, else the first workspace.
119
+ *
120
+ * @stability Beta
121
+ */
122
+ declare function defaultWorkspace<W extends Workspace>(workspaces: readonly W[], rememberedId?: string | null): W | undefined;
123
+ /**
124
+ * Initials for a workspace with no image: the first letters of its first two words.
125
+ *
126
+ * @stability Beta
127
+ */
128
+ declare function workspaceInitials(label: string): string;
129
+
130
+ export { type GenesisWorkspaceKinds, WORKSPACE_KIND_ORDER, type Workspace, type WorkspaceGroup, type WorkspaceHrefOptions, type WorkspaceKind, defaultWorkspace, groupWorkspaces, keepSection, pathInWorkspace, workspaceAt, workspaceHref, workspaceInitials };
@@ -0,0 +1,3 @@
1
+ export { WORKSPACE_KIND_ORDER, defaultWorkspace, groupWorkspaces, keepSection, pathInWorkspace, workspaceAt, workspaceHref, workspaceInitials } from './chunk-5JRXF7F7.js';
2
+ //# sourceMappingURL=workspaces.js.map
3
+ //# sourceMappingURL=workspaces.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":"","file":"workspaces.js"}
package/package.json CHANGED
@@ -1,10 +1,23 @@
1
1
  {
2
2
  "name": "@marktiderman/genesis-core",
3
- "version": "2.1.0",
3
+ "version": "2.2.0",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "sideEffects": false,
7
7
  "description": "Genesis platform-agnostic providers, hooks, and data layer. Part of the Genesis framework.",
8
+ "keywords": [
9
+ "genesis",
10
+ "genesis-framework",
11
+ "react",
12
+ "data-layer",
13
+ "providers",
14
+ "hooks",
15
+ "supabase"
16
+ ],
17
+ "homepage": "https://github.com/marktiderman/genesis/tree/main/packages/core#readme",
18
+ "bugs": {
19
+ "url": "https://github.com/marktiderman/genesis/issues"
20
+ },
8
21
  "repository": {
9
22
  "type": "git",
10
23
  "url": "git+https://github.com/marktiderman/genesis.git",
@@ -51,6 +64,10 @@
51
64
  "types": "./dist/navigation.d.ts",
52
65
  "import": "./dist/navigation.js"
53
66
  },
67
+ "./workspaces": {
68
+ "types": "./dist/workspaces.d.ts",
69
+ "import": "./dist/workspaces.js"
70
+ },
54
71
  "./testing": {
55
72
  "types": "./dist/testing/index.d.ts",
56
73
  "import": "./dist/testing/index.js"
@@ -97,7 +114,7 @@
97
114
  "@testing-library/react": "^16.3.2",
98
115
  "@types/react": "^19.2.14",
99
116
  "@types/react-dom": "^19.2.3",
100
- "happy-dom": "^20.9.0",
117
+ "happy-dom": "^21.0.4",
101
118
  "react": "^19.0.0",
102
119
  "react-dom": "^19.0.0",
103
120
  "react-hook-form": "^7.56.4",
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/hooks/viewer-scope.tsx"],"names":["Fragment"],"mappings":";;;;;;;;;AAUA,IAAI,cAAA,GAAiB,KAAA;AAOrB,SAAS,WAAW,KAAA,EAA+C;AACjE,EAAA,IAAI,QAAA,GAAW,KAAA;AACf,EAAA,MAAM,KAAA,GAAQ,CAAC,CAAA,KAAwB;AACrC,IAAA,IAAI,MAAM,OAAA,CAAQ,CAAC,GAAG,OAAO,CAAA,CAAE,IAAI,KAAK,CAAA,CAAE,GAAA,CAAI,CAAC,MAAM,CAAC,UAAA,CAAW,CAAC,CAAA,EAAG,CAAC,CAAU,CAAA,CAAE,IAAA,CAAK,CAAC,CAAC,CAAC,CAAA,EAAG,CAAC,CAAC,CAAA,KAAO,CAAA,GAAI,IAAI,EAAA,GAAK,CAAA,GAAI,IAAI,CAAA,GAAI,CAAE,EAAE,GAAA,CAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;AACnJ,IAAA,IAAI,CAAA,IAAK,OAAO,CAAA,KAAM,QAAA,EAAU;AAC9B,MAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,cAAA,CAAe,CAAC,CAAA;AACrC,MAAA,IAAI,KAAA,KAAU,MAAA,CAAO,SAAA,IAAa,KAAA,KAAU,IAAA,EAAM;AAChD,QAAA,IAAI,QAAQ,GAAA,CAAI,QAAA,KAAa,cAAc,MAAM,IAAI,UAAU,4EAA4E,CAAA;AAC3I,QAAA,QAAA,GAAW,IAAA;AACX,QAAA,OAAO,IAAA;AAAA,MACT;AACA,MAAA,OAAO,OAAO,WAAA,CAAY,MAAA,CAAO,QAAQ,CAA4B,CAAA,CAAE,IAAI,CAAC,CAAC,CAAA,EAAG,CAAC,MAAM,CAAC,CAAA,EAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;AAAA,IACvG;AACA,IAAA,OAAO,CAAA;AAAA,EACT,CAAA;AACA,EAAA,MAAM,GAAA,GAAM,UAAA,CAAW,KAAA,CAAM,KAAK,CAAC,CAAA;AACnC,EAAA,IAAI,CAAC,UAAU,OAAO,GAAA;AACtB,EAAA,IAAI,CAAC,cAAA,EAAgB;AACnB,IAAA,cAAA,GAAiB,IAAA;AACjB,IAAA,WAAA,CAAY,IAAI,SAAA,CAAU,wHAAwH,CAAA,EAAG,mBAAmB,CAAA;AAAA,EAC1K;AACA,EAAA,OAAO,MAAA;AACT;AAGA,SAAS,SAAS,IAAA,EAAmB;AACnC,EAAA,MAAM,CAAC,KAAK,MAAM,CAAA,GAAI,SAAS,MAAM,KAAA,CAAM,IAAI,CAAC,CAAA;AAChD,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,MAAM,KAAA,GAAQ,MAAM,MAAA,CAAO,KAAA,CAAM,IAAI,CAAC,CAAA;AACtC,IAAA,KAAA,EAAM;AACN,IAAA,MAAM,YAAY,MAAM;AACtB,MAAA,IAAI,OAAO,QAAA,KAAa,WAAA,IAAe,QAAA,CAAS,eAAA,KAAoB,WAAW,KAAA,EAAM;AAAA,IACvF,CAAA;AACA,IAAA,IAAI,OAAO,QAAA,KAAa,WAAA,EAAa,QAAA,CAAS,gBAAA,CAAiB,oBAAoB,SAAS,CAAA;AAE5F,IAAA,MAAM,KAAA,GAAQ,WAAA,CAAY,KAAA,EAAO,GAAM,CAAA;AACvC,IAAA,OAAO,MAAM;AACX,MAAA,IAAI,OAAO,QAAA,KAAa,WAAA,EAAa,QAAA,CAAS,mBAAA,CAAoB,oBAAoB,SAAS,CAAA;AAC/F,MAAA,aAAA,CAAc,KAAK,CAAA;AAAA,IACrB,CAAA;AAAA,EACF,CAAA,EAAG,CAAC,IAAI,CAAC,CAAA;AACT,EAAA,OAAO,GAAA;AACT;AAQA,eAAsB,iBAAiB,WAAA,EAAyC;AAC9E,EAAA,MAAM,mBAAmB,WAAW,CAAA;AACpC,EAAA,MAAM,YAAY,aAAA,EAAc;AAChC,EAAA,WAAA,CAAY,KAAA,EAAM;AACpB;AAoCA,IAAM,kBAAA,GAAqB,cAAoC,IAAI,CAAA;AAG5D,SAAS,cAAA,GAAgC;AAC9C,EAAA,MAAM,KAAA,GAAQ,WAAW,kBAAkB,CAAA;AAC3C,EAAA,IAAI,CAAC,KAAA,EAAO,MAAM,IAAI,MAAM,8DAA8D,CAAA;AAC1F,EAAA,OAAO,KAAA;AACT;AAGO,SAAS,sBAAA,GAA+C;AAC7D,EAAA,OAAO,WAAW,kBAAkB,CAAA;AACtC;AAOO,SAAS,SAAA,GAAoB;AAClC,EAAA,MAAM,OAAA,GAAU,WAAW,kBAAkB,CAAA;AAC7C,EAAA,OAAO,OAAA;AAAA,IACL,MACE,UACI,MAAA,CAAO,MAAA,CAAO,EAAE,EAAA,EAAI,OAAA,CAAQ,MAAA,EAAQ,KAAA,EAAO,OAAA,CAAQ,KAAA,EAAO,GAAI,OAAA,CAAQ,KAAA,KAAU,MAAA,GAAY,EAAE,KAAA,EAAO,OAAA,CAAQ,OAAM,GAAI,EAAC,EAAI,CAAA,GAC5H,SAAA;AAAA,IACN,CAAC,OAAO;AAAA,GACV;AACF;AA2CO,SAAS,UAAA,CAAW,eAA0C,UAAA,EAA4B;AAC/F,EAAA,IAAI,kBAAkB,MAAA,IAAa,aAAA,KAAkB,IAAA,IAAQ,aAAA,KAAkB,IAAI,OAAO,UAAA;AAC1F,EAAA,IAAI,UAAA,CAAW,aAAa,CAAA,EAAG,OAAO,aAAA;AACtC,EAAA,MAAM,KAAA,GAAQ,IAAI,UAAA,CAAW,CAAA,8BAAA,EAAiC,aAAa,CAAA,6EAAA,CAA+E,CAAA;AAC1J,EAAA,IAAI,OAAA,CAAQ,GAAA,CAAI,QAAA,KAAa,YAAA,EAAc,MAAM,KAAA;AAEjD,EAAA,IAAI,CAAC,kBAAA,CAAmB,GAAA,CAAI,aAAa,CAAA,EAAG;AAC1C,IAAA,kBAAA,CAAmB,IAAI,aAAa,CAAA;AACpC,IAAA,WAAA,CAAY,OAAO,mBAAmB,CAAA;AAAA,EACxC;AACA,EAAA,OAAO,UAAA;AACT;AAGA,IAAM,kBAAA,uBAAyB,GAAA,EAAY;AAgBpC,SAAS,WAAA,CAAY,EAAE,MAAA,EAAQ,eAAA,EAAiB,KAAA,EAAO,KAAA,EAAO,QAAA,EAAU,aAAA,EAAe,QAAA,GAAW,IAAA,EAAM,QAAA,EAAS,EAAqB;AAC3I,EAAA,MAAM,cAAc,cAAA,EAAe;AACnC,EAAA,MAAM,IAAA,GAAO,cAAA,CAAe,EAAE,QAAA,EAAU,CAAA;AAExC,EAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,MAAM,UAAA,CAAW,aAAA,EAAe,IAAI,CAAA,EAAG,CAAC,aAAA,EAAe,IAAI,CAAC,CAAA;AACtF,EAAA,MAAM,GAAA,GAAM,SAAS,IAAI,CAAA;AAEzB,EAAA,MAAM,QAAA,GAAW,UAAA,CAAW,KAAA,IAAS,EAAE,CAAA;AAGvC,EAAA,MAAM,QAAA,GAAW,KAAA,KAAU,MAAA,GAAY,MAAA,GAAY,WAAW,KAAK,CAAA;AACnE,EAAA,MAAM,KAAA,GAAQ,OAAA;AAAA,IACZ,OAAO,EAAE,MAAA,EAAQ,MAAA,IAAU,MAAM,KAAA,EAAO,KAAA,IAAS,EAAC,EAAG,GAAI,aAAa,MAAA,GAAY,EAAE,OAAM,GAAI,IAAK,QAAA,EAAU,IAAA,EAAM,aAAA,EAAe,SAAA,EAAW,GAAA,EAAI,CAAA;AAAA;AAAA,IAEjJ,CAAC,MAAA,EAAQ,QAAA,EAAU,QAAA,EAAU,IAAA,EAAM,WAAW,GAAG;AAAA,GACnD;AAKA,EAAA,MAAM,QAAQ,MAAA,CAAyE,EAAE,MAAA,EAAQ,KAAA,EAAO,QAAW,CAAA;AACnH,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,KAAA,CAAM,QAAQ,MAAA,KAAW,MAAA,QAAc,OAAA,GAAU,EAAE,MAAA,EAAQ,KAAA,EAAO,MAAA,EAAU;AAChF,IAAA,IAAI,aAAa,MAAA,EAAW;AAC5B,IAAA,MAAM,QAAA,GAAW,MAAM,OAAA,CAAQ,KAAA;AAC/B,IAAA,KAAA,CAAM,QAAQ,KAAA,GAAQ,QAAA;AACtB,IAAA,IAAI,QAAA,KAAa,MAAA,IAAa,QAAA,KAAa,QAAA,EAAU;AAGrD,IAAA,KAAK,mBAAmB,WAAW,CAAA,CAAE,KAAK,MAAM,WAAA,CAAY,mBAAmB,CAAA;AAAA,EACjF,CAAA,EAAG,CAAC,MAAA,EAAQ,QAAA,EAAU,WAAW,CAAC,CAAA;AAGlC,EAAA,MAAM,CAAC,OAAA,EAAS,UAAU,CAAA,GAAI,SAA+D,MAAS,CAAA;AACtG,EAAA,IAAI,WAAW,MAAA,EAAW,uBAAO,GAAA,CAAAA,QAAAA,EAAA,EAAG,QAAA,EAAA,QAAA,EAAS,CAAA;AAC7C,EAAA,IAAI,OAAA,KAAY,MAAA,IAAa,OAAA,CAAQ,MAAA,KAAW,MAAA,EAAQ;AACtD,IAAA,MAAM,IAAA,GAAO,OAAA,KAAY,MAAA,IAAa,eAAA,KAAoB,UAAa,eAAA,KAAoB,MAAA;AAG3F,IAAA,IAAI,CAAC,IAAA,EAAM;AAIT,MAAA,iBAAA,CAAkB,WAAW,CAAA;AAC7B,MAAA,KAAK,YAAY,aAAA,EAAc;AAC/B,MAAA,WAAA,CAAY,KAAA,EAAM;AAAA,IACpB;AACA,IAAA,UAAA,CAAW,EAAE,MAAA,EAAQ,KAAA,EAAA,CAAQ,SAAS,KAAA,IAAS,CAAA,IAAK,GAAG,CAAA;AACvD,IAAA,uBAAO,GAAA,CAAAA,QAAAA,EAAA,EAAG,QAAA,EAAA,QAAA,EAAS,CAAA;AAAA,EACrB;AACA,EAAA,uBACE,GAAA,CAAC,kBAAA,CAAmB,QAAA,EAAnB,EAA4B,OAC3B,QAAA,kBAAA,GAAA,CAACA,UAAA,EAAA,EAA6D,QAAA,EAAA,EAA/C,CAAA,EAAG,UAAU,YAAY,CAAA,CAAA,EAAI,OAAA,CAAQ,KAAK,EAAc,CAAA,EACzE,CAAA;AAEJ","file":"chunk-3FFBW4XC.js","sourcesContent":["import { useQueryClient, type QueryClient } from \"@tanstack/react-query\";\nimport { createContext, Fragment, useContext, useEffect, useMemo, useRef, useState, type ReactNode } from \"react\";\nimport { dayIn, isTimeZone, personTimeZone, type Day } from \"../dates\";\nimport { reportError } from \"../errors\";\nimport { stableJson } from \"./draft-controller\";\nimport { NO_VIEWER, type GenesisViewerRoles, type Viewer } from \"../viewer\";\nimport { dropPendingWrites, flushPendingWrites } from \"./mutation-mode\";\n\nexport { NO_VIEWER, type GenesisViewerRoles, type Viewer };\n\nlet warnedNotPlain = false;\n\n/**\n * Roles as a value: object keys and lists sorted, so `[\"editor\", \"owner\"]` equals\n * `[\"owner\", \"editor\"]`. A Set, Map or class would stringify as `{}` and hide a change: in\n * development that throws; in production it warns once and the roles count as unknown (undefined).\n */\nfunction rolesKeyOf(roles: GenesisViewerRoles): string | undefined {\n let notPlain = false;\n const plain = (v: unknown): unknown => {\n if (Array.isArray(v)) return v.map(plain).map((x) => [stableJson(x), x] as const).sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0)).map(([, x]) => x);\n if (v && typeof v === \"object\") {\n const proto = Object.getPrototypeOf(v);\n if (proto !== Object.prototype && proto !== null) {\n if (process.env.NODE_ENV !== \"production\") throw new TypeError(\"[genesis-core] ViewerScope roles must be plain JSON (no Set, Map or class)\");\n notPlain = true;\n return null;\n }\n return Object.fromEntries(Object.entries(v as Record<string, unknown>).map(([k, x]) => [k, plain(x)]));\n }\n return v;\n };\n const key = stableJson(plain(roles));\n if (!notPlain) return key;\n if (!warnedNotPlain) {\n warnedNotPlain = true;\n reportError(new TypeError(\"ViewerScope roles must be plain JSON (no Set, Map or class); treating them as unknown, so guards that need them refuse\"), \"core:viewer-scope\");\n }\n return undefined;\n}\n\n/** Today in `zone`, rechecked when the page comes back into view and at the next minute boundary while it's open. */\nfunction useToday(zone: string): Day {\n const [day, setDay] = useState(() => dayIn(zone));\n useEffect(() => {\n const check = () => setDay(dayIn(zone));\n check();\n const onVisible = () => {\n if (typeof document === \"undefined\" || document.visibilityState === \"visible\") check();\n };\n if (typeof document !== \"undefined\") document.addEventListener(\"visibilitychange\", onVisible);\n // A page left open over midnight rolls over within a minute.\n const timer = setInterval(check, 60_000);\n return () => {\n if (typeof document !== \"undefined\") document.removeEventListener(\"visibilitychange\", onVisible);\n clearInterval(timer);\n };\n }, [zone]);\n return day;\n}\n\n/**\n * Empties the query cache for a new viewer: sends the old viewer's waiting\n * undoable writes (the session is still theirs), cancels reads in flight,\n * then removes every query. Call it in the sign-in and sign-out actions,\n * before the session changes.\n */\nexport async function clearViewerCache(queryClient: QueryClient): Promise<void> {\n await flushPendingWrites(queryClient);\n await queryClient.cancelQueries();\n queryClient.clear();\n}\n\n/**\n * Where the viewer is working: the person, space or set of people Genesis knows by name, plus\n * whatever the app scopes to under its own key (`{ orgId }`, `{ leagueId }`, `{ locationId }`).\n * Screens turn it into server filters and create defaults (a view's `scope: [\"league_id\"]` reads\n * `league_id`, then `leagueId`); it never decides access (row-level security does).\n */\nexport interface ResourceScope {\n personId?: string;\n spaceId?: string;\n /** Several people at once (a coach's client list, a group). */\n personIds?: readonly string[];\n /** The app's own scope keys: `orgId`, `leagueId`, `locationId`, … */\n [key: string]: unknown;\n}\n\nexport interface ViewerContext {\n viewer: string | null;\n scope: ResourceScope;\n /** The viewer's roles (see `GenesisViewerRoles`), when ViewerScope was given them. */\n roles?: GenesisViewerRoles;\n /** The zone the viewer's days are counted in: theirs if known, else the device's. */\n timeZone: string;\n /**\n * The zone of whatever the viewer is scoped to (a location, a league), for columns with\n * `timeZone: \"scope\"`: ViewerScope's `scopeTimeZone` when valid, else {@link timeZone}.\n */\n scopeTimeZone?: string;\n /**\n * Today on the viewer's clock (YYYY-MM-DD), kept current when the page comes back into view.\n * Use it for every \"today\" read and as query keys' `day`: `keys.for(useViewerScope())`.\n */\n day: Day;\n}\n\nconst ViewerContextValue = createContext<ViewerContext | null>(null);\n\n/** The viewer and scope from the nearest `ViewerScope`. Throws without one: screens that cache per viewer need it. */\nexport function useViewerScope(): ViewerContext {\n const value = useContext(ViewerContextValue);\n if (!value) throw new Error(\"[genesis-core] useViewerScope needs a <ViewerScope> above it\");\n return value;\n}\n\n/** Like useViewerScope, or null outside a ViewerScope. */\nexport function useOptionalViewerScope(): ViewerContext | null {\n return useContext(ViewerContextValue);\n}\n\n/**\n * The viewer for guards: `{ id, scope, roles }` from the nearest ViewerScope, or\n * {@link NO_VIEWER} without one. The object is stable while those are equal by value, so it can\n * sit in a memo's dependencies.\n */\nexport function useViewer(): Viewer {\n const context = useContext(ViewerContextValue);\n return useMemo<Viewer>(\n () =>\n context\n ? Object.freeze({ id: context.viewer, scope: context.scope, ...(context.roles !== undefined ? { roles: context.roles } : {}) })\n : NO_VIEWER,\n [context],\n );\n}\n\nexport interface ViewerScopeProps {\n /** The signed-in viewer's id, null when signed out, undefined while the session loads. */\n viewer: string | null | undefined;\n /**\n * The viewer a persisted cache was saved for. When the first known viewer\n * is this one, the restored cache is kept; otherwise it's emptied.\n */\n persistedViewer?: string | null;\n /** Where the viewer is working (see `ResourceScope`). Changing it doesn't remount or clear anything. */\n scope?: ResourceScope;\n /**\n * What the viewer may do there (see `GenesisViewerRoles`), for view guards. Compared by value,\n * so a new object with the same roles changes nothing. Undefined while they load: guards that\n * need them refuse. Arriving (undefined → roles) or going back to undefined changes nothing;\n * different roles send the person's waiting writes, then reread every query, with nothing\n * remounted. Plain JSON values only (lists are compared as sets, in any order): a Set, Map or\n * class instance throws in development; in production it warns once and the roles count as\n * unknown (as if undefined), so guards that need them refuse.\n */\n roles?: GenesisViewerRoles;\n /**\n * The viewer's saved time zone (IANA), when known; else the device's is used. Pass it when\n * rendering on a server, whose own zone is rarely the viewer's.\n */\n timeZone?: string | null;\n /**\n * The IANA zone of whatever the viewer is scoped to (a location, a league), when it has one.\n * Columns with `timeZone: \"scope\"` read on it; without it they read on the viewer's clock.\n */\n scopeTimeZone?: string | null;\n /** Shown while the session loads (and for the one render a change takes). */\n fallback?: ReactNode;\n children: ReactNode;\n}\n\n/**\n * The scope's clock: `scopeTimeZone` when the runtime knows it, else the viewer's. A zone it\n * doesn't know is never a quiet fallback: it throws in development, and in production it is\n * reported (`reportError`, once per zone) before the viewer's clock is used, so a misspelt zone can't show\n * times on the wrong clock unnoticed.\n */\nexport function scopeClock(scopeTimeZone: string | null | undefined, viewerZone: string): string {\n if (scopeTimeZone === undefined || scopeTimeZone === null || scopeTimeZone === \"\") return viewerZone;\n if (isTimeZone(scopeTimeZone)) return scopeTimeZone;\n const error = new RangeError(`[genesis-core] scopeTimeZone \"${scopeTimeZone}\" isn't a time zone this runtime knows (an IANA name such as \"Europe/Berlin\")`);\n if (process.env.NODE_ENV !== \"production\") throw error;\n // Once per zone: a bad zone in a long-lived screen must not flood the error reporter.\n if (!reportedScopeZones.has(scopeTimeZone)) {\n reportedScopeZones.add(scopeTimeZone);\n reportError(error, \"core:viewer-scope\");\n }\n return viewerZone;\n}\n\n/** The unknown scope zones already reported, so each is reported once per page load. */\nconst reportedScopeZones = new Set<string>();\n\n/**\n * Keeps one viewer's cached data from ever showing to the next. Children\n * render only once the viewer is known, under a key of that viewer, so a\n * sign-out or a new person signing in unmounts every screen and its queries\n * before the cache is emptied and the new viewer's screens mount fresh. The\n * first known viewer empties a restored cache too, unless it's the\n * `persistedViewer` it was saved for.\n *\n * ```tsx\n * <ViewerScope viewer={session === undefined ? undefined : (session?.user.id ?? null)}>\n * <App />\n * </ViewerScope>\n * ```\n */\nexport function ViewerScope({ viewer, persistedViewer, scope, roles, timeZone, scopeTimeZone, fallback = null, children }: ViewerScopeProps) {\n const queryClient = useQueryClient();\n const zone = personTimeZone({ timeZone });\n // Memoised, and scopeClock reports a zone once, so a bad zone isn't reported on every render.\n const scopeZone = useMemo(() => scopeClock(scopeTimeZone, zone), [scopeTimeZone, zone]);\n const day = useToday(zone);\n // A new scope object each render shouldn't re-render every reader: compare by value.\n const scopeKey = stableJson(scope ?? {});\n // Roles by value too: undefined stays undefined, so \"not known yet\" never equals \"none\".\n // Roles that aren't plain JSON count as unknown in production (rolesKeyOf warns; development throws).\n const rolesKey = roles === undefined ? undefined : rolesKeyOf(roles);\n const value = useMemo<ViewerContext>(\n () => ({ viewer: viewer ?? null, scope: scope ?? {}, ...(rolesKey !== undefined ? { roles } : {}), timeZone: zone, scopeTimeZone: scopeZone, day }),\n // eslint-disable-next-line react-hooks/exhaustive-deps\n [viewer, scopeKey, rolesKey, zone, scopeZone, day],\n );\n // The last roles known for this viewer. Arriving (undefined → roles) or going back to undefined\n // changes nothing; different roles for the same person send their waiting writes, then reread\n // everything under the new roles. Nothing remounts: the person, their drafts and their\n // navigation are the same.\n const known = useRef<{ viewer: string | null | undefined; roles: string | undefined }>({ viewer, roles: undefined });\n useEffect(() => {\n if (known.current.viewer !== viewer) known.current = { viewer, roles: undefined };\n if (rolesKey === undefined) return;\n const previous = known.current.roles;\n known.current.roles = rolesKey;\n if (previous === undefined || previous === rolesKey) return;\n // The session is still theirs: their writes go out, and the database decides each one with the\n // roles as they are when it arrives (a refused one fails as any refused write does).\n void flushPendingWrites(queryClient).then(() => queryClient.invalidateQueries());\n }, [viewer, rolesKey, queryClient]);\n // Who the children were last mounted for, and how many times they were reset. Undefined before\n // the first mount.\n const [mounted, setMounted] = useState<{ viewer: string | null; epoch: number } | undefined>(undefined);\n if (viewer === undefined) return <>{fallback}</>;\n if (mounted === undefined || mounted.viewer !== viewer) {\n const keep = mounted === undefined && persistedViewer !== undefined && persistedViewer === viewer;\n // Nothing for the new viewer is mounted yet, so emptying now can't strand\n // a fetch; the old viewer's screens unmount with this render.\n if (!keep) {\n // The session already belongs to the new viewer: the old one's unsent\n // writes must never go out under it. (clearViewerCache, run before the\n // session changes, sends them instead.)\n dropPendingWrites(queryClient);\n void queryClient.cancelQueries();\n queryClient.clear();\n }\n setMounted({ viewer, epoch: (mounted?.epoch ?? 0) + 1 });\n return <>{fallback}</>;\n }\n return (\n <ViewerContextValue.Provider value={value}>\n <Fragment key={`${viewer ?? \"signed-out\"}#${mounted.epoch}`}>{children}</Fragment>\n </ViewerContextValue.Provider>\n );\n}\n"]}