doover-js 0.6.4 → 0.6.5

package/dist/apis/organisations-api.d.ts

@@ -0,0 +1,26 @@
+import type { RestClient } from "../http/rest-client";
+import type { CustomerSite, Organisation, PaginatedResponse } from "../types/viewer";
+export interface ListOrganisationsOptions {
+    page?: number;
+    perPage?: number;
+    search?: string;
+    archived?: boolean | "";
+    ordering?: string;
+    name?: string;
+    name__contains?: string;
+    name__icontains?: string;
+    id?: string | number;
+    [key: string]: string | number | boolean | "" | undefined;
+}
+export declare class OrganisationsApi {
+    private readonly rest;
+    private readonly controlApiUrl?;
+    constructor(rest: RestClient, controlApiUrl?: string | undefined);
+    listOrganisations(options?: ListOrganisationsOptions): Promise<PaginatedResponse<Organisation>>;
+    getOrganisation(id: string): Promise<Organisation>;
+    /**
+     * Convert an organisation record from `/organisations/` into the smaller
+     * customer-site bootstrap shape returned by `/site/`.
+     */
+    toCustomerSite(organisation: Organisation): CustomerSite;
+}

package/dist/apis/organisations-api.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganisationsApi = void 0;
+class OrganisationsApi {
+    constructor(rest, controlApiUrl) {
+        this.rest = rest;
+        this.controlApiUrl = controlApiUrl;
+    }
+    listOrganisations(options) {
+        return this.rest.get("/organisations/", buildListQuery(options), this.controlApiUrl);
+    }
+    getOrganisation(id) {
+        return this.rest.get(`/organisations/${id}/`, undefined, this.controlApiUrl);
+    }
+    /**
+     * Convert an organisation record from `/organisations/` into the smaller
+     * customer-site bootstrap shape returned by `/site/`.
+     */
+    toCustomerSite(organisation) {
+        return {
+            id: organisation.id,
+            name: organisation.name,
+            application_id: organisation.application_id,
+            archived: organisation.archived,
+            theme: organisation.theme ?? {},
+        };
+    }
+}
+exports.OrganisationsApi = OrganisationsApi;
+function buildListQuery(options) {
+    if (!options)
+        return undefined;
+    const { page, perPage, ...rest } = options;
+    const query = {};
+    if (page !== undefined)
+        query.page = page;
+    if (perPage !== undefined)
+        query.per_page = perPage;
+    for (const [key, value] of Object.entries(rest)) {
+        if (value === undefined)
+            continue;
+        query[key] = value;
+    }
+    return query;
+}

package/dist/auth/cookie-auth.d.ts

@@ -13,5 +13,6 @@ export declare class CookieAuth extends DooverAuth {
         headers?: Record<string, string>;
     }>;
     setToken(_token: string | null, _tokenExpires?: Date | number | null): void;
+    setRefreshToken(_refreshToken: string | null): void;
     ensureReady(): Promise<void>;
 }

package/dist/auth/cookie-auth.js

