doover-js 0.11.0 → 0.13.0

package/dist/test/api-args.test.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chai_1 = require("chai");
-const _args_1 = require("../apis/_args");
-describe("resolveChannelArgs", () => {
-    it("parses positional (agentId, channelName)", () => {
-        const result = (0, _args_1.resolveChannelArgs)(["a1", "c1"]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", channelName: "c1", options: undefined });
-    });
-    it("parses positional with options", () => {
-        const result = (0, _args_1.resolveChannelArgs)(["a1", "c1", { x: 7 }]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", channelName: "c1", options: { x: 7 } });
-    });
-    it("parses identifier object", () => {
-        const result = (0, _args_1.resolveChannelArgs)([
-            { agentId: "a1", channelName: "c1" },
-        ]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", channelName: "c1", options: undefined });
-    });
-    it("parses identifier object with options", () => {
-        const result = (0, _args_1.resolveChannelArgs)([
-            { agentId: "a1", channelName: "c1" },
-            { x: 7 },
-        ]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", channelName: "c1", options: { x: 7 } });
-    });
-});
-describe("resolveAgentArgs", () => {
-    it("parses positional agentId", () => {
-        const result = (0, _args_1.resolveAgentArgs)(["a1"]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", options: undefined });
-    });
-    it("parses positional with options", () => {
-        const result = (0, _args_1.resolveAgentArgs)(["a1", { archived: true }]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", options: { archived: true } });
-    });
-    it("parses identifier object", () => {
-        const result = (0, _args_1.resolveAgentArgs)([{ agentId: "a1" }]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", options: undefined });
-    });
-    it("parses identifier object with options", () => {
-        const result = (0, _args_1.resolveAgentArgs)([
-            { agentId: "a1" },
-            { archived: true },
-        ]);
-        (0, chai_1.expect)(result).to.deep.equal({ agentId: "a1", options: { archived: true } });
-    });
-});

package/dist/test/api-overloads.test.d.ts

@@ -1,9 +0,0 @@
-import type { RestClient } from "../http/rest-client";
-interface RecordedCall {
-    method: "get" | "post" | "put" | "patch" | "delete" | "request";
-    args: unknown[];
-}
-export declare function makeRestStub(): RestClient & {
-    calls: RecordedCall[];
-};
-export {};

package/dist/test/api-overloads.test.js

@@ -1,330 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeRestStub = makeRestStub;
-const chai_1 = require("chai");
-const channels_api_1 = require("../apis/channels-api");
-const messages_api_1 = require("../apis/messages-api");
-function makeRestStub() {
-    const calls = [];
-    const stub = {
-        calls,
-        get: (...args) => {
-            calls.push({ method: "get", args });
-            return Promise.resolve([]);
-        },
-        post: (...args) => {
-            calls.push({ method: "post", args });
-            return Promise.resolve(undefined);
-        },
-        put: (...args) => {
-            calls.push({ method: "put", args });
-            return Promise.resolve(undefined);
-        },
-        patch: (...args) => {
-            calls.push({ method: "patch", args });
-            return Promise.resolve(undefined);
-        },
-        delete: (...args) => {
-            calls.push({ method: "delete", args });
-            return Promise.resolve(undefined);
-        },
-        request: (...args) => {
-            calls.push({ method: "request", args });
-            return Promise.resolve(undefined);
-        },
-    };
-    return stub;
-}
-describe("ChannelsApi overloads", () => {
-    it("getChannel positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new channels_api_1.ChannelsApi(restA);
-        const apiB = new channels_api_1.ChannelsApi(restB);
-        await apiA.getChannel("a1", "c1", { include_aggregate: true });
-        await apiB.getChannel({ agentId: "a1", channelName: "c1" }, { include_aggregate: true });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-    it("listChannels positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new channels_api_1.ChannelsApi(restA);
-        const apiB = new channels_api_1.ChannelsApi(restB);
-        await apiA.listChannels("a1", { include_archived: true });
-        await apiB.listChannels({ agentId: "a1" }, { include_archived: true });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-    it("archiveChannel posts to /archive", async () => {
-        const rest = makeRestStub();
-        const api = new channels_api_1.ChannelsApi(rest);
-        await api.archiveChannel("a1", "c1");
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            { method: "post", args: ["/agents/a1/channels/c1/archive", {}] },
-        ]);
-    });
-    it("unarchiveChannel posts to /unarchive", async () => {
-        const rest = makeRestStub();
-        const api = new channels_api_1.ChannelsApi(rest);
-        await api.unarchiveChannel({ agentId: "a1", channelName: "c1" });
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            { method: "post", args: ["/agents/a1/channels/c1/unarchive", {}] },
-        ]);
-    });
-});
-describe("MessagesApi overloads + defaults", () => {
-    it("listMessages positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new messages_api_1.MessagesApi(restA);
-        const apiB = new messages_api_1.MessagesApi(restB);
-        const before = "185536526405337088";
-        await apiA.listMessages("a1", "c1", { limit: 5, order: "desc", before });
-        await apiB.listMessages({ agentId: "a1", channelName: "c1" }, { limit: 5, order: "desc", before });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-    it("listMessages defaults limit to 10 when omitted", async () => {
-        const rest = makeRestStub();
-        const api = new messages_api_1.MessagesApi(rest);
-        await api.listMessages("a1", "c1");
-        (0, chai_1.expect)(rest.calls).to.have.lengthOf(1);
-        const params = rest.calls[0].args[1];
-        (0, chai_1.expect)(params.limit).to.equal(10);
-        (0, chai_1.expect)(params.before, "before should be set to a snowflake id").to.be.a("string");
-    });
-    it("listMessages with order='asc' reverses the response array", async () => {
-        const rest = makeRestStub();
-        rest.get = ((..._args) => Promise.resolve([
-            { id: "3", data: {}, attachments: [], author_id: "a", channel: { agent_id: "a1", name: "c1" } },
-            { id: "2", data: {}, attachments: [], author_id: "a", channel: { agent_id: "a1", name: "c1" } },
-            { id: "1", data: {}, attachments: [], author_id: "a", channel: { agent_id: "a1", name: "c1" } },
-        ]));
-        const api = new messages_api_1.MessagesApi(rest);
-        const result = await api.listMessages("a1", "c1", { order: "asc", limit: 3 });
-        (0, chai_1.expect)(result.map((m) => m.id)).to.deep.equal(["1", "2", "3"]);
-    });
-    it("listMessages with order='desc' (default) preserves server order", async () => {
-        const rest = makeRestStub();
-        rest.get = ((..._args) => Promise.resolve([
-            { id: "3", data: {}, attachments: [], author_id: "a", channel: { agent_id: "a1", name: "c1" } },
-            { id: "2", data: {}, attachments: [], author_id: "a", channel: { agent_id: "a1", name: "c1" } },
-        ]));
-        const api = new messages_api_1.MessagesApi(rest);
-        const result = await api.listMessages("a1", "c1", { limit: 2 });
-        (0, chai_1.expect)(result.map((m) => m.id)).to.deep.equal(["3", "2"]);
-    });
-    it("getTimeseries strips order before sending to server", async () => {
-        const rest = makeRestStub();
-        const api = new messages_api_1.MessagesApi(rest);
-        await api.getTimeseries("a1", "c1", { limit: 5, order: "asc" });
-        (0, chai_1.expect)(rest.calls).to.have.lengthOf(1);
-        const wireParams = rest.calls[0].args[1];
-        (0, chai_1.expect)(wireParams.order).to.equal(undefined);
-        (0, chai_1.expect)(wireParams.limit).to.equal(5);
-    });
-    it("getTimeseries forwards paginate to the server", async () => {
-        const rest = makeRestStub();
-        const api = new messages_api_1.MessagesApi(rest);
-        await api.getTimeseries("a1", "c1", { limit: 1500, paginate: true });
-        const wireParams = rest.calls[0].args[1];
-        (0, chai_1.expect)(wireParams.paginate).to.equal(true);
-        (0, chai_1.expect)(wireParams.limit).to.equal(1500);
-    });
-});
-const aggregates_api_1 = require("../apis/aggregates-api");
-describe("AggregatesApi overloads", () => {
-    it("getAggregate positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new aggregates_api_1.AggregatesApi(restA);
-        const apiB = new aggregates_api_1.AggregatesApi(restB);
-        await apiA.getAggregate("a1", "c1");
-        await apiB.getAggregate({ agentId: "a1", channelName: "c1" });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-    it("patchAggregate identifier form passes through body and params", async () => {
-        const rest = makeRestStub();
-        const api = new aggregates_api_1.AggregatesApi(rest);
-        await api.patchAggregate({ agentId: "a1", channelName: "c1" }, { x: 1 }, { suppress_response: true });
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            {
-                method: "patch",
-                args: ["/agents/a1/channels/c1/aggregate", { x: 1 }, { suppress_response: true }],
-            },
-        ]);
-    });
-});
-const alarms_api_1 = require("../apis/alarms-api");
-describe("AlarmsApi overloads", () => {
-    it("listAlarms positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new alarms_api_1.AlarmsApi(restA);
-        const apiB = new alarms_api_1.AlarmsApi(restB);
-        await apiA.listAlarms("a1", "c1");
-        await apiB.listAlarms({ agentId: "a1", channelName: "c1" });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-    it("getAlarm via identifier hits expected path", async () => {
-        const rest = makeRestStub();
-        const api = new alarms_api_1.AlarmsApi(rest);
-        await api.getAlarm({ agentId: "a1", channelName: "c1" }, "alm1");
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            { method: "get", args: ["/agents/a1/channels/c1/alarms/alm1"] },
-        ]);
-    });
-});
-const connections_api_1 = require("../apis/connections-api");
-describe("ConnectionsApi overloads", () => {
-    it("getAgentConnections positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new connections_api_1.ConnectionsApi(restA);
-        const apiB = new connections_api_1.ConnectionsApi(restB);
-        await apiA.getAgentConnections("a1");
-        await apiB.getAgentConnections({ agentId: "a1" });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-    it("getChannelSubscriptions identifier form hits expected path", async () => {
-        const rest = makeRestStub();
-        const api = new connections_api_1.ConnectionsApi(rest);
-        await api.getChannelSubscriptions({ agentId: "a1", channelName: "c1" });
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            { method: "get", args: ["/agents/a1/channels/c1/subscriptions"] },
-        ]);
-    });
-});
-const notifications_api_1 = require("../apis/notifications-api");
-describe("NotificationsApi overloads", () => {
-    it("getAgentNotifications positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new notifications_api_1.NotificationsApi(restA);
-        const apiB = new notifications_api_1.NotificationsApi(restB);
-        await apiA.getAgentNotifications("a1");
-        await apiB.getAgentNotifications({ agentId: "a1" });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-    it("updateNotificationEndpoint identifier form preserves endpointId and body", async () => {
-        const rest = makeRestStub();
-        const api = new notifications_api_1.NotificationsApi(rest);
-        await api.updateNotificationEndpoint({ agentId: "a1" }, "ep1", { name: "x" });
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            {
-                method: "patch",
-                args: ["/agents/a1/notifications/endpoints/ep1", { name: "x" }],
-            },
-        ]);
-    });
-});
-const permissions_api_1 = require("../apis/permissions-api");
-describe("PermissionsApi overloads", () => {
-    it("getAgentPermission positional and identifier-object produce identical requests", async () => {
-        const restA = makeRestStub();
-        const restB = makeRestStub();
-        const apiA = new permissions_api_1.PermissionsApi(restA);
-        const apiB = new permissions_api_1.PermissionsApi(restB);
-        await apiA.getAgentPermission("a1");
-        await apiB.getAgentPermission({ agentId: "a1" });
-        (0, chai_1.expect)(restA.calls).to.deep.equal(restB.calls);
-    });
-});
-const processors_api_1 = require("../apis/processors-api");
-describe("ProcessorsApi overloads", () => {
-    it("createProcessorSchedule identifier form hits expected path", async () => {
-        const rest = makeRestStub();
-        const api = new processors_api_1.ProcessorsApi(rest);
-        await api.createProcessorSchedule({ agentId: "a1" }, "sch1", { foo: "bar" });
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            {
-                method: "put",
-                args: ["/agents/a1/processors/schedules/sch1", { foo: "bar" }],
-            },
-        ]);
-    });
-});
-const agents_api_1 = require("../apis/agents-api");
-const organisations_api_1 = require("../apis/organisations-api");
-describe("AgentsApi listAgents", () => {
-    it("calls /agents/ on controlApiUrl with omitSharingHeader", async () => {
-        const rest = makeRestStub();
-        const api = new agents_api_1.AgentsApi(rest, "https://control.example.com");
-        rest.request = ((...args) => {
-            rest.calls.push({ method: "request", args });
-            return Promise.resolve({ agents: [] });
-        });
-        await api.listAgents({ includeArchived: true });
-        (0, chai_1.expect)(rest.calls).to.have.lengthOf(1);
-        (0, chai_1.expect)(rest.calls[0].method).to.equal("request");
-        const req = rest.calls[0].args[0];
-        (0, chai_1.expect)(req.path).to.equal("/agents/");
-        (0, chai_1.expect)(req.baseUrl).to.equal("https://control.example.com");
-        (0, chai_1.expect)(req.omitSharingHeader).to.equal(true);
-        (0, chai_1.expect)(req.query).to.deep.equal({ "include-archived": true });
-    });
-    it("normalises agent entries and merges organisations/users when requested", async () => {
-        const rest = makeRestStub();
-        rest.request = ((..._args) => Promise.resolve({
-            agents: [
-                { id: "a1", name: "Agent One", type: "device" },
-            ],
-            organisations: [{ id: "o1", name: "Org One" }],
-            users: [{ id: "u1", name: "User One" }],
-        }));
-        const api = new agents_api_1.AgentsApi(rest);
-        const result = await api.listAgents({
-            includeOrganisations: true,
-            includeUsers: true,
-            mergeIncludedAsAgents: true,
-        });
-        (0, chai_1.expect)(result.results).to.have.lengthOf(3);
-        (0, chai_1.expect)(result.count).to.equal(3);
-        const ids = (result.results ?? []).map((a) => a.id).sort();
-        (0, chai_1.expect)(ids).to.deep.equal(["a1", "o1", "u1"]);
-        const types = (result.results ?? []).map((a) => a.type).sort();
-        (0, chai_1.expect)(types).to.deep.equal(["device", "organisation", "user"]);
-    });
-});
-describe("OrganisationsApi", () => {
-    it("lists organisations on controlApiUrl with expected query params", async () => {
-        const rest = makeRestStub();
-        const api = new organisations_api_1.OrganisationsApi(rest, "https://control.example.com");
-        rest.get = ((...args) => {
-            rest.calls.push({ method: "get", args });
-            return Promise.resolve({ count: 0, results: [] });
-        });
-        await api.listOrganisations({
-            page: 2,
-            perPage: 50,
-            search: "pump",
-            archived: false,
-        });
-        (0, chai_1.expect)(rest.calls).to.deep.equal([
-            {
-                method: "get",
-                args: [
-                    "/organisations/",
-                    { page: 2, per_page: 50, search: "pump", archived: false },
-                    "https://control.example.com",
-                ],
-            },
-        ]);
-    });
-    it("maps an organisation to customer-site bootstrap shape", () => {
-        const rest = makeRestStub();
-        const api = new organisations_api_1.OrganisationsApi(rest);
-        (0, chai_1.expect)(api.toCustomerSite({
-            id: "org-1",
-            name: "Org One",
-            archived: false,
-            application_id: "app-1",
-            domains: [],
-            theme: { accent_colour: "#0c71c3" },
-        })).to.deep.equal({
-            id: "org-1",
-            name: "Org One",
-            archived: false,
-            application_id: "app-1",
-            theme: { accent_colour: "#0c71c3" },
-        });
-    });
-});