doover-js 0.6.4 → 0.6.6

package/dist/client/request-options.d.ts

@@ -0,0 +1,23 @@
+import type { OfflineReadCacheOptions } from "./offline-cache";
+export declare const REQUEST_OPTIONS_SYMBOL: unique symbol;
+export interface DooverRequestOptions {
+    /**
+     * Restrict a call to these source ids on a `MultiplexClient`.
+     */
+    sources?: string[];
+    /**
+     * Offline cache behavior for this specific call. `false` opts out even when
+     * a stored channel policy would otherwise match.
+     */
+    cache?: OfflineReadCacheOptions | false;
+    [REQUEST_OPTIONS_SYMBOL]?: true;
+}
+export declare function requestOptions<T extends Omit<DooverRequestOptions, typeof REQUEST_OPTIONS_SYMBOL>>(options: T): T & {
+    [REQUEST_OPTIONS_SYMBOL]: true;
+};
+export declare function isDooverRequestOptions(value: unknown): value is DooverRequestOptions;
+export declare function splitRequestOptions(args: unknown[]): {
+    args: unknown[];
+    request?: DooverRequestOptions;
+};
+export declare function delegateRequestOptions(request?: DooverRequestOptions): DooverRequestOptions | undefined;

package/dist/client/request-options.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_OPTIONS_SYMBOL = void 0;
+exports.requestOptions = requestOptions;
+exports.isDooverRequestOptions = isDooverRequestOptions;
+exports.splitRequestOptions = splitRequestOptions;
+exports.delegateRequestOptions = delegateRequestOptions;
+exports.REQUEST_OPTIONS_SYMBOL = Symbol.for("doover.requestOptions");
+function requestOptions(options) {
+    return { ...options, [exports.REQUEST_OPTIONS_SYMBOL]: true };
+}
+function isDooverRequestOptions(value) {
+    if (!value || typeof value !== "object" || Array.isArray(value))
+        return false;
+    const candidate = value;
+    return (candidate[exports.REQUEST_OPTIONS_SYMBOL] === true ||
+        Array.isArray(candidate.sources) ||
+        "cache" in candidate);
+}
+function splitRequestOptions(args) {
+    const last = args[args.length - 1];
+    if (!isDooverRequestOptions(last))
+        return { args };
+    return { args: args.slice(0, -1), request: last };
+}
+function delegateRequestOptions(request) {
+    if (!request?.sources)
+        return undefined;
+    return requestOptions({ sources: request.sources });
+}

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();
@@ -138,7 +138,10 @@ class RestClient {
             return response.json();
         }
         if (contentType.includes("application/octet-stream") ||
-            contentType.includes("application/pdf")) {
+            contentType.includes("application/pdf") ||
+            contentType.startsWith("image/") ||
+            contentType.startsWith("video/") ||
+            contentType.startsWith("audio/")) {
             return response.blob();
         }
         const text = await response.text();

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";
@@ -24,7 +26,11 @@ export type { ChannelHandlers } from "./gateway/gateway-client";
 export type { RpcStatsSnapshot } from "./client/stats";
 export { ALL_CAPABILITIES } from "./client/capabilities";
 export type { Capability } from "./client/capabilities";