@@ -22,6 +22,9 @@ class CookieAuth extends doover_auth_1.DooverAuth {
     setToken(_token, _tokenExpires) {
         // No-op for cookie auth.
     }
+    setRefreshToken(_refreshToken) {
+        // No-op for cookie auth.
+    }
     async ensureReady() {
         // Nothing to prepare for cookie auth.
     }

package/dist/auth/doover-auth.d.ts

@@ -31,6 +31,11 @@ export declare abstract class DooverAuth {
      * Subclasses that do not use tokens may no-op.
      */
     abstract setToken(token: string | null, tokenExpires?: Date | number | null): void;
+    /**
+     * Imperatively set or clear the refresh token. Subclasses that do not use
+     * refresh tokens may no-op.
+     */
+    abstract setRefreshToken(refreshToken: string | null): void;
     /**
      * Ensure the auth layer is ready (e.g. token refreshed if needed).
      * Called before every HTTP request and before opening a websocket.

package/dist/auth/doover-token-auth.d.ts

@@ -26,6 +26,7 @@ export declare class DooverTokenAuth extends DooverAuth {
         headers?: Record<string, string>;
     }>;
     setToken(token: string | null, tokenExpires?: Date | number | null): void;
+    setRefreshToken(refreshToken: string | null): void;
     ensureReady(): Promise<void>;
     attachProfile(profile: AuthProfile, configManager?: AuthProfileStore): void;
     private needsRefresh;

package/dist/auth/doover-token-auth.js

@@ -48,6 +48,11 @@ class DooverTokenAuth extends doover_auth_1.DooverAuth {
     setToken(token, tokenExpires) {
         this.token = token;
         this.tokenExpires = this.resolveExpiry(tokenExpires, token);
+        this.persistToProfile();
+    }
+    setRefreshToken(refreshToken) {
+        this.refreshToken = refreshToken;
+        this.persistToProfile();
     }
     async ensureReady() {
         if (!this.needsRefresh()) {

package/dist/client/doover-client.d.ts

@@ -1,3 +1,4 @@
+import { OrganisationsApi } from "../apis/organisations-api";
 import type { DooverAuth } from "../auth/doover-auth";
 import { RestClient, type DooverClientConfig } from "../http/rest-client";
 import { DooverDataProvider } from "../viewer/doover-data-provider";
@@ -15,6 +16,7 @@ export declare class DooverClient implements DataClient {
     readonly alarms: AlarmsApiLike;
     readonly connections: ConnectionsApiLike;
     readonly notifications: NotificationsApiLike;
+    readonly organisations: OrganisationsApi;
     readonly permissions: PermissionsApiLike;
     readonly processors: ProcessorsApiLike;
     readonly turn: TurnApiLike;

package/dist/client/doover-client.js

@@ -8,6 +8,7 @@ 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 notifications_api_1 = require("../apis/notifications-api");
+const organisations_api_1 = require("../apis/organisations-api");
 const permissions_api_1 = require("../apis/permissions-api");
 const processors_api_1 = require("../apis/processors-api");
 const turn_api_1 = require("../apis/turn-api");
@@ -63,6 +64,7 @@ class DooverClient {
         this.alarms = (0, provenance_1.wrapSubclient)(new alarms_api_1.AlarmsApi(this.rest), "alarms", stamper);
         this.connections = (0, provenance_1.wrapSubclient)(new connections_api_1.ConnectionsApi(this.rest), "connections", stamper);
         this.notifications = (0, provenance_1.wrapSubclient)(new notifications_api_1.NotificationsApi(this.rest), "notifications", stamper);
+        this.organisations = (0, provenance_1.wrapSubclient)(new organisations_api_1.OrganisationsApi(this.rest, config.controlApiUrl), "organisations", stamper);
         this.permissions = (0, provenance_1.wrapSubclient)(new permissions_api_1.PermissionsApi(this.rest), "permissions", stamper);
         this.processors = (0, provenance_1.wrapSubclient)(new processors_api_1.ProcessorsApi(this.rest), "processors", stamper);
         this.turn = (0, provenance_1.wrapSubclient)(new turn_api_1.TurnApi(this.rest), "turn", stamper);

package/dist/http/rest-client.js

@@ -47,7 +47,7 @@ class RestClient {
         if (!options.omitSharingHeader) {
             headers.set("X-Doover-Sharing", this.config.sharing);
         }
-        if (this.config.organisationId) {
+        if (this.config.organisationId && !headers.has("X-Doover-Organisation")) {
             headers.set("X-Doover-Organisation", this.config.organisationId);
         }
         const impersonated = this.getImpersonatedUserId();

package/dist/index.d.ts

@@ -13,6 +13,8 @@ export { ChannelsApi } from "./apis/channels-api";
 export { ConnectionsApi } from "./apis/connections-api";
 export { MessagesApi } from "./apis/messages-api";
 export { NotificationsApi } from "./apis/notifications-api";
+export { OrganisationsApi } from "./apis/organisations-api";
+export type { ListOrganisationsOptions } from "./apis/organisations-api";
 export { PermissionsApi } from "./apis/permissions-api";
 export { ProcessorsApi } from "./apis/processors-api";
 export { TurnApi } from "./apis/turn-api";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSnowflakeIdAtTime = exports.extractSnowflakeId = exports.addTimestampToMessage = exports.DV_AUDIT_CHANNEL = exports.getIdentifierFromPath = exports.DooverDataProvider = exports.DooverValidationError = exports.DooverGatewayError = exports.DooverApiError = exports.RestClient = exports.GatewayClient = exports.buildAuth = exports.DooverAuthError = exports.AuthProfile = exports.DooverTokenAuth = exports.CookieAuth = exports.DooverAuth = exports.AmbiguousWriteError = exports.UnsupportedCapabilityError = exports.ALL_CAPABILITIES = exports.DooverRpcError = exports.RpcDispatcher = exports.UsersApi = exports.TurnApi = exports.ProcessorsApi = exports.PermissionsApi = exports.NotificationsApi = exports.MessagesApi = exports.ConnectionsApi = exports.ChannelsApi = exports.AlarmsApi = exports.AggregatesApi = exports.AgentsApi = exports.DooverStatsCollector = exports.resetDooverClient = exports.peekDooverClient = exports.getDooverClient = exports.MultiplexClient = exports.LocalAgentClient = exports.DooverClient = void 0;
+exports.generateSnowflakeIdAtTime = exports.extractSnowflakeId = exports.addTimestampToMessage = exports.DV_AUDIT_CHANNEL = exports.getIdentifierFromPath = exports.DooverDataProvider = exports.DooverValidationError = exports.DooverGatewayError = exports.DooverApiError = exports.RestClient = exports.GatewayClient = exports.buildAuth = exports.DooverAuthError = exports.AuthProfile = exports.DooverTokenAuth = exports.CookieAuth = exports.DooverAuth = exports.AmbiguousWriteError = exports.UnsupportedCapabilityError = exports.ALL_CAPABILITIES = exports.DooverRpcError = exports.RpcDispatcher = exports.UsersApi = exports.TurnApi = exports.ProcessorsApi = exports.PermissionsApi = exports.OrganisationsApi = exports.NotificationsApi = exports.MessagesApi = exports.ConnectionsApi = exports.ChannelsApi = exports.AlarmsApi = exports.AggregatesApi = exports.AgentsApi = exports.DooverStatsCollector = exports.resetDooverClient = exports.peekDooverClient = exports.getDooverClient = exports.MultiplexClient = exports.LocalAgentClient = exports.DooverClient = void 0;
 var doover_client_1 = require("./client/doover-client");
 Object.defineProperty(exports, "DooverClient", { enumerable: true, get: function () { return doover_client_1.DooverClient; } });
 var local_agent_client_1 = require("./client/local-agent-client");
@@ -27,6 +27,8 @@ var messages_api_1 = require("./apis/messages-api");
 Object.defineProperty(exports, "MessagesApi", { enumerable: true, get: function () { return messages_api_1.MessagesApi; } });
 var notifications_api_1 = require("./apis/notifications-api");
 Object.defineProperty(exports, "NotificationsApi", { enumerable: true, get: function () { return notifications_api_1.NotificationsApi; } });
+var organisations_api_1 = require("./apis/organisations-api");
+Object.defineProperty(exports, "OrganisationsApi", { enumerable: true, get: function () { return organisations_api_1.OrganisationsApi; } });
 var permissions_api_1 = require("./apis/permissions-api");
 Object.defineProperty(exports, "PermissionsApi", { enumerable: true, get: function () { return permissions_api_1.PermissionsApi; } });
 var processors_api_1 = require("./apis/processors-api");

package/dist/refine/index.d.ts

@@ -0,0 +1,72 @@
+import type { RestClient } from "../http/rest-client";
+export type RefineRecord = Record<string, unknown> & {
+    id?: string | number;
+};
+export type RefineMeta = Record<string, unknown> | undefined;
+export interface RefinePagination {
+    currentPage?: number;
+    pageSize?: number;
+}
+export interface RefineSorter {
+    field: string;
+    order?: "asc" | "desc";
+}
+export interface RefineCrudFilter {
+    field: string;
+    operator: string;
+    value: unknown;
+}
+export interface RefineGetListParams {
+    resource: string;
+    pagination?: RefinePagination;
+    sorters?: RefineSorter[];
+    filters?: RefineCrudFilter[];
+    meta?: RefineMeta;
+}
+export interface RefineOneParams {
+    resource: string;
+    id: string | number;
+    meta?: RefineMeta;
+}
+export interface RefineMutationParams {
+    resource: string;
+    id?: string | number;
+    variables?: unknown;
+    meta?: RefineMeta;
+}
+export interface RefineCustomParams {
+    url: string;
+    method: string;
+    headers?: Record<string, string>;
+    payload?: unknown;
+    meta?: RefineMeta;
+}
+export interface RefineDataProviderLike {
+    getOne: (params: RefineOneParams) => Promise<{
+        data: unknown;
+    }>;
+    getList: <TData extends RefineRecord = RefineRecord>(params: RefineGetListParams) => Promise<{
+        data: TData[];
+        total: number;
+    }>;
+    create: (params: RefineMutationParams) => Promise<{
+        data: unknown;
+    }>;
+    update: (params: RefineMutationParams & {
+        id: string | number;
+    }) => Promise<{
+        data: unknown;
+    }>;
+    deleteOne: (params: RefineOneParams) => Promise<{
+        data: unknown;
+    }>;
+    custom: (params: RefineCustomParams) => Promise<{
+        data: unknown;
+    }>;
+    getApiUrl: () => string;
+}
+export interface CreateRefineDataProviderOptions {
+    baseUrl?: string;
+}
+export declare function createRefineDataProvider(rest: RestClient, options?: CreateRefineDataProviderOptions): RefineDataProviderLike;
+export declare function getApiPath(resource: string, meta?: RefineMeta): string;

package/dist/refine/index.js

@@ -0,0 +1,219 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRefineDataProvider = createRefineDataProvider;
+exports.getApiPath = getApiPath;
+function createRefineDataProvider(rest, options = {}) {
+    const baseUrl = options.baseUrl ?? rest.config.controlApiUrl;
+    return {
+        getOne: async ({ resource, id, meta }) => {
+            const data = await rest.request({
+                path: `/${getApiPath(resource, meta)}/${id}/`,
+                headers: getMetaHeaders(meta),
+                baseUrl,
+            });
+            return { data };
+        },
+        getList: async ({ resource, pagination, sorters, filters, meta, }) => {
+            const data = await rest.request({
+                path: `/${getApiPath(resource, meta)}/`,
+                query: buildListQuery({ pagination, sorters, filters, meta }),
+                headers: getMetaHeaders(meta),
+                baseUrl,
+            });
+            return {
+                data: data.results,
+                total: data.count,
+            };
+        },
+        create: async ({ resource, variables, meta }) => {
+            const mergedMeta = isRecord(variables) ? { ...meta, ...variables } : meta;
+            const data = await rest.request({
+                path: `/${getApiPath(resource, mergedMeta)}/`,
+                method: "POST",
+                body: prepareVariables(variables, meta),
+                headers: getMetaHeaders(meta),
+                baseUrl,
+            });
+            return { data };
+        },
+        update: async ({ resource, id, variables, meta }) => {
+            const data = await rest.request({
+                path: `/${getApiPath(resource, meta)}/${id}/`,
+                method: "PATCH",
+                body: prepareVariables(variables, meta),
+                headers: getMetaHeaders(meta),
+                baseUrl,
+            });
+            return { data };
+        },
+        deleteOne: async ({ resource, id, meta }) => {
+            const data = await rest.request({
+                path: `/${getApiPath(resource, meta)}/${id}/`,
+                method: "DELETE",
+                headers: getMetaHeaders(meta),
+                baseUrl,
+            });
+            return { data: data ?? null };
+        },
+        custom: async ({ url, method, headers, payload, meta }) => {
+            const { path, query } = splitCustomUrl(url);
+            const data = await rest.request({
+                path,
+                method,
+                headers: { ...headers, ...getMetaHeaders(meta) },
+                body: payload == null ? undefined : payload,
+                query,
+                baseUrl,
+            });
+            return { data };
+        },
+        getApiUrl: () => baseUrl,
+    };
+}
+function getMetaHeaders(meta) {
+    if (!meta?.organisation)
+        return undefined;
+    return { "X-Doover-Organisation": String(idValue(meta.organisation)) };
+}
+function getApiPath(resource, meta) {
+    const apiPath = meta?.api_path;
+    if (apiPath !== undefined) {
+        const paths = typeof apiPath === "string" ? [apiPath] : apiPath;
+        if (Array.isArray(paths)) {
+            for (const path of paths) {
+                if (typeof path !== "string")
+                    continue;
+                try {
+                    return fillApiPath(path, meta);
+                }
+                catch (err) {
+                    if (paths.length === 1)
+                        throw err;
+                }
+            }
+        }
+    }
+    return resource;
+}
+function fillApiPath(path, meta) {
+    let apiPath = path;
+    const matches = [...apiPath.matchAll(/:([^/]+)/g)].map((m) => m[1]);
+    for (const match of matches) {
+        const value = lookupPathParam(match, meta);
+        if (value === undefined) {
+            throw new Error(`Missing value for ${match} in meta`);
+        }
+        apiPath = apiPath.replace(`:${match}`, String(value));
+    }
+    return apiPath;
+}
+function lookupPathParam(match, meta) {
+    if (!meta)
+        return undefined;
+    if (match in meta && meta[match] !== undefined)
+        return idValue(meta[match]);
+    const withoutId = match.replace(/id$/i, "");
+    if (withoutId in meta && meta[withoutId] !== undefined) {
+        return idValue(meta[withoutId]);
+    }
+    return undefined;
+}
+function idValue(value) {
+    return isRecord(value) && "id" in value ? value.id : value;
+}
+function buildListQuery({ pagination, sorters, filters, meta, }) {
+    const query = {};
+    if (pagination) {
+        query.page = pagination.currentPage ?? 1;
+        if (pagination.pageSize)
+            query.per_page = pagination.pageSize;
+    }
+    if (sorters && sorters.length > 0) {
+        query.ordering = `${sorters[0].order === "desc" ? "-" : ""}${sorters[0].field}`;
+    }
+    let hasArchivedFilter = false;
+    for (const filter of filters ?? []) {
+        if (!filter.field || !filter.operator)
+            continue;
+        if (filter.operator === "contains" && filter.field === "search") {
+            query.search = String(filter.value ?? "");
+            continue;
+        }
+        if (filter.field === "archived" || filter.field === "device_archived") {
+            hasArchivedFilter = hasArchivedFilter || filter.field === "archived";
+            if (filter.operator === "eq" || filter.operator === "in") {
+                query[filter.field] =
+                    filter.value === "__all__" ? "" : String(filter.value ?? "");
+            }
+            continue;
+        }
+        if (filter.operator === "contains") {
+            query[`${filter.field}__icontains`] = String(filter.value ?? "");
+        }
+        else if (filter.operator === "containss") {
+            query[`${filter.field}__contains`] = String(filter.value ?? "");
+        }
+        else if (filter.operator === "eq" || filter.operator === "in") {
+            query[filter.field] = String(filter.value ?? "");
+        }
+    }
+    if (meta?.canArchive === true && !hasArchivedFilter) {
+        query.archived = "false";
+    }
+    return query;
+}
+function prepareVariables(variables, meta) {
+    if (!isRecord(variables))
+        return variables;
+    const next = { ...variables };
+    const renameFields = isRecord(meta?.renameFields) ? meta.renameFields : null;
+    if (renameFields) {
+        for (const [from, to] of Object.entries(renameFields)) {
+            if (typeof to !== "string")
+                continue;
+            const value = next[from];
+            const mapped = Array.isArray(value)
+                ? value.map((item) => idValue(item))
+                : idValue(value);
+            next[from] = mapped;
+            next[to] = mapped;
+        }
+    }
+    if (Object.values(next).some(isFileLike)) {
+        const formData = new FormData();
+        for (const [key, value] of Object.entries(next)) {
+            if (value == null)
+                continue;
+            if (isFileLike(value)) {
+                formData.append(key, value);
+            }
+            else if (typeof value === "object") {
+                formData.append(key, JSON.stringify(value));
+            }
+            else {
+                formData.append(key, String(value));
+            }
+        }
+        return formData;
+    }
+    return next;
+}
+function splitCustomUrl(url) {
+    const [rawPath, rawQuery] = url.replace(/^\//, "").split("?", 2);
+    const path = `/${rawPath.replace(/\/?$/, "/")}`;
+    if (!rawQuery)
+        return { path, query: undefined };
+    const params = new URLSearchParams(rawQuery);
+    const query = {};
+    for (const key of new Set(params.keys())) {
+        const values = params.getAll(key);
+        query[key] = values.length > 1 ? values : values[0] ?? "";
+    }
+    return { path, query };
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isFileLike(value) {
+    return typeof File !== "undefined" && value instanceof File;
+}

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

@@ -243,6 +243,7 @@ describe("ProcessorsApi overloads", () => {
     });
 });
 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();
@@ -283,3 +284,47 @@ describe("AgentsApi listAgents", () => {
         (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" },
+        });
+    });
+});

package/dist/test/auth.test.js

@@ -91,6 +91,25 @@ class MemoryProfileStore {
             Authorization: "Bearer new-token",
         });
     });
+    (0, mocha_1.it)("setRefreshToken updates the refresh token used by ensureReady", async () => {
+        const fetchMock = (0, helpers_1.createFetchMock)(() => (0, helpers_1.createJsonResponse)({
+            access_token: "new-access-token",
+            expires_in: 3600,
+        }));
+        const auth = new doover_token_auth_1.DooverTokenAuth({
+            token: null,
+            authServerUrl: "https://auth.example.com",
+            authServerClientId: "client-1",
+            fetchImpl: fetchMock,
+        });
+        auth.setRefreshToken("new-refresh-token");
+        await auth.ensureReady();
+        (0, chai_1.expect)(fetchMock.callCount).to.equal(1);
+        (0, chai_1.expect)(fetchMock.firstCall.args[0]).to.contain("refresh_token=new-refresh-token");
+        (0, chai_1.expect)(await auth.getHttpHeaders()).to.deep.equal({
+            Authorization: "Bearer new-access-token",
+        });
+    });
     // -- Refresh behaviour ----------------------------------------------------
     (0, mocha_1.it)("does not refresh when token is clearly valid", async () => {
         const farFuture = Date.now() + 3600000;

package/dist/test/refine.test.d.ts

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

package/dist/test/refine.test.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const mocha_1 = require("mocha");
+const refine_1 = require("../refine");
+const rest_client_1 = require("../http/rest-client");
+const helpers_1 = require("./helpers");
+(0, mocha_1.describe)("createRefineDataProvider", () => {
+    (0, mocha_1.it)("builds list requests with api_path, pagination, sorters, filters and organisation header", async () => {
+        const fetchMock = (0, helpers_1.createFetchMock)(() => (0, helpers_1.createJsonResponse)({ count: 1, results: [{ id: "1", name: "Device" }] }));
+        const rest = new rest_client_1.RestClient({
+            dataRestUrl: "https://data.example.com/api",
+            controlApiUrl: "https://control.example.com",
+            dataWssUrl: "wss://data.example.com/gateway",
+            organisationId: "org-1",
+            fetchImpl: fetchMock,
+        });
+        const provider = (0, refine_1.createRefineDataProvider)(rest);
+        const result = await provider.getList({
+            resource: "devices",
+            pagination: { currentPage: 2, pageSize: 25 },
+            sorters: [{ field: "name", order: "desc" }],
+            filters: [
+                { field: "search", operator: "contains", value: "pump" },
+                { field: "archived", operator: "eq", value: false },
+            ],
+            meta: { api_path: "organisations/:organisationId/devices", organisationId: "org-2" },
+        });
+        (0, chai_1.expect)(result).to.deep.equal({
+            data: [{ id: "1", name: "Device" }],
+            total: 1,
+        });
+        (0, chai_1.expect)(fetchMock.callCount).to.equal(1);
+        const [url, init] = fetchMock.getCall(0).args;
+        (0, chai_1.expect)(url).to.equal("https://control.example.com/organisations/org-2/devices/?page=2&per_page=25&ordering=-name&search=pump&archived=false");
+        (0, chai_1.expect)((init?.headers).get("X-Doover-Organisation")).to.equal("org-1");
+        const explicit = await provider.getList({
+            resource: "devices",
+            meta: { organisation: "org-3" },
+        });
+        (0, chai_1.expect)(explicit.total).to.equal(1);
+        (0, chai_1.expect)((fetchMock.getCall(1).args[1]?.headers).get("X-Doover-Organisation")).to.equal("org-3");
+    });
+    (0, mocha_1.it)("renames object fields and sends JSON mutations through RestClient", async () => {
+        const fetchMock = (0, helpers_1.createFetchMock)((_url, init) => (0, helpers_1.createJsonResponse)(JSON.parse(String(init?.body))));
+        const rest = new rest_client_1.RestClient({
+            dataRestUrl: "https://data.example.com/api",
+            controlApiUrl: "https://control.example.com",
+            dataWssUrl: "wss://data.example.com/gateway",
+            fetchImpl: fetchMock,
+        });
+        const provider = (0, refine_1.createRefineDataProvider)(rest);
+        const result = await provider.update({
+            resource: "devices",
+            id: "device-1",
+            variables: { group: { id: "group-1", name: "Group" } },
+            meta: { renameFields: { group: "group_id" } },
+        });
+        (0, chai_1.expect)(result.data).to.deep.equal({
+            group: "group-1",
+            group_id: "group-1",
+        });
+    });
+});
+(0, mocha_1.describe)("getApiPath", () => {
+    (0, mocha_1.it)("falls back across api_path candidates", () => {
+        (0, chai_1.expect)((0, refine_1.getApiPath)("domains", {
+            api_path: ["organisations/:organisationId/domains", "organisations/domains"],
+        })).to.equal("organisations/domains");
+    });
+});

package/dist/types/viewer.d.ts

@@ -29,6 +29,43 @@ export interface User {
     __source?: SourceProvenance;
     [key: string]: unknown;
 }
+export interface Theme {
+    [key: string]: unknown;
+}
+export interface OrganisationDomain {
+    id: string;
+    hostname: string;
+    default: boolean;
+}
+export interface Organisation {
+    id: string;
+    name: string;
+    archived: boolean;
+    application_id: string;
+    domains: OrganisationDomain[];
+    root_group?: unknown;
+    retention_period?: number;
+    legacy_doover_api_key?: string | null;
+    llm_api_key?: string | null;
+    extra_config?: Record<string, unknown>;
+    theme?: Theme;
+    __source?: SourceProvenance;
+    [key: string]: unknown;
+}
+export interface CustomerSite {
+    id: string;
+    name: string;
+    application_id: string;
+    archived: boolean;
+    theme: Theme;
+}
+export interface PaginatedResponse<T> {
+    count: number;
+    results: T[];
+    next?: string | null;
+    previous?: string | null;
+    [key: string]: unknown;
+}
 export interface GetAgentsOptions {
     includeArchived?: boolean;
     includeOrganisations?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doover-js",
-  "version": "0.6.4",
+  "version": "0.6.5",
   "description": "TypeScript client for Doover.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,6 +16,10 @@
     "./react": {
       "types": "./dist/react/index.d.ts",
       "default": "./dist/react/index.js"
+    },
+    "./refine": {
+      "types": "./dist/refine/index.d.ts",
+      "default": "./dist/refine/index.js"
     }
   },
   "repository": {
@@ -42,10 +46,14 @@
   ],
   "license": "Apache-2.0",
   "peerDependencies": {
+    "@refinedev/core": "^5",
     "@tanstack/react-query": "^5",
     "react": "^18 || ^19"
   },
   "peerDependenciesMeta": {
+    "@refinedev/core": {
+      "optional": true
+    },
     "@tanstack/react-query": {
       "optional": true
     },