@peers-app/peers-sdk 0.27.3 → 0.27.4

package/dist/contracts/__tests__/legacy-removal.test.js

@@ -1,128 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const sdk = require("../../index");
-const utils_1 = require("../../utils");
-const builder_1 = require("../builder");
-const registry_1 = require("../registry");
-const tool_catalog_1 = require("../tool-catalog");
-const tool_catalog_migrations_1 = require("../tool-catalog-migrations");
-const removedRegistryExports = [
-    "registerTool",
-    "getRegisteredTool",
-    "unregisterTools",
-    "getAllRegisteredTools",
-    "clearRegisteredTools",
-    "tools",
-];
-test("the SDK exports no executable registry", () => {
-    for (const name of removedRegistryExports)
-        expect(sdk).not.toHaveProperty(name);
-});
-test("package administration has no RPC stubs; System Packages replaces them", () => {
-    for (const name of [
-        "addOrUpdatePackage",
-        "seedBundledPeersCore",
-        "signPackageAuthorVersion",
-        "injectUIBundle",
-    ])
-        expect(sdk.rpcServerCalls).not.toHaveProperty(name);
-    expect(sdk).not.toHaveProperty("unwrapAddOrUpdatePackageResult");
-    expect(sdk.getPackagesContractDefinition().name).toBe("System Packages");
-});
-test("the host shell has no RPC stubs; System Host Shell replaces them", () => {
-    for (const name of [
-        "openLinkInBrowser",
-        "openPath",
-        "openPackage",
-        "copyPvarValueToClipboard",
-        "appQuit",
-        "appRestart",
-        "uiReload",
-        "uiInspect",
-        "uiClick",
-        "uiSet",
-        "uiScroll",
-    ])
-        expect(sdk.rpcServerCalls).not.toHaveProperty(name);
-    for (const name of [
-        "setClientPath",
-        "openThread",
-        "uiGetState",
-        "uiDoClick",
-        "uiDoSet",
-        "uiDoScroll",
-    ])
-        expect(sdk.rpcClientCalls).not.toHaveProperty(name);
-    expect(sdk).not.toHaveProperty("UIState");
-    expect(sdk.getHostShellContractDefinition().name).toBe("System Host Shell");
-});
-test("old SDK assignments warn once and never produce executables", () => {
-    const builder = new builder_1.ContractBuilder((0, utils_1.newid)(), 1, "Old package");
-    const warn = jest.spyOn(console, "warn").mockImplementation(() => { });
-    try {
-        builder.toolInstances = [{ toolFn: jest.fn() }];
-        builder.toolInstances = [];
-        expect(warn).toHaveBeenCalledTimes(1);
-        expect(warn).toHaveBeenCalledWith(expect.stringContaining(`Contract Old package (${builder.contractId}@1) assigned toolInstances, which no longer run`));
-        expect(builder._build()).not.toHaveProperty("toolInstances");
-    }
-    finally {
-        warn.mockRestore();
-    }
-});
-test("runner metadata uses the shape target and ignores arbitrary tool IDs", () => {
-    const contractId = (0, utils_1.newid)();
-    const shape = {
-        tool: {
-            toolId: (0, utils_1.newid)(),
-            name: "runner",
-            usageDescription: "run",
-            isAssistantRunner: true,
-            configSchema: { type: sdk.IOSchemaType.none, fields: [] },
-            detailedDescription: "details",
-        },
-    };
-    const result = (0, builder_1.definePackage)((pkg) => {
-        pkg.packageId = (0, utils_1.newid)();
-        pkg.contract(contractId, 1, "Runner").tools = [shape];
-    });
-    const target = { contractId, version: 1, toolName: "runner" };
-    expect(result.toolMetadata).toEqual([
-        {
-            ...target,
-            isAssistantRunner: true,
-            configSchema: shape.tool.configSchema,
-            detailedDescription: "details",
-        },
-    ]);
-    expect(result).not.toHaveProperty("toolInstances");
-    expect((0, tool_catalog_migrations_1.toolCatalogIds)(target)).not.toContain(shape.tool.toolId);
-    shape.tool.toolId = (0, utils_1.newid)();
-    expect((0, tool_catalog_migrations_1.toolCatalogIds)(target)).toEqual([sdk.deriveToolCatalogId(target)]);
-});
-test("metadata targeting another publication is rejected before any catalog write", async () => {
-    const getTable = jest.fn();
-    const registry = new registry_1.ContractRegistry();
-    const catalog = new tool_catalog_1.ToolCatalog({ tableContainer: { getTable } }, registry);
-    const definition = (0, builder_1.definePackage)((pkg) => {
-        pkg.packageId = (0, utils_1.newid)();
-        pkg.contract((0, utils_1.newid)(), 1, "Own").tools = [{ tool: { name: "own", usageDescription: "own" } }];
-    });
-    const foreign = {
-        ...definition.contracts[0],
-        contractId: (0, utils_1.newid)(),
-        tools: [{ ...definition.contracts[0].tools[0], name: "foreign" }],
-    };
-    expect(registry.register((0, utils_1.newid)(), foreign).valid).toBe(true);
-    const prepare = jest.fn();
-    const activate = jest.fn();
-    try {
-        await expect(catalog.publish(definition.packageId, definition.contracts.map((definition) => ({ definition })), prepare, activate, [{ contractId: foreign.contractId, version: 1, toolName: "foreign" }])).rejects.toThrow(/member of this publication/);
-        expect(getTable).not.toHaveBeenCalled();
-        expect(prepare).not.toHaveBeenCalled();
-        expect(activate).not.toHaveBeenCalled();
-    }
-    finally {
-        await catalog.dispose();
-    }
-});

