@peers-app/peers-sdk 0.27.3 → 0.27.4

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 (258) hide show
  1. package/dist/contracts/contract-proxy.d.ts +7 -0
  2. package/dist/contracts/contract-proxy.js +19 -2
  3. package/dist/contracts/create-local-consumer.js +16 -1
  4. package/dist/contracts/index.d.ts +2 -0
  5. package/dist/contracts/index.js +2 -0
  6. package/dist/contracts/system/index.d.ts +2 -0
  7. package/dist/contracts/system/index.js +2 -0
  8. package/dist/contracts/system/invites-contract.js +2 -1
  9. package/dist/contracts/system/sync-check-contract.d.ts +97 -0
  10. package/dist/contracts/system/sync-check-contract.js +115 -0
  11. package/dist/contracts/tool-arguments.d.ts +15 -0
  12. package/dist/contracts/tool-arguments.js +41 -0
  13. package/dist/contracts/tool-catalog-service.js +2 -12
  14. package/dist/data/change-tracking.d.ts +40 -0
  15. package/dist/data/change-tracking.js +89 -0
  16. package/dist/data/orm/types.d.ts +24 -7
  17. package/dist/data/orm/types.js +97 -24
  18. package/dist/define/manifest.js +6 -34
  19. package/dist/package-loader/package-loader.js +27 -22
  20. package/dist/system-ids.d.ts +5 -0
  21. package/dist/system-ids.js +6 -1
  22. package/package.json +4 -2
  23. package/dist/context/user-context-identity.test.d.ts +0 -1
  24. package/dist/context/user-context-identity.test.js +0 -220
  25. package/dist/contracts/__tests__/action-dispatch.test.d.ts +0 -1
  26. package/dist/contracts/__tests__/action-dispatch.test.js +0 -319
  27. package/dist/contracts/__tests__/also-implements.test.d.ts +0 -1
  28. package/dist/contracts/__tests__/also-implements.test.js +0 -110
  29. package/dist/contracts/__tests__/builder.test.d.ts +0 -1
  30. package/dist/contracts/__tests__/builder.test.js +0 -669
  31. package/dist/contracts/__tests__/contract-events.test.d.ts +0 -1
  32. package/dist/contracts/__tests__/contract-events.test.js +0 -199
  33. package/dist/contracts/__tests__/contract-observables.test.d.ts +0 -1
  34. package/dist/contracts/__tests__/contract-observables.test.js +0 -290
  35. package/dist/contracts/__tests__/contract-provider-router.test.d.ts +0 -1
  36. package/dist/contracts/__tests__/contract-provider-router.test.js +0 -315
  37. package/dist/contracts/__tests__/contract-proxy.test.d.ts +0 -1
  38. package/dist/contracts/__tests__/contract-proxy.test.js +0 -657
  39. package/dist/contracts/__tests__/contract-resolvers.test.d.ts +0 -1
  40. package/dist/contracts/__tests__/contract-resolvers.test.js +0 -758
  41. package/dist/contracts/__tests__/contract-subscription-lifecycle.test.d.ts +0 -1
  42. package/dist/contracts/__tests__/contract-subscription-lifecycle.test.js +0 -353
  43. package/dist/contracts/__tests__/contract-table-events.test.d.ts +0 -1
  44. package/dist/contracts/__tests__/contract-table-events.test.js +0 -209
  45. package/dist/contracts/__tests__/contract-transport.test.d.ts +0 -1
  46. package/dist/contracts/__tests__/contract-transport.test.js +0 -163
  47. package/dist/contracts/__tests__/extract.test.d.ts +0 -1
  48. package/dist/contracts/__tests__/extract.test.js +0 -145
  49. package/dist/contracts/__tests__/frozen-contracts.test.d.ts +0 -1
  50. package/dist/contracts/__tests__/frozen-contracts.test.js +0 -191
  51. package/dist/contracts/__tests__/generic-tool-dispatch.test.d.ts +0 -1
  52. package/dist/contracts/__tests__/generic-tool-dispatch.test.js +0 -130
  53. package/dist/contracts/__tests__/host-contract-client.test.d.ts +0 -1
  54. package/dist/contracts/__tests__/host-contract-client.test.js +0 -793
  55. package/dist/contracts/__tests__/host-contract-consumer.test.d.ts +0 -1
  56. package/dist/contracts/__tests__/host-contract-consumer.test.js +0 -163
  57. package/dist/contracts/__tests__/host-contract-transport.test.d.ts +0 -1
  58. package/dist/contracts/__tests__/host-contract-transport.test.js +0 -66
  59. package/dist/contracts/__tests__/integration.test.d.ts +0 -1
  60. package/dist/contracts/__tests__/integration.test.js +0 -348
  61. package/dist/contracts/__tests__/legacy-removal.test.d.ts +0 -1
  62. package/dist/contracts/__tests__/legacy-removal.test.js +0 -128
  63. package/dist/contracts/__tests__/persistent-registry.test.d.ts +0 -1
  64. package/dist/contracts/__tests__/persistent-registry.test.js +0 -109
  65. package/dist/contracts/__tests__/playground.test.d.ts +0 -1
  66. package/dist/contracts/__tests__/playground.test.js +0 -216
  67. package/dist/contracts/__tests__/registry.test.d.ts +0 -1
  68. package/dist/contracts/__tests__/registry.test.js +0 -238
  69. package/dist/contracts/__tests__/remote-contract-transport.test.d.ts +0 -1
  70. package/dist/contracts/__tests__/remote-contract-transport.test.js +0 -119
  71. package/dist/contracts/__tests__/system-contracts.test.d.ts +0 -1
  72. package/dist/contracts/__tests__/system-contracts.test.js +0 -247
  73. package/dist/contracts/__tests__/target-dispatch.d.ts +0 -11
  74. package/dist/contracts/__tests__/target-dispatch.js +0 -24
  75. package/dist/contracts/__tests__/tool-catalog-inventory.test.d.ts +0 -1
  76. package/dist/contracts/__tests__/tool-catalog-inventory.test.js +0 -44
  77. package/dist/contracts/__tests__/tool-catalog-service.test.d.ts +0 -1
  78. package/dist/contracts/__tests__/tool-catalog-service.test.js +0 -482
  79. package/dist/contracts/__tests__/tool-catalog.test.d.ts +0 -1
  80. package/dist/contracts/__tests__/tool-catalog.test.js +0 -1199
  81. package/dist/contracts/__tests__/validate.test.d.ts +0 -1
  82. package/dist/contracts/__tests__/validate.test.js +0 -991
  83. package/dist/contracts/__tests__/workflow-context.test.d.ts +0 -1
  84. package/dist/contracts/__tests__/workflow-context.test.js +0 -50
  85. package/dist/data/access-level.test.d.ts +0 -1
  86. package/dist/data/access-level.test.js +0 -53
  87. package/dist/data/change-tracking.test.d.ts +0 -1
  88. package/dist/data/change-tracking.test.js +0 -62
  89. package/dist/data/files/files.test.d.ts +0 -1
  90. package/dist/data/files/files.test.js +0 -770
  91. package/dist/data/group-members.test.d.ts +0 -1
  92. package/dist/data/group-members.test.js +0 -336
  93. package/dist/data/group-share.test.d.ts +0 -1
  94. package/dist/data/group-share.test.js +0 -110
  95. package/dist/data/groups.test.d.ts +0 -1
  96. package/dist/data/groups.test.js +0 -153
  97. package/dist/data/orm/cursor.test.d.ts +0 -1
  98. package/dist/data/orm/cursor.test.js +0 -314
  99. package/dist/data/orm/data-query.mongo.test.d.ts +0 -1
  100. package/dist/data/orm/data-query.mongo.test.js +0 -367
  101. package/dist/data/orm/data-query.sqlite.test.d.ts +0 -1
  102. package/dist/data/orm/data-query.sqlite.test.js +0 -365
  103. package/dist/data/orm/data-query.test.d.ts +0 -1
  104. package/dist/data/orm/data-query.test.js +0 -545
  105. package/dist/data/orm/dependency-injection.test.d.ts +0 -1
  106. package/dist/data/orm/dependency-injection.test.js +0 -171
  107. package/dist/data/orm/event-registry.test.d.ts +0 -1
  108. package/dist/data/orm/event-registry.test.js +0 -44
  109. package/dist/data/orm/multi-cursors.test.d.ts +0 -1
  110. package/dist/data/orm/multi-cursors.test.js +0 -463
  111. package/dist/data/orm/sql.data-source.test.d.ts +0 -1
  112. package/dist/data/orm/sql.data-source.test.js +0 -731
  113. package/dist/data/orm/table-container-events.test.d.ts +0 -1
  114. package/dist/data/orm/table-container-events.test.js +0 -101
  115. package/dist/data/orm/table-container.test.d.ts +0 -1
  116. package/dist/data/orm/table-container.test.js +0 -273
  117. package/dist/data/orm/table.event-source.test.d.ts +0 -1
  118. package/dist/data/orm/table.event-source.test.js +0 -331
  119. package/dist/data/orm/types.test.d.ts +0 -1
  120. package/dist/data/orm/types.test.js +0 -409
  121. package/dist/data/package-table-identity.test.d.ts +0 -1
  122. package/dist/data/package-table-identity.test.js +0 -46
  123. package/dist/data/package-version-permissions.test.d.ts +0 -1
  124. package/dist/data/package-version-permissions.test.js +0 -107
  125. package/dist/data/package-version-resolver.test.d.ts +0 -4
  126. package/dist/data/package-version-resolver.test.js +0 -543
  127. package/dist/data/package-versions.test.d.ts +0 -1
  128. package/dist/data/package-versions.test.js +0 -227
  129. package/dist/data/persistent-vars.conflict.test.d.ts +0 -1
  130. package/dist/data/persistent-vars.conflict.test.js +0 -126
  131. package/dist/data/persistent-vars.migration.test.d.ts +0 -1
  132. package/dist/data/persistent-vars.migration.test.js +0 -133
  133. package/dist/data/persistent-vars.package-scope.test.d.ts +0 -1
  134. package/dist/data/persistent-vars.package-scope.test.js +0 -27
  135. package/dist/data/sync-recovery-queue.test.d.ts +0 -1
  136. package/dist/data/sync-recovery-queue.test.js +0 -215
  137. package/dist/data/table-signing.test.d.ts +0 -1
  138. package/dist/data/table-signing.test.js +0 -118
  139. package/dist/data/tool-access.test.d.ts +0 -1
  140. package/dist/data/tool-access.test.js +0 -166
  141. package/dist/data/user-permissions.test.d.ts +0 -1
  142. package/dist/data/user-permissions.test.js +0 -305
  143. package/dist/data/user-trust-levels.test.d.ts +0 -1
  144. package/dist/data/user-trust-levels.test.js +0 -37
  145. package/dist/define/also-implements.test.d.ts +0 -1
  146. package/dist/define/also-implements.test.js +0 -123
  147. package/dist/define/declare-contract.test.d.ts +0 -1
  148. package/dist/define/declare-contract.test.js +0 -573
  149. package/dist/define/define.test.d.ts +0 -1
  150. package/dist/define/define.test.js +0 -1010
  151. package/dist/define/empty-fields.test.d.ts +0 -1
  152. package/dist/define/empty-fields.test.js +0 -55
  153. package/dist/define/events-observables.test.d.ts +0 -1
  154. package/dist/define/events-observables.test.js +0 -1013
  155. package/dist/define/serve-members.test.d.ts +0 -1
  156. package/dist/define/serve-members.test.js +0 -630
  157. package/dist/define/vars.test.d.ts +0 -1
  158. package/dist/define/vars.test.js +0 -39
  159. package/dist/device/binary-peer-connection-v2.test.d.ts +0 -1
  160. package/dist/device/binary-peer-connection-v2.test.js +0 -730
  161. package/dist/device/binary-peer-connection.test.d.ts +0 -1
  162. package/dist/device/binary-peer-connection.test.js +0 -184
  163. package/dist/device/connection.test.d.ts +0 -1
  164. package/dist/device/connection.test.js +0 -613
  165. package/dist/device/device-election.test.d.ts +0 -1
  166. package/dist/device/device-election.test.js +0 -516
  167. package/dist/device/device.test.d.ts +0 -1
  168. package/dist/device/device.test.js +0 -243
  169. package/dist/device/frame-cipher.test.d.ts +0 -1
  170. package/dist/device/frame-cipher.test.js +0 -219
  171. package/dist/device/get-trust-level-fn.test.d.ts +0 -1
  172. package/dist/device/get-trust-level-fn.test.js +0 -685
  173. package/dist/device/streamed-socket.test.d.ts +0 -1
  174. package/dist/device/streamed-socket.test.js +0 -216
  175. package/dist/device/tx-encoding.test.d.ts +0 -1
  176. package/dist/device/tx-encoding.test.js +0 -295
  177. package/dist/device-pairing/cpace.test.d.ts +0 -1
  178. package/dist/device-pairing/cpace.test.js +0 -116
  179. package/dist/device-pairing/device-pairing.test.d.ts +0 -1
  180. package/dist/device-pairing/device-pairing.test.js +0 -211
  181. package/dist/hlc.test.d.ts +0 -1
  182. package/dist/hlc.test.js +0 -45
  183. package/dist/host-credentials.test.d.ts +0 -1
  184. package/dist/host-credentials.test.js +0 -88
  185. package/dist/identity/account-email.test.d.ts +0 -1
  186. package/dist/identity/account-email.test.js +0 -59
  187. package/dist/identity/anchor-document.test.d.ts +0 -1
  188. package/dist/identity/anchor-document.test.js +0 -16
  189. package/dist/identity/anchor-resolution.test.d.ts +0 -1
  190. package/dist/identity/anchor-resolution.test.js +0 -130
  191. package/dist/identity/key-change.test.d.ts +0 -1
  192. package/dist/identity/key-change.test.js +0 -811
  193. package/dist/invites/group-approval.test.d.ts +0 -1
  194. package/dist/invites/group-approval.test.js +0 -223
  195. package/dist/invites/invite-token.test.d.ts +0 -1
  196. package/dist/invites/invite-token.test.js +0 -123
  197. package/dist/keys.test.d.ts +0 -1
  198. package/dist/keys.test.js +0 -336
  199. package/dist/logging/console-logger.test.d.ts +0 -1
  200. package/dist/logging/console-logger.test.js +0 -300
  201. package/dist/logging/console-logs.table.test.d.ts +0 -1
  202. package/dist/logging/console-logs.table.test.js +0 -156
  203. package/dist/observable.test.d.ts +0 -1
  204. package/dist/observable.test.js +0 -309
  205. package/dist/package-build/build-package.test.d.ts +0 -1
  206. package/dist/package-build/build-package.test.js +0 -204
  207. package/dist/package-build/contract-add.test.d.ts +0 -1
  208. package/dist/package-build/contract-add.test.js +0 -467
  209. package/dist/package-build/freeze-contracts.test.d.ts +0 -1
  210. package/dist/package-build/freeze-contracts.test.js +0 -355
  211. package/dist/package-installer/package-author-signing.test.d.ts +0 -1
  212. package/dist/package-installer/package-author-signing.test.js +0 -200
  213. package/dist/package-installer/package-cloner.test.d.ts +0 -1
  214. package/dist/package-installer/package-cloner.test.js +0 -278
  215. package/dist/package-installer/package-creator.test.d.ts +0 -1
  216. package/dist/package-installer/package-creator.test.js +0 -908
  217. package/dist/package-installer/package-dev-tools.test.d.ts +0 -1
  218. package/dist/package-installer/package-dev-tools.test.js +0 -64
  219. package/dist/package-installer/package-installer.test.d.ts +0 -1
  220. package/dist/package-installer/package-installer.test.js +0 -882
  221. package/dist/package-installer/package-propagation.test.d.ts +0 -1
  222. package/dist/package-installer/package-propagation.test.js +0 -1269
  223. package/dist/package-installer/package-publisher.test.d.ts +0 -1
  224. package/dist/package-installer/package-publisher.test.js +0 -153
  225. package/dist/package-installer/package-remote-checker.test.d.ts +0 -1
  226. package/dist/package-installer/package-remote-checker.test.js +0 -334
  227. package/dist/package-installer/package-seed-installer.test.d.ts +0 -1
  228. package/dist/package-installer/package-seed-installer.test.js +0 -123
  229. package/dist/package-installer/package-tarball.test.d.ts +0 -1
  230. package/dist/package-installer/package-tarball.test.js +0 -75
  231. package/dist/package-installer/peers-core-installer.test.d.ts +0 -1
  232. package/dist/package-installer/peers-core-installer.test.js +0 -49
  233. package/dist/package-installer/peers-core-trust-anchor.test.d.ts +0 -1
  234. package/dist/package-installer/peers-core-trust-anchor.test.js +0 -155
  235. package/dist/package-loader/contract-package-loader.test.d.ts +0 -1
  236. package/dist/package-loader/contract-package-loader.test.js +0 -274
  237. package/dist/package-loader/host-authority-loading.test.d.ts +0 -1
  238. package/dist/package-loader/host-authority-loading.test.js +0 -104
  239. package/dist/package-loader/host-dispatch-policy.test.d.ts +0 -1
  240. package/dist/package-loader/host-dispatch-policy.test.js +0 -56
  241. package/dist/package-loader/isolated-artifact.test.d.ts +0 -1
  242. package/dist/package-loader/isolated-artifact.test.js +0 -688
  243. package/dist/package-loader/isolated-persistent-var-gateway.test.d.ts +0 -1
  244. package/dist/package-loader/isolated-persistent-var-gateway.test.js +0 -56
  245. package/dist/package-loader/isolated-table-gateway.test.d.ts +0 -1
  246. package/dist/package-loader/isolated-table-gateway.test.js +0 -633
  247. package/dist/package-loader/package-loader.test.d.ts +0 -1
  248. package/dist/package-loader/package-loader.test.js +0 -1764
  249. package/dist/package-loader/resolve-consumed-contracts.test.d.ts +0 -1
  250. package/dist/package-loader/resolve-consumed-contracts.test.js +0 -166
  251. package/dist/serial-json.compat.test.d.ts +0 -1
  252. package/dist/serial-json.compat.test.js +0 -369
  253. package/dist/serial-json.test.d.ts +0 -1
  254. package/dist/serial-json.test.js +0 -401
  255. package/dist/testing/mock-host-contract.test.d.ts +0 -1
  256. package/dist/testing/mock-host-contract.test.js +0 -782
  257. package/dist/utils.test.d.ts +0 -1
  258. package/dist/utils.test.js +0 -232