-export { UnsupportedCapabilityError, AmbiguousWriteError } from "./client/errors";
+export { UnsupportedCapabilityError, AmbiguousWriteError, DooverOfflineError } from "./client/errors";
+export { OfflineDataClient, MemoryOfflineStorageAdapter, DEFAULT_OFFLINE_RETENTION_MS, } from "./client/offline-cache";
+export type { OfflineCacheMode, OfflineReadCacheOptions, OfflineChannelPolicy, OfflineCacheScope, OfflineCacheRecord, OfflineStorageAdapter, OfflineDataClientOptions, } from "./client/offline-cache";
+export { requestOptions, isDooverRequestOptions, splitRequestOptions, } from "./client/request-options";
+export type { DooverRequestOptions } from "./client/request-options";
 export type { DataClient, AgentScope, DataClientStatus, DataClientConnectionState, AgentsApiLike, AggregatesApiLike, AlarmsApiLike, ChannelsApiLike, ConnectionsApiLike, MessagesApiLike, NotificationsApiLike, PermissionsApiLike, ProcessorsApiLike, TurnApiLike, UsersApiLike, GatewayClientLike, RpcDispatcherLike, } from "./client/data-client";
 export type { SourceProvenance, SourceProvenanceViaRest, SourceProvenanceViaGateway, } from "./types/provenance";
 export { DooverAuth } from "./auth/doover-auth";

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.splitRequestOptions = exports.isDooverRequestOptions = exports.requestOptions = exports.DEFAULT_OFFLINE_RETENTION_MS = exports.MemoryOfflineStorageAdapter = exports.OfflineDataClient = exports.DooverOfflineError = 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");
@@ -44,6 +46,15 @@ Object.defineProperty(exports, "ALL_CAPABILITIES", { enumerable: true, get: func
 var errors_2 = require("./client/errors");
 Object.defineProperty(exports, "UnsupportedCapabilityError", { enumerable: true, get: function () { return errors_2.UnsupportedCapabilityError; } });
 Object.defineProperty(exports, "AmbiguousWriteError", { enumerable: true, get: function () { return errors_2.AmbiguousWriteError; } });
+Object.defineProperty(exports, "DooverOfflineError", { enumerable: true, get: function () { return errors_2.DooverOfflineError; } });
+var offline_cache_1 = require("./client/offline-cache");
+Object.defineProperty(exports, "OfflineDataClient", { enumerable: true, get: function () { return offline_cache_1.OfflineDataClient; } });
+Object.defineProperty(exports, "MemoryOfflineStorageAdapter", { enumerable: true, get: function () { return offline_cache_1.MemoryOfflineStorageAdapter; } });
+Object.defineProperty(exports, "DEFAULT_OFFLINE_RETENTION_MS", { enumerable: true, get: function () { return offline_cache_1.DEFAULT_OFFLINE_RETENTION_MS; } });
+var request_options_1 = require("./client/request-options");
+Object.defineProperty(exports, "requestOptions", { enumerable: true, get: function () { return request_options_1.requestOptions; } });
+Object.defineProperty(exports, "isDooverRequestOptions", { enumerable: true, get: function () { return request_options_1.isDooverRequestOptions; } });
+Object.defineProperty(exports, "splitRequestOptions", { enumerable: true, get: function () { return request_options_1.splitRequestOptions; } });
 var doover_auth_1 = require("./auth/doover-auth");
 Object.defineProperty(exports, "DooverAuth", { enumerable: true, get: function () { return doover_auth_1.DooverAuth; } });
 var cookie_auth_1 = require("./auth/cookie-auth");

package/dist/react/index.d.ts

@@ -2,6 +2,8 @@ export { DooverProvider, useDooverClient } from "./context";
 export type { DooverProviderProps } from "./context";
 export type { DataClientStatus, DataClientConnectionState, AgentScope } from "../client/data-client";
 export { useClientStatus } from "./useClientStatus";
+export { useOfflineStatus, hasOfflineStatus } from "./useOfflineStatus";
+export type { OfflineStatusSnapshot, OfflineStatusClient } from "./useOfflineStatus";
 export { useConnectionState } from "./useConnectionState";
 export type { ConnectionState, ConnectionStatus } from "./useConnectionState";
 export { useAgentConnections, agentConnectionsQueryKey, } from "./useAgentConnections";

package/dist/react/index.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resetSharedQueryClient = exports.getSharedQueryClient = exports.useTurnCredentials = exports.useDeviceMap = exports.multiAgentChannelMessagesQueryKey = exports.useMultiAgentChannelMessages = exports.multiAgentAggregatesQueryKey = exports.useMultiAgentAggregates = exports.useSendRpc = exports.invocationLogsQueryKey = exports.useInvocationLogs = exports.channelMessageQueryKey = exports.useChannelMessage = exports.channelMessagesQueryKey = exports.useChannelMessages = exports.useUpdateMessage = exports.useUpdateAggregate = exports.useSendMessage = exports.useAgentChannel = exports.channelAggregateQueryKey = exports.useChannelAggregate = exports.useChannelSubscription = exports.agentConnectionsQueryKey = exports.useAgentConnections = exports.useConnectionState = exports.useClientStatus = exports.useDooverClient = exports.DooverProvider = void 0;
+exports.resetSharedQueryClient = exports.getSharedQueryClient = exports.useTurnCredentials = exports.useDeviceMap = exports.multiAgentChannelMessagesQueryKey = exports.useMultiAgentChannelMessages = exports.multiAgentAggregatesQueryKey = exports.useMultiAgentAggregates = exports.useSendRpc = exports.invocationLogsQueryKey = exports.useInvocationLogs = exports.channelMessageQueryKey = exports.useChannelMessage = exports.channelMessagesQueryKey = exports.useChannelMessages = exports.useUpdateMessage = exports.useUpdateAggregate = exports.useSendMessage = exports.useAgentChannel = exports.channelAggregateQueryKey = exports.useChannelAggregate = exports.useChannelSubscription = exports.agentConnectionsQueryKey = exports.useAgentConnections = exports.useConnectionState = exports.hasOfflineStatus = exports.useOfflineStatus = exports.useClientStatus = exports.useDooverClient = exports.DooverProvider = void 0;
 var context_1 = require("./context");
 Object.defineProperty(exports, "DooverProvider", { enumerable: true, get: function () { return context_1.DooverProvider; } });
 Object.defineProperty(exports, "useDooverClient", { enumerable: true, get: function () { return context_1.useDooverClient; } });
 var useClientStatus_1 = require("./useClientStatus");
 Object.defineProperty(exports, "useClientStatus", { enumerable: true, get: function () { return useClientStatus_1.useClientStatus; } });
+var useOfflineStatus_1 = require("./useOfflineStatus");
+Object.defineProperty(exports, "useOfflineStatus", { enumerable: true, get: function () { return useOfflineStatus_1.useOfflineStatus; } });
+Object.defineProperty(exports, "hasOfflineStatus", { enumerable: true, get: function () { return useOfflineStatus_1.hasOfflineStatus; } });
 var useConnectionState_1 = require("./useConnectionState");
 Object.defineProperty(exports, "useConnectionState", { enumerable: true, get: function () { return useConnectionState_1.useConnectionState; } });
 var useAgentConnections_1 = require("./useAgentConnections");

package/dist/react/useChannelAggregate.d.ts

@@ -1,6 +1,7 @@
 import { type UseQueryResult } from "@tanstack/react-query";
 import type { Aggregate } from "../types/common";
 import type { ChannelIdentifier } from "../types/viewer";
+import { type OfflineStatusSnapshot } from "./useOfflineStatus";
 export declare function channelAggregateQueryKey(agentId: string | undefined, channelName: string | undefined, sources?: string[]): readonly ["doover", "agent", string | undefined, "channel", string | undefined, "src", string];
 /**
  * Shape returned by `useChannelAggregate`. Shadows the react-query
@@ -23,6 +24,8 @@ export interface UseChannelAggregateResult<TData> extends Omit<UseQueryResult<Ag
      * years in the future).
      */
     last_updated: number | null | undefined;
+    /** Offline/cache status when the provided client supports offline caching. */
+    offline: OfflineStatusSnapshot;
 }
 export interface UseChannelAggregateOptions {
     /**

package/dist/react/useChannelAggregate.js

@@ -7,6 +7,7 @@ const react_query_1 = require("@tanstack/react-query");
 const errors_1 = require("../http/errors");
 const context_1 = require("./context");
 const useChannelSubscription_1 = require("./useChannelSubscription");
+const useOfflineStatus_1 = require("./useOfflineStatus");
 function channelAggregateQueryKey(agentId, channelName, sources) {
     const sourceDim = sources && sources.length ? [...sources].sort().join(",") : "*";
     return ["doover", "agent", agentId, "channel", channelName, "src", sourceDim];
@@ -24,6 +25,7 @@ function channelAggregateQueryKey(agentId, channelName, sources) {
  */
 function useChannelAggregate(identifier, options) {
     const client = (0, context_1.useDooverClient)();
+    const offline = (0, useOfflineStatus_1.useOfflineStatus)();
     const queryClient = (0, react_query_1.useQueryClient)();
     const { agentId, channelName } = identifier;
     const sources = options?.sources;
@@ -74,5 +76,6 @@ function useChannelAggregate(identifier, options) {
         data: aggregate?.data,
         attachments: aggregate?.attachments,
         last_updated: aggregate?.last_updated,
+        offline,
     };
 }

package/dist/react/useChannelMessages.d.ts

@@ -1,6 +1,7 @@
 import { type InfiniteData, type UseInfiniteQueryResult } from "@tanstack/react-query";
 import type { MessageStructure } from "../types/common";
 import type { ChannelIdentifier } from "../types/viewer";
+import { type OfflineStatusSnapshot } from "./useOfflineStatus";
 export declare function channelMessagesQueryKey(agentId: string | undefined, channelName: string | undefined, fields?: readonly string[], sources?: string[]): readonly ["doover", "agent", string | undefined, "channel", string | undefined, "messages", "src", string] | readonly ["doover", "agent", string | undefined, "channel", string | undefined, "messages", "src", string, {
     readonly fields: string[];
 }];
@@ -49,6 +50,8 @@ export interface UseChannelMessagesResult<TData> extends Omit<UseInfiniteQueryRe
     messages: MessageStructure<TData>[];
     /** Raw react-query data (pages). */
     data: InfiniteData<Page<TData>> | undefined;
+    /** Offline/cache status when the provided client supports offline caching. */
+    offline: OfflineStatusSnapshot;
 }
 /**
  * Paginated infinite query over `DooverDataProvider.getMessages`, with live

package/dist/react/useChannelMessages.js

@@ -6,6 +6,7 @@ const react_1 = require("react");
 const react_query_1 = require("@tanstack/react-query");
 const context_1 = require("./context");
 const useChannelSubscription_1 = require("./useChannelSubscription");
+const useOfflineStatus_1 = require("./useOfflineStatus");
 function channelMessagesQueryKey(agentId, channelName, fields, sources) {
     // Source-dimension the key (multiplex source subsets cache independently);
     // "*" means "all/unspecified" for a plain DooverClient/LocalAgentClient.
@@ -28,6 +29,7 @@ function channelMessagesQueryKey(agentId, channelName, fields, sources) {
  */
 function useChannelMessages(identifier, options) {
     const client = (0, context_1.useDooverClient)();
+    const offline = (0, useOfflineStatus_1.useOfflineStatus)();
     const queryClient = (0, react_query_1.useQueryClient)();
     const { agentId, channelName } = identifier;
     const limit = options?.limit;
@@ -99,5 +101,5 @@ function useChannelMessages(identifier, options) {
         query.fetchNextPage();
     }, [autoPaginate, query.isFetching, query.hasNextPage, query.fetchNextPage]);
     const messages = (0, react_1.useMemo)(() => (query.data?.pages ?? []).flat(), [query.data]);
-    return { ...query, messages };
+    return { ...query, messages, offline };
 }