package/dist/contracts/__tests__/persistent-registry.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/contracts/__tests__/persistent-registry.test.js

@@ -1,109 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const field_type_1 = require("../../types/field-type");
-const utils_1 = require("../../utils");
-const contract_providers_table_1 = require("../contract-providers.table");
-const contracts_table_1 = require("../contracts.table");
-const persistent_registry_1 = require("../persistent-registry");
-const registry_1 = require("../registry");
-jest.mock("../contract-providers.table", () => ({ ContractProviders: jest.fn() }));
-jest.mock("../contracts.table", () => ({ Contracts: jest.fn() }));
-const contracts = contracts_table_1.Contracts;
-const contractProviders = contract_providers_table_1.ContractProviders;
-const dataContext = {};
-const contractRecords = [];
-const providerRecords = [];
-const contractsTable = {
-    findOne: jest.fn(async (filter) => contractRecords.find((record) => Object.entries(filter).every(([key, value]) => record[key] === value))),
-    list: jest.fn(async () => [...contractRecords]),
-    save: jest.fn(async (record) => {
-        const index = contractRecords.findIndex((existing) => existing.contractId === record.contractId && existing.version === record.version);
-        if (index >= 0) {
-            contractRecords[index] = record;
-        }
-        else {
-            contractRecords.push(record);
-        }
-        return record;
-    }),
-};
-const providersTable = {
-    findOne: jest.fn(async (filter) => providerRecords.find((record) => Object.entries(filter).every(([key, value]) => record[key] === value))),
-    list: jest.fn(async () => [...providerRecords]),
-    save: jest.fn(async (record) => {
-        const index = providerRecords.findIndex((existing) => existing.contractProviderId === record.contractProviderId);
-        if (index >= 0) {
-            providerRecords[index] = record;
-        }
-        else {
-            providerRecords.push(record);
-        }
-        return record;
-    }),
-};
-beforeEach(() => {
-    contractRecords.length = 0;
-    providerRecords.length = 0;
-    jest.clearAllMocks();
-    contracts.mockReturnValue(contractsTable);
-    contractProviders.mockReturnValue(providersTable);
-});
-function makeDefinition() {
-    return {
-        contractId: (0, utils_1.newid)(),
-        version: 1,
-        devTag: "dev",
-        name: "Event Contract",
-        description: "Persists events",
-        tables: [],
-        tools: [],
-        observables: [],
-        events: [
-            {
-                name: "widgetChanged",
-                description: "A widget changed",
-                payloadFields: [{ name: "widgetId", type: field_type_1.FieldType.id, description: "Changed widget" }],
-            },
-        ],
-    };
-}
-describe("PersistentContractRegistry event definitions", () => {
-    it("persists and hydrates event names, descriptions, and payload fields", async () => {
-        const definition = makeDefinition();
-        const providerPackageId = (0, utils_1.newid)();
-        const persistent = new persistent_registry_1.PersistentContractRegistry(new registry_1.ContractRegistry(), dataContext);
-        await persistent.persist(definition, providerPackageId, true);
-        expect(JSON.parse(contractRecords[0].shape).events).toEqual(definition.events);
-        const hydratedRegistry = new registry_1.ContractRegistry();
-        await new persistent_registry_1.PersistentContractRegistry(hydratedRegistry, dataContext).hydrate();
-        expect(hydratedRegistry.getDefinition(definition.contractId, definition.version)).toEqual(definition);
-    });
-    it("hydrates old persisted shapes without events as an empty event list", async () => {
-        const definition = makeDefinition();
-        const providerPackageId = (0, utils_1.newid)();
-        contractRecords.push({
-            contractId: definition.contractId,
-            version: definition.version,
-            devTag: definition.devTag,
-            name: definition.name,
-            description: definition.description,
-            shape: JSON.stringify({
-                tables: definition.tables,
-                tools: definition.tools,
-                observables: definition.observables,
-            }),
-            registeredAt: new Date(0).toISOString(),
-        });
-        providerRecords.push({
-            contractProviderId: (0, utils_1.newid)(),
-            contractId: definition.contractId,
-            version: definition.version,
-            providerPackageId,
-            isActive: true,
-            registeredAt: new Date(0).toISOString(),
-        });
-        const registry = new registry_1.ContractRegistry();
-        await new persistent_registry_1.PersistentContractRegistry(registry, dataContext).hydrate();
-        expect(registry.getDefinition(definition.contractId, definition.version)?.events).toEqual([]);
-    });
-});

