grist-widget-sdk 0.3.27 → 0.5.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.
Files changed (88) hide show
  1. package/CHANGELOG.md +84 -0
  2. package/README.md +79 -208
  3. package/dist/app.cjs +1336 -4415
  4. package/dist/app.cjs.map +1 -1
  5. package/dist/app.d.cts +6 -103
  6. package/dist/app.d.ts +6 -103
  7. package/dist/app.js +5 -7
  8. package/dist/chunk-4ZGVKGDF.js +204 -0
  9. package/dist/chunk-4ZGVKGDF.js.map +1 -0
  10. package/dist/{chunk-6Y2IONGJ.js → chunk-LSALXIGM.js} +191 -20
  11. package/dist/chunk-LSALXIGM.js.map +1 -0
  12. package/dist/chunk-MAPAWVQC.js +1898 -0
  13. package/dist/chunk-MAPAWVQC.js.map +1 -0
  14. package/dist/{chunk-YQNMIL33.js → chunk-OXA2VITC.js} +532 -181
  15. package/dist/chunk-OXA2VITC.js.map +1 -0
  16. package/dist/define-widget-B1FIvI-h.d.cts +433 -0
  17. package/dist/define-widget-B9gEtJP0.d.ts +433 -0
  18. package/dist/emulator/testing.cjs +3341 -6512
  19. package/dist/emulator/testing.cjs.map +1 -1
  20. package/dist/emulator/testing.d.cts +29 -14
  21. package/dist/emulator/testing.d.ts +29 -14
  22. package/dist/emulator/testing.js +78 -72
  23. package/dist/emulator/testing.js.map +1 -1
  24. package/dist/emulator.cjs +63 -249
  25. package/dist/emulator.cjs.map +1 -1
  26. package/dist/emulator.d.cts +6 -8
  27. package/dist/emulator.d.ts +6 -8
  28. package/dist/emulator.js +5 -11
  29. package/dist/index.cjs +1442 -4862
  30. package/dist/index.cjs.map +1 -1
  31. package/dist/index.d.cts +81 -260
  32. package/dist/index.d.ts +81 -260
  33. package/dist/index.js +12 -158
  34. package/dist/mount-grist-widget-CkB-3iG_.d.ts +137 -0
  35. package/dist/mount-grist-widget-Dtelqao_.d.cts +137 -0
  36. package/dist/{inline-DpcT8tV9.d.ts → templates-CGmRIQBV.d.cts} +89 -35
  37. package/dist/{inline-C7DkvuET.d.cts → templates-Cq94qOcf.d.ts} +89 -35
  38. package/dist/{types-D3JxUCfL.d.cts → types-DBStn0Dk.d.cts} +2 -26
  39. package/dist/{types-D3JxUCfL.d.ts → types-DBStn0Dk.d.ts} +2 -26
  40. package/package.json +8 -37
  41. package/dist/advanced.cjs +0 -2799
  42. package/dist/advanced.cjs.map +0 -1
  43. package/dist/advanced.d.cts +0 -822
  44. package/dist/advanced.d.ts +0 -822
  45. package/dist/advanced.js +0 -872
  46. package/dist/advanced.js.map +0 -1
  47. package/dist/chunk-22U7WAY3.js +0 -463
  48. package/dist/chunk-22U7WAY3.js.map +0 -1
  49. package/dist/chunk-64SVRWW7.js +0 -758
  50. package/dist/chunk-64SVRWW7.js.map +0 -1
  51. package/dist/chunk-6Y2IONGJ.js.map +0 -1
  52. package/dist/chunk-B4AKVSWV.js +0 -2362
  53. package/dist/chunk-B4AKVSWV.js.map +0 -1
  54. package/dist/chunk-ELGVOHFD.js +0 -32
  55. package/dist/chunk-ELGVOHFD.js.map +0 -1
  56. package/dist/chunk-GTTD5HPO.js +0 -36
  57. package/dist/chunk-GTTD5HPO.js.map +0 -1
  58. package/dist/chunk-NO6FYX33.js +0 -2084
  59. package/dist/chunk-NO6FYX33.js.map +0 -1
  60. package/dist/chunk-OPTOYD2Y.js +0 -277
  61. package/dist/chunk-OPTOYD2Y.js.map +0 -1
  62. package/dist/chunk-PM3B4WYV.js +0 -12
  63. package/dist/chunk-PM3B4WYV.js.map +0 -1
  64. package/dist/chunk-REV5AUXD.js +0 -25
  65. package/dist/chunk-REV5AUXD.js.map +0 -1
  66. package/dist/chunk-YQNMIL33.js.map +0 -1
  67. package/dist/create-grist-emulator-BCqp1BF9.d.ts +0 -81
  68. package/dist/create-grist-emulator-DBM8OSIR.d.cts +0 -81
  69. package/dist/emulator/devtools.cjs +0 -1404
  70. package/dist/emulator/devtools.cjs.map +0 -1
  71. package/dist/emulator/devtools.d.cts +0 -48
  72. package/dist/emulator/devtools.d.ts +0 -48
  73. package/dist/emulator/devtools.js +0 -506
  74. package/dist/emulator/devtools.js.map +0 -1
  75. package/dist/emulator/transports.cjs +0 -1132
  76. package/dist/emulator/transports.cjs.map +0 -1
  77. package/dist/emulator/transports.d.cts +0 -38
  78. package/dist/emulator/transports.d.ts +0 -38
  79. package/dist/emulator/transports.js +0 -12
  80. package/dist/emulator/transports.js.map +0 -1
  81. package/dist/templates-8k2LKoO-.d.cts +0 -24
  82. package/dist/templates-DIwi_mvI.d.ts +0 -24
  83. package/dist/use-grist-reads-DUMvJgV7.d.ts +0 -480
  84. package/dist/use-grist-reads-DpjVuI0H.d.cts +0 -480
  85. package/dist/use-grist-types-DdOLEJXN.d.cts +0 -499
  86. package/dist/use-grist-types-kwxoFeub.d.ts +0 -499
  87. package/dist/use-grist-widget-options-from-context-CGOlQ5Vc.d.cts +0 -43
  88. package/dist/use-grist-widget-options-from-context-CGOlQ5Vc.d.ts +0 -43
