@peers-app/peers-sdk 0.27.2 → 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 (260) 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/data/persistent-vars.d.ts +5 -0
  19. package/dist/data/persistent-vars.js +24 -6
  20. package/dist/define/manifest.js +6 -34
  21. package/dist/package-loader/package-loader.js +27 -22
  22. package/dist/system-ids.d.ts +5 -0
  23. package/dist/system-ids.js +6 -1
  24. package/package.json +4 -2
  25. package/dist/context/user-context-identity.test.d.ts +0 -1
  26. package/dist/context/user-context-identity.test.js +0 -220
  27. package/dist/contracts/__tests__/action-dispatch.test.d.ts +0 -1
  28. package/dist/contracts/__tests__/action-dispatch.test.js +0 -319
  29. package/dist/contracts/__tests__/also-implements.test.d.ts +0 -1
  30. package/dist/contracts/__tests__/also-implements.test.js +0 -110
  31. package/dist/contracts/__tests__/builder.test.d.ts +0 -1
  32. package/dist/contracts/__tests__/builder.test.js +0 -669
  33. package/dist/contracts/__tests__/contract-events.test.d.ts +0 -1
  34. package/dist/contracts/__tests__/contract-events.test.js +0 -199
  35. package/dist/contracts/__tests__/contract-observables.test.d.ts +0 -1
  36. package/dist/contracts/__tests__/contract-observables.test.js +0 -290
  37. package/dist/contracts/__tests__/contract-provider-router.test.d.ts +0 -1
  38. package/dist/contracts/__tests__/contract-provider-router.test.js +0 -315
  39. package/dist/contracts/__tests__/contract-proxy.test.d.ts +0 -1
  40. package/dist/contracts/__tests__/contract-proxy.test.js +0 -657
  41. package/dist/contracts/__tests__/contract-resolvers.test.d.ts +0 -1
  42. package/dist/contracts/__tests__/contract-resolvers.test.js +0 -758
  43. package/dist/contracts/__tests__/contract-subscription-lifecycle.test.d.ts +0 -1
  44. package/dist/contracts/__tests__/contract-subscription-lifecycle.test.js +0 -353
  45. package/dist/contracts/__tests__/contract-table-events.test.d.ts +0 -1
  46. package/dist/contracts/__tests__/contract-table-events.test.js +0 -209
  47. package/dist/contracts/__tests__/contract-transport.test.d.ts +0 -1
  48. package/dist/contracts/__tests__/contract-transport.test.js +0 -163
  49. package/dist/contracts/__tests__/extract.test.d.ts +0 -1
  50. package/dist/contracts/__tests__/extract.test.js +0 -145
  51. package/dist/contracts/__tests__/frozen-contracts.test.d.ts +0 -1
  52. package/dist/contracts/__tests__/frozen-contracts.test.js +0 -191
  53. package/dist/contracts/__tests__/generic-tool-dispatch.test.d.ts +0 -1
  54. package/dist/contracts/__tests__/generic-tool-dispatch.test.js +0 -130
  55. package/dist/contracts/__tests__/host-contract-client.test.d.ts +0 -1
  56. package/dist/contracts/__tests__/host-contract-client.test.js +0 -793
  57. package/dist/contracts/__tests__/host-contract-consumer.test.d.ts +0 -1
  58. package/dist/contracts/__tests__/host-contract-consumer.test.js +0 -163
  59. package/dist/contracts/__tests__/host-contract-transport.test.d.ts +0 -1
  60. package/dist/contracts/__tests__/host-contract-transport.test.js +0 -66
  61. package/dist/contracts/__tests__/integration.test.d.ts +0 -1
  62. package/dist/contracts/__tests__/integration.test.js +0 -348
  63. package/dist/contracts/__tests__/legacy-removal.test.d.ts +0 -1
  64. package/dist/contracts/__tests__/legacy-removal.test.js +0 -128
  65. package/dist/contracts/__tests__/persistent-registry.test.d.ts +0 -1
  66. package/dist/contracts/__tests__/persistent-registry.test.js +0 -109
  67. package/dist/contracts/__tests__/playground.test.d.ts +0 -1
  68. package/dist/contracts/__tests__/playground.test.js +0 -216
  69. package/dist/contracts/__tests__/registry.test.d.ts +0 -1
  70. package/dist/contracts/__tests__/registry.test.js +0 -238
  71. package/dist/contracts/__tests__/remote-contract-transport.test.d.ts +0 -1
  72. package/dist/contracts/__tests__/remote-contract-transport.test.js +0 -119
  73. package/dist/contracts/__tests__/system-contracts.test.d.ts +0 -1
  74. package/dist/contracts/__tests__/system-contracts.test.js +0 -247
  75. package/dist/contracts/__tests__/target-dispatch.d.ts +0 -11
  76. package/dist/contracts/__tests__/target-dispatch.js +0 -24
  77. package/dist/contracts/__tests__/tool-catalog-inventory.test.d.ts +0 -1
  78. package/dist/contracts/__tests__/tool-catalog-inventory.test.js +0 -44
  79. package/dist/contracts/__tests__/tool-catalog-service.test.d.ts +0 -1
  80. package/dist/contracts/__tests__/tool-catalog-service.test.js +0 -482
  81. package/dist/contracts/__tests__/tool-catalog.test.d.ts +0 -1
  82. package/dist/contracts/__tests__/tool-catalog.test.js +0 -1199
  83. package/dist/contracts/__tests__/validate.test.d.ts +0 -1
  84. package/dist/contracts/__tests__/validate.test.js +0 -991
  85. package/dist/contracts/__tests__/workflow-context.test.d.ts +0 -1
  86. package/dist/contracts/__tests__/workflow-context.test.js +0 -50
  87. package/dist/data/access-level.test.d.ts +0 -1
  88. package/dist/data/access-level.test.js +0 -53
  89. package/dist/data/change-tracking.test.d.ts +0 -1
  90. package/dist/data/change-tracking.test.js +0 -62
  91. package/dist/data/files/files.test.d.ts +0 -1
  92. package/dist/data/files/files.test.js +0 -770
  93. package/dist/data/group-members.test.d.ts +0 -1
  94. package/dist/data/group-members.test.js +0 -336
  95. package/dist/data/group-share.test.d.ts +0 -1
  96. package/dist/data/group-share.test.js +0 -110
  97. package/dist/data/groups.test.d.ts +0 -1
  98. package/dist/data/groups.test.js +0 -153
  99. package/dist/data/orm/cursor.test.d.ts +0 -1
  100. package/dist/data/orm/cursor.test.js +0 -314
  101. package/dist/data/orm/data-query.mongo.test.d.ts +0 -1
  102. package/dist/data/orm/data-query.mongo.test.js +0 -367
  103. package/dist/data/orm/data-query.sqlite.test.d.ts +0 -1
  104. package/dist/data/orm/data-query.sqlite.test.js +0 -365
  105. package/dist/data/orm/data-query.test.d.ts +0 -1
  106. package/dist/data/orm/data-query.test.js +0 -545
  107. package/dist/data/orm/dependency-injection.test.d.ts +0 -1
  108. package/dist/data/orm/dependency-injection.test.js +0 -171
  109. package/dist/data/orm/event-registry.test.d.ts +0 -1
  110. package/dist/data/orm/event-registry.test.js +0 -44
  111. package/dist/data/orm/multi-cursors.test.d.ts +0 -1
  112. package/dist/data/orm/multi-cursors.test.js +0 -463
  113. package/dist/data/orm/sql.data-source.test.d.ts +0 -1
  114. package/dist/data/orm/sql.data-source.test.js +0 -731
  115. package/dist/data/orm/table-container-events.test.d.ts +0 -1
  116. package/dist/data/orm/table-container-events.test.js +0 -101
  117. package/dist/data/orm/table-container.test.d.ts +0 -1
  118. package/dist/data/orm/table-container.test.js +0 -273
  119. package/dist/data/orm/table.event-source.test.d.ts +0 -1
  120. package/dist/data/orm/table.event-source.test.js +0 -331
  121. package/dist/data/orm/types.test.d.ts +0 -1
  122. package/dist/data/orm/types.test.js +0 -409
  123. package/dist/data/package-table-identity.test.d.ts +0 -1
  124. package/dist/data/package-table-identity.test.js +0 -46
  125. package/dist/data/package-version-permissions.test.d.ts +0 -1
  126. package/dist/data/package-version-permissions.test.js +0 -107
  127. package/dist/data/package-version-resolver.test.d.ts +0 -4
  128. package/dist/data/package-version-resolver.test.js +0 -543
  129. package/dist/data/package-versions.test.d.ts +0 -1
  130. package/dist/data/package-versions.test.js +0 -227
  131. package/dist/data/persistent-vars.conflict.test.d.ts +0 -1
  132. package/dist/data/persistent-vars.conflict.test.js +0 -126
  133. package/dist/data/persistent-vars.migration.test.d.ts +0 -1
  134. package/dist/data/persistent-vars.migration.test.js +0 -133
  135. package/dist/data/persistent-vars.package-scope.test.d.ts +0 -1
  136. package/dist/data/persistent-vars.package-scope.test.js +0 -27
  137. package/dist/data/sync-recovery-queue.test.d.ts +0 -1
  138. package/dist/data/sync-recovery-queue.test.js +0 -215
  139. package/dist/data/table-signing.test.d.ts +0 -1
  140. package/dist/data/table-signing.test.js +0 -118
  141. package/dist/data/tool-access.test.d.ts +0 -1
  142. package/dist/data/tool-access.test.js +0 -166
  143. package/dist/data/user-permissions.test.d.ts +0 -1
  144. package/dist/data/user-permissions.test.js +0 -305
  145. package/dist/data/user-trust-levels.test.d.ts +0 -1
  146. package/dist/data/user-trust-levels.test.js +0 -37
  147. package/dist/define/also-implements.test.d.ts +0 -1
  148. package/dist/define/also-implements.test.js +0 -123
  149. package/dist/define/declare-contract.test.d.ts +0 -1
  150. package/dist/define/declare-contract.test.js +0 -573
  151. package/dist/define/define.test.d.ts +0 -1
  152. package/dist/define/define.test.js +0 -1010
  153. package/dist/define/empty-fields.test.d.ts +0 -1
  154. package/dist/define/empty-fields.test.js +0 -55
  155. package/dist/define/events-observables.test.d.ts +0 -1
  156. package/dist/define/events-observables.test.js +0 -1013
  157. package/dist/define/serve-members.test.d.ts +0 -1
  158. package/dist/define/serve-members.test.js +0 -630
  159. package/dist/define/vars.test.d.ts +0 -1
  160. package/dist/define/vars.test.js +0 -39
  161. package/dist/device/binary-peer-connection-v2.test.d.ts +0 -1
  162. package/dist/device/binary-peer-connection-v2.test.js +0 -730
  163. package/dist/device/binary-peer-connection.test.d.ts +0 -1
  164. package/dist/device/binary-peer-connection.test.js +0 -184
  165. package/dist/device/connection.test.d.ts +0 -1
  166. package/dist/device/connection.test.js +0 -613
  167. package/dist/device/device-election.test.d.ts +0 -1
  168. package/dist/device/device-election.test.js +0 -516
  169. package/dist/device/device.test.d.ts +0 -1
  170. package/dist/device/device.test.js +0 -243
  171. package/dist/device/frame-cipher.test.d.ts +0 -1
  172. package/dist/device/frame-cipher.test.js +0 -219
  173. package/dist/device/get-trust-level-fn.test.d.ts +0 -1
  174. package/dist/device/get-trust-level-fn.test.js +0 -685
  175. package/dist/device/streamed-socket.test.d.ts +0 -1
  176. package/dist/device/streamed-socket.test.js +0 -216
  177. package/dist/device/tx-encoding.test.d.ts +0 -1
  178. package/dist/device/tx-encoding.test.js +0 -295
  179. package/dist/device-pairing/cpace.test.d.ts +0 -1
  180. package/dist/device-pairing/cpace.test.js +0 -116
  181. package/dist/device-pairing/device-pairing.test.d.ts +0 -1
  182. package/dist/device-pairing/device-pairing.test.js +0 -211
  183. package/dist/hlc.test.d.ts +0 -1
  184. package/dist/hlc.test.js +0 -45
  185. package/dist/host-credentials.test.d.ts +0 -1
  186. package/dist/host-credentials.test.js +0 -88
  187. package/dist/identity/account-email.test.d.ts +0 -1
  188. package/dist/identity/account-email.test.js +0 -59
  189. package/dist/identity/anchor-document.test.d.ts +0 -1
  190. package/dist/identity/anchor-document.test.js +0 -16
  191. package/dist/identity/anchor-resolution.test.d.ts +0 -1
  192. package/dist/identity/anchor-resolution.test.js +0 -130
  193. package/dist/identity/key-change.test.d.ts +0 -1
  194. package/dist/identity/key-change.test.js +0 -811
  195. package/dist/invites/group-approval.test.d.ts +0 -1
  196. package/dist/invites/group-approval.test.js +0 -223
  197. package/dist/invites/invite-token.test.d.ts +0 -1
  198. package/dist/invites/invite-token.test.js +0 -123
  199. package/dist/keys.test.d.ts +0 -1
  200. package/dist/keys.test.js +0 -336
  201. package/dist/logging/console-logger.test.d.ts +0 -1
  202. package/dist/logging/console-logger.test.js +0 -300
  203. package/dist/logging/console-logs.table.test.d.ts +0 -1
  204. package/dist/logging/console-logs.table.test.js +0 -156
  205. package/dist/observable.test.d.ts +0 -1
  206. package/dist/observable.test.js +0 -309
  207. package/dist/package-build/build-package.test.d.ts +0 -1
  208. package/dist/package-build/build-package.test.js +0 -204
  209. package/dist/package-build/contract-add.test.d.ts +0 -1
  210. package/dist/package-build/contract-add.test.js +0 -467
  211. package/dist/package-build/freeze-contracts.test.d.ts +0 -1
  212. package/dist/package-build/freeze-contracts.test.js +0 -355
  213. package/dist/package-installer/package-author-signing.test.d.ts +0 -1
  214. package/dist/package-installer/package-author-signing.test.js +0 -200
  215. package/dist/package-installer/package-cloner.test.d.ts +0 -1
  216. package/dist/package-installer/package-cloner.test.js +0 -278
  217. package/dist/package-installer/package-creator.test.d.ts +0 -1
  218. package/dist/package-installer/package-creator.test.js +0 -908
  219. package/dist/package-installer/package-dev-tools.test.d.ts +0 -1
  220. package/dist/package-installer/package-dev-tools.test.js +0 -64
  221. package/dist/package-installer/package-installer.test.d.ts +0 -1
  222. package/dist/package-installer/package-installer.test.js +0 -882
  223. package/dist/package-installer/package-propagation.test.d.ts +0 -1
  224. package/dist/package-installer/package-propagation.test.js +0 -1269
  225. package/dist/package-installer/package-publisher.test.d.ts +0 -1
  226. package/dist/package-installer/package-publisher.test.js +0 -153
  227. package/dist/package-installer/package-remote-checker.test.d.ts +0 -1
  228. package/dist/package-installer/package-remote-checker.test.js +0 -334
  229. package/dist/package-installer/package-seed-installer.test.d.ts +0 -1
  230. package/dist/package-installer/package-seed-installer.test.js +0 -123
  231. package/dist/package-installer/package-tarball.test.d.ts +0 -1
  232. package/dist/package-installer/package-tarball.test.js +0 -75
  233. package/dist/package-installer/peers-core-installer.test.d.ts +0 -1
  234. package/dist/package-installer/peers-core-installer.test.js +0 -49
  235. package/dist/package-installer/peers-core-trust-anchor.test.d.ts +0 -1
  236. package/dist/package-installer/peers-core-trust-anchor.test.js +0 -155
  237. package/dist/package-loader/contract-package-loader.test.d.ts +0 -1
  238. package/dist/package-loader/contract-package-loader.test.js +0 -274
  239. package/dist/package-loader/host-authority-loading.test.d.ts +0 -1
  240. package/dist/package-loader/host-authority-loading.test.js +0 -104
  241. package/dist/package-loader/host-dispatch-policy.test.d.ts +0 -1
  242. package/dist/package-loader/host-dispatch-policy.test.js +0 -56
  243. package/dist/package-loader/isolated-artifact.test.d.ts +0 -1
  244. package/dist/package-loader/isolated-artifact.test.js +0 -688
  245. package/dist/package-loader/isolated-persistent-var-gateway.test.d.ts +0 -1
  246. package/dist/package-loader/isolated-persistent-var-gateway.test.js +0 -56
  247. package/dist/package-loader/isolated-table-gateway.test.d.ts +0 -1
  248. package/dist/package-loader/isolated-table-gateway.test.js +0 -633
  249. package/dist/package-loader/package-loader.test.d.ts +0 -1
  250. package/dist/package-loader/package-loader.test.js +0 -1764
  251. package/dist/package-loader/resolve-consumed-contracts.test.d.ts +0 -1
  252. package/dist/package-loader/resolve-consumed-contracts.test.js +0 -166
  253. package/dist/serial-json.compat.test.d.ts +0 -1
  254. package/dist/serial-json.compat.test.js +0 -369
  255. package/dist/serial-json.test.d.ts +0 -1
  256. package/dist/serial-json.test.js +0 -401
  257. package/dist/testing/mock-host-contract.test.d.ts +0 -1
  258. package/dist/testing/mock-host-contract.test.js +0 -782
  259. package/dist/utils.test.d.ts +0 -1
  260. package/dist/utils.test.js +0 -232