package/dist/react/useOfflineStatus.d.ts

@@ -0,0 +1,8 @@
+import type { OfflineStatusSnapshot } from "../client/offline-cache";
+export type { OfflineStatusSnapshot } from "../client/offline-cache";
+export interface OfflineStatusClient {
+    getOfflineStatus(): OfflineStatusSnapshot;
+    onOfflineStatusChange(listener: (status: OfflineStatusSnapshot) => void): () => void;
+}
+export declare function hasOfflineStatus(client: unknown): client is OfflineStatusClient;
+export declare function useOfflineStatus(): OfflineStatusSnapshot;

package/dist/react/useOfflineStatus.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasOfflineStatus = hasOfflineStatus;
+exports.useOfflineStatus = useOfflineStatus;
+const react_1 = require("react");
+const context_1 = require("./context");
+function hasOfflineStatus(client) {
+    return (!!client &&
+        typeof client === "object" &&
+        typeof client.getOfflineStatus === "function" &&
+        typeof client.onOfflineStatusChange === "function");
+}
+const UNAVAILABLE_OFFLINE_STATUS = {
+    online: true,
+    state: "online",
+    isOfflineFallback: false,
+    isExpired: false,
+    at: 0,
+};
+function useOfflineStatus() {
+    const client = (0, context_1.useDooverClient)();
+    return (0, react_1.useSyncExternalStore)((listener) => hasOfflineStatus(client)
+        ? client.onOfflineStatusChange(listener)
+        : () => undefined, () => hasOfflineStatus(client)
+        ? client.getOfflineStatus()
+        : UNAVAILABLE_OFFLINE_STATUS, () => UNAVAILABLE_OFFLINE_STATUS);
+}

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;