@@ -1,81 +0,0 @@
1
- import { E as EmulatorDocumentState, g as EventBus, c as EmulatorApiBundle, f as EmulatorTransport, I as InlineGristGlobal } from './inline-DpcT8tV9.js';
2
- import { d as GristWidgetColumnMap, b as GristReplicaDocument } from './types-D3JxUCfL.js';
3
-
4
- /**
5
- * Top-level emulator factory. Produces a fully-wired emulator instance:
6
- *
7
- * - typed in-memory document state,
8
- * - shared event bus,
9
- * - the six host API impls,
10
- * - one transport (inline by default, iframe when an iframe is provided),
11
- * - imperative helpers (`mutate`, `apply`, `selectRow`, `selectTable`)
12
- * that drive the document via the action engine and emit corresponding
13
- * events.
14
- *
15
- * The instance is multi-instance friendly: nothing is stored on `window`.
16
- */
17
-
18
- type CreateGristEmulatorOptions = {
19
- /** The starting document (must satisfy {@link parseDocument}). */
20
- document: GristReplicaDocument;
21
- /**
22
- * Pick a transport:
23
- * - omit / "inline" → synthesises `window.grist` directly (or onto `target`),
24
- * - "iframe" → wires a real iframe loading `grist-plugin-api.js`.
25
- */
26
- transport?: {
27
- kind: "inline";
28
- target?: Window & typeof globalThis;
29
- } | {
30
- kind: "iframe";
31
- iframe: HTMLIFrameElement;
32
- targetOrigin?: string;
33
- };
34
- /** Initial widget options exposed via `WidgetAPI`. */
35
- widgetOptions?: Record<string, unknown>;
36
- /**
37
- * Initial widget interaction info (`access_level` and friends) sent
38
- * alongside `onOptions`. Defaults to `{ access_level: "read table" }`.
39
- */
40
- widgetInteraction?: Record<string, unknown>;
41
- /** Initial document theme replayed on widget ready (host `message` channel). */
42
- initialTheme?: "light" | "dark";
43
- };
44
- type GristEmulator = {
45
- /** Underlying mutable document. Treat as read-only outside of `mutate(...)`. */
46
- state: EmulatorDocumentState;
47
- bus: EventBus;
48
- api: EmulatorApiBundle;
49
- transport: EmulatorTransport;
50
- /** Synthesised `grist` global (only for the inline transport). */
51
- grist?: InlineGristGlobal;
52
- /** Apply a list of Grist user actions; emits the matching events. */
53
- apply: (actions: unknown[][]) => {
54
- retValues: unknown[];
55
- };
56
- /** Convenience helpers for tests and demos. */
57
- mutate: {
58
- addRow: (tableId: string, fields: Record<string, unknown>) => number;
59
- updateRow: (tableId: string, rowId: number, fields: Record<string, unknown>) => void;
60
- removeRow: (tableId: string, rowId: number) => void;
61
- };
62
- selectRow: (rowId: number | "new" | null) => void;
63
- selectTable: (tableId: string) => void;
64
- /**
65
- * Set logical→real column mappings for the playground inspector (and tests).
66
- * Pass `undefined` to clear — `mappings()` becomes `null` until set again.
67
- */
68
- setColumnMappings: (mappings: GristWidgetColumnMap | undefined) => void;
69
- setOptions: (options: Record<string, unknown>) => Promise<void>;
70
- setInteraction: (interaction: Record<string, unknown>) => void;
71
- /** Host theme controls (`grist.on("message")` / `msg.theme`). */
72
- theme: {
73
- set: (theme: "light" | "dark") => void;
74
- };
75
- /** Tear down the emulator. Idempotent. */
76
- dispose: () => void;
77
- };
78
- declare function createGristEmulator(options: CreateGristEmulatorOptions): GristEmulator;
79
-
80
- export { createGristEmulator as c };
81
- export type { CreateGristEmulatorOptions as C, GristEmulator as G };
@@ -1,81 +0,0 @@
1
- import { E as EmulatorDocumentState, g as EventBus, c as EmulatorApiBundle, f as EmulatorTransport, I as InlineGristGlobal } from './inline-C7DkvuET.cjs';
2
- import { d as GristWidgetColumnMap, b as GristReplicaDocument } from './types-D3JxUCfL.cjs';
3
-
4
- /**
5
- * Top-level emulator factory. Produces a fully-wired emulator instance:
6
- *
7
- * - typed in-memory document state,
8
- * - shared event bus,
9
- * - the six host API impls,
10
- * - one transport (inline by default, iframe when an iframe is provided),
11
- * - imperative helpers (`mutate`, `apply`, `selectRow`, `selectTable`)
12
- * that drive the document via the action engine and emit corresponding
13
- * events.
14
- *
15
- * The instance is multi-instance friendly: nothing is stored on `window`.
16
- */
17
-
18
- type CreateGristEmulatorOptions = {
19
- /** The starting document (must satisfy {@link parseDocument}). */
20
- document: GristReplicaDocument;
21
- /**
22
- * Pick a transport:
23
- * - omit / "inline" → synthesises `window.grist` directly (or onto `target`),
24
- * - "iframe" → wires a real iframe loading `grist-plugin-api.js`.
25
- */
26
- transport?: {
27
- kind: "inline";
28
- target?: Window & typeof globalThis;
29
- } | {
30
- kind: "iframe";
31
- iframe: HTMLIFrameElement;
32
- targetOrigin?: string;
33
- };
34
- /** Initial widget options exposed via `WidgetAPI`. */
35
- widgetOptions?: Record<string, unknown>;
36
- /**
37
- * Initial widget interaction info (`access_level` and friends) sent
38
- * alongside `onOptions`. Defaults to `{ access_level: "read table" }`.
39
- */
40
- widgetInteraction?: Record<string, unknown>;
41
- /** Initial document theme replayed on widget ready (host `message` channel). */
42
- initialTheme?: "light" | "dark";
43
- };
44
- type GristEmulator = {
45
- /** Underlying mutable document. Treat as read-only outside of `mutate(...)`. */
46
- state: EmulatorDocumentState;
47
- bus: EventBus;
48
- api: EmulatorApiBundle;
49
- transport: EmulatorTransport;
50
- /** Synthesised `grist` global (only for the inline transport). */
51
- grist?: InlineGristGlobal;
52
- /** Apply a list of Grist user actions; emits the matching events. */
53
- apply: (actions: unknown[][]) => {
54
- retValues: unknown[];
55
- };
56
- /** Convenience helpers for tests and demos. */
57
- mutate: {
58
- addRow: (tableId: string, fields: Record<string, unknown>) => number;
59
- updateRow: (tableId: string, rowId: number, fields: Record<string, unknown>) => void;
60
- removeRow: (tableId: string, rowId: number) => void;
61
- };
62
- selectRow: (rowId: number | "new" | null) => void;
63
- selectTable: (tableId: string) => void;
64
- /**
65
- * Set logical→real column mappings for the playground inspector (and tests).
66
- * Pass `undefined` to clear — `mappings()` becomes `null` until set again.
67
- */
68
- setColumnMappings: (mappings: GristWidgetColumnMap | undefined) => void;
69
- setOptions: (options: Record<string, unknown>) => Promise<void>;
70
- setInteraction: (interaction: Record<string, unknown>) => void;
71
- /** Host theme controls (`grist.on("message")` / `msg.theme`). */
72
- theme: {
73
- set: (theme: "light" | "dark") => void;
74
- };
75
- /** Tear down the emulator. Idempotent. */
76
- dispose: () => void;
77
- };
78
- declare function createGristEmulator(options: CreateGristEmulatorOptions): GristEmulator;
79
-
80
- export { createGristEmulator as c };
81
- export type { CreateGristEmulatorOptions as C, GristEmulator as G };