@@ -1,1010 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const node_fs_1 = require("node:fs");
4
- const path = require("node:path");
5
- const types_1 = require("../data/orm/types");
6
- const contract_members_1 = require("../package-loader/contract-members");
7
- const isolated_artifact_1 = require("../package-loader/isolated-artifact");
8
- const peer_id_1 = require("../peer-id");
9
- const system_ids_1 = require("../system-ids");
10
- const index_1 = require("./index");
11
- const manifest_1 = require("./manifest");
12
- /** A ctx whose host calls are recorded and answered by `answer`. */
13
- function fakeContext(answer = () => null) {
14
- const calls = [];
15
- const ctx = new Proxy({}, {
16
- get(_target, method) {
17
- return async (...args) => {
18
- calls.push([method, ...args]);
19
- return answer(method, args);
20
- };
21
- },
22
- });
23
- return { ctx, calls };
24
- }
25
- const itemSchema = index_1.z.object({
26
- itemId: index_1.zodPeerId.describe("Item id."),
27
- name: index_1.z.string().describe("Item name."),
28
- done: index_1.z.boolean().default(false).describe("Checked off."),
29
- note: index_1.z.string().optional().describe("Free text."),
30
- });
31
- const Items = (0, index_1.defineTable)({
32
- name: "Items",
33
- description: "Things to do.",
34
- primaryKeyName: "itemId",
35
- schema: itemSchema,
36
- });
37
- describe("defineTable", () => {
38
- test("calls the owned table with each method's arguments", async () => {
39
- const { ctx, calls } = fakeContext((_method, args) => {
40
- if (args[1] === "list")
41
- return [{ itemId: "a" }];
42
- if (args[1] === "count")
43
- return 3;
44
- if (args[1] === "save")
45
- return args[2][0];
46
- return null;
47
- });
48
- const items = Items(ctx);
49
- expect(await items.list({ done: false }, { pageSize: 5 })).toEqual([{ itemId: "a" }]);
50
- expect(await items.count()).toBe(3);
51
- expect(await items.get("x")).toBeUndefined();
52
- expect(await items.findOne({ name: "milk" })).toBeUndefined();
53
- await items.delete("x");
54
- expect(calls).toEqual([
55
- ["callOwnedTable", "Items", "list", [{ done: false }, { pageSize: 5 }]],
56
- ["callOwnedTable", "Items", "count", [{}]],
57
- ["callOwnedTable", "Items", "get", ["x"]],
58
- ["callOwnedTable", "Items", "findOne", [{ name: "milk" }]],
59
- ["callOwnedTable", "Items", "delete", ["x"]],
60
- ]);
61
- });
62
- test("parses a saved row with the schema, so defaults apply and bad rows fail", async () => {
63
- const { ctx, calls } = fakeContext((_method, args) => args[2][0]);
64
- const itemId = (0, peer_id_1.newid)();
65
- await expect(Items(ctx).save({ itemId, name: "milk" })).resolves.toEqual({
66
- itemId,
67
- name: "milk",
68
- done: false,
69
- });
70
- await expect(Items(ctx).save({ itemId: "nope", name: "milk" })).rejects.toThrow();
71
- expect(calls).toHaveLength(1);
72
- });
73
- test("rejects a primary key that isn't in the schema", () => {
74
- expect(() => (0, index_1.defineTable)({
75
- name: "Bad",
76
- description: "",
77
- primaryKeyName: "missing",
78
- schema: itemSchema,
79
- })).toThrow(/primary key "missing"/);
80
- });
81
- });
82
- describe("defineTool", () => {
83
- const echo = (0, index_1.defineTool)({
84
- name: "echo",
85
- usageDescription: "Echo a count.",
86
- accessLevel: index_1.AccessLevel.Reader,
87
- inputSchema: index_1.z.object({ count: index_1.z.number().default(1) }),
88
- outputSchema: index_1.z.object({ doubled: index_1.z.number() }),
89
- handler: (args) => ({ doubled: args.count * 2 }),
90
- });
91
- test("parses input with the schema before the handler runs", async () => {
92
- const { ctx } = fakeContext();
93
- await expect((0, index_1.runPackageTool)(echo, null, ctx)).resolves.toEqual({ doubled: 2 });
94
- await expect((0, index_1.runPackageTool)(echo, { count: 4, extra: true }, ctx)).resolves.toEqual({
95
- doubled: 8,
96
- });
97
- await expect((0, index_1.runPackageTool)(echo, { count: "4" }, ctx)).rejects.toThrow();
98
- });
99
- test.each([
100
- index_1.z.number().default(1),
101
- index_1.z
102
- .number()
103
- .default(1)
104
- .refine((value) => value > 0),
105
- index_1.z.number().default(1).brand(),
106
- index_1.z.number().default(1).readonly(),
107
- index_1.z.number().catch(1),
108
- ])("defaulted tool inputs pass catalog validation (%#)", async (count) => {
109
- const tool = (0, index_1.defineTool)({
110
- ...echo.definition,
111
- inputSchema: index_1.z.object({ count }),
112
- outputSchema: index_1.z.object({ doubled: index_1.z.number() }),
113
- handler: (args) => ({ doubled: args.count * 2 }),
114
- });
115
- const definition = (0, index_1.definePackage)((pkg) => {
116
- pkg.packageId = (0, peer_id_1.newid)();
117
- pkg.version = "1.0.0";
118
- pkg.provides((0, index_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 1, name: "Echo", tools: [tool] }));
119
- });
120
- const manifest = (0, manifest_1.buildPackageManifest)(definition);
121
- const fields = manifest.provides[0].tools[0].inputFields ?? [];
122
- expect(fields).toEqual([{ name: "count", type: "number", optional: true }]);
123
- const args = (0, types_1.fieldsToSchema)(fields).passthrough().parse({});
124
- const { ctx } = fakeContext();
125
- await expect((0, index_1.runPackageTool)(tool, args, ctx)).resolves.toEqual({ doubled: 2 });
126
- });
127
- test("an array element's default does not make the array input optional", () => {
128
- const tool = (0, index_1.defineTool)({
129
- ...echo.definition,
130
- inputSchema: index_1.z.object({ counts: index_1.z.number().default(1).array().brand() }),
131
- outputSchema: index_1.z.object({ doubled: index_1.z.number() }),
132
- handler: ({ counts }) => ({ doubled: counts.length * 2 }),
133
- });
134
- const definition = (0, index_1.definePackage)((pkg) => {
135
- pkg.packageId = (0, peer_id_1.newid)();
136
- pkg.version = "1.0.0";
137
- pkg.provides((0, index_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 1, name: "Echo", tools: [tool] }));
138
- });
139
- const fields = (0, manifest_1.buildPackageManifest)(definition).provides[0].tools[0].inputFields ?? [];
140
- expect(fields).toEqual([{ name: "counts", type: "number", isArray: true }]);
141
- expect((0, types_1.fieldsToSchema)(fields).safeParse({}).success).toBe(false);
142
- });
143
- test("enums and literals are scalar types in table and tool IR, as in events", () => {
144
- const status = index_1.z.enum(["running", "paused"]);
145
- const Rows = (0, index_1.defineTable)({
146
- name: "Rows",
147
- description: "Rows.",
148
- primaryKeyName: "rowId",
149
- schema: index_1.z.object({
150
- rowId: index_1.zodPeerId,
151
- status: status.describe("Status."),
152
- kind: index_1.z.literal("timer").optional(),
153
- steps: index_1.z.array(status),
154
- size: index_1.z.literal(3),
155
- }),
156
- });
157
- const tool = (0, index_1.defineTool)({
158
- ...echo.definition,
159
- inputSchema: index_1.z.object({ status: status.default("running") }),
160
- outputSchema: index_1.z.object({ doubled: index_1.z.number() }),
161
- handler: () => ({ doubled: 2 }),
162
- });
163
- const definition = (0, index_1.definePackage)((pkg) => {
164
- pkg.packageId = (0, peer_id_1.newid)();
165
- pkg.version = "1.0.0";
166
- pkg.provides((0, index_1.defineContract)({
167
- contractId: (0, peer_id_1.newid)(),
168
- version: 1,
169
- name: "E",
170
- tables: [Rows],
171
- tools: [tool],
172
- }));
173
- });
174
- const manifest = (0, manifest_1.buildPackageManifest)(definition);
175
- expect(manifest.tables?.[0].fields.map(({ name, type, optional, isArray }) => ({
176
- name,
177
- type,
178
- optional,
179
- isArray,
180
- }))).toEqual([
181
- { name: "rowId", type: "id", optional: undefined, isArray: undefined },
182
- { name: "status", type: "string", optional: undefined, isArray: undefined },
183
- { name: "kind", type: "string", optional: true, isArray: undefined },
184
- { name: "steps", type: "string", optional: undefined, isArray: true },
185
- { name: "size", type: "number", optional: undefined, isArray: undefined },
186
- ]);
187
- expect(manifest.tables?.[0].fields.map(({ enumValues }) => enumValues)).toEqual([
188
- undefined,
189
- ["running", "paused"],
190
- ["timer"],
191
- ["running", "paused"],
192
- [3],
193
- ]);
194
- expect(manifest.provides[0].tools[0].inputFields).toEqual([
195
- { name: "status", type: "string", optional: true, enumValues: ["running", "paused"] },
196
- ]);
197
- });
198
- test("enum and literal inference keeps valid empty, transformed, and nested values", () => {
199
- const schema = index_1.z.object({
200
- rowId: index_1.zodPeerId,
201
- maybe: index_1.z.enum(["running", "paused"]).nullish(),
202
- transformed: index_1.z.literal("yes").transform(() => true),
203
- nullableItems: index_1.z.array(index_1.z.enum(["running"]).nullable()),
204
- optionalItems: index_1.z.array(index_1.z.literal(3).optional()),
205
- nested: index_1.z.array(index_1.z.array(index_1.z.literal(false))),
206
- flag: index_1.z.literal(true),
207
- });
208
- const Rows = (0, index_1.defineTable)({
209
- name: "Rows",
210
- description: "Rows.",
211
- primaryKeyName: "rowId",
212
- schema,
213
- });
214
- const tool = (0, index_1.defineTool)({
215
- ...echo.definition,
216
- inputSchema: schema,
217
- outputSchema: index_1.z.object({ doubled: index_1.z.number() }),
218
- handler: () => ({ doubled: 2 }),
219
- });
220
- const manifest = (0, manifest_1.buildPackageManifest)((0, index_1.definePackage)((pkg) => {
221
- pkg.packageId = (0, peer_id_1.newid)();
222
- pkg.version = "1.0.0";
223
- pkg.provides((0, index_1.defineContract)({
224
- contractId: (0, peer_id_1.newid)(),
225
- version: 1,
226
- name: "E",
227
- tables: [Rows],
228
- tools: [tool],
229
- }));
230
- }));
231
- const input = {
232
- rowId: (0, peer_id_1.newid)(),
233
- maybe: null,
234
- transformed: "yes",
235
- nullableItems: [null, "running"],
236
- optionalItems: [3, undefined],
237
- nested: [[false]],
238
- flag: true,
239
- };
240
- // The host removes empty optional fields before it checks types.
241
- const inputFields = manifest.provides[0].tools[0].inputFields ?? [];
242
- expect((0, types_1.fieldsToSchema)(inputFields).safeParse((0, types_1.withoutEmptyFields)(inputFields, input)).success).toBe(true);
243
- const fields = manifest.tables?.[0].fields ?? [];
244
- expect((0, types_1.fieldsToSchema)(fields).safeParse((0, types_1.withoutEmptyFields)(fields, schema.parse(input))).success).toBe(true);
245
- expect(fields.find((field) => field.name === "flag")?.type).toBe("boolean");
246
- });
247
- test("the manifest describes nested objects, enum values, and empty fields", () => {
248
- let Color;
249
- (function (Color) {
250
- Color["Red"] = "red";
251
- Color["Blue"] = "blue";
252
- })(Color || (Color = {}));
253
- let Level;
254
- (function (Level) {
255
- Level[Level["Low"] = 1] = "Low";
256
- Level[Level["High"] = 2] = "High";
257
- })(Level || (Level = {}));
258
- const place = index_1.z.object({
259
- city: index_1.z.string().describe("City."),
260
- unit: index_1.z.enum(["F", "C"]).default("F"),
261
- zone: index_1.z.string().nullable().optional(),
262
- });
263
- const inputSchema = index_1.z.object({
264
- place,
265
- places: index_1.z.array(place).optional(),
266
- maybePlace: place.nullish(),
267
- color: index_1.z.nativeEnum(Color),
268
- level: index_1.z.nativeEnum(Level),
269
- size: index_1.z.union([index_1.z.literal("small"), index_1.z.literal("large")]),
270
- mixed: index_1.z.union([index_1.z.literal("auto"), index_1.z.literal(3)]),
271
- refined: index_1.z
272
- .string()
273
- .refine((value) => value.length > 0)
274
- .optional()
275
- .nullable(),
276
- items: index_1.z.array(index_1.z.string().nullable()),
277
- // Where the schema stops describing the value in IR terms, the IR says no more.
278
- transformed: place.transform((value) => value.city),
279
- grid: index_1.z.array(index_1.z.array(place)),
280
- record: index_1.z.record(index_1.z.string()),
281
- lazy: index_1.z.lazy(() => place),
282
- anything: index_1.z.unknown(),
283
- });
284
- const tool = (0, index_1.defineTool)({
285
- ...echo.definition,
286
- inputSchema,
287
- outputSchema: index_1.z.object({ place }),
288
- handler: () => ({ place: { city: "Austin", unit: "F" } }),
289
- });
290
- const manifest = (0, manifest_1.buildPackageManifest)((0, index_1.definePackage)((pkg) => {
291
- pkg.packageId = (0, peer_id_1.newid)();
292
- pkg.version = "1.0.0";
293
- pkg.provides((0, index_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 1, name: "E", tools: [tool] }));
294
- }));
295
- const [inputs, outputs] = [
296
- manifest.provides[0].tools[0].inputFields ?? [],
297
- manifest.provides[0].tools[0].outputFields ?? [],
298
- ];
299
- const byName = new Map(inputs.map((field) => [field.name, field]));
300
- const placeFields = (input) => [
301
- { name: "city", type: "string", description: "City." },
302
- // A defaulted input may be omitted; a parsed output always has it.
303
- {
304
- name: "unit",
305
- type: "string",
306
- enumValues: ["F", "C"],
307
- ...(input ? { optional: true } : {}),
308
- },
309
- { name: "zone", type: "string", optional: true },
310
- ];
311
- expect(byName.get("place")).toEqual({
312
- name: "place",
313
- type: "object",
314
- fields: placeFields(true),
315
- });
316
- expect(outputs[0]).toEqual({ name: "place", type: "object", fields: placeFields(false) });
317
- expect(byName.get("places")).toMatchObject({
318
- isArray: true,
319
- optional: true,
320
- fields: placeFields(true),
321
- });
322
- expect(byName.get("maybePlace")).toMatchObject({ type: "object", optional: true });
323
- expect(byName.get("color")).toEqual({
324
- name: "color",
325
- type: "string",
326
- enumValues: ["red", "blue"],
327
- });
328
- expect(byName.get("level")).toEqual({ name: "level", type: "number", enumValues: [1, 2] });
329
- expect(byName.get("size")).toEqual({
330
- name: "size",
331
- type: "any",
332
- enumValues: ["small", "large"],
333
- });
334
- expect(byName.get("mixed")).toEqual({ name: "mixed", type: "any", enumValues: ["auto", 3] });
335
- // `.optional().nullable()` is optional too, though `schemaToFields` reads only the outer
336
- // wrapper.
337
- expect(byName.get("refined")).toEqual({ name: "refined", type: "string", optional: true });
338
- // An array's nullable elements aren't an empty field.
339
- expect(byName.get("items")).toEqual({ name: "items", type: "string", isArray: true });
340
- for (const name of ["transformed", "grid", "record", "lazy", "anything"]) {
341
- const { fields, enumValues, optional } = byName.get(name) ?? {};
342
- expect({ name, fields, enumValues, optional }).toEqual({ name });
343
- }
344
- // The build validates strictly, and the host's type-level checks accept every valid input.
345
- expect(() => (0, isolated_artifact_1.validateIsolatedPackageArtifact)({ manifest, providerSource: "void 0;" }, { strict: true })).not.toThrow();
346
- const input = inputSchema.parse({
347
- place: { city: "Austin" },
348
- maybePlace: null,
349
- color: "red",
350
- level: 2,
351
- size: "small",
352
- mixed: 3,
353
- refined: null,
354
- // Not null items or a grid: tool IR can't express nullable elements or nested arrays,
355
- // and the host's type check refuses them (as before this IR).
356
- items: ["a"],
357
- transformed: { city: "Austin" },
358
- grid: [],
359
- record: { a: "b" },
360
- lazy: { city: "Austin" },
361
- anything: null,
362
- });
363
- expect((0, types_1.fieldsToSchema)(inputs).safeParse((0, types_1.withoutEmptyFields)(inputs, { ...input, transformed: { city: "Austin" } })).success).toBe(true);
364
- });
365
- test("nested fields stop at the depth the host accepts", () => {
366
- let schema = index_1.z.object({ leaf: index_1.z.string() });
367
- for (let level = 0; level < 20; level++) {
368
- schema = index_1.z.object({ next: schema });
369
- }
370
- const tool = (0, index_1.defineTool)({
371
- ...echo.definition,
372
- inputSchema: index_1.z.object({ deep: schema }),
373
- outputSchema: index_1.z.object({ doubled: index_1.z.number() }),
374
- handler: () => ({ doubled: 2 }),
375
- });
376
- const manifest = (0, manifest_1.buildPackageManifest)((0, index_1.definePackage)((pkg) => {
377
- pkg.packageId = (0, peer_id_1.newid)();
378
- pkg.version = "1.0.0";
379
- pkg.provides((0, index_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 1, name: "E", tools: [tool] }));
380
- }));
381
- let depth = 0;
382
- let fields = manifest.provides[0].tools[0].inputFields;
383
- while (fields?.length) {
384
- depth++;
385
- fields = fields[0].fields;
386
- }
387
- expect(depth).toBe(isolated_artifact_1.ISOLATED_MAX_FIELD_DEPTH);
388
- expect(() => (0, isolated_artifact_1.validateIsolatedPackageArtifact)({ manifest, providerSource: "void 0;" }, { strict: true })).not.toThrow();
389
- });
390
- test("an empty enum field is optional and keeps its existing any type", () => {
391
- const schema = index_1.z.object({
392
- mode: index_1.z.enum(["on", "off"]).nullish(),
393
- size: index_1.z
394
- .union([index_1.z.literal("auto"), index_1.z.literal(3)])
395
- .optional()
396
- .nullable(),
397
- modes: index_1.z.array(index_1.z.enum(["on", "off"]).nullable()),
398
- optionalModes: index_1.z.array(index_1.z.enum(["on", "off"]).optional()),
399
- });
400
- const fields = (0, manifest_1.irFields)(schema, true);
401
- expect(fields).toEqual([
402
- { name: "mode", type: "any", optional: true, enumValues: ["on", "off"] },
403
- { name: "size", type: "any", optional: true, enumValues: ["auto", 3] },
404
- // Empty elements have no IR representation; don't add a narrower enum.
405
- { name: "modes", type: "any", isArray: true },
406
- { name: "optionalModes", type: "any", isArray: true },
407
- ]);
408
- const value = { mode: null, size: null, modes: [null], optionalModes: [undefined] };
409
- expect(schema.safeParse(value).success).toBe(true);
410
- const sent = (0, types_1.withoutEmptyFields)(fields, value);
411
- expect(sent).toEqual({ modes: [null], optionalModes: [undefined] });
412
- expect((0, types_1.fieldsToShapeSchema)(fields).safeParse(sent).success).toBe(true);
413
- expect((0, types_1.fieldsToShapeSchema)(fields).safeParse({ ...sent, mode: "invalid" }).success).toBe(false);
414
- });
415
- test("an empty array field is optional, whatever its element type", () => {
416
- const schema = index_1.z.object({
417
- records: index_1.z.array(index_1.z.record(index_1.z.string())).nullish(),
418
- anything: index_1.z.array(index_1.z.unknown()).nullish(),
419
- modes: index_1.z.array(index_1.z.enum(["on", "off"]).nullable()).nullish(),
420
- });
421
- const fields = (0, manifest_1.irFields)(schema, true);
422
- expect(fields).toEqual([
423
- { name: "records", type: "any", isArray: true, optional: true },
424
- { name: "anything", type: "any", isArray: true, optional: true },
425
- { name: "modes", type: "any", isArray: true, optional: true },
426
- ]);
427
- for (const value of [
428
- { records: null, anything: null, modes: null },
429
- { records: [{ a: "b" }], anything: [1, null], modes: ["on", null] },
430
- ]) {
431
- expect(schema.safeParse(value).success).toBe(true);
432
- const sent = (0, types_1.withoutEmptyFields)(fields, value);
433
- expect((0, types_1.fieldsToSchema)(fields).safeParse(sent).success).toBe(true);
434
- expect((0, types_1.fieldsToShapeSchema)(fields).safeParse(sent).success).toBe(true);
435
- }
436
- });
437
- test("the build refuses .nullable() unless the field is also optional and has no default", () => {
438
- const build = (contract) => () => (0, manifest_1.buildPackageManifest)((0, index_1.definePackage)((pkg) => {
439
- pkg.packageId = (0, peer_id_1.newid)();
440
- pkg.version = "1.0.0";
441
- pkg.provides((0, index_1.defineContract)(contract));
442
- }));
443
- const contract = { contractId: (0, peer_id_1.newid)(), version: 1, name: "E" };
444
- const toolWith = (inputSchema) => (0, index_1.defineTool)({
445
- ...echo.definition,
446
- inputSchema,
447
- outputSchema: index_1.z.object({ doubled: index_1.z.number() }),
448
- handler: () => ({ doubled: 2 }),
449
- });
450
- expect(build({ ...contract, tools: [toolWith(index_1.z.object({ rating: index_1.z.number().nullable() }))] })).toThrow('Tool echo input: Field "rating" uses .nullable(); an empty field is a missing field in Peers, so use .optional() (a null sent for it is removed)');
451
- expect(build({
452
- ...contract,
453
- tools: [toolWith(index_1.z.object({ rating: index_1.z.number().nullable().default(3) }))],
454
- })).toThrow('Tool echo input: Field "rating" has a default and uses .nullable()');
455
- const Rows = (0, index_1.defineTable)({
456
- name: "Rows",
457
- description: "Rows.",
458
- primaryKeyName: "rowId",
459
- schema: index_1.z.object({
460
- rowId: index_1.zodPeerId,
461
- where: index_1.z.object({ zip: index_1.z.string().nullable() }),
462
- }),
463
- });
464
- expect(build({ ...contract, tables: [Rows] })).toThrow('Table Rows: Field "where.zip" uses .nullable()');
465
- expect(build({ ...contract, tools: [toolWith(index_1.z.object({ rating: index_1.z.number().nullish() }))] })).not.toThrow();
466
- });
467
- test("a tool's empty optional inputs and outputs are left out", async () => {
468
- const tool = (0, index_1.defineTool)({
469
- name: "rate",
470
- usageDescription: "Rate something.",
471
- accessLevel: index_1.AccessLevel.Reader,
472
- inputSchema: index_1.z.object({
473
- rating: index_1.z.number().optional(),
474
- limit: index_1.z.number().default(10),
475
- where: index_1.z.object({ city: index_1.z.string(), zip: index_1.z.string().optional() }).optional(),
476
- }),
477
- outputSchema: index_1.z.object({ note: index_1.z.string().nullish(), seen: index_1.z.unknown() }),
478
- handler: (input) => ({ note: null, seen: input }),
479
- });
480
- const { ctx } = fakeContext();
481
- // As models often send: null for an optional input, including in a nested object.
482
- await expect((0, index_1.runPackageTool)(tool, { rating: null, limit: null, where: { city: "Austin", zip: null } }, ctx)).resolves.toEqual({ seen: { limit: 10, where: { city: "Austin" } } });
483
- });
484
- test("handlers return complete results because output schemas aren't parsed", async () => {
485
- const withDefault = (0, index_1.defineTool)({
486
- name: "length",
487
- usageDescription: "Return a length.",
488
- accessLevel: index_1.AccessLevel.Reader,
489
- inputSchema: index_1.z.object({}),
490
- outputSchema: index_1.z.object({ length: index_1.z.number().default(3) }),
491
- handler: () => ({ length: 3 }),
492
- });
493
- const { ctx } = fakeContext();
494
- await expect((0, index_1.runPackageTool)(withDefault, {}, ctx)).resolves.toEqual({ length: 3 });
495
- // @ts-expect-error Results aren't parsed, so the handler must return the output type.
496
- (0, index_1.defineTool)({
497
- name: "invalidLength",
498
- usageDescription: "Invalid result type.",
499
- accessLevel: index_1.AccessLevel.Reader,
500
- inputSchema: index_1.z.object({}),
501
- outputSchema: index_1.z.object({ length: index_1.z.number().default(3) }),
502
- handler: () => ({}),
503
- });
504
- });
505
- test("passes input through untouched for a tool declared in IR", async () => {
506
- let received;
507
- const raw = (0, index_1.defineTool)({
508
- name: "raw",
509
- usageDescription: "Raw.",
510
- accessLevel: index_1.AccessLevel.Reader,
511
- inputFields: [{ name: "args", type: "object", description: "Anything." }],
512
- outputFields: [],
513
- handler: (args) => {
514
- received = args;
515
- return args;
516
- },
517
- });
518
- const { ctx } = fakeContext();
519
- const args = { args: { nested: { kept: true } } };
520
- await expect((0, index_1.runPackageTool)(raw, args, ctx)).resolves.toEqual(args);
521
- expect(received).toBe(args);
522
- });
523
- test("a result's undefined fields are omitted, as the bridge carries it", async () => {
524
- const reply = (0, index_1.defineTool)({
525
- name: "reply",
526
- usageDescription: "Reply.",
527
- accessLevel: index_1.AccessLevel.Reader,
528
- inputSchema: index_1.z.object({}),
529
- outputSchema: index_1.z.object({ result: index_1.z.string(), speech: index_1.z.string().optional() }),
530
- handler: () => ({ result: "ok", speech: undefined }),
531
- });
532
- const { ctx } = fakeContext();
533
- const result = await (0, index_1.runPackageTool)(reply, {}, ctx);
534
- expect(result).toEqual({ result: "ok" });
535
- expect(Object.hasOwn(result, "speech")).toBe(false);
536
- const nothing = (0, index_1.defineTool)({
537
- name: "nothing",
538
- usageDescription: "Nothing.",
539
- accessLevel: index_1.AccessLevel.Reader,
540
- inputFields: [],
541
- outputFields: [],
542
- handler: () => undefined,
543
- });
544
- await expect((0, index_1.runPackageTool)(nothing, {}, ctx)).resolves.toBeUndefined();
545
- });
546
- test("needs schemas or fields, a handler, and a valid access level", () => {
547
- const base = { name: "t", usageDescription: "", handler: () => null };
548
- expect(() => (0, index_1.defineTool)({ ...base, accessLevel: 101, inputFields: [], outputFields: [] })).toThrow(/accessLevel/);
549
- expect(() => (0, index_1.defineTool)({ ...base, accessLevel: 20 })).toThrow(/either inputSchema/);
550
- });
551
- });
552
- describe("contractRef", () => {
553
- test("a contract client runs tools as consumed calls", async () => {
554
- const { ctx, calls } = fakeContext(() => ({ ok: true }));
555
- const client = (0, index_1.SystemHttp)(ctx);
556
- // A field left undefined is omitted, as the bridge carries the arguments.
557
- await client.tools.request({
558
- requestId: "r",
559
- method: "GET",
560
- url: "https://a.example",
561
- body: undefined,
562
- });
563
- expect(client.tools.then).toBeUndefined();
564
- expect(calls).toEqual([
565
- [
566
- "callConsumedTool",
567
- index_1.SystemHttp.contractId,
568
- 1,
569
- "request",
570
- { requestId: "r", method: "GET", url: "https://a.example" },
571
- ],
572
- ]);
573
- expect(Object.hasOwn(calls[0][4], "body")).toBe(false);
574
- expect(() => (0, index_1.contractRef)((0, peer_id_1.newid)(), 0)).toThrow(/positive integer/);
575
- });
576
- test("SystemContractCatalog lists every provider of a contract", async () => {
577
- const { ctx, calls } = fakeContext(() => ({ providers: [] }));
578
- const listed = await (0, index_1.SystemContractCatalog)(ctx).tools.listContractProviders({
579
- contractId: "c",
580
- version: 1,
581
- });
582
- expect(listed).toEqual({ providers: [] });
583
- expect(calls).toEqual([
584
- [
585
- "callConsumedTool",
586
- system_ids_1.contractCatalogContractId,
587
- 1,
588
- "listContractProviders",
589
- { contractId: "c", version: 1 },
590
- ],
591
- ]);
592
- });
593
- test("awaiting, logging, or converting a client calls no tools", async () => {
594
- const { ctx, calls } = fakeContext(() => {
595
- throw new Error("No tool should run");
596
- });
597
- const client = (0, index_1.SystemHttp)(ctx);
598
- // The sandbox console formats objects with JSON.stringify.
599
- expect(JSON.stringify(client)).toBe('{"tools":{},"tables":{},"observables":{}}');
600
- expect(() => String(client.tools)).toThrow(TypeError);
601
- expect(await client.tools).toBe(client.tools);
602
- expect(await client.tables).toBe(client.tables);
603
- expect(await client.observables).toBe(client.observables);
604
- expect(calls).toEqual([]);
605
- });
606
- test("a reference typed with a contract types its tools and tables", async () => {
607
- const contractId = "00muxgugn6u6qncnno1ywu6tl";
608
- const add = (0, index_1.defineTool)({
609
- name: "add",
610
- usageDescription: "Add an item.",
611
- accessLevel: index_1.AccessLevel.Writer,
612
- inputSchema: index_1.z.object({ name: index_1.z.string() }),
613
- outputSchema: index_1.z.object({ count: index_1.z.number() }),
614
- handler: () => ({ count: 1 }),
615
- });
616
- const ping = (0, index_1.defineTool)({
617
- name: "ping",
618
- usageDescription: "Nothing to send.",
619
- accessLevel: 0,
620
- inputSchema: index_1.z.object({ note: index_1.z.string().optional() }),
621
- outputSchema: index_1.z.object({}),
622
- handler: () => ({}),
623
- });
624
- const Main = (0, index_1.defineContract)({
625
- contractId,
626
- version: 2,
627
- name: "Main",
628
- tables: [Items],
629
- tools: [add, ping],
630
- });
631
- const { ctx, calls } = fakeContext((method, args) => {
632
- if (method === "callConsumedTool")
633
- return { count: 4 };
634
- if (args[3] === "list")
635
- return [{ itemId: "a", name: "milk", done: false }];
636
- if (args[3] === "save")
637
- return args[4][0];
638
- return null;
639
- });
640
- expect(Object.isFrozen(Main.tools)).toBe(true);
641
- expect(() => {
642
- // @ts-expect-error contract members are immutable
643
- Main.tools.push(ping);
644
- }).toThrow(TypeError);
645
- const MainRef = (0, index_1.contractRef)(contractId, 2);
646
- const main = MainRef(ctx);
647
- const added = await main.tools.add({ name: "milk" });
648
- expect(added).toEqual({ count: 4 });
649
- await main.tools.ping();
650
- const rows = await main.tables.Items.list({ done: false });
651
- const name = rows[0].name;
652
- expect(name).toBe("milk");
653
- expect(await main.tables.Items.get("a")).toBeUndefined();
654
- // Sent as given: the providing package's table parses it, defaults included.
655
- const saved = await main.tables.Items.save({
656
- itemId: "b",
657
- name: "eggs",
658
- done: true,
659
- note: undefined,
660
- });
661
- expect(Object.hasOwn(saved, "note")).toBe(false);
662
- expect(calls).toEqual([
663
- ["callConsumedTool", contractId, 2, "add", { name: "milk" }],
664
- ["callConsumedTool", contractId, 2, "ping", undefined],
665
- ["callConsumedTable", contractId, 2, "Items", "list", [{ done: false }, {}]],
666
- ["callConsumedTable", contractId, 2, "Items", "get", ["a"]],
667
- [
668
- "callConsumedTable",
669
- contractId,
670
- 2,
671
- "Items",
672
- "save",
673
- [{ itemId: "b", name: "eggs", done: true }],
674
- ],
675
- ]);
676
- const inputTypeChecks = () => {
677
- // The provider fills `done`'s default, so a consumer may leave it out.
678
- void main.tables.Items.save({ itemId: "c", name: "bread" });
679
- // @ts-expect-error `name` has no default
680
- void main.tables.Items.save({ itemId: "c" });
681
- };
682
- void inputTypeChecks;
683
- // @ts-expect-error the version doesn't match the contract's
684
- (0, index_1.contractRef)(contractId, 1);
685
- // @ts-expect-error nor does the id
686
- (0, index_1.contractRef)((0, peer_id_1.newid)(), 2);
687
- // @ts-expect-error add needs its input
688
- void main.tools.add();
689
- // @ts-expect-error no such tool
690
- void main.tools.remove;
691
- // @ts-expect-error no such table
692
- void main.tables.Notes;
693
- });
694
- });
695
- /** Owned pvars kept in memory, notifying watchers the way the host does after each write. */
696
- function pvarHost(initial = {}) {
697
- const store = new Map(Object.entries(initial));
698
- const watchers = new Map();
699
- const saves = [];
700
- const write = (name, value) => {
701
- store.set(name, value);
702
- for (const watcher of watchers.get(name) ?? []) {
703
- void watcher();
704
- }
705
- };
706
- const ctx = {
707
- getOwnedPersistentVar: async (_scope, name) => store.get(name) ?? null,
708
- setOwnedPersistentVar: async (scope, name, value) => {
709
- saves.push([scope, name, value]);
710
- write(name, value);
711
- return value;
712
- },
713
- watchOwnedPersistentVar: async (_scope, name, handler) => {
714
- const set = watchers.get(name) ?? new Set();
715
- set.add(handler);
716
- watchers.set(name, set);
717
- return () => set.delete(handler);
718
- },
719
- };
720
- return { ctx, store, saves, changeElsewhere: write };
721
- }
722
- const settle = () => new Promise((resolve) => setTimeout(resolve, 0));
723
- /** A package with nothing on it, to start the variables with. */
724
- const bare = (0, index_1.definePackage)((pkg) => {
725
- pkg.packageId = (0, peer_id_1.newid)();
726
- pkg.version = "1.0.0";
727
- });
728
- describe("package variables", () => {
729
- test("outside a worker a variable is an in-memory observable with its default", async () => {
730
- const name = `memory-${(0, peer_id_1.newid)()}`;
731
- const schedule = (0, index_1.deviceVar)(name, { defaultValue: "" });
732
- expect((0, index_1.deviceVar)(name, { defaultValue: "" })).toBe(schedule);
733
- expect(schedule()).toBe("");
734
- expect(await schedule.loadingPromise).toBe(schedule);
735
- schedule("s1");
736
- expect(schedule()).toBe("s1");
737
- expect((0, index_1.deviceVar)(`unset-${(0, peer_id_1.newid)()}`)()).toBeUndefined();
738
- expect(() => (0, index_1.deviceVar)("")).toThrow(/needs a name/);
739
- });
740
- test("the worker start loads stored values, saves writes, and follows changes from elsewhere", async () => {
741
- const name = `count-${(0, peer_id_1.newid)()}`;
742
- const count = (0, index_1.userVar)(name, { defaultValue: 0 });
743
- const host = pvarHost({ [name]: 5 });
744
- await (0, index_1.startPackage)(bare, host.ctx);
745
- expect(count()).toBe(5);
746
- const seen = [];
747
- count.subscribe((value) => seen.push(value));
748
- count(6);
749
- await count.loadingPromise;
750
- expect(host.saves).toEqual([["user", name, 6]]);
751
- host.changeElsewhere(name, 9);
752
- await settle();
753
- expect(count()).toBe(9);
754
- expect(seen).toEqual([6, 9]);
755
- // A value read from the host isn't saved back.
756
- expect(host.saves).toHaveLength(1);
757
- });
758
- test("a subscriber's write in response to a change from elsewhere is saved", async () => {
759
- const name = `clamp-${(0, peer_id_1.newid)()}`;
760
- const level = (0, index_1.deviceVar)(name, { defaultValue: 0 });
761
- const host = pvarHost();
762
- await (0, index_1.startPackage)(bare, host.ctx);
763
- level.subscribe((value) => {
764
- if (value > 10)
765
- level(10);
766
- });
767
- host.changeElsewhere(name, 50);
768
- await settle();
769
- await level.loadingPromise;
770
- await settle();
771
- expect(level()).toBe(10);
772
- expect(host.saves).toEqual([["device", name, 10]]);
773
- expect(host.store.get(name)).toBe(10);
774
- });
775
- test("writes save in order and the variable ends on the last one", async () => {
776
- const name = `order-${(0, peer_id_1.newid)()}`;
777
- const host = pvarHost();
778
- await (0, index_1.startPackage)(bare, host.ctx);
779
- const step = (0, index_1.deviceVar)(name, { defaultValue: 0 });
780
- await step.loadingPromise;
781
- step(1);
782
- step(2);
783
- step(3);
784
- await step.loadingPromise;
785
- await settle();
786
- expect(host.saves.map(([, , value]) => value)).toEqual([1, 2, 3]);
787
- expect(step()).toBe(3);
788
- expect(host.store.get(name)).toBe(3);
789
- });
790
- test("a variable declared after the worker starts loads right away, and delete resets it", async () => {
791
- const name = `late-${(0, peer_id_1.newid)()}`;
792
- const host = pvarHost({ [name]: { theme: "dark" } });
793
- await (0, index_1.startPackage)(bare, host.ctx);
794
- const prefs = (0, index_1.deviceVar)(name, { defaultValue: { theme: "light" } });
795
- await prefs.loadingPromise;
796
- expect(prefs()).toEqual({ theme: "dark" });
797
- // An equal object from a re-read notifies no one.
798
- const seen = [];
799
- prefs.subscribe((value) => seen.push(value));
800
- host.changeElsewhere(name, { theme: "dark" });
801
- await settle();
802
- expect(seen).toEqual([]);
803
- await prefs.delete();
804
- await settle();
805
- expect(prefs()).toEqual({ theme: "light" });
806
- expect(host.store.get(name)).toBeNull();
807
- expect(host.saves.at(-1)).toEqual(["device", name, null]);
808
- });
809
- });
810
- describe("definePackage and buildPackageManifest", () => {
811
- const packageId = (0, peer_id_1.newid)();
812
- const contractId = (0, peer_id_1.newid)();
813
- const Notes = (0, index_1.defineTable)({
814
- name: "Notes",
815
- description: "Private notes.",
816
- primaryKeyName: "noteId",
817
- schema: index_1.z.object({ noteId: index_1.zodPeerId, text: index_1.z.string() }),
818
- localOnly: true,
819
- });
820
- const add = (0, index_1.defineTool)({
821
- name: "add",
822
- usageDescription: "Add an item.",
823
- accessLevel: index_1.AccessLevel.Writer,
824
- timeoutMs: 5_000,
825
- inputSchema: index_1.z.object({ name: index_1.z.string().describe("Item name.") }),
826
- outputSchema: index_1.z.object({ items: index_1.z.array(itemSchema).describe("All items.") }),
827
- handler: async () => ({ items: [] }),
828
- });
829
- const Other = (0, index_1.contractRef)((0, peer_id_1.newid)(), 2);
830
- function define(overrides) {
831
- return (0, index_1.definePackage)((pkg) => {
832
- pkg.packageId = packageId;
833
- pkg.version = "1.2.3";
834
- pkg.tables = [Notes];
835
- pkg.provides((0, index_1.defineContract)({
836
- contractId,
837
- version: 1,
838
- name: "Main",
839
- description: "The main contract.",
840
- tables: [Items],
841
- tools: [add],
842
- }));
843
- pkg.consumes(index_1.SystemHttp);
844
- pkg.consumes(Other, { optional: true });
845
- pkg.network = { allowedHosts: ["a.example"] };
846
- pkg.appNavs = [{ name: "Main", iconClassName: "bi bi-list", navigationPath: "app" }];
847
- overrides(pkg);
848
- });
849
- }
850
- test("produces the manifest in Peers IR, and it validates", () => {
851
- const manifest = (0, manifest_1.buildPackageManifest)(define(() => undefined));
852
- expect(manifest).toEqual({
853
- packageId,
854
- version: "1.2.3",
855
- guestApi: 3,
856
- provides: [
857
- {
858
- contractId,
859
- version: 1,
860
- name: "Main",
861
- description: "The main contract.",
862
- tables: [{ name: "Items" }],
863
- tools: [
864
- {
865
- name: "add",
866
- usageDescription: "Add an item.",
867
- suggestedAccessLevel: 40,
868
- timeoutMs: 5_000,
869
- inputFields: [{ name: "name", type: "string", description: "Item name." }],
870
- outputFields: [
871
- {
872
- name: "items",
873
- type: "object",
874
- isArray: true,
875
- description: "All items.",
876
- fields: [
877
- { name: "itemId", type: "id", description: "Item id." },
878
- { name: "name", type: "string", description: "Item name." },
879
- { name: "done", type: "boolean", description: "Checked off." },
880
- { name: "note", type: "string", optional: true, description: "Free text." },
881
- ],
882
- },
883
- ],
884
- },
885
- ],
886
- },
887
- ],
888
- consumes: [
889
- { contractId: index_1.SystemHttp.contractId, version: 1 },
890
- { contractId: Other.contractId, version: 2, optional: true },
891
- ],
892
- tables: [
893
- {
894
- name: "Notes",
895
- description: "Private notes.",
896
- primaryKeyName: "noteId",
897
- fields: [
898
- { name: "noteId", type: "id" },
899
- { name: "text", type: "string" },
900
- ],
901
- localOnly: true,
902
- },
903
- {
904
- name: "Items",
905
- description: "Things to do.",
906
- primaryKeyName: "itemId",
907
- // The default for `done` is a function; it stays in the package.
908
- fields: [
909
- { name: "itemId", type: "id", description: "Item id." },
910
- { name: "name", type: "string", description: "Item name." },
911
- { name: "done", type: "boolean", description: "Checked off." },
912
- { name: "note", type: "string", optional: true, description: "Free text." },
913
- ],
914
- },
915
- ],
916
- network: { allowedHosts: ["a.example"] },
917
- appNavs: [{ name: "Main", iconClassName: "bi bi-list", navigationPath: "app" }],
918
- });
919
- expect(() => (0, isolated_artifact_1.validateIsolatedPackageArtifact)({ manifest, providerSource: "void 0;" })).not.toThrow();
920
- });
921
- test("rejects bad ids, duplicate tools, and clashing tables", () => {
922
- expect(() => define((pkg) => {
923
- pkg.packageId = "nope";
924
- })).toThrow(/packageId/);
925
- expect(() => (0, index_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 1, name: "Dup", tools: [add, add] })).toThrow(/declares tool "add" twice/);
926
- expect(() => (0, index_1.defineContract)({ contractId: "nope", version: 1, name: "Bad id" })).toThrow(/25-character contract id/);
927
- expect(() => (0, index_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 0, name: "Bad version" })).toThrow(/positive integer/);
928
- expect(() => (0, index_1.defineContract)({ contractId: (0, peer_id_1.newid)(), version: 1, name: "Not a tool", tools: [{}] })).toThrow(/isn't a tool from defineTool/);
929
- expect(() => define((pkg) => {
930
- pkg.provides((0, index_1.defineContract)({ contractId, version: 1, name: "Again" }));
931
- })).toThrow(/is provided twice/);
932
- expect(() => define((pkg) => {
933
- pkg.provides({ contractId, version: 1 });
934
- })).toThrow(/pkg.provides takes a contract from defineContract/);
935
- expect(() => define((pkg) => {
936
- pkg.consumes({ contractId, version: 1 });
937
- })).toThrow(/pkg.consumes takes a reference from contractRef/);
938
- expect(() => define((pkg) => {
939
- pkg.tables = [
940
- Notes,
941
- (0, index_1.defineTable)({
942
- name: "Notes",
943
- description: "",
944
- primaryKeyName: "id",
945
- schema: index_1.z.object({ id: index_1.zodPeerId }),
946
- }),
947
- ];
948
- })).toThrow(/Two different tables are named "Notes"/);
949
- });
950
- test("servePackage registers each provided tool, and only inside a worker", async () => {
951
- const definition = define(() => undefined);
952
- expect(() => (0, index_1.servePackage)(definition)).toThrow(/inside an isolated package worker/);
953
- const registered = new Map();
954
- const handlers = [];
955
- const startHooks = [];
956
- const global = globalThis;
957
- global.registerContractTool = (id, version, name, fn) => registered.set(`${id}@${version}:${name}`, fn);
958
- global.registerHandler = (name) => handlers.push(name);
959
- global.onWorkerStart = (fn) => startHooks.push(fn);
960
- try {
961
- (0, index_1.servePackage)(definition);
962
- }
963
- finally {
964
- delete global.registerContractTool;
965
- delete global.registerHandler;
966
- delete global.onWorkerStart;
967
- }
968
- expect([...registered.keys()]).toEqual([`${contractId}@1:add`]);
969
- // The contract's tables, observables, and events are served by the package (guest API 3).
970
- expect(handlers).toEqual([
971
- (0, contract_members_1.contractMemberHandlerName)(contractId, 1),
972
- (0, contract_members_1.contractDeliveryHandlerName)(contractId, 1),
973
- ]);
974
- // Package variables load when the worker starts.
975
- expect(startHooks).toHaveLength(1);
976
- const { ctx } = fakeContext();
977
- await expect(registered.get(`${contractId}@1:add`)?.({ name: "x" }, ctx)).resolves.toEqual({
978
- items: [],
979
- });
980
- });
981
- });
982
- describe("the package entry", () => {
983
- /** Runtime imports reachable from `src/define/index.ts`, following relative modules. */
984
- function runtimeImports() {
985
- const bare = new Set();
986
- const seen = new Set();
987
- const visit = (file) => {
988
- if (seen.has(file))
989
- return;
990
- seen.add(file);
991
- const source = (0, node_fs_1.readFileSync)(file, "utf8");
992
- const specifiers = [
993
- ...source.matchAll(/^(?:import|export)\s+(?!type\b)[^;]*?from\s+"([^"]+)";/gms),
994
- ].map((match) => match[1]);
995
- for (const specifier of specifiers) {
996
- if (specifier.startsWith(".")) {
997
- visit(path.resolve(path.dirname(file), `${specifier}.ts`));
998
- }
999
- else {
1000
- bare.add(specifier);
1001
- }
1002
- }
1003
- };
1004
- visit(path.join(__dirname, "index.ts"));
1005
- return bare;
1006
- }
1007
- test("loads only zod and tweetnacl, so a sandbox bundle stays small", () => {
1008
- expect([...runtimeImports()].sort()).toEqual(["tweetnacl", "zod"]);
1009
- });
1010
- });