package/dist/contracts/__tests__/playground.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/contracts/__tests__/playground.test.js

@@ -1,216 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * SCRATCH / PLAYGROUND — not a curated part of the suite.
- *
- * A place to hand-write contract *provider* (impl side) and *consumer* (caller
- * side) tests and feel out the ergonomics. Rename, rewrite, or delete freely.
- *
- * Run just this file:
- *   cd peers-sdk && npx jest playground
- * Watch it:
- *   cd peers-sdk && npx jest --watch playground
- */
-const observable_1 = require("../../observable");
-const field_type_1 = require("../../types/field-type");
-const utils_1 = require("../../utils");
-const contract_proxy_1 = require("../contract-proxy");
-const contract_transport_1 = require("../contract-transport");
-const cleanups = [];
-afterEach(() => {
-    for (const cleanup of cleanups.splice(0).reverse()) {
-        cleanup();
-    }
-});
-/**
- * Build a consumer wired in-process to a provider *session* (via a transport pair).
- *
- * The session (not the stateless `createContractProvider`) is what a consumer should face:
- * it serves request/response dispatch *and* the subscription/streaming traffic that every
- * consumer now opens implicitly (observable mirrors fire a `subscribe` at construction, and
- * the session is what can push updates back on the notify channel). Returns the live session
- * too so a test can `session.dispose()`.
- */
-function inProcessConsumer(contract, resolution, opts = {}) {
-    const [consumerTransport, providerTransport] = (0, contract_transport_1.inProcessTransportPair)();
-    const session = (0, contract_proxy_1.createContractProviderSession)(resolution, providerTransport, opts);
-    const consumer = (0, contract_proxy_1.createContractConsumer)(contract, consumerTransport);
-    cleanups.push(() => {
-        consumer.dispose();
-        session.dispose();
-    });
-    return { consumer, session };
-}
-const CONTRACT_ID = "00mrbloudwk9svfxd42oyxqhi";
-/** The contract *shape* a consumer sees: one table, one tool, one observable. */
-function makeContract() {
-    return {
-        contractId: CONTRACT_ID,
-        version: 1,
-        devTag: "dev",
-        name: "Playground Contract",
-        description: "Scratch space",
-        tables: [
-            {
-                name: "Widgets",
-                description: "Widget table",
-                primaryKeyName: "widgetId",
-                fields: [{ name: "widgetId", type: field_type_1.FieldType.id, description: "PK" }],
-            },
-        ],
-        tools: [
-            {
-                name: "make-widget",
-                usageDescription: "Makes a widget",
-                inputFields: [{ name: "color", type: field_type_1.FieldType.string, description: "Color" }],
-                outputFields: [{ name: "widgetId", type: field_type_1.FieldType.id, description: "ID" }],
-            },
-        ],
-        observables: [
-            { name: "widgetCount", description: "Count", valueType: field_type_1.FieldType.number, writable: true },
-        ],
-    };
-}
-/** A live, in-memory implementation the *provider* dispatches to. */
-function makeResolution() {
-    const rows = [];
-    const table = {
-        list: async (filter = {}) => rows.filter((r) => Object.entries(filter).every(([k, v]) => r[k] === v)),
-        get: async (id) => rows.find((r) => r.widgetId === id),
-        save: async (record) => {
-            rows.push(record);
-            return record;
-        },
-    };
-    const makeWidget = async ({ color }) => ({ widgetId: (0, utils_1.newid)(), color });
-    const widgetCount = (0, observable_1.observable)(0);
-    const resolution = {
-        contractId: CONTRACT_ID,
-        version: 1,
-        tables: { Widgets: table },
-        tools: {
-            "make-widget": { tool: { toolId: (0, utils_1.newid)(), name: "make-widget" }, toolFn: makeWidget },
-        },
-        observables: { widgetCount },
-        observableWritability: { widgetCount: true },
-    };
-    return { resolution, table, makeWidget, widgetCount, rows };
-}
-/** Wire a consumer straight to a provider session, in-process (over a transport pair). */
-function wire() {
-    const contract = makeContract();
-    const { resolution, ...rest } = makeResolution();
-    const { consumer, session } = inProcessConsumer(contract, resolution);
-    return { consumer, session, contract, ...rest };
-}
-describe("playground", () => {
-    it("round-trips a save through consumer -> provider -> live table", async () => {
-        const { consumer } = wire();
-        const saved = await consumer.tables.Widgets.save({ widgetId: "w1", color: "red" });
-        expect(saved).toEqual({ widgetId: "w1", color: "red" });
-        const listed = await consumer.tables.Widgets.list({ color: "red" });
-        expect(listed).toEqual([{ widgetId: "w1", color: "red" }]);
-    });
-    // Start fiddling here — try a tool call, observable get/set, permission
-    // checks (sameUserContractPermissionCheck), or swap in your own contract shape.
-    it("keeps compatible contract versions isolated and reactive", async () => {
-        const logs = [];
-        let lastLogTime;
-        const inc = (0, observable_1.observable)(0);
-        const logCountObs = (0, observable_1.computed)(() => {
-            inc();
-            return logs.length;
-        });
-        const lastLogTimeObs = (0, observable_1.computed)(() => {
-            inc();
-            return lastLogTime;
-        });
-        const logTextFn = (text) => {
-            logs.push(text);
-            lastLogTime = Date.now();
-            inc(inc() + 1);
-            return logs.length - 1;
-        };
-        const logsContractV1 = {
-            contractId: CONTRACT_ID,
-            version: 1,
-            devTag: "dev",
-            name: "Playground Contract",
-            description: "Scratch space",
-            tables: [],
-            tools: [
-                {
-                    name: "logText",
-                    usageDescription: "logs text",
-                    inputFields: [{ name: "text", type: field_type_1.FieldType.string }],
-                    outputFields: [{ name: "logId", type: field_type_1.FieldType.id, description: "log id" }],
-                },
-            ],
-            observables: [
-                { name: "logCount", description: "Count", valueType: field_type_1.FieldType.number, writable: false },
-            ],
-        };
-        const providerV1 = {
-            contractId: CONTRACT_ID,
-            version: 1,
-            tools: {
-                logText: {
-                    tool: { toolId: "", name: "logText", accessLevel: 0 },
-                    toolFn: logTextFn,
-                },
-            },
-            observables: { logCount: logCountObs },
-            observableWritability: { logCount: false },
-        };
-        const logsContractV2 = {
-            ...logsContractV1,
-            version: 2,
-            devTag: "dev",
-            observables: [
-                ...logsContractV1.observables,
-                {
-                    name: "lastLogTime",
-                    description: "last time a log was written",
-                    valueType: field_type_1.FieldType.number,
-                    writable: false,
-                },
-            ],
-        };
-        const providerV2 = {
-            ...providerV1,
-            version: 2,
-            observables: {
-                ...providerV1.observables,
-                lastLogTime: lastLogTimeObs,
-            },
-            observableWritability: {
-                ...providerV1.observableWritability,
-                lastLogTime: false,
-            },
-        };
-        const { consumer: consumerV1 } = inProcessConsumer(logsContractV1, providerV1);
-        const { consumer: consumerV2 } = inProcessConsumer(logsContractV2, providerV2);
-        await Promise.all([consumerV1.loadingPromise, consumerV2.loadingPromise]);
-        await consumerV1.tools.logText("log1");
-        expect(logs).toEqual(["log1"]);
-        let observedLogCount = consumerV1.observables.logCount();
-        expect(observedLogCount).toBe(1);
-        let resolveSecondLog;
-        const secondLogObserved = new Promise((resolve) => {
-            resolveSecondLog = resolve;
-        });
-        const observedSub = consumerV2.observables.logCount.subscribe((value) => {
-            observedLogCount = value;
-            if (value === 2) {
-                resolveSecondLog();
-            }
-        });
-        cleanups.push(() => observedSub.dispose());
-        await consumerV2.tools.logText("log2");
-        await secondLogObserved;
-        expect(logs).toEqual(["log1", "log2"]);
-        expect(observedLogCount).toBe(2);
-        // TODO test tables so we can see what this looks like and how it works for both providers and consumers
-        // TODO consider renaming ContractResolution to ContractProviderInstance or something like that.  ContractResolution is awkward.
-    });
-});

package/dist/contracts/__tests__/registry.test.d.ts

@@ -1 +0,0 @@
-export {};