doover-js 0.5.3 → 0.6.0

package/dist/viewer/doover-data-provider.js

@@ -6,113 +6,50 @@ const aggregates_api_1 = require("../apis/aggregates-api");
 const channels_api_1 = require("../apis/channels-api");
 const connections_api_1 = require("../apis/connections-api");
 const messages_api_1 = require("../apis/messages-api");
+const users_api_1 = require("../apis/users-api");
 const gateway_client_1 = require("../gateway/gateway-client");
 const errors_1 = require("../http/errors");
 const rest_client_1 = require("../http/rest-client");
-const snowflake_1 = require("../utils/snowflake");
+const rpc_dispatcher_1 = require("../rpc/rpc-dispatcher");
 const path_parsing_1 = require("./path-parsing");
-function isRpcMessageData(data) {
-    return (typeof data === "object" &&
-        data !== null &&
-        "status" in data &&
-        "method" in data &&
-        "request" in data);
-}
-function isPlainObject(value) {
-    return (typeof value === "object" &&
-        value !== null &&
-        !Array.isArray(value));
-}
+/** @deprecated Use DooverClient subclients directly. Removed in 0.6.0. */
 class DooverDataProvider {
-    constructor(config, auth) {
-        this.config = config;
-        this.subscriptions = new Map();
-        this.rest = new rest_client_1.RestClient(config, auth);
-        this.gateway = new gateway_client_1.GatewayClient(config, auth);
-        this.agentsApi = new agents_api_1.AgentsApi(this.rest);
+    // implementation
+    constructor(configOrInjected, auth) {
+        this.bridges = new Map();
+        if ("rest" in configOrInjected && "gateway" in configOrInjected) {
+            this.rest = configOrInjected.rest;
+            this.gateway = configOrInjected.gateway;
+            this.controlApiUrl = configOrInjected.controlApiUrl;
+        }
+        else {
+            this.rest = new rest_client_1.RestClient(configOrInjected, auth);
+            this.gateway = new gateway_client_1.GatewayClient(configOrInjected, auth);
+            this.controlApiUrl = configOrInjected.controlApiUrl;
+        }
+        this.agentsApi = new agents_api_1.AgentsApi(this.rest, this.controlApiUrl);
         this.channelsApi = new channels_api_1.ChannelsApi(this.rest);
         this.messagesApi = new messages_api_1.MessagesApi(this.rest);
         this.aggregatesApi = new aggregates_api_1.AggregatesApi(this.rest);
         this.connectionsApi = new connections_api_1.ConnectionsApi(this.rest);
-        this.gateway.on("messageCreate", (message) => {
-            const key = this.channelKey(message.channel.agent_id, message.channel.name);
-            const identifier = this.toIdentifier(message.channel.agent_id, message.channel.name);
-            this.subscriptions.get(key)?.forEach((entry) => entry.messageCallback(identifier, message));
-        });
-        this.gateway.on("messageUpdate", (message, request_data) => {
-            const key = this.channelKey(message.channel.agent_id, message.channel.name);
-            const identifier = this.toIdentifier(message.channel.agent_id, message.channel.name);
-            this.subscriptions.get(key)?.forEach((entry) => entry.messageUpdateCallback?.(identifier, message, request_data));
-        });
-        this.gateway.on("channelSync", (event) => {
-            const key = this.channelKey(event.channel.agent_id, event.channel.name);
-            const identifier = this.toIdentifier(event.channel.agent_id, event.channel.name);
-            this.subscriptions.get(key)?.forEach((entry) => entry.aggregateCallback(identifier, event.aggregate));
-        });
-        this.gateway.on("aggregateUpdate", (event) => {
-            const key = this.channelKey(event.channel.agent_id, event.channel.name);
-            const identifier = this.toIdentifier(event.channel.agent_id, event.channel.name);
-            this.subscriptions.get(key)?.forEach((entry) => entry.aggregateCallback(identifier, event.aggregate));
-        });
     }
+    /** @deprecated Use `client.users.getMe()` instead. Removed in 0.6.0. */
     getMe() {
-        return this.rest.get("/users/me", undefined, this.config.controlApiUrl);
+        return new users_api_1.UsersApi(this.rest, this.controlApiUrl).getMe();
     }
+    /** @deprecated Use `client.agents.listAgents(opts)` instead. Removed in 0.6.0. */
     async getAgents(options) {
-        const query = {};
-        if (options?.includeArchived) {
-            query["include-archived"] = true;
-        }
-        if (options?.includeOrganisations) {
-            query["include-organisations"] = true;
-        }
-        if (options?.includeUsers) {
-            query["include-users"] = true;
-        }
-        const raw = await this.rest.request({
-            path: "/agents/",
-            baseUrl: this.config.controlApiUrl,
-            omitSharingHeader: true,
-            query: Object.keys(query).length > 0 ? query : undefined,
-        });
-        const rawAgents = Array.isArray(raw.agents) ? raw.agents : [];
-        const normalizedAgents = rawAgents.map((agent) => this.normalizeAgentEntry(agent));
-        if (!options?.mergeIncludedAsAgents) {
-            return {
-                ...raw,
-                agents: normalizedAgents,
-            };
-        }
-        const merged = [...normalizedAgents];
-        if (options.includeOrganisations) {
-            const rawOrganisations = Array.isArray(raw.organisations)
-                ? raw.organisations
-                : [];
-            for (const org of rawOrganisations) {
-                merged.push(this.normalizeOrganisationEntry(org));
-            }
-        }
-        if (options.includeUsers) {
-            const rawUsers = Array.isArray(raw.users) ? raw.users : [];
-            for (const user of rawUsers) {
-                merged.push(this.normalizeUserEntry(user));
-            }
-        }
-        return {
-            ...raw,
-            agents: merged,
-            results: merged,
-            count: merged.length,
-        };
+        return this.agentsApi.listAgents(options);
     }
+    /** @deprecated Use `client.channels.listChannels(id, opts)` instead. Removed in 0.6.0. */
     async getChannels(identifier, options) {
-        if (!identifier.agentId) {
+        if (!identifier.agentId)
             return undefined;
-        }
         return this.channelsApi.listChannels(identifier.agentId, {
             include_archived: options?.includeArchived,
         });
     }
+    /** @deprecated Use `client.channels.putChannel(id, name, body)` instead. Removed in 0.6.0. */
     createChannel(identifier, channelName, options) {
         if (!identifier.agentId) {
             throw new errors_1.DooverValidationError("Identifier must contain agentId");
@@ -121,179 +58,114 @@ class DooverDataProvider {
             is_private: options?.is_private ?? false,
         });
     }
+    /** @deprecated Use `client.channels.archiveChannel(id)` instead. Removed in 0.6.0. */
     archiveChannel(identifier) {
-        const validated = this.requireChannel(identifier);
-        return this.rest.post(`/agents/${validated.agentId}/channels/${validated.channelName}/archive`, {});
+        const v = this.requireChannel(identifier);
+        return this.channelsApi.archiveChannel(v.agentId, v.channelName);
     }
+    /** @deprecated Use `client.channels.unarchiveChannel(id)` instead. Removed in 0.6.0. */
     unarchiveChannel(identifier) {
-        const validated = this.requireChannel(identifier);
-        return this.rest.post(`/agents/${validated.agentId}/channels/${validated.channelName}/unarchive`, {});
+        const v = this.requireChannel(identifier);
+        return this.channelsApi.unarchiveChannel(v.agentId, v.channelName);
     }
+    /** @deprecated Use `client.channels.getChannel(id)` instead. Removed in 0.6.0. */
     getChannel(identifier) {
         if (!identifier.agentId || !identifier.channelName) {
             return Promise.resolve(undefined);
         }
         return this.channelsApi.getChannel(identifier.agentId, identifier.channelName);
     }
+    /** @deprecated Use `client.gateway.subscribeToChannel(channel, handlers)` instead. Removed in 0.6.0. */
     async subscribeToChannel(identifier, callback, aggregateCallback, messageUpdateCallback) {
         const validated = this.requireChannel(identifier);
-        const key = this.channelKey(validated.agentId, validated.channelName);
-        const entries = this.subscriptions.get(key) ?? [];
-        entries.push({
-            messageCallback: callback,
-            aggregateCallback,
-            messageUpdateCallback,
+        const channel = { agent_id: validated.agentId, name: validated.channelName };
+        const off = this.gateway.subscribeToChannel(channel, {
+            onMessage: (msg) => callback(identifier, msg),
+            onAggregate: (agg) => aggregateCallback(identifier, agg),
+            onMessageUpdate: messageUpdateCallback
+                ? (msg, rd) => messageUpdateCallback(identifier, msg, rd)
+                : undefined,
         });
-        this.subscriptions.set(key, entries);
+        this.bridges.set(callback, off);
         await this.gateway.connect();
-        this.gateway.subscribe({
-            agent_id: validated.agentId,
-            name: validated.channelName,
-        });
-        return Promise.resolve();
     }
-    async unsubscribeFromChannel(identifier, callback) {
-        const validated = this.requireChannel(identifier);
-        const key = this.channelKey(validated.agentId, validated.channelName);
-        const entries = this.subscriptions.get(key);
-        if (!entries) {
-            return Promise.reject(new errors_1.DooverValidationError("Not Currently Subscribed to Channel"));
-        }
-        const next = entries.filter((entry) => entry.messageCallback !== callback);
-        if (next.length === 0) {
-            this.subscriptions.delete(key);
-            this.gateway.unsubscribe({
-                agent_id: validated.agentId,
-                name: validated.channelName,
-            });
-        }
-        else {
-            this.subscriptions.set(key, next);
+    /** @deprecated Call the unsubscribe fn returned by `client.gateway.subscribeToChannel`. Removed in 0.6.0. */
+    async unsubscribeFromChannel(_identifier, callback) {
+        const off = this.bridges.get(callback);
+        if (!off) {
+            throw new errors_1.DooverValidationError("Not Currently Subscribed to Channel");
         }
-        return Promise.resolve();
+        off();
+        this.bridges.delete(callback);
     }
+    /** @deprecated Compose `client.channels.getChannel(id).then(c => c.aggregate ?? client.aggregates.getAggregate(id))` instead. Removed in 0.6.0. */
     async getAggregate(identifier) {
-        if (!identifier.agentId || !identifier.channelName) {
+        if (!identifier.agentId || !identifier.channelName)
             return undefined;
-        }
-        const channel = await this.channelsApi.getChannel(identifier.agentId, identifier.channelName);
-        if (channel.aggregate) {
-            return channel.aggregate;
-        }
+        const ch = await this.channelsApi.getChannel(identifier.agentId, identifier.channelName);
+        if (ch.aggregate)
+            return ch.aggregate;
         return this.aggregatesApi.getAggregate(identifier.agentId, identifier.channelName);
     }
-    /**
-     * Fetch a page of messages for a channel.
-     *
-     * Accepts either a cursor string (legacy — shorthand for `{ before }`)
-     * or a `ListMessagesParams` options object.
-     *
-     * Default limit is 10 for backwards compatibility; pass `limit` explicitly
-     * for larger pages.
-     */
+    /** @deprecated Use `client.messages.listMessages(id, { ...opts, order: "asc" })` instead. Removed in 0.6.0. */
     async getMessages(identifier, optionsOrBefore) {
-        if (!identifier.agentId || !identifier.channelName) {
+        if (!identifier.agentId || !identifier.channelName)
             return undefined;
-        }
-        const options = typeof optionsOrBefore === "string"
+        const params = typeof optionsOrBefore === "string"
             ? { before: optionsOrBefore }
             : (optionsOrBefore ?? {});
-        const messages = await this.messagesApi.listMessages(identifier.agentId, identifier.channelName, {
-            before: options.before ?? (0, snowflake_1.generateSnowflakeIdAtTime)(new Date()),
-            limit: options.limit ?? 10,
-            ...(options.after !== undefined ? { after: options.after } : {}),
-            ...(options.field_name !== undefined ? { field_name: options.field_name } : {}),
+        return this.messagesApi.listMessages(identifier.agentId, identifier.channelName, {
+            ...params,
+            order: "asc",
         });
-        return messages.reverse();
     }
+    /** @deprecated Use `client.messages.deleteMessage(id, msgId)` instead. Removed in 0.6.0. */
     deleteMessage(identifier, messageId) {
-        const validated = this.requireChannel(identifier);
-        return this.messagesApi.deleteMessage(validated.agentId, validated.channelName, messageId);
+        const v = this.requireChannel(identifier);
+        return this.messagesApi.deleteMessage(v.agentId, v.channelName, messageId);
     }
+    /** @deprecated Use `client.messages.postMessage(id, { data })` instead. Removed in 0.6.0. */
     sendMessage(identifier, message) {
-        const validated = this.requireChannel(identifier);
-        return this.messagesApi.postMessage(validated.agentId, validated.channelName, {
+        const v = this.requireChannel(identifier);
+        return this.messagesApi.postMessage(v.agentId, v.channelName, {
             data: message,
         });
     }
-    /**
-     * Send a message-based RPC to a channel and await a settled response.
-     *
-     * Wire protocol: POST a message with `{ type: "rpc", ...rpcRequest }`; the
-     * server echoes progress via `MessageUpdate` events keyed by the message id,
-     * carrying a `status` envelope. Resolves on `success` with the `response`
-     * payload, rejects on `error` with the status message.
-     *
-     * For low-latency ephemeral commands (camera PTZ etc.), use
-     * `gateway.sendOneShotMessage` directly instead — that path is not persisted
-     * to the database.
-     *
-     * `onStatus` fires on every intermediate status (`sent`, `acknowledged`,
-     * `deferred`, `pending`) and once more on terminal states.
-     */
+    /** @deprecated Use `client.rpc.send(id, req, opts)` instead. Removed in 0.6.0. */
     sendRPC(identifier, rpcRequest, options) {
-        return new Promise((resolve, reject) => {
-            let rpcMessageId;
-            let settled = false;
-            const onUpdate = (_identifier, message) => {
-                if (settled)
-                    return;
-                if (rpcMessageId === undefined || message.id !== rpcMessageId)
-                    return;
-                if (!isRpcMessageData(message.data))
-                    return;
-                const rpcMessage = message.data;
-                options?.onStatus?.(rpcMessage.status);
-                if (rpcMessage.status.code === "success") {
-                    settled = true;
-                    void this.unsubscribeFromChannel(identifier, noopMessageCallback);
-                    resolve(rpcMessage.response);
-                }
-                else if (rpcMessage.status.code === "error") {
-                    settled = true;
-                    void this.unsubscribeFromChannel(identifier, noopMessageCallback);
-                    reject(rpcMessage.status.message);
-                }
-            };
-            // noopMessageCallback is used as the identity handle for this
-            // subscription — subscribe/unsubscribe pair matches by reference.
-            const noopMessageCallback = () => { };
-            const noopAggregateCallback = () => { };
-            this.subscribeToChannel(identifier, noopMessageCallback, noopAggregateCallback, onUpdate)
-                .then(() => this.sendMessage(identifier, { type: "rpc", ...rpcRequest }))
-                .then((message) => {
-                rpcMessageId = message.id;
-            })
-                .catch((error) => {
-                if (settled)
-                    return;
-                settled = true;
-                void this.unsubscribeFromChannel(identifier, noopMessageCallback);
-                reject(error);
-            });
-        });
+        const v = this.requireChannel(identifier);
+        if (!this.dispatcher) {
+            this.dispatcher = new rpc_dispatcher_1.RpcDispatcher(this.gateway, this.messagesApi);
+        }
+        return this.dispatcher.send({ agentId: v.agentId, channelName: v.channelName }, rpcRequest, options);
     }
+    /** @deprecated Use `client.aggregates.patchAggregate(id, data, params)` instead. Removed in 0.6.0. */
     updateAggregate(identifier, message, params) {
-        const validated = this.requireChannel(identifier);
-        return this.aggregatesApi.patchAggregate(validated.agentId, validated.channelName, message, params);
+        const v = this.requireChannel(identifier);
+        return this.aggregatesApi.patchAggregate(v.agentId, v.channelName, message, params);
     }
+    /** @deprecated Use `client.aggregates.putAggregate(id, data, params)` instead. Removed in 0.6.0. */
     putAggregate(identifier, message, params) {
-        const validated = this.requireChannel(identifier);
-        return this.aggregatesApi.putAggregate(validated.agentId, validated.channelName, message, params);
+        const v = this.requireChannel(identifier);
+        return this.aggregatesApi.putAggregate(v.agentId, v.channelName, message, params);
     }
+    /** @deprecated Use `client.connections.getChannelSubscriptions(id)` instead. Removed in 0.6.0. */
     getChannelSubscriptions(identifier) {
-        const validated = this.requireChannel(identifier);
-        return this.connectionsApi.getChannelSubscriptions(validated.agentId, validated.channelName);
+        const v = this.requireChannel(identifier);
+        return this.connectionsApi.getChannelSubscriptions(v.agentId, v.channelName);
     }
+    /** @deprecated Use `client.connections.getAgentConnections(id)` instead. Removed in 0.6.0. */
     getAgentConnections(identifier) {
         if (!identifier.agentId) {
             return Promise.reject(new errors_1.DooverValidationError("Invalid Identifier"));
         }
         return this.connectionsApi.getAgentConnections(identifier.agentId);
     }
+    /** @deprecated Use the free function `getIdentifierFromPath(path, search)` instead. Removed in 0.6.0. */
     getIdentifierFromPath(path, searchParams) {
         return (0, path_parsing_1.getIdentifierFromPath)(path, searchParams);
     }
+    /** @deprecated No replacement — this was a synthesized stub. Removed in 0.6.0. */
     getAgentInfo(agentId) {
         return Promise.resolve({
             id: agentId,
@@ -308,106 +180,6 @@ class DooverDataProvider {
             extra_config: {},
         });
     }
-    normalizeAgentEntry(rawAgent) {
-        const source = isPlainObject(rawAgent)
-            ? rawAgent
-            : {};
-        const fixedLocation = source.fixed_location;
-        const normalizedFixedLocation = isPlainObject(fixedLocation) &&
-            typeof fixedLocation.latitude === "number" &&
-            typeof fixedLocation.longitude === "number"
-            ? {
-                latitude: fixedLocation.latitude,
-                longitude: fixedLocation.longitude,
-            }
-            : { latitude: 0, longitude: 0 };
-        const faIcon = typeof source.fa_icon === "string" && source.fa_icon.length > 0
-            ? source.fa_icon
-            : "fa-solid fa-robot";
-        return {
-            ...source,
-            id: typeof source.id === "string" ? source.id : String(source.id ?? ""),
-            organisation: typeof source.organisation === "string" ? source.organisation : "",
-            name: typeof source.name === "string" ? source.name : "",
-            display_name: typeof source.display_name === "string" ? source.display_name : "",
-            archived: typeof source.archived === "boolean" ? source.archived : false,
-            group: typeof source.group === "string" ? source.group : "",
-            fa_icon: faIcon,
-            type: source.type === "device" ||
-                source.type === "dashboard" ||
-                source.type === "organisation" ||
-                source.type === "user"
-                ? source.type
-                : "device",
-            fixed_location: normalizedFixedLocation,
-            extra_config: this.coerceExtraConfig(source.extra_config),
-        };
-    }
-    normalizeOrganisationEntry(rawOrganisation) {
-        const source = isPlainObject(rawOrganisation)
-            ? rawOrganisation
-            : {};
-        const name = typeof source.name === "string" ? source.name : "";
-        const rootGroup = isPlainObject(source.root_group) ? source.root_group : null;
-        const groupName = rootGroup && typeof rootGroup.name === "string" ? rootGroup.name : "";
-        return {
-            id: typeof source.id === "string" ? source.id : String(source.id ?? ""),
-            organisation: name,
-            name,
-            display_name: name,
-            archived: typeof source.archived === "boolean" ? source.archived : false,
-            group: groupName,
-            fa_icon: "fa-solid fa-building",
-            type: "organisation",
-            fixed_location: { latitude: 0, longitude: 0 },
-            extra_config: this.coerceExtraConfig(source.extra_config),
-        };
-    }
-    normalizeUserEntry(rawUser) {
-        const source = isPlainObject(rawUser)
-            ? rawUser
-            : {};
-        const id = typeof source.id === "string" ? source.id : String(source.id ?? "");
-        const username = typeof source.username === "string" ? source.username : "";
-        const email = typeof source.email === "string" ? source.email : "";
-        const name = username !== "" ? username : email !== "" ? email : id;
-        return {
-            id,
-            organisation: "",
-            name,
-            display_name: this.buildUserDisplayName(source),
-            archived: false,
-            group: "",
-            fa_icon: "fa-solid fa-user",
-            type: "user",
-            fixed_location: { latitude: 0, longitude: 0 },
-            extra_config: this.coerceExtraConfig(source.custom_data),
-        };
-    }
-    buildUserDisplayName(rawUser) {
-        const source = isPlainObject(rawUser)
-            ? rawUser
-            : {};
-        const firstName = typeof source.first_name === "string" ? source.first_name.trim() : "";
-        const lastName = typeof source.last_name === "string" ? source.last_name.trim() : "";
-        const fullName = `${firstName} ${lastName}`.trim();
-        if (fullName !== "") {
-            return fullName;
-        }
-        if (typeof source.username === "string" && source.username !== "") {
-            return source.username;
-        }
-        if (typeof source.email === "string" && source.email !== "") {
-            return source.email;
-        }
-        if (typeof source.id === "string" && source.id !== "") {
-            return source.id;
-        }
-        return String(source.id ?? "");
-    }
-    coerceExtraConfig(value) {
-        return isPlainObject(value) ? value : {};
-    }
     requireChannel(identifier) {
         if (!identifier.agentId || !identifier.channelName) {
             throw new errors_1.DooverValidationError("Identifier must contain agentId and channelName");
@@ -417,11 +189,5 @@ class DooverDataProvider {
             channelName: identifier.channelName,
         };
     }
-    channelKey(agentId, channelName) {
-        return `${agentId}/${channelName}`;
-    }
-    toIdentifier(agentId, channelName) {
-        return { agentId, channelName };
-    }
 }
 exports.DooverDataProvider = DooverDataProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doover-js",
-  "version": "0.5.3",
+  "version": "0.6.0",
   "description": "TypeScript client for Doover.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",