@peers-app/peers-sdk 0.27.3 → 0.27.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/contracts/contract-proxy.d.ts +7 -0
- package/dist/contracts/contract-proxy.js +19 -2
- package/dist/contracts/contract-transport.d.ts +2 -1
- package/dist/contracts/contract-transport.js +24 -2
- package/dist/contracts/create-local-consumer.js +16 -1
- package/dist/contracts/index.d.ts +2 -0
- package/dist/contracts/index.js +2 -0
- package/dist/contracts/system/index.d.ts +2 -0
- package/dist/contracts/system/index.js +2 -0
- package/dist/contracts/system/invites-contract.js +2 -1
- package/dist/contracts/system/sync-check-contract.d.ts +97 -0
- package/dist/contracts/system/sync-check-contract.js +115 -0
- package/dist/contracts/tool-arguments.d.ts +15 -0
- package/dist/contracts/tool-arguments.js +41 -0
- package/dist/contracts/tool-catalog-service.js +2 -12
- package/dist/contracts/tool-catalog.js +6 -2
- package/dist/data/change-tracking.d.ts +40 -0
- package/dist/data/change-tracking.js +89 -0
- package/dist/data/orm/types.d.ts +24 -7
- package/dist/data/orm/types.js +97 -24
- package/dist/define/manifest.js +6 -34
- package/dist/device/binary-peer-connection-v2.d.ts +7 -15
- package/dist/device/binary-peer-connection-v2.js +14 -30
- package/dist/device/connection.d.ts +34 -43
- package/dist/device/connection.js +188 -186
- package/dist/device/device.d.ts +1 -8
- package/dist/device/device.js +1 -30
- package/dist/device/socket.type.d.ts +6 -12
- package/dist/package-loader/package-loader.js +27 -22
- package/dist/system-ids.d.ts +5 -0
- package/dist/system-ids.js +6 -1
- package/package.json +4 -2
- package/dist/context/user-context-identity.test.d.ts +0 -1
- package/dist/context/user-context-identity.test.js +0 -220
- package/dist/contracts/__tests__/action-dispatch.test.d.ts +0 -1
- package/dist/contracts/__tests__/action-dispatch.test.js +0 -319
- package/dist/contracts/__tests__/also-implements.test.d.ts +0 -1
- package/dist/contracts/__tests__/also-implements.test.js +0 -110
- package/dist/contracts/__tests__/builder.test.d.ts +0 -1
- package/dist/contracts/__tests__/builder.test.js +0 -669
- package/dist/contracts/__tests__/contract-events.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-events.test.js +0 -199
- package/dist/contracts/__tests__/contract-observables.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-observables.test.js +0 -290
- package/dist/contracts/__tests__/contract-provider-router.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-provider-router.test.js +0 -315
- package/dist/contracts/__tests__/contract-proxy.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-proxy.test.js +0 -657
- package/dist/contracts/__tests__/contract-resolvers.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-resolvers.test.js +0 -758
- package/dist/contracts/__tests__/contract-subscription-lifecycle.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-subscription-lifecycle.test.js +0 -353
- package/dist/contracts/__tests__/contract-table-events.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-table-events.test.js +0 -209
- package/dist/contracts/__tests__/contract-transport.test.d.ts +0 -1
- package/dist/contracts/__tests__/contract-transport.test.js +0 -163
- package/dist/contracts/__tests__/extract.test.d.ts +0 -1
- package/dist/contracts/__tests__/extract.test.js +0 -145
- package/dist/contracts/__tests__/frozen-contracts.test.d.ts +0 -1
- package/dist/contracts/__tests__/frozen-contracts.test.js +0 -191
- package/dist/contracts/__tests__/generic-tool-dispatch.test.d.ts +0 -1
- package/dist/contracts/__tests__/generic-tool-dispatch.test.js +0 -130
- package/dist/contracts/__tests__/host-contract-client.test.d.ts +0 -1
- package/dist/contracts/__tests__/host-contract-client.test.js +0 -793
- package/dist/contracts/__tests__/host-contract-consumer.test.d.ts +0 -1
- package/dist/contracts/__tests__/host-contract-consumer.test.js +0 -163
- package/dist/contracts/__tests__/host-contract-transport.test.d.ts +0 -1
- package/dist/contracts/__tests__/host-contract-transport.test.js +0 -66
- package/dist/contracts/__tests__/integration.test.d.ts +0 -1
- package/dist/contracts/__tests__/integration.test.js +0 -348
- package/dist/contracts/__tests__/legacy-removal.test.d.ts +0 -1
- package/dist/contracts/__tests__/legacy-removal.test.js +0 -128
- package/dist/contracts/__tests__/persistent-registry.test.d.ts +0 -1
- package/dist/contracts/__tests__/persistent-registry.test.js +0 -109
- package/dist/contracts/__tests__/playground.test.d.ts +0 -1
- package/dist/contracts/__tests__/playground.test.js +0 -216
- package/dist/contracts/__tests__/registry.test.d.ts +0 -1
- package/dist/contracts/__tests__/registry.test.js +0 -238
- package/dist/contracts/__tests__/remote-contract-transport.test.d.ts +0 -1
- package/dist/contracts/__tests__/remote-contract-transport.test.js +0 -119
- package/dist/contracts/__tests__/system-contracts.test.d.ts +0 -1
- package/dist/contracts/__tests__/system-contracts.test.js +0 -247
- package/dist/contracts/__tests__/target-dispatch.d.ts +0 -11
- package/dist/contracts/__tests__/target-dispatch.js +0 -24
- package/dist/contracts/__tests__/tool-catalog-inventory.test.d.ts +0 -1
- package/dist/contracts/__tests__/tool-catalog-inventory.test.js +0 -44
- package/dist/contracts/__tests__/tool-catalog-service.test.d.ts +0 -1
- package/dist/contracts/__tests__/tool-catalog-service.test.js +0 -482
- package/dist/contracts/__tests__/tool-catalog.test.d.ts +0 -1
- package/dist/contracts/__tests__/tool-catalog.test.js +0 -1199
- package/dist/contracts/__tests__/validate.test.d.ts +0 -1
- package/dist/contracts/__tests__/validate.test.js +0 -991
- package/dist/contracts/__tests__/workflow-context.test.d.ts +0 -1
- package/dist/contracts/__tests__/workflow-context.test.js +0 -50
- package/dist/data/access-level.test.d.ts +0 -1
- package/dist/data/access-level.test.js +0 -53
- package/dist/data/change-tracking.test.d.ts +0 -1
- package/dist/data/change-tracking.test.js +0 -62
- package/dist/data/files/files.test.d.ts +0 -1
- package/dist/data/files/files.test.js +0 -770
- package/dist/data/group-members.test.d.ts +0 -1
- package/dist/data/group-members.test.js +0 -336
- package/dist/data/group-share.test.d.ts +0 -1
- package/dist/data/group-share.test.js +0 -110
- package/dist/data/groups.test.d.ts +0 -1
- package/dist/data/groups.test.js +0 -153
- package/dist/data/orm/cursor.test.d.ts +0 -1
- package/dist/data/orm/cursor.test.js +0 -314
- package/dist/data/orm/data-query.mongo.test.d.ts +0 -1
- package/dist/data/orm/data-query.mongo.test.js +0 -367
- package/dist/data/orm/data-query.sqlite.test.d.ts +0 -1
- package/dist/data/orm/data-query.sqlite.test.js +0 -365
- package/dist/data/orm/data-query.test.d.ts +0 -1
- package/dist/data/orm/data-query.test.js +0 -545
- package/dist/data/orm/dependency-injection.test.d.ts +0 -1
- package/dist/data/orm/dependency-injection.test.js +0 -171
- package/dist/data/orm/event-registry.test.d.ts +0 -1
- package/dist/data/orm/event-registry.test.js +0 -44
- package/dist/data/orm/multi-cursors.test.d.ts +0 -1
- package/dist/data/orm/multi-cursors.test.js +0 -463
- package/dist/data/orm/sql.data-source.test.d.ts +0 -1
- package/dist/data/orm/sql.data-source.test.js +0 -731
- package/dist/data/orm/table-container-events.test.d.ts +0 -1
- package/dist/data/orm/table-container-events.test.js +0 -101
- package/dist/data/orm/table-container.test.d.ts +0 -1
- package/dist/data/orm/table-container.test.js +0 -273
- package/dist/data/orm/table.event-source.test.d.ts +0 -1
- package/dist/data/orm/table.event-source.test.js +0 -331
- package/dist/data/orm/types.test.d.ts +0 -1
- package/dist/data/orm/types.test.js +0 -409
- package/dist/data/package-table-identity.test.d.ts +0 -1
- package/dist/data/package-table-identity.test.js +0 -46
- package/dist/data/package-version-permissions.test.d.ts +0 -1
- package/dist/data/package-version-permissions.test.js +0 -107
- package/dist/data/package-version-resolver.test.d.ts +0 -4
- package/dist/data/package-version-resolver.test.js +0 -543
- package/dist/data/package-versions.test.d.ts +0 -1
- package/dist/data/package-versions.test.js +0 -227
- package/dist/data/persistent-vars.conflict.test.d.ts +0 -1
- package/dist/data/persistent-vars.conflict.test.js +0 -126
- package/dist/data/persistent-vars.migration.test.d.ts +0 -1
- package/dist/data/persistent-vars.migration.test.js +0 -133
- package/dist/data/persistent-vars.package-scope.test.d.ts +0 -1
- package/dist/data/persistent-vars.package-scope.test.js +0 -27
- package/dist/data/sync-recovery-queue.test.d.ts +0 -1
- package/dist/data/sync-recovery-queue.test.js +0 -215
- package/dist/data/table-signing.test.d.ts +0 -1
- package/dist/data/table-signing.test.js +0 -118
- package/dist/data/tool-access.test.d.ts +0 -1
- package/dist/data/tool-access.test.js +0 -166
- package/dist/data/user-permissions.test.d.ts +0 -1
- package/dist/data/user-permissions.test.js +0 -305
- package/dist/data/user-trust-levels.test.d.ts +0 -1
- package/dist/data/user-trust-levels.test.js +0 -37
- package/dist/define/also-implements.test.d.ts +0 -1
- package/dist/define/also-implements.test.js +0 -123
- package/dist/define/declare-contract.test.d.ts +0 -1
- package/dist/define/declare-contract.test.js +0 -573
- package/dist/define/define.test.d.ts +0 -1
- package/dist/define/define.test.js +0 -1010
- package/dist/define/empty-fields.test.d.ts +0 -1
- package/dist/define/empty-fields.test.js +0 -55
- package/dist/define/events-observables.test.d.ts +0 -1
- package/dist/define/events-observables.test.js +0 -1013
- package/dist/define/serve-members.test.d.ts +0 -1
- package/dist/define/serve-members.test.js +0 -630
- package/dist/define/vars.test.d.ts +0 -1
- package/dist/define/vars.test.js +0 -39
- package/dist/device/binary-peer-connection-v2.test.d.ts +0 -1
- package/dist/device/binary-peer-connection-v2.test.js +0 -730
- package/dist/device/binary-peer-connection.d.ts +0 -58
- package/dist/device/binary-peer-connection.js +0 -516
- package/dist/device/binary-peer-connection.test.d.ts +0 -1
- package/dist/device/binary-peer-connection.test.js +0 -184
- package/dist/device/connection.test.d.ts +0 -1
- package/dist/device/connection.test.js +0 -613
- package/dist/device/device-election.test.d.ts +0 -1
- package/dist/device/device-election.test.js +0 -516
- package/dist/device/device.test.d.ts +0 -1
- package/dist/device/device.test.js +0 -243
- package/dist/device/frame-cipher.test.d.ts +0 -1
- package/dist/device/frame-cipher.test.js +0 -219
- package/dist/device/get-trust-level-fn.test.d.ts +0 -1
- package/dist/device/get-trust-level-fn.test.js +0 -685
- package/dist/device/streamed-socket.d.ts +0 -23
- package/dist/device/streamed-socket.js +0 -255
- package/dist/device/streamed-socket.test.d.ts +0 -1
- package/dist/device/streamed-socket.test.js +0 -216
- package/dist/device/tx-encoding.test.d.ts +0 -1
- package/dist/device/tx-encoding.test.js +0 -295
- package/dist/device-pairing/cpace.test.d.ts +0 -1
- package/dist/device-pairing/cpace.test.js +0 -116
- package/dist/device-pairing/device-pairing.test.d.ts +0 -1
- package/dist/device-pairing/device-pairing.test.js +0 -211
- package/dist/hlc.test.d.ts +0 -1
- package/dist/hlc.test.js +0 -45
- package/dist/host-credentials.test.d.ts +0 -1
- package/dist/host-credentials.test.js +0 -88
- package/dist/identity/account-email.test.d.ts +0 -1
- package/dist/identity/account-email.test.js +0 -59
- package/dist/identity/anchor-document.test.d.ts +0 -1
- package/dist/identity/anchor-document.test.js +0 -16
- package/dist/identity/anchor-resolution.test.d.ts +0 -1
- package/dist/identity/anchor-resolution.test.js +0 -130
- package/dist/identity/key-change.test.d.ts +0 -1
- package/dist/identity/key-change.test.js +0 -811
- package/dist/invites/group-approval.test.d.ts +0 -1
- package/dist/invites/group-approval.test.js +0 -223
- package/dist/invites/invite-token.test.d.ts +0 -1
- package/dist/invites/invite-token.test.js +0 -123
- package/dist/keys.test.d.ts +0 -1
- package/dist/keys.test.js +0 -336
- package/dist/logging/console-logger.test.d.ts +0 -1
- package/dist/logging/console-logger.test.js +0 -300
- package/dist/logging/console-logs.table.test.d.ts +0 -1
- package/dist/logging/console-logs.table.test.js +0 -156
- package/dist/observable.test.d.ts +0 -1
- package/dist/observable.test.js +0 -309
- package/dist/package-build/build-package.test.d.ts +0 -1
- package/dist/package-build/build-package.test.js +0 -204
- package/dist/package-build/contract-add.test.d.ts +0 -1
- package/dist/package-build/contract-add.test.js +0 -467
- package/dist/package-build/freeze-contracts.test.d.ts +0 -1
- package/dist/package-build/freeze-contracts.test.js +0 -355
- package/dist/package-installer/package-author-signing.test.d.ts +0 -1
- package/dist/package-installer/package-author-signing.test.js +0 -200
- package/dist/package-installer/package-cloner.test.d.ts +0 -1
- package/dist/package-installer/package-cloner.test.js +0 -278
- package/dist/package-installer/package-creator.test.d.ts +0 -1
- package/dist/package-installer/package-creator.test.js +0 -908
- package/dist/package-installer/package-dev-tools.test.d.ts +0 -1
- package/dist/package-installer/package-dev-tools.test.js +0 -64
- package/dist/package-installer/package-installer.test.d.ts +0 -1
- package/dist/package-installer/package-installer.test.js +0 -882
- package/dist/package-installer/package-propagation.test.d.ts +0 -1
- package/dist/package-installer/package-propagation.test.js +0 -1269
- package/dist/package-installer/package-publisher.test.d.ts +0 -1
- package/dist/package-installer/package-publisher.test.js +0 -153
- package/dist/package-installer/package-remote-checker.test.d.ts +0 -1
- package/dist/package-installer/package-remote-checker.test.js +0 -334
- package/dist/package-installer/package-seed-installer.test.d.ts +0 -1
- package/dist/package-installer/package-seed-installer.test.js +0 -123
- package/dist/package-installer/package-tarball.test.d.ts +0 -1
- package/dist/package-installer/package-tarball.test.js +0 -75
- package/dist/package-installer/peers-core-installer.test.d.ts +0 -1
- package/dist/package-installer/peers-core-installer.test.js +0 -49
- package/dist/package-installer/peers-core-trust-anchor.test.d.ts +0 -1
- package/dist/package-installer/peers-core-trust-anchor.test.js +0 -155
- package/dist/package-loader/contract-package-loader.test.d.ts +0 -1
- package/dist/package-loader/contract-package-loader.test.js +0 -274
- package/dist/package-loader/host-authority-loading.test.d.ts +0 -1
- package/dist/package-loader/host-authority-loading.test.js +0 -104
- package/dist/package-loader/host-dispatch-policy.test.d.ts +0 -1
- package/dist/package-loader/host-dispatch-policy.test.js +0 -56
- package/dist/package-loader/isolated-artifact.test.d.ts +0 -1
- package/dist/package-loader/isolated-artifact.test.js +0 -688
- package/dist/package-loader/isolated-persistent-var-gateway.test.d.ts +0 -1
- package/dist/package-loader/isolated-persistent-var-gateway.test.js +0 -56
- package/dist/package-loader/isolated-table-gateway.test.d.ts +0 -1
- package/dist/package-loader/isolated-table-gateway.test.js +0 -633
- package/dist/package-loader/package-loader.test.d.ts +0 -1
- package/dist/package-loader/package-loader.test.js +0 -1764
- package/dist/package-loader/resolve-consumed-contracts.test.d.ts +0 -1
- package/dist/package-loader/resolve-consumed-contracts.test.js +0 -166
- package/dist/serial-json.compat.test.d.ts +0 -1
- package/dist/serial-json.compat.test.js +0 -369
- package/dist/serial-json.test.d.ts +0 -1
- package/dist/serial-json.test.js +0 -401
- package/dist/testing/mock-host-contract.test.d.ts +0 -1
- package/dist/testing/mock-host-contract.test.js +0 -782
- package/dist/utils.test.d.ts +0 -1
- package/dist/utils.test.js +0 -232
|
@@ -1,991 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
const zod_1 = require("zod");
|
|
4
|
-
const types_1 = require("../../data/orm/types");
|
|
5
|
-
const field_type_1 = require("../../types/field-type");
|
|
6
|
-
const utils_1 = require("../../utils");
|
|
7
|
-
const types_2 = require("../types");
|
|
8
|
-
const validate_1 = require("../validate");
|
|
9
|
-
const DEFAULT_CONTRACT_ID = (0, utils_1.newid)();
|
|
10
|
-
/** Helper to build a minimal contract definition for tests. */
|
|
11
|
-
function makeContract(overrides = {}) {
|
|
12
|
-
return {
|
|
13
|
-
contractId: DEFAULT_CONTRACT_ID,
|
|
14
|
-
version: 1,
|
|
15
|
-
name: "Test Contract",
|
|
16
|
-
description: "A test contract",
|
|
17
|
-
tables: [],
|
|
18
|
-
tools: [],
|
|
19
|
-
observables: [],
|
|
20
|
-
events: [],
|
|
21
|
-
...overrides,
|
|
22
|
-
};
|
|
23
|
-
}
|
|
24
|
-
describe("validateProviderSatisfiesContract", () => {
|
|
25
|
-
describe("tables", () => {
|
|
26
|
-
it("passes when implementation has the same fields as the contract", () => {
|
|
27
|
-
const contract = makeContract({
|
|
28
|
-
tables: [
|
|
29
|
-
{
|
|
30
|
-
name: "Tasks",
|
|
31
|
-
description: "Tasks table",
|
|
32
|
-
primaryKeyName: "taskId",
|
|
33
|
-
fields: [
|
|
34
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
35
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
36
|
-
],
|
|
37
|
-
},
|
|
38
|
-
],
|
|
39
|
-
});
|
|
40
|
-
const impl = makeContract({ tables: [...contract.tables] });
|
|
41
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
42
|
-
expect(result.valid).toBe(true);
|
|
43
|
-
expect(result.errors).toHaveLength(0);
|
|
44
|
-
});
|
|
45
|
-
it("passes when implementation has extra optional fields", () => {
|
|
46
|
-
const contract = makeContract({
|
|
47
|
-
tables: [
|
|
48
|
-
{
|
|
49
|
-
name: "Tasks",
|
|
50
|
-
description: "Tasks table",
|
|
51
|
-
primaryKeyName: "taskId",
|
|
52
|
-
fields: [
|
|
53
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
54
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
55
|
-
],
|
|
56
|
-
},
|
|
57
|
-
],
|
|
58
|
-
});
|
|
59
|
-
const impl = makeContract({
|
|
60
|
-
tables: [
|
|
61
|
-
{
|
|
62
|
-
name: "Tasks",
|
|
63
|
-
description: "Tasks table",
|
|
64
|
-
primaryKeyName: "taskId",
|
|
65
|
-
fields: [
|
|
66
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
67
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
68
|
-
{ name: "priority", type: field_type_1.FieldType.number, optional: true },
|
|
69
|
-
],
|
|
70
|
-
},
|
|
71
|
-
],
|
|
72
|
-
});
|
|
73
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
74
|
-
expect(result.valid).toBe(true);
|
|
75
|
-
});
|
|
76
|
-
it("fails when implementation is missing a required field", () => {
|
|
77
|
-
const contract = makeContract({
|
|
78
|
-
tables: [
|
|
79
|
-
{
|
|
80
|
-
name: "Tasks",
|
|
81
|
-
description: "Tasks table",
|
|
82
|
-
primaryKeyName: "taskId",
|
|
83
|
-
fields: [
|
|
84
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
85
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
86
|
-
{ name: "status", type: field_type_1.FieldType.string },
|
|
87
|
-
],
|
|
88
|
-
},
|
|
89
|
-
],
|
|
90
|
-
});
|
|
91
|
-
const impl = makeContract({
|
|
92
|
-
tables: [
|
|
93
|
-
{
|
|
94
|
-
name: "Tasks",
|
|
95
|
-
description: "Tasks table",
|
|
96
|
-
primaryKeyName: "taskId",
|
|
97
|
-
fields: [
|
|
98
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
99
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
100
|
-
],
|
|
101
|
-
},
|
|
102
|
-
],
|
|
103
|
-
});
|
|
104
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
105
|
-
expect(result.valid).toBe(false);
|
|
106
|
-
expect(result.errors).toHaveLength(1);
|
|
107
|
-
expect(result.errors[0].message).toContain("status");
|
|
108
|
-
expect(result.errors[0].message).toContain("missing");
|
|
109
|
-
});
|
|
110
|
-
it("allows missing optional contract fields in the implementation", () => {
|
|
111
|
-
const contract = makeContract({
|
|
112
|
-
tables: [
|
|
113
|
-
{
|
|
114
|
-
name: "Tasks",
|
|
115
|
-
description: "Tasks table",
|
|
116
|
-
primaryKeyName: "taskId",
|
|
117
|
-
fields: [
|
|
118
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
119
|
-
{ name: "notes", type: field_type_1.FieldType.string, optional: true },
|
|
120
|
-
],
|
|
121
|
-
},
|
|
122
|
-
],
|
|
123
|
-
});
|
|
124
|
-
const impl = makeContract({
|
|
125
|
-
tables: [
|
|
126
|
-
{
|
|
127
|
-
name: "Tasks",
|
|
128
|
-
description: "Tasks table",
|
|
129
|
-
primaryKeyName: "taskId",
|
|
130
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
131
|
-
},
|
|
132
|
-
],
|
|
133
|
-
});
|
|
134
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
135
|
-
expect(result.valid).toBe(true);
|
|
136
|
-
});
|
|
137
|
-
it("fails when a field has the wrong type", () => {
|
|
138
|
-
const contract = makeContract({
|
|
139
|
-
tables: [
|
|
140
|
-
{
|
|
141
|
-
name: "Tasks",
|
|
142
|
-
description: "Tasks table",
|
|
143
|
-
primaryKeyName: "taskId",
|
|
144
|
-
fields: [
|
|
145
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
146
|
-
{ name: "count", type: field_type_1.FieldType.number },
|
|
147
|
-
],
|
|
148
|
-
},
|
|
149
|
-
],
|
|
150
|
-
});
|
|
151
|
-
const impl = makeContract({
|
|
152
|
-
tables: [
|
|
153
|
-
{
|
|
154
|
-
name: "Tasks",
|
|
155
|
-
description: "Tasks table",
|
|
156
|
-
primaryKeyName: "taskId",
|
|
157
|
-
fields: [
|
|
158
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
159
|
-
{ name: "count", type: field_type_1.FieldType.string },
|
|
160
|
-
],
|
|
161
|
-
},
|
|
162
|
-
],
|
|
163
|
-
});
|
|
164
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
165
|
-
expect(result.valid).toBe(false);
|
|
166
|
-
expect(result.errors[0].message).toContain("type mismatch");
|
|
167
|
-
});
|
|
168
|
-
it("fails when contract requires required but implementation has optional", () => {
|
|
169
|
-
const contract = makeContract({
|
|
170
|
-
tables: [
|
|
171
|
-
{
|
|
172
|
-
name: "Tasks",
|
|
173
|
-
description: "d",
|
|
174
|
-
primaryKeyName: "taskId",
|
|
175
|
-
fields: [{ name: "title", type: field_type_1.FieldType.string }],
|
|
176
|
-
},
|
|
177
|
-
],
|
|
178
|
-
});
|
|
179
|
-
const impl = makeContract({
|
|
180
|
-
tables: [
|
|
181
|
-
{
|
|
182
|
-
name: "Tasks",
|
|
183
|
-
description: "d",
|
|
184
|
-
primaryKeyName: "taskId",
|
|
185
|
-
fields: [{ name: "title", type: field_type_1.FieldType.string, optional: true }],
|
|
186
|
-
},
|
|
187
|
-
],
|
|
188
|
-
});
|
|
189
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
190
|
-
expect(result.valid).toBe(false);
|
|
191
|
-
expect(result.errors[0].message).toContain("optional");
|
|
192
|
-
});
|
|
193
|
-
it("fails when contract table is entirely missing from implementation", () => {
|
|
194
|
-
const contract = makeContract({
|
|
195
|
-
tables: [
|
|
196
|
-
{
|
|
197
|
-
name: "Tasks",
|
|
198
|
-
description: "d",
|
|
199
|
-
primaryKeyName: "taskId",
|
|
200
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
201
|
-
},
|
|
202
|
-
],
|
|
203
|
-
});
|
|
204
|
-
const impl = makeContract({ tables: [] });
|
|
205
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
206
|
-
expect(result.valid).toBe(false);
|
|
207
|
-
expect(result.errors[0].kind).toBe("table");
|
|
208
|
-
expect(result.errors[0].message).toContain("not provided");
|
|
209
|
-
});
|
|
210
|
-
it("fails when primary key names differ", () => {
|
|
211
|
-
const contract = makeContract({
|
|
212
|
-
tables: [
|
|
213
|
-
{
|
|
214
|
-
name: "Tasks",
|
|
215
|
-
description: "d",
|
|
216
|
-
primaryKeyName: "taskId",
|
|
217
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
218
|
-
},
|
|
219
|
-
],
|
|
220
|
-
});
|
|
221
|
-
const impl = makeContract({
|
|
222
|
-
tables: [
|
|
223
|
-
{
|
|
224
|
-
name: "Tasks",
|
|
225
|
-
description: "d",
|
|
226
|
-
primaryKeyName: "id",
|
|
227
|
-
fields: [{ name: "id", type: field_type_1.FieldType.id }],
|
|
228
|
-
},
|
|
229
|
-
],
|
|
230
|
-
});
|
|
231
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
232
|
-
expect(result.valid).toBe(false);
|
|
233
|
-
expect(result.errors[0].message).toContain("primary key");
|
|
234
|
-
});
|
|
235
|
-
it("fails when implementation has extra required fields not in contract", () => {
|
|
236
|
-
const contract = makeContract({
|
|
237
|
-
tables: [
|
|
238
|
-
{
|
|
239
|
-
name: "Tasks",
|
|
240
|
-
description: "d",
|
|
241
|
-
primaryKeyName: "taskId",
|
|
242
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
243
|
-
},
|
|
244
|
-
],
|
|
245
|
-
});
|
|
246
|
-
const impl = makeContract({
|
|
247
|
-
tables: [
|
|
248
|
-
{
|
|
249
|
-
name: "Tasks",
|
|
250
|
-
description: "d",
|
|
251
|
-
primaryKeyName: "taskId",
|
|
252
|
-
fields: [
|
|
253
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
254
|
-
{ name: "internalField", type: field_type_1.FieldType.string },
|
|
255
|
-
],
|
|
256
|
-
},
|
|
257
|
-
],
|
|
258
|
-
});
|
|
259
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
260
|
-
expect(result.valid).toBe(false);
|
|
261
|
-
expect(result.errors[0].message).toContain("extra required field");
|
|
262
|
-
});
|
|
263
|
-
it("validates isArray compatibility", () => {
|
|
264
|
-
const contract = makeContract({
|
|
265
|
-
tables: [
|
|
266
|
-
{
|
|
267
|
-
name: "T",
|
|
268
|
-
description: "d",
|
|
269
|
-
primaryKeyName: "id",
|
|
270
|
-
fields: [
|
|
271
|
-
{ name: "id", type: field_type_1.FieldType.id },
|
|
272
|
-
{ name: "tags", type: field_type_1.FieldType.string, isArray: true },
|
|
273
|
-
],
|
|
274
|
-
},
|
|
275
|
-
],
|
|
276
|
-
});
|
|
277
|
-
const impl = makeContract({
|
|
278
|
-
tables: [
|
|
279
|
-
{
|
|
280
|
-
name: "T",
|
|
281
|
-
description: "d",
|
|
282
|
-
primaryKeyName: "id",
|
|
283
|
-
fields: [
|
|
284
|
-
{ name: "id", type: field_type_1.FieldType.id },
|
|
285
|
-
{ name: "tags", type: field_type_1.FieldType.string },
|
|
286
|
-
],
|
|
287
|
-
},
|
|
288
|
-
],
|
|
289
|
-
});
|
|
290
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
291
|
-
expect(result.valid).toBe(false);
|
|
292
|
-
expect(result.errors[0].message).toContain("array");
|
|
293
|
-
});
|
|
294
|
-
});
|
|
295
|
-
describe("tools", () => {
|
|
296
|
-
it("passes when tool signatures match", () => {
|
|
297
|
-
const contract = makeContract({
|
|
298
|
-
tools: [
|
|
299
|
-
{
|
|
300
|
-
name: "create-task",
|
|
301
|
-
usageDescription: "Creates a task",
|
|
302
|
-
inputFields: [{ name: "title", type: field_type_1.FieldType.string }],
|
|
303
|
-
outputFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
304
|
-
},
|
|
305
|
-
],
|
|
306
|
-
});
|
|
307
|
-
const impl = makeContract({ tools: [...contract.tools] });
|
|
308
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
309
|
-
expect(result.valid).toBe(true);
|
|
310
|
-
});
|
|
311
|
-
it("fails when a required tool is missing", () => {
|
|
312
|
-
const contract = makeContract({
|
|
313
|
-
tools: [
|
|
314
|
-
{
|
|
315
|
-
name: "create-task",
|
|
316
|
-
usageDescription: "Creates a task",
|
|
317
|
-
inputFields: [],
|
|
318
|
-
outputFields: [],
|
|
319
|
-
},
|
|
320
|
-
],
|
|
321
|
-
});
|
|
322
|
-
const impl = makeContract({ tools: [] });
|
|
323
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
324
|
-
expect(result.valid).toBe(false);
|
|
325
|
-
expect(result.errors[0].kind).toBe("tool");
|
|
326
|
-
});
|
|
327
|
-
it("allows extra optional input fields in implementation", () => {
|
|
328
|
-
const contract = makeContract({
|
|
329
|
-
tools: [
|
|
330
|
-
{
|
|
331
|
-
name: "create-task",
|
|
332
|
-
usageDescription: "d",
|
|
333
|
-
inputFields: [{ name: "title", type: field_type_1.FieldType.string }],
|
|
334
|
-
outputFields: [],
|
|
335
|
-
},
|
|
336
|
-
],
|
|
337
|
-
});
|
|
338
|
-
const impl = makeContract({
|
|
339
|
-
tools: [
|
|
340
|
-
{
|
|
341
|
-
name: "create-task",
|
|
342
|
-
usageDescription: "d",
|
|
343
|
-
inputFields: [
|
|
344
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
345
|
-
{ name: "priority", type: field_type_1.FieldType.number, optional: true },
|
|
346
|
-
],
|
|
347
|
-
outputFields: [],
|
|
348
|
-
},
|
|
349
|
-
],
|
|
350
|
-
});
|
|
351
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
352
|
-
expect(result.valid).toBe(true);
|
|
353
|
-
});
|
|
354
|
-
it("fails when implementation has extra required input fields", () => {
|
|
355
|
-
const contract = makeContract({
|
|
356
|
-
tools: [
|
|
357
|
-
{
|
|
358
|
-
name: "create-task",
|
|
359
|
-
usageDescription: "d",
|
|
360
|
-
inputFields: [{ name: "title", type: field_type_1.FieldType.string }],
|
|
361
|
-
outputFields: [],
|
|
362
|
-
},
|
|
363
|
-
],
|
|
364
|
-
});
|
|
365
|
-
const impl = makeContract({
|
|
366
|
-
tools: [
|
|
367
|
-
{
|
|
368
|
-
name: "create-task",
|
|
369
|
-
usageDescription: "d",
|
|
370
|
-
inputFields: [
|
|
371
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
372
|
-
{ name: "mandatory", type: field_type_1.FieldType.string },
|
|
373
|
-
],
|
|
374
|
-
outputFields: [],
|
|
375
|
-
},
|
|
376
|
-
],
|
|
377
|
-
});
|
|
378
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
379
|
-
expect(result.valid).toBe(false);
|
|
380
|
-
expect(result.errors[0].message).toContain("extra required input");
|
|
381
|
-
});
|
|
382
|
-
it("allows extra output fields in implementation (returns more data)", () => {
|
|
383
|
-
const contract = makeContract({
|
|
384
|
-
tools: [
|
|
385
|
-
{
|
|
386
|
-
name: "create-task",
|
|
387
|
-
usageDescription: "d",
|
|
388
|
-
inputFields: [],
|
|
389
|
-
outputFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
390
|
-
},
|
|
391
|
-
],
|
|
392
|
-
});
|
|
393
|
-
const impl = makeContract({
|
|
394
|
-
tools: [
|
|
395
|
-
{
|
|
396
|
-
name: "create-task",
|
|
397
|
-
usageDescription: "d",
|
|
398
|
-
inputFields: [],
|
|
399
|
-
outputFields: [
|
|
400
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
401
|
-
{ name: "createdAt", type: field_type_1.FieldType.Date },
|
|
402
|
-
],
|
|
403
|
-
},
|
|
404
|
-
],
|
|
405
|
-
});
|
|
406
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
407
|
-
expect(result.valid).toBe(true);
|
|
408
|
-
});
|
|
409
|
-
});
|
|
410
|
-
describe("observables", () => {
|
|
411
|
-
it("passes when observables match", () => {
|
|
412
|
-
const contract = makeContract({
|
|
413
|
-
observables: [
|
|
414
|
-
{ name: "taskCount", description: "d", valueType: field_type_1.FieldType.number, writable: false },
|
|
415
|
-
],
|
|
416
|
-
});
|
|
417
|
-
const impl = makeContract({ observables: [...contract.observables] });
|
|
418
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
419
|
-
expect(result.valid).toBe(true);
|
|
420
|
-
});
|
|
421
|
-
it("fails when an observable is missing", () => {
|
|
422
|
-
const contract = makeContract({
|
|
423
|
-
observables: [
|
|
424
|
-
{ name: "taskCount", description: "d", valueType: field_type_1.FieldType.number, writable: false },
|
|
425
|
-
],
|
|
426
|
-
});
|
|
427
|
-
const impl = makeContract({ observables: [] });
|
|
428
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
429
|
-
expect(result.valid).toBe(false);
|
|
430
|
-
expect(result.errors[0].kind).toBe("observable");
|
|
431
|
-
});
|
|
432
|
-
it("fails on value type mismatch", () => {
|
|
433
|
-
const contract = makeContract({
|
|
434
|
-
observables: [
|
|
435
|
-
{ name: "taskCount", description: "d", valueType: field_type_1.FieldType.number, writable: false },
|
|
436
|
-
],
|
|
437
|
-
});
|
|
438
|
-
const impl = makeContract({
|
|
439
|
-
observables: [
|
|
440
|
-
{ name: "taskCount", description: "d", valueType: field_type_1.FieldType.string, writable: false },
|
|
441
|
-
],
|
|
442
|
-
});
|
|
443
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
444
|
-
expect(result.valid).toBe(false);
|
|
445
|
-
expect(result.errors[0].message).toContain("type mismatch");
|
|
446
|
-
});
|
|
447
|
-
it("fails when contract requires writable but impl is read-only", () => {
|
|
448
|
-
const contract = makeContract({
|
|
449
|
-
observables: [
|
|
450
|
-
{ name: "taskCount", description: "d", valueType: field_type_1.FieldType.number, writable: true },
|
|
451
|
-
],
|
|
452
|
-
});
|
|
453
|
-
const impl = makeContract({
|
|
454
|
-
observables: [
|
|
455
|
-
{ name: "taskCount", description: "d", valueType: field_type_1.FieldType.number, writable: false },
|
|
456
|
-
],
|
|
457
|
-
});
|
|
458
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
459
|
-
expect(result.valid).toBe(false);
|
|
460
|
-
expect(result.errors[0].message).toContain("writable");
|
|
461
|
-
});
|
|
462
|
-
});
|
|
463
|
-
describe("events", () => {
|
|
464
|
-
it("passes when an implementation event has compatible payload fields", () => {
|
|
465
|
-
const contract = makeContract({
|
|
466
|
-
events: [
|
|
467
|
-
{
|
|
468
|
-
name: "taskChanged",
|
|
469
|
-
description: "A task changed",
|
|
470
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
471
|
-
},
|
|
472
|
-
],
|
|
473
|
-
});
|
|
474
|
-
const impl = makeContract({
|
|
475
|
-
events: [
|
|
476
|
-
{
|
|
477
|
-
name: "taskChanged",
|
|
478
|
-
description: "A task changed",
|
|
479
|
-
payloadFields: [
|
|
480
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
481
|
-
{ name: "source", type: field_type_1.FieldType.string, optional: true },
|
|
482
|
-
],
|
|
483
|
-
},
|
|
484
|
-
],
|
|
485
|
-
});
|
|
486
|
-
expect((0, validate_1.validateProviderSatisfiesContract)(impl, contract)).toEqual({
|
|
487
|
-
valid: true,
|
|
488
|
-
errors: [],
|
|
489
|
-
});
|
|
490
|
-
});
|
|
491
|
-
it("fails when a required event is missing", () => {
|
|
492
|
-
const contract = makeContract({
|
|
493
|
-
events: [
|
|
494
|
-
{
|
|
495
|
-
name: "taskChanged",
|
|
496
|
-
description: "A task changed",
|
|
497
|
-
payloadFields: [],
|
|
498
|
-
},
|
|
499
|
-
],
|
|
500
|
-
});
|
|
501
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(makeContract(), contract);
|
|
502
|
-
expect(result.valid).toBe(false);
|
|
503
|
-
expect(result.errors[0]).toEqual(expect.objectContaining({ kind: "event", name: "taskChanged" }));
|
|
504
|
-
});
|
|
505
|
-
it("fails when an event payload field is incompatible", () => {
|
|
506
|
-
const contract = makeContract({
|
|
507
|
-
events: [
|
|
508
|
-
{
|
|
509
|
-
name: "taskChanged",
|
|
510
|
-
description: "A task changed",
|
|
511
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
512
|
-
},
|
|
513
|
-
],
|
|
514
|
-
});
|
|
515
|
-
const impl = makeContract({
|
|
516
|
-
events: [
|
|
517
|
-
{
|
|
518
|
-
name: "taskChanged",
|
|
519
|
-
description: "A task changed",
|
|
520
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.number }],
|
|
521
|
-
},
|
|
522
|
-
],
|
|
523
|
-
});
|
|
524
|
-
const result = (0, validate_1.validateProviderSatisfiesContract)(impl, contract);
|
|
525
|
-
expect(result.valid).toBe(false);
|
|
526
|
-
expect(result.errors[0]).toEqual(expect.objectContaining({
|
|
527
|
-
kind: "field",
|
|
528
|
-
name: "taskChanged.payload.taskId",
|
|
529
|
-
message: expect.stringMatching(/type mismatch/),
|
|
530
|
-
}));
|
|
531
|
-
});
|
|
532
|
-
});
|
|
533
|
-
});
|
|
534
|
-
describe("validateImmutability", () => {
|
|
535
|
-
it("allows any change for dev contracts", () => {
|
|
536
|
-
const existing = makeContract({ devTag: "dev", tables: [] });
|
|
537
|
-
const incoming = makeContract({
|
|
538
|
-
devTag: "dev",
|
|
539
|
-
tables: [
|
|
540
|
-
{
|
|
541
|
-
name: "New",
|
|
542
|
-
description: "d",
|
|
543
|
-
primaryKeyName: "id",
|
|
544
|
-
fields: [{ name: "id", type: field_type_1.FieldType.id }],
|
|
545
|
-
},
|
|
546
|
-
],
|
|
547
|
-
});
|
|
548
|
-
const result = (0, validate_1.validateImmutability)(existing, incoming);
|
|
549
|
-
expect(result.valid).toBe(true);
|
|
550
|
-
});
|
|
551
|
-
it("rejects registering a dev version when stable version already exists", () => {
|
|
552
|
-
const existing = makeContract({
|
|
553
|
-
tables: [
|
|
554
|
-
{
|
|
555
|
-
name: "Tasks",
|
|
556
|
-
description: "d",
|
|
557
|
-
primaryKeyName: "taskId",
|
|
558
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
559
|
-
},
|
|
560
|
-
],
|
|
561
|
-
});
|
|
562
|
-
const incoming = makeContract({
|
|
563
|
-
devTag: "dev",
|
|
564
|
-
tables: [
|
|
565
|
-
{
|
|
566
|
-
name: "Tasks",
|
|
567
|
-
description: "d",
|
|
568
|
-
primaryKeyName: "taskId",
|
|
569
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
570
|
-
},
|
|
571
|
-
],
|
|
572
|
-
});
|
|
573
|
-
const result = (0, validate_1.validateImmutability)(existing, incoming);
|
|
574
|
-
expect(result.valid).toBe(false);
|
|
575
|
-
expect(result.errors[0].message).toContain("frozen");
|
|
576
|
-
});
|
|
577
|
-
it("passes when a frozen contract is re-published identically", () => {
|
|
578
|
-
const contract = makeContract({
|
|
579
|
-
tables: [
|
|
580
|
-
{
|
|
581
|
-
name: "Tasks",
|
|
582
|
-
description: "d",
|
|
583
|
-
primaryKeyName: "taskId",
|
|
584
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
585
|
-
},
|
|
586
|
-
],
|
|
587
|
-
});
|
|
588
|
-
const result = (0, validate_1.validateImmutability)(contract, { ...contract });
|
|
589
|
-
expect(result.valid).toBe(true);
|
|
590
|
-
});
|
|
591
|
-
it("fails when a frozen contract shape is modified", () => {
|
|
592
|
-
const existing = makeContract({
|
|
593
|
-
tables: [
|
|
594
|
-
{
|
|
595
|
-
name: "Tasks",
|
|
596
|
-
description: "d",
|
|
597
|
-
primaryKeyName: "taskId",
|
|
598
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
599
|
-
},
|
|
600
|
-
],
|
|
601
|
-
});
|
|
602
|
-
const incoming = makeContract({
|
|
603
|
-
tables: [
|
|
604
|
-
{
|
|
605
|
-
name: "Tasks",
|
|
606
|
-
description: "d",
|
|
607
|
-
primaryKeyName: "taskId",
|
|
608
|
-
fields: [
|
|
609
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
610
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
611
|
-
],
|
|
612
|
-
},
|
|
613
|
-
],
|
|
614
|
-
});
|
|
615
|
-
const result = (0, validate_1.validateImmutability)(existing, incoming);
|
|
616
|
-
expect(result.valid).toBe(false);
|
|
617
|
-
expect(result.errors[0].message).toContain("frozen");
|
|
618
|
-
});
|
|
619
|
-
it.each([
|
|
620
|
-
[
|
|
621
|
-
"addition",
|
|
622
|
-
[
|
|
623
|
-
{
|
|
624
|
-
name: "taskChanged",
|
|
625
|
-
description: "A task changed",
|
|
626
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
627
|
-
},
|
|
628
|
-
{
|
|
629
|
-
name: "taskDeleted",
|
|
630
|
-
description: "A task was deleted",
|
|
631
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
632
|
-
},
|
|
633
|
-
],
|
|
634
|
-
],
|
|
635
|
-
["removal", []],
|
|
636
|
-
[
|
|
637
|
-
"rename",
|
|
638
|
-
[
|
|
639
|
-
{
|
|
640
|
-
name: "taskUpdated",
|
|
641
|
-
description: "A task changed",
|
|
642
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
643
|
-
},
|
|
644
|
-
],
|
|
645
|
-
],
|
|
646
|
-
[
|
|
647
|
-
"payload change",
|
|
648
|
-
[
|
|
649
|
-
{
|
|
650
|
-
name: "taskChanged",
|
|
651
|
-
description: "A task changed",
|
|
652
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.number }],
|
|
653
|
-
},
|
|
654
|
-
],
|
|
655
|
-
],
|
|
656
|
-
])("rejects frozen event %s", (_change, incomingEvents) => {
|
|
657
|
-
const existing = makeContract({
|
|
658
|
-
events: [
|
|
659
|
-
{
|
|
660
|
-
name: "taskChanged",
|
|
661
|
-
description: "A task changed",
|
|
662
|
-
payloadFields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
663
|
-
},
|
|
664
|
-
],
|
|
665
|
-
});
|
|
666
|
-
const result = (0, validate_1.validateImmutability)(existing, makeContract({ events: incomingEvents }));
|
|
667
|
-
expect(result.valid).toBe(false);
|
|
668
|
-
expect(result.errors[0].message).toContain("frozen");
|
|
669
|
-
});
|
|
670
|
-
});
|
|
671
|
-
describe("validateImmutability compares shapes, not text", () => {
|
|
672
|
-
const tool = (inputFields) => ({
|
|
673
|
-
name: "setMode",
|
|
674
|
-
usageDescription: "Set the mode.",
|
|
675
|
-
inputFields,
|
|
676
|
-
outputFields: [{ name: "ok", type: field_type_1.FieldType.boolean }],
|
|
677
|
-
});
|
|
678
|
-
const mode = { name: "mode", type: field_type_1.FieldType.string, enumValues: ["on", "off"] };
|
|
679
|
-
const note = { name: "note", type: field_type_1.FieldType.string, optional: true, description: "A note." };
|
|
680
|
-
const frozen = makeContract({
|
|
681
|
-
tools: [tool([mode, note])],
|
|
682
|
-
observables: [
|
|
683
|
-
{
|
|
684
|
-
name: "state",
|
|
685
|
-
description: "The state.",
|
|
686
|
-
valueType: field_type_1.FieldType.object,
|
|
687
|
-
value: { type: field_type_1.FieldType.object, fields: [{ name: "on", type: field_type_1.FieldType.boolean }] },
|
|
688
|
-
writable: false,
|
|
689
|
-
},
|
|
690
|
-
],
|
|
691
|
-
});
|
|
692
|
-
it("allows new descriptions and any member, field, or key order", () => {
|
|
693
|
-
const incoming = makeContract({
|
|
694
|
-
observables: [
|
|
695
|
-
{
|
|
696
|
-
writable: false,
|
|
697
|
-
value: { fields: [{ type: field_type_1.FieldType.boolean, name: "on" }], type: field_type_1.FieldType.object },
|
|
698
|
-
valueType: field_type_1.FieldType.object,
|
|
699
|
-
description: "Deprecated: use v2.",
|
|
700
|
-
name: "state",
|
|
701
|
-
},
|
|
702
|
-
],
|
|
703
|
-
tools: [
|
|
704
|
-
{
|
|
705
|
-
...tool([
|
|
706
|
-
{ ...note, description: "Don't use this." },
|
|
707
|
-
{ ...mode, enumValues: ["off", "on"] },
|
|
708
|
-
]),
|
|
709
|
-
usageDescription: "Deprecated: use v2.",
|
|
710
|
-
},
|
|
711
|
-
],
|
|
712
|
-
});
|
|
713
|
-
expect((0, validate_1.validateImmutability)(frozen, incoming).valid).toBe(true);
|
|
714
|
-
});
|
|
715
|
-
it("matches a shape built before fields, enumValues, and value existed", () => {
|
|
716
|
-
const older = makeContract({
|
|
717
|
-
tools: [
|
|
718
|
-
tool([
|
|
719
|
-
{ name: "mode", type: field_type_1.FieldType.string },
|
|
720
|
-
{ name: "note", type: field_type_1.FieldType.string, optional: true },
|
|
721
|
-
]),
|
|
722
|
-
],
|
|
723
|
-
observables: [
|
|
724
|
-
{ name: "state", description: "", valueType: field_type_1.FieldType.object, writable: false },
|
|
725
|
-
],
|
|
726
|
-
});
|
|
727
|
-
expect((0, validate_1.validateImmutability)(frozen, older).valid).toBe(true);
|
|
728
|
-
expect((0, validate_1.validateImmutability)(older, frozen).valid).toBe(true);
|
|
729
|
-
});
|
|
730
|
-
it("ignores duplicate enum entries when comparing sets", () => {
|
|
731
|
-
const incoming = makeContract({
|
|
732
|
-
tools: [tool([{ ...mode, enumValues: ["off", "on", "on"] }, note])],
|
|
733
|
-
observables: frozen.observables,
|
|
734
|
-
});
|
|
735
|
-
expect((0, validate_1.validateImmutability)(frozen, incoming).valid).toBe(true);
|
|
736
|
-
expect((0, validate_1.validateImmutability)(incoming, frozen).valid).toBe(true);
|
|
737
|
-
});
|
|
738
|
-
it("matches unchanged legacy default factories across schema rebuilds and JSON storage", () => {
|
|
739
|
-
const factory = jest.fn(() => "generated");
|
|
740
|
-
const legacy = () => makeContract({
|
|
741
|
-
tables: [
|
|
742
|
-
{
|
|
743
|
-
name: "Records",
|
|
744
|
-
description: "",
|
|
745
|
-
primaryKeyName: "id",
|
|
746
|
-
fields: (0, types_1.schemaToFields)(zod_1.z.object({
|
|
747
|
-
id: zod_1.z.string().default(() => factory()),
|
|
748
|
-
label: zod_1.z.string().default("untitled"),
|
|
749
|
-
})),
|
|
750
|
-
},
|
|
751
|
-
],
|
|
752
|
-
});
|
|
753
|
-
const first = legacy();
|
|
754
|
-
const rebuilt = legacy();
|
|
755
|
-
const stored = JSON.parse(JSON.stringify(first));
|
|
756
|
-
expect((0, validate_1.validateImmutability)(first, rebuilt).valid).toBe(true);
|
|
757
|
-
expect((0, validate_1.validateImmutability)(stored, rebuilt).valid).toBe(true);
|
|
758
|
-
expect((0, validate_1.validateImmutability)(rebuilt, stored).valid).toBe(true);
|
|
759
|
-
expect(factory).not.toHaveBeenCalled();
|
|
760
|
-
});
|
|
761
|
-
it("compares default objects as data, including descriptions and array order", () => {
|
|
762
|
-
const contract = (defaultValue) => makeContract({
|
|
763
|
-
tools: [tool([{ ...mode, defaultValue }])],
|
|
764
|
-
});
|
|
765
|
-
const first = contract({ description: "data", values: ["a", "b"] });
|
|
766
|
-
expect((0, validate_1.validateImmutability)(first, contract({ values: ["a", "b"], description: "data" })).valid).toBe(true);
|
|
767
|
-
expect((0, validate_1.validateImmutability)(first, contract({ description: "changed", values: ["a", "b"] })).valid).toBe(false);
|
|
768
|
-
expect((0, validate_1.validateImmutability)(first, contract({ description: "data", values: ["b", "a"] })).valid).toBe(false);
|
|
769
|
-
});
|
|
770
|
-
it.each([
|
|
771
|
-
["an enum value", tool([{ ...mode, enumValues: ["on"] }, note])],
|
|
772
|
-
["optional", tool([mode, { ...note, optional: false }])],
|
|
773
|
-
["a default value", tool([{ ...mode, defaultValue: "on" }, note])],
|
|
774
|
-
["a type", tool([mode, { ...note, type: field_type_1.FieldType.number }])],
|
|
775
|
-
])("rejects a changed %s", (_change, changed) => {
|
|
776
|
-
const result = (0, validate_1.validateImmutability)(frozen, makeContract({ tools: [changed], observables: frozen.observables }));
|
|
777
|
-
expect(result.valid).toBe(false);
|
|
778
|
-
});
|
|
779
|
-
it("rejects a changed observable value shape when both have one", () => {
|
|
780
|
-
const [state] = frozen.observables;
|
|
781
|
-
const incoming = makeContract({
|
|
782
|
-
tools: frozen.tools,
|
|
783
|
-
observables: [
|
|
784
|
-
{
|
|
785
|
-
...state,
|
|
786
|
-
value: { type: field_type_1.FieldType.object, fields: [{ name: "on", type: field_type_1.FieldType.string }] },
|
|
787
|
-
},
|
|
788
|
-
],
|
|
789
|
-
});
|
|
790
|
-
expect((0, validate_1.validateImmutability)(frozen, incoming).valid).toBe(false);
|
|
791
|
-
});
|
|
792
|
-
it("ignores a tool's policy, which isn't part of its shape", () => {
|
|
793
|
-
const tool = {
|
|
794
|
-
name: "run",
|
|
795
|
-
usageDescription: "Run.",
|
|
796
|
-
inputFields: [{ name: "id", type: field_type_1.FieldType.id }],
|
|
797
|
-
outputFields: [],
|
|
798
|
-
};
|
|
799
|
-
const frozen = makeContract({ tools: [{ ...tool, remoteAccessLevel: 40 }] });
|
|
800
|
-
const incoming = makeContract({
|
|
801
|
-
tools: [{ ...tool, remoteAccessLevel: 60, requiresWorkflowRun: true }],
|
|
802
|
-
});
|
|
803
|
-
expect((0, validate_1.validateImmutability)(frozen, incoming)).toEqual({ valid: true, errors: [] });
|
|
804
|
-
});
|
|
805
|
-
it("names what changed", () => {
|
|
806
|
-
const field = { name: "id", type: field_type_1.FieldType.id };
|
|
807
|
-
const tool = (name, inputFields = [field]) => ({
|
|
808
|
-
name,
|
|
809
|
-
usageDescription: name,
|
|
810
|
-
inputFields,
|
|
811
|
-
outputFields: [],
|
|
812
|
-
});
|
|
813
|
-
const frozen = makeContract({ tools: [tool("keep"), tool("change"), tool("drop")] });
|
|
814
|
-
const incoming = makeContract({
|
|
815
|
-
tools: [tool("keep"), tool("change", [{ ...field, type: field_type_1.FieldType.string }]), tool("new")],
|
|
816
|
-
});
|
|
817
|
-
expect((0, validate_1.contractShapeChanges)(frozen, incoming)).toEqual([
|
|
818
|
-
"tool change changed",
|
|
819
|
-
"tool drop was removed",
|
|
820
|
-
"tool new was added",
|
|
821
|
-
]);
|
|
822
|
-
expect((0, validate_1.validateImmutability)(frozen, incoming).errors[0].message).toContain("(tool change changed; tool drop was removed; tool new was added)");
|
|
823
|
-
});
|
|
824
|
-
it.each([
|
|
825
|
-
"tables",
|
|
826
|
-
"tools",
|
|
827
|
-
"observables",
|
|
828
|
-
"events",
|
|
829
|
-
])("does not hide added or changed duplicate %s behind the last member", (kind) => {
|
|
830
|
-
const member = { name: "duplicate", description: "Original" };
|
|
831
|
-
const before = makeContract({ [kind]: [member] });
|
|
832
|
-
const after = makeContract({ [kind]: [{ ...member, extra: true }, member] });
|
|
833
|
-
expect((0, validate_1.validateImmutability)(before, after).valid).toBe(false);
|
|
834
|
-
expect((0, validate_1.validateImmutability)(after, before).valid).toBe(false);
|
|
835
|
-
const changedDuplicate = makeContract({ [kind]: [{ ...member, extra: false }, member] });
|
|
836
|
-
expect((0, validate_1.validateImmutability)(after, changedDuplicate).valid).toBe(false);
|
|
837
|
-
});
|
|
838
|
-
});
|
|
839
|
-
describe("validateAlsoImplements", () => {
|
|
840
|
-
const contractStore = new Map();
|
|
841
|
-
const TASKS_CONTRACT_ID = (0, utils_1.newid)();
|
|
842
|
-
const FANCY_TASKS_CONTRACT_ID = (0, utils_1.newid)();
|
|
843
|
-
const NONEXISTENT_ID = (0, utils_1.newid)();
|
|
844
|
-
function getContract(id, ver) {
|
|
845
|
-
return contractStore.get((0, types_2.contractKey)(id, ver));
|
|
846
|
-
}
|
|
847
|
-
beforeEach(() => {
|
|
848
|
-
contractStore.clear();
|
|
849
|
-
});
|
|
850
|
-
it("passes when implementation is a superset of the target contract", () => {
|
|
851
|
-
const targetV1 = makeContract({
|
|
852
|
-
contractId: TASKS_CONTRACT_ID,
|
|
853
|
-
version: 1,
|
|
854
|
-
tables: [
|
|
855
|
-
{
|
|
856
|
-
name: "Tasks",
|
|
857
|
-
description: "d",
|
|
858
|
-
primaryKeyName: "taskId",
|
|
859
|
-
fields: [
|
|
860
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
861
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
862
|
-
],
|
|
863
|
-
},
|
|
864
|
-
],
|
|
865
|
-
});
|
|
866
|
-
contractStore.set((0, types_2.contractKey)(TASKS_CONTRACT_ID, 1), targetV1);
|
|
867
|
-
const impl = makeContract({
|
|
868
|
-
contractId: FANCY_TASKS_CONTRACT_ID,
|
|
869
|
-
version: 1,
|
|
870
|
-
tables: [
|
|
871
|
-
{
|
|
872
|
-
name: "Tasks",
|
|
873
|
-
description: "d",
|
|
874
|
-
primaryKeyName: "taskId",
|
|
875
|
-
fields: [
|
|
876
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
877
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
878
|
-
{ name: "priority", type: field_type_1.FieldType.number, optional: true },
|
|
879
|
-
],
|
|
880
|
-
},
|
|
881
|
-
],
|
|
882
|
-
});
|
|
883
|
-
const result = (0, validate_1.validateAlsoImplements)(impl, [{ contractId: TASKS_CONTRACT_ID, version: 1 }], getContract);
|
|
884
|
-
expect(result.valid).toBe(true);
|
|
885
|
-
});
|
|
886
|
-
it("validates all versions in a range", () => {
|
|
887
|
-
const v1 = makeContract({
|
|
888
|
-
contractId: TASKS_CONTRACT_ID,
|
|
889
|
-
version: 1,
|
|
890
|
-
tables: [
|
|
891
|
-
{
|
|
892
|
-
name: "Tasks",
|
|
893
|
-
description: "d",
|
|
894
|
-
primaryKeyName: "taskId",
|
|
895
|
-
fields: [
|
|
896
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
897
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
898
|
-
],
|
|
899
|
-
},
|
|
900
|
-
],
|
|
901
|
-
});
|
|
902
|
-
const v2 = makeContract({
|
|
903
|
-
contractId: TASKS_CONTRACT_ID,
|
|
904
|
-
version: 2,
|
|
905
|
-
tables: [
|
|
906
|
-
{
|
|
907
|
-
name: "Tasks",
|
|
908
|
-
description: "d",
|
|
909
|
-
primaryKeyName: "taskId",
|
|
910
|
-
fields: [
|
|
911
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
912
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
913
|
-
{ name: "status", type: field_type_1.FieldType.string, optional: true },
|
|
914
|
-
],
|
|
915
|
-
},
|
|
916
|
-
],
|
|
917
|
-
});
|
|
918
|
-
contractStore.set((0, types_2.contractKey)(TASKS_CONTRACT_ID, 1), v1);
|
|
919
|
-
contractStore.set((0, types_2.contractKey)(TASKS_CONTRACT_ID, 2), v2);
|
|
920
|
-
// Implementation satisfies both: has all fields from both versions.
|
|
921
|
-
// 'status' is optional so v1 consumers can still write valid rows.
|
|
922
|
-
const impl = makeContract({
|
|
923
|
-
tables: [
|
|
924
|
-
{
|
|
925
|
-
name: "Tasks",
|
|
926
|
-
description: "d",
|
|
927
|
-
primaryKeyName: "taskId",
|
|
928
|
-
fields: [
|
|
929
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
930
|
-
{ name: "title", type: field_type_1.FieldType.string },
|
|
931
|
-
{ name: "status", type: field_type_1.FieldType.string, optional: true },
|
|
932
|
-
],
|
|
933
|
-
},
|
|
934
|
-
],
|
|
935
|
-
});
|
|
936
|
-
const result = (0, validate_1.validateAlsoImplements)(impl, [{ contractId: TASKS_CONTRACT_ID, version: { from: 1, to: 2 } }], getContract);
|
|
937
|
-
expect(result.valid).toBe(true);
|
|
938
|
-
});
|
|
939
|
-
it("fails when implementation is missing a field from one version in range", () => {
|
|
940
|
-
const v1 = makeContract({
|
|
941
|
-
contractId: TASKS_CONTRACT_ID,
|
|
942
|
-
version: 1,
|
|
943
|
-
tables: [
|
|
944
|
-
{
|
|
945
|
-
name: "Tasks",
|
|
946
|
-
description: "d",
|
|
947
|
-
primaryKeyName: "taskId",
|
|
948
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
949
|
-
},
|
|
950
|
-
],
|
|
951
|
-
});
|
|
952
|
-
const v2 = makeContract({
|
|
953
|
-
contractId: TASKS_CONTRACT_ID,
|
|
954
|
-
version: 2,
|
|
955
|
-
tables: [
|
|
956
|
-
{
|
|
957
|
-
name: "Tasks",
|
|
958
|
-
description: "d",
|
|
959
|
-
primaryKeyName: "taskId",
|
|
960
|
-
fields: [
|
|
961
|
-
{ name: "taskId", type: field_type_1.FieldType.id },
|
|
962
|
-
{ name: "assignee", type: field_type_1.FieldType.string },
|
|
963
|
-
],
|
|
964
|
-
},
|
|
965
|
-
],
|
|
966
|
-
});
|
|
967
|
-
contractStore.set((0, types_2.contractKey)(TASKS_CONTRACT_ID, 1), v1);
|
|
968
|
-
contractStore.set((0, types_2.contractKey)(TASKS_CONTRACT_ID, 2), v2);
|
|
969
|
-
// Implementation only satisfies v1 (missing 'assignee')
|
|
970
|
-
const impl = makeContract({
|
|
971
|
-
tables: [
|
|
972
|
-
{
|
|
973
|
-
name: "Tasks",
|
|
974
|
-
description: "d",
|
|
975
|
-
primaryKeyName: "taskId",
|
|
976
|
-
fields: [{ name: "taskId", type: field_type_1.FieldType.id }],
|
|
977
|
-
},
|
|
978
|
-
],
|
|
979
|
-
});
|
|
980
|
-
const result = (0, validate_1.validateAlsoImplements)(impl, [{ contractId: TASKS_CONTRACT_ID, version: { from: 1, to: 2 } }], getContract);
|
|
981
|
-
expect(result.valid).toBe(false);
|
|
982
|
-
expect(result.errors[0].message).toContain("v2");
|
|
983
|
-
expect(result.errors[0].message).toContain("assignee");
|
|
984
|
-
});
|
|
985
|
-
it("fails when a referenced contract does not exist", () => {
|
|
986
|
-
const impl = makeContract({ tables: [] });
|
|
987
|
-
const result = (0, validate_1.validateAlsoImplements)(impl, [{ contractId: NONEXISTENT_ID, version: 1 }], getContract);
|
|
988
|
-
expect(result.valid).toBe(false);
|
|
989
|
-
expect(result.errors[0].message).toContain("not found");
|
|
990
|
-
});
|
|
991
|
-
});
|