@@ -1 +0,0 @@
1
- export {};
@@ -1,630 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const zod_1 = require("zod");
4
- const observable_1 = require("../observable");
5
- const contract_members_1 = require("../package-loader/contract-members");
6
- const isolated_artifact_1 = require("../package-loader/isolated-artifact");
7
- const peer_id_1 = require("../peer-id");
8
- const field_type_1 = require("../types/field-type");
9
- const zod_types_1 = require("../types/zod-types");
10
- const define_package_1 = require("./define-package");
11
- const events_1 = require("./events");
12
- const manifest_1 = require("./manifest");
13
- const observables_1 = require("./observables");
14
- const serve_members_1 = require("./serve-members");
15
- const table_1 = require("./table");
16
- const vars_1 = require("./vars");
17
- /** A ctx whose owned-table and variable calls answer from memory, recording each call. */
18
- function fakeContext() {
19
- const rows = new Map();
20
- const vars = new Map();
21
- const calls = [];
22
- const ctx = new Proxy({}, {
23
- get(_target, method) {
24
- return async (...args) => {
25
- if (method === "callOwnedTable") {
26
- const [table, operation, rest] = args;
27
- calls.push(`${table}.${operation}`);
28
- if (operation === "save") {
29
- const row = rest[0];
30
- rows.set(row.itemId, row);
31
- return row;
32
- }
33
- if (operation === "get")
34
- return rows.get(rest[0]);
35
- if (operation === "list")
36
- return [...rows.values()];
37
- if (operation === "count")
38
- return rows.size;
39
- if (operation === "delete")
40
- return rows.delete(rest[0]);
41
- return undefined;
42
- }
43
- if (method === "getOwnedPersistentVar")
44
- return vars.get(JSON.stringify(args)) ?? null;
45
- if (method === "setOwnedPersistentVar") {
46
- vars.set(JSON.stringify(args.slice(0, 2)), args[2]);
47
- return args[2];
48
- }
49
- return null;
50
- };
51
- },
52
- });
53
- return { ctx, rows, vars, calls };
54
- }
55
- const itemSchema = zod_1.z.object({
56
- itemId: zod_types_1.zodPeerId,
57
- title: zod_1.z.string(),
58
- hidden: zod_1.z.boolean().default(false),
59
- });
60
- class ItemsTable extends table_1.PackageTable {
61
- async save(item) {
62
- return super.save({ ...item, title: item.title.trim() });
63
- }
64
- dataChanged(event) {
65
- return event.dataObject.hidden
66
- ? undefined
67
- : {
68
- ...event,
69
- dataObject: { ...event.dataObject, title: event.dataObject.title.toUpperCase() },
70
- };
71
- }
72
- }
73
- const Items = (0, table_1.defineTable)({
74
- name: "Items",
75
- description: "Items.",
76
- primaryKeyName: "itemId",
77
- schema: itemSchema,
78
- tableClass: ItemsTable,
79
- });
80
- describe("PackageTable", () => {
81
- test("a save omits fields left undefined, so they're stored unset", async () => {
82
- const { ctx, rows } = fakeContext();
83
- const Notes = (0, table_1.defineTable)({
84
- name: "Notes",
85
- description: "Notes.",
86
- primaryKeyName: "itemId",
87
- schema: zod_1.z.object({ itemId: zod_types_1.zodPeerId, title: zod_1.z.string(), link: zod_1.z.string().optional() }),
88
- });
89
- const id = (0, peer_id_1.newid)();
90
- await Notes(ctx).save({ itemId: id, title: "a", link: undefined });
91
- expect(Object.hasOwn(rows.get(id) ?? {}, "link")).toBe(false);
92
- });
93
- test("the package's own calls go through its class, and super parses with the schema", async () => {
94
- const { ctx, rows } = fakeContext();
95
- const items = Items(ctx);
96
- expect(items).toBeInstanceOf(ItemsTable);
97
- const id = (0, peer_id_1.newid)();
98
- const saved = await items.save({ itemId: id, title: " milk " });
99
- expect(saved).toEqual({ itemId: id, title: "milk", hidden: false });
100
- expect(rows.get(id)).toEqual(saved);
101
- // A table without a class gets PackageTable's methods.
102
- const Plain = (0, table_1.defineTable)({
103
- name: "Plain",
104
- description: "Plain.",
105
- primaryKeyName: "itemId",
106
- schema: itemSchema,
107
- });
108
- expect(Plain(ctx)).toBeInstanceOf(table_1.PackageTable);
109
- expect(Plain(ctx).dataChanged({ dataObject: saved, op: "insert", source: "local" })).toEqual({
110
- dataObject: saved,
111
- op: "insert",
112
- source: "local",
113
- });
114
- });
115
- test("storage replies clean old nested empty fields before provider code reads them", async () => {
116
- const schema = itemSchema.extend({
117
- detail: zod_1.z.object({ note: zod_1.z.string().optional(), data: zod_1.z.unknown() }),
118
- stops: zod_1.z.array(zod_1.z.object({ note: zod_1.z.string().optional() })),
119
- });
120
- const Notes = (0, table_1.defineTable)({
121
- ...Items.definition,
122
- name: "Notes",
123
- schema,
124
- tableClass: undefined,
125
- });
126
- // A table definition stored before richer IR has no nested fields to clean on the host.
127
- const stored = {
128
- itemId: (0, peer_id_1.newid)(),
129
- title: "old",
130
- hidden: false,
131
- detail: { note: null, data: null },
132
- stops: [{ note: null }],
133
- };
134
- const ctx = {
135
- ...fakeContext().ctx,
136
- callOwnedTable: async (_name, operation) => (operation === "list" ? [stored] : stored),
137
- };
138
- const expected = { ...stored, detail: { data: null }, stops: [{}] };
139
- const notes = Notes(ctx);
140
- await expect(notes.get(stored.itemId)).resolves.toStrictEqual(expected);
141
- await expect(notes.list()).resolves.toStrictEqual([expected]);
142
- await expect(notes.findOne()).resolves.toStrictEqual(expected);
143
- await expect(notes.save(expected)).resolves.toStrictEqual(expected);
144
- expect(stored.detail).toStrictEqual({ note: null, data: null });
145
- expect(stored.stops).toStrictEqual([{ note: null }]);
146
- });
147
- test("tableClass must extend PackageTable", () => {
148
- expect(() => (0, table_1.defineTable)({
149
- name: "Bad",
150
- description: "Bad.",
151
- primaryKeyName: "itemId",
152
- schema: itemSchema,
153
- tableClass: class {
154
- },
155
- })).toThrow("tableClass must extend PackageTable");
156
- });
157
- });
158
- describe("serveContractMembers", () => {
159
- const level = (0, observable_1.observable)(1);
160
- const theme = (0, vars_1.deviceVar)("serve-members-theme", { defaultValue: "light" });
161
- const saved = (0, events_1.defineEvent)({
162
- name: "saved",
163
- description: "Saved.",
164
- payloadSchema: zod_1.z.object({ count: zod_1.z.number() }),
165
- });
166
- const Contract = (0, define_package_1.defineContract)({
167
- contractId: (0, peer_id_1.newid)(),
168
- version: 1,
169
- name: "Items",
170
- tables: [Items],
171
- events: [saved],
172
- observables: [
173
- (0, observables_1.defineObservable)({
174
- name: "level",
175
- description: "Level.",
176
- schema: zod_1.z.number().int().max(10),
177
- writable: true,
178
- source: level,
179
- }),
180
- (0, observables_1.defineObservable)({
181
- name: "theme",
182
- description: "Theme.",
183
- schema: zod_1.z.enum(["light", "dark"]),
184
- writable: true,
185
- source: theme,
186
- }),
187
- {
188
- name: "stored",
189
- description: "IR, stored in a variable.",
190
- valueType: field_type_1.FieldType.string,
191
- writable: true,
192
- persistentVar: { scope: "device", name: "stored", defaultValue: "start" },
193
- },
194
- ],
195
- });
196
- function serve() {
197
- const handlers = new Map();
198
- (0, serve_members_1.serveContractMembers)(Contract, (name, handler) => handlers.set(name, handler));
199
- const call = handlers.get((0, contract_members_1.contractMemberHandlerName)(Contract.contractId, 1));
200
- const deliver = handlers.get((0, contract_members_1.contractDeliveryHandlerName)(Contract.contractId, 1));
201
- if (!call || !deliver)
202
- throw new Error("handlers not registered");
203
- return { call, deliver };
204
- }
205
- test("table calls reach the table's class; subscriptions are accepted", async () => {
206
- const { call } = serve();
207
- const { ctx, calls } = fakeContext();
208
- const id = (0, peer_id_1.newid)();
209
- const table = (operation, args = []) => Promise.resolve().then(() => call({ member: "table", name: "Items", operation, args }, ctx));
210
- await expect(table("save", [{ itemId: id, title: " eggs " }])).resolves.toEqual({
211
- itemId: id,
212
- title: "eggs",
213
- hidden: false,
214
- });
215
- await expect(table("count")).resolves.toBe(1);
216
- await expect(table("subscribe")).resolves.toBeNull();
217
- await expect(table("insert")).rejects.toThrow("is not callable");
218
- await expect(Promise.resolve().then(() => call({ member: "table", name: "Missing", operation: "list", args: [] }, ctx))).rejects.toThrow("has no table 'Missing'");
219
- expect(calls).toEqual(["Items.save", "Items.count"]);
220
- });
221
- test("outgoing changes pass through the class; events and values pass unchanged", async () => {
222
- const { deliver } = serve();
223
- const { ctx } = fakeContext();
224
- const change = (hidden) => ({
225
- member: "table",
226
- name: "Items",
227
- value: { op: "insert", source: "local", dataObject: { itemId: "a", title: "x", hidden } },
228
- });
229
- await expect(deliver(change(false), ctx)).resolves.toEqual({
230
- send: true,
231
- value: {
232
- op: "insert",
233
- source: "local",
234
- dataObject: { itemId: "a", title: "X", hidden: false },
235
- },
236
- });
237
- await expect(deliver(change(true), ctx)).resolves.toEqual({ send: false });
238
- await expect(deliver({ member: "event", name: "saved", value: { count: 1 } }, ctx)).resolves.toEqual({ send: true, value: { count: 1 } });
239
- });
240
- test("table overrides' replies and deliveries omit undefined fields at the member boundary", async () => {
241
- const notesSchema = itemSchema.extend({ note: zod_1.z.string().optional() });
242
- class NotesTable extends table_1.PackageTable {
243
- async get(id) {
244
- return { itemId: id, title: "note", hidden: false, note: undefined };
245
- }
246
- dataChanged(event) {
247
- return { ...event, dataObject: { ...event.dataObject, note: undefined } };
248
- }
249
- }
250
- const Notes = (0, table_1.defineTable)({
251
- ...Items.definition,
252
- name: "Notes",
253
- schema: notesSchema,
254
- tableClass: NotesTable,
255
- });
256
- const contract = (0, define_package_1.defineContract)({
257
- contractId: (0, peer_id_1.newid)(),
258
- version: 1,
259
- name: "Notes",
260
- tables: [Notes],
261
- });
262
- const handlers = new Map();
263
- (0, serve_members_1.serveContractMembers)(contract, (name, handler) => handlers.set(name, handler));
264
- const call = handlers.get((0, contract_members_1.contractMemberHandlerName)(contract.contractId, 1));
265
- const deliver = handlers.get((0, contract_members_1.contractDeliveryHandlerName)(contract.contractId, 1));
266
- if (!call || !deliver)
267
- throw new Error("handlers not registered");
268
- const { ctx } = fakeContext();
269
- const row = await call({ member: "table", name: "Notes", operation: "get", args: ["a"] }, ctx);
270
- expect(Object.hasOwn(row, "note")).toBe(false);
271
- const change = (await deliver({ member: "table", name: "Notes", value: { op: "insert", source: "local", dataObject: row } }, ctx));
272
- expect(change.send).toBe(true);
273
- expect(Object.hasOwn(change.value.dataObject, "note")).toBe(false);
274
- await expect(call({ member: "table", name: "Notes", operation: "delete", args: ["a"] }, ctx)).resolves.toBeNull();
275
- });
276
- test("table overrides' rows and changes leave out empty fields, as stored rows do", async () => {
277
- const tagsSchema = itemSchema.extend({ tag: zod_1.z.string().nullish(), data: zod_1.z.unknown() });
278
- const empty = { tag: null, data: null };
279
- const incoming = jest.fn();
280
- const itemId = (0, peer_id_1.newid)();
281
- class TagsTable extends table_1.PackageTable {
282
- async save(row) {
283
- incoming(row);
284
- return super.save(row);
285
- }
286
- async get(id) {
287
- return { itemId: id, title: "tag", hidden: false, ...empty };
288
- }
289
- async list() {
290
- return [await this.get(itemId)];
291
- }
292
- dataChanged(event) {
293
- incoming(event.dataObject);
294
- return { ...event, dataObject: { ...event.dataObject, ...empty } };
295
- }
296
- }
297
- const Tags = (0, table_1.defineTable)({
298
- ...Items.definition,
299
- name: "Tags",
300
- schema: tagsSchema,
301
- tableClass: TagsTable,
302
- });
303
- const contract = (0, define_package_1.defineContract)({
304
- contractId: (0, peer_id_1.newid)(),
305
- version: 1,
306
- name: "Tags",
307
- tables: [Tags],
308
- });
309
- const handlers = new Map();
310
- (0, serve_members_1.serveContractMembers)(contract, (name, handler) => handlers.set(name, handler));
311
- const call = handlers.get((0, contract_members_1.contractMemberHandlerName)(contract.contractId, 1));
312
- const deliver = handlers.get((0, contract_members_1.contractDeliveryHandlerName)(contract.contractId, 1));
313
- if (!call || !deliver)
314
- throw new Error("handlers not registered");
315
- const { ctx } = fakeContext();
316
- // `data` isn't described field by field, so it keeps its null.
317
- const row = { itemId, title: "tag", hidden: false, data: null };
318
- await expect(call({ member: "table", name: "Tags", operation: "get", args: [itemId] }, ctx)).resolves.toStrictEqual(row);
319
- await expect(call({ member: "table", name: "Tags", operation: "list", args: [] }, ctx)).resolves.toStrictEqual([row]);
320
- const sent = { ...row, tag: null };
321
- await expect(call({ member: "table", name: "Tags", operation: "save", args: [sent] }, ctx)).resolves.toStrictEqual(row);
322
- expect(incoming).toHaveBeenLastCalledWith(row);
323
- expect(sent).toHaveProperty("tag", null);
324
- const change = { op: "insert", source: "local", dataObject: row };
325
- await expect(deliver({ member: "table", name: "Tags", value: { ...change, dataObject: sent } }, ctx)).resolves.toStrictEqual({ send: true, value: change });
326
- expect(incoming).toHaveBeenLastCalledWith(row);
327
- });
328
- test("observables read and write their sources", async () => {
329
- const { call } = serve();
330
- const { ctx, vars } = fakeContext();
331
- await (0, observables_1.servePackageObservables)([Contract], ctx);
332
- const observableCall = (name, operation, args = []) => Promise.resolve().then(() => call({ member: "observable", name, operation, args }, ctx));
333
- await expect(observableCall("level", "get")).resolves.toBe(1);
334
- await expect(observableCall("level", "set", [4])).resolves.toBe(4);
335
- expect(level()).toBe(4);
336
- await expect(observableCall("level", "set", [40])).rejects.toThrow();
337
- expect(level()).toBe(4);
338
- await expect(observableCall("theme", "get")).resolves.toBe("light");
339
- await expect(observableCall("theme", "set", ["dark"])).resolves.toBe("dark");
340
- expect(theme()).toBe("dark");
341
- await expect(observableCall("stored", "get")).resolves.toBe("start");
342
- await expect(observableCall("stored", "set", ["next"])).resolves.toBe("next");
343
- expect(vars.get(JSON.stringify(["device", "stored"]))).toBe("next");
344
- await expect(observableCall("stored", "subscribe")).resolves.toBeNull();
345
- });
346
- test("stored observable calls reject failed loads and saves, and later writes recover", async () => {
347
- const { call } = serve();
348
- const { ctx } = fakeContext();
349
- let failRead = true;
350
- let failWrite = false;
351
- const failing = {
352
- ...ctx,
353
- watchOwnedPersistentVar: async () => () => { },
354
- getOwnedPersistentVar: async () => {
355
- if (failRead)
356
- throw new Error("storage read failed");
357
- return "dark";
358
- },
359
- setOwnedPersistentVar: async () => {
360
- if (failWrite)
361
- throw new Error("storage write failed");
362
- return "dark";
363
- },
364
- };
365
- const errors = jest.spyOn(console, "error").mockImplementation(() => { });
366
- try {
367
- await (0, vars_1.bindPackageVars)(failing);
368
- const themeCall = (operation, args = []) => call({ member: "observable", name: "theme", operation, args }, failing);
369
- await expect(themeCall("get")).rejects.toThrow("storage read failed");
370
- failRead = false;
371
- failWrite = true;
372
- // The refresh succeeds, but must not hide the failed save.
373
- await expect(themeCall("set", ["light"])).rejects.toThrow("storage write failed");
374
- failWrite = false;
375
- await expect(themeCall("set", ["dark"])).resolves.toBe("dark");
376
- await expect(themeCall("get")).resolves.toBe("dark");
377
- }
378
- finally {
379
- errors.mockRestore();
380
- }
381
- });
382
- test("a stored observable write that persisted succeeds even when the refresh after it fails", async () => {
383
- const { call } = serve();
384
- const { ctx } = fakeContext();
385
- let stored = "light";
386
- let failRead = false;
387
- const controlled = {
388
- ...ctx,
389
- watchOwnedPersistentVar: async () => () => { },
390
- getOwnedPersistentVar: async () => {
391
- if (failRead)
392
- throw new Error("storage read failed");
393
- return stored;
394
- },
395
- setOwnedPersistentVar: async (_scope, _name, value) => {
396
- stored = value;
397
- // The save is done; the read that refreshes the mirror after it fails.
398
- failRead = true;
399
- return value;
400
- },
401
- };
402
- await (0, vars_1.bindPackageVars)(controlled);
403
- const errors = jest.spyOn(console, "error").mockImplementation(() => { });
404
- try {
405
- await expect(call({ member: "observable", name: "theme", operation: "set", args: ["dark"] }, controlled)).resolves.toBe("dark");
406
- expect(stored).toBe("dark");
407
- expect(errors).toHaveBeenCalledWith('Reading package variable "serve-members-theme" failed', expect.any(Error));
408
- }
409
- finally {
410
- errors.mockRestore();
411
- }
412
- });
413
- test("a stored observable read returns its storage result while a newer refresh is pending", async () => {
414
- const { call } = serve();
415
- const { ctx } = fakeContext();
416
- let refresh;
417
- const reads = [];
418
- let holding = false;
419
- const controlled = {
420
- ...ctx,
421
- watchOwnedPersistentVar: async (_scope, name, handler) => {
422
- if (name === "serve-members-theme")
423
- refresh = handler;
424
- return () => { };
425
- },
426
- getOwnedPersistentVar: async (_scope, name) => {
427
- if (name !== "serve-members-theme" || !holding)
428
- return "light";
429
- return new Promise((resolve) => reads.push(resolve));
430
- },
431
- };
432
- await (0, vars_1.bindPackageVars)(controlled);
433
- holding = true;
434
- const reading = call({ member: "observable", name: "theme", operation: "get" }, controlled);
435
- // Let the contract read issue its storage request, then start a newer watch refresh.
436
- await Promise.resolve();
437
- const refreshing = refresh?.();
438
- expect(reads).toHaveLength(2);
439
- reads[0]("dark");
440
- try {
441
- // The mirror is still "light": only the newer refresh may apply to it. That must
442
- // not replace the value this contract read actually received from storage.
443
- await expect(reading).resolves.toBe("dark");
444
- expect(theme()).toBe("light");
445
- }
446
- finally {
447
- reads[1]("dark");
448
- await refreshing;
449
- }
450
- expect(theme()).toBe("dark");
451
- });
452
- test("a stored observable write replies with its own value when a later write fails", async () => {
453
- const { call } = serve();
454
- const { ctx } = fakeContext();
455
- let stored = "light";
456
- let release;
457
- const firstSave = new Promise((resolve) => {
458
- release = resolve;
459
- });
460
- const controlled = {
461
- ...ctx,
462
- watchOwnedPersistentVar: async () => () => { },
463
- getOwnedPersistentVar: async () => stored,
464
- setOwnedPersistentVar: async (_scope, _name, value) => {
465
- if (value === "light")
466
- throw new Error("later save failed");
467
- await firstSave;
468
- stored = value;
469
- return value;
470
- },
471
- };
472
- await (0, vars_1.bindPackageVars)(controlled);
473
- const write = (value) => call({ member: "observable", name: "theme", operation: "set", args: [value] }, controlled);
474
- const errors = jest.spyOn(console, "error").mockImplementation(() => { });
475
- try {
476
- const first = write("dark");
477
- const later = expect(write("light")).rejects.toThrow("later save failed");
478
- release();
479
- const reply = await first;
480
- await later;
481
- expect(stored).toBe("dark");
482
- expect(reply).toBe("dark");
483
- }
484
- finally {
485
- errors.mockRestore();
486
- }
487
- });
488
- test.each([
489
- true,
490
- false,
491
- ])("a subscriber's reentrant write cannot replace the contract save's result (first fails: %s)", async (firstFails) => {
492
- const { call } = serve();
493
- const { ctx } = fakeContext();
494
- let stored = "light";
495
- const controlled = {
496
- ...ctx,
497
- watchOwnedPersistentVar: async () => () => { },
498
- getOwnedPersistentVar: async () => stored,
499
- setOwnedPersistentVar: async (_scope, _name, value) => {
500
- if ((value === "dark") === firstFails)
501
- throw new Error(`save ${value} failed`);
502
- stored = value;
503
- return value;
504
- },
505
- };
506
- await (0, vars_1.bindPackageVars)(controlled);
507
- const subscription = theme.subscribe((value) => {
508
- if (value === "dark")
509
- theme("light");
510
- });
511
- const errors = jest.spyOn(console, "error").mockImplementation(() => { });
512
- try {
513
- const writing = call({ member: "observable", name: "theme", operation: "set", args: ["dark"] }, controlled);
514
- if (firstFails)
515
- await expect(writing).rejects.toThrow("save dark failed");
516
- else
517
- await expect(writing).resolves.toBe("dark");
518
- await theme.loadingPromise;
519
- expect(stored).toBe(firstFails ? "light" : "dark");
520
- }
521
- finally {
522
- subscription.dispose();
523
- errors.mockRestore();
524
- }
525
- });
526
- test("a queued stored write persists its captured value even if the package mutates the source", async () => {
527
- const state = (0, vars_1.deviceVar)("serve-members-mutable", { defaultValue: { count: 0 } });
528
- const Mutable = (0, define_package_1.defineContract)({
529
- contractId: (0, peer_id_1.newid)(),
530
- version: 1,
531
- name: "Mutable",
532
- observables: [
533
- (0, observables_1.defineObservable)({
534
- name: "state",
535
- description: "Mutable state.",
536
- schema: zod_1.z.object({ count: zod_1.z.number() }),
537
- writable: true,
538
- source: state,
539
- }),
540
- ],
541
- });
542
- let call;
543
- (0, serve_members_1.serveContractMembers)(Mutable, (name, handler) => {
544
- if (name === (0, contract_members_1.contractMemberHandlerName)(Mutable.contractId, 1))
545
- call = handler;
546
- });
547
- const { ctx } = fakeContext();
548
- let stored = { count: 0 };
549
- let writes = 0;
550
- const controlled = {
551
- ...ctx,
552
- watchOwnedPersistentVar: async () => () => { },
553
- getOwnedPersistentVar: async () => ({ ...stored }),
554
- setOwnedPersistentVar: async (_scope, _name, value) => {
555
- if (++writes > 1)
556
- throw new Error("later save failed");
557
- stored = { ...value };
558
- return stored;
559
- },
560
- };
561
- await (0, vars_1.bindPackageVars)(controlled);
562
- const errors = jest.spyOn(console, "error").mockImplementation(() => { });
563
- try {
564
- const first = call({ member: "observable", name: "state", operation: "set", args: [{ count: 1 }] }, controlled);
565
- // A package can mutate its object and explicitly notify. That is a later write;
566
- // it must not change the value captured by the already queued contract write.
567
- state().count = 2;
568
- state.notifySubscribers();
569
- await expect(first).resolves.toEqual({ count: 1 });
570
- await state.loadingPromise;
571
- expect(stored).toEqual({ count: 1 });
572
- }
573
- finally {
574
- errors.mockRestore();
575
- }
576
- });
577
- test("a stored observable's pushed values leave out empty fields, as its reads do", async () => {
578
- const place = (0, vars_1.deviceVar)("serve-members-place", { defaultValue: { city: "" } });
579
- const Places = (0, define_package_1.defineContract)({
580
- contractId: (0, peer_id_1.newid)(),
581
- version: 1,
582
- name: "Places",
583
- observables: [
584
- (0, observables_1.defineObservable)({
585
- name: "place",
586
- description: "A place.",
587
- schema: zod_1.z.object({ city: zod_1.z.string(), zone: zod_1.z.string().optional(), data: zod_1.z.unknown() }),
588
- source: place,
589
- }),
590
- ],
591
- });
592
- const handlers = new Map();
593
- (0, serve_members_1.serveContractMembers)(Places, (name, handler) => handlers.set(name, handler));
594
- const call = handlers.get((0, contract_members_1.contractMemberHandlerName)(Places.contractId, 1));
595
- const deliver = handlers.get((0, contract_members_1.contractDeliveryHandlerName)(Places.contractId, 1));
596
- if (!call || !deliver)
597
- throw new Error("handlers not registered");
598
- // Stored by the package's own code or an older build: the host pushes it from storage.
599
- const stored = { city: "Austin", zone: null, data: null };
600
- const { ctx } = fakeContext();
601
- const controlled = {
602
- ...ctx,
603
- watchOwnedPersistentVar: async () => () => { },
604
- getOwnedPersistentVar: async () => stored,
605
- };
606
- await (0, vars_1.bindPackageVars)(controlled);
607
- const expected = { city: "Austin", data: null };
608
- await expect(call({ member: "observable", name: "place", operation: "get", args: [] }, controlled)).resolves.toEqual(expected);
609
- await expect(deliver({ member: "observable", name: "place", value: stored }, controlled)).resolves.toEqual({ send: true, value: expected });
610
- expect(stored).toEqual({ city: "Austin", zone: null, data: null });
611
- });
612
- });
613
- describe("guest API 3", () => {
614
- test("a package declared with definePackage serves its own members", () => {
615
- const manifest = (0, manifest_1.buildPackageManifest)((0, define_package_1.definePackage)((pkg) => {
616
- pkg.packageId = (0, peer_id_1.newid)();
617
- pkg.version = "1.0.0";
618
- pkg.provides((0, define_package_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 1, name: "C", tables: [Items] }));
619
- }));
620
- expect(manifest.guestApi).toBe(3);
621
- expect((0, isolated_artifact_1.servesContractMembers)(manifest)).toBe(true);
622
- expect((0, isolated_artifact_1.servesContractMembers)({ guestApi: 2 })).toBe(false);
623
- const artifact = (guestApi) => ({
624
- manifest: { ...manifest, guestApi },
625
- providerSource: "/* provider */",
626
- });
627
- expect(() => (0, isolated_artifact_1.validateIsolatedPackageArtifact)(artifact(2))).not.toThrow();
628
- expect(() => (0, isolated_artifact_1.validateIsolatedPackageArtifact)(artifact(4))).toThrow("manifest.guestApi must be 2 or 3 when set");
629
- });
630
- });
@@ -1 +0,0 @@
1
- export {};
@@ -1,39 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const index_1 = require("./index");
4
- const vars_1 = require("./vars");
5
- test("the public variable helpers retain value types and reject persistence failures", async () => {
6
- const variable = (0, index_1.deviceVar)("awaited", { defaultValue: 0 });
7
- let stored = 0;
8
- let failRead = false;
9
- let failWrite = false;
10
- const ctx = {
11
- watchOwnedPersistentVar: async () => () => undefined,
12
- getOwnedPersistentVar: async () => {
13
- if (failRead)
14
- throw new Error("durable read failed");
15
- return stored;
16
- },
17
- setOwnedPersistentVar: async (_scope, _name, value) => {
18
- if (failWrite)
19
- throw new Error("durable save failed");
20
- stored = value;
21
- },
22
- };
23
- await (0, vars_1.bindPackageVars)(ctx);
24
- const saved = await (0, index_1.writePackageVar)(variable, 7);
25
- const read = await (0, index_1.readPackageVar)(variable);
26
- expect([saved, read]).toEqual([7, 7]);
27
- const errors = jest.spyOn(console, "error").mockImplementation(() => undefined);
28
- try {
29
- failWrite = true;
30
- await expect((0, index_1.writePackageVar)(variable, 8)).rejects.toThrow("durable save failed");
31
- failWrite = false;
32
- await expect((0, index_1.writePackageVar)(variable, 9)).resolves.toBe(9);
33
- failRead = true;
34
- await expect((0, index_1.readPackageVar)(variable)).rejects.toThrow("durable read failed");
35
- }
36
- finally {
37
- errors.mockRestore();
38
- }
39
- });
@@ -1 +0,0 @@
1
- export {};