@comapeo/core-react 1.0.1 → 1.1.0

package/dist/commonjs/lib/react-query/invites.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvitesQueryKey = getInvitesQueryKey;
+exports.getPendingInvitesQueryKey = getPendingInvitesQueryKey;
+exports.pendingInvitesQueryOptions = pendingInvitesQueryOptions;
+const react_query_1 = require("@tanstack/react-query");
+const shared_js_1 = require("./shared.js");
+function getInvitesQueryKey() {
+    return [shared_js_1.ROOT_QUERY_KEY, 'invites'];
+}
+function getPendingInvitesQueryKey() {
+    return [shared_js_1.ROOT_QUERY_KEY, 'invites', { status: 'pending' }];
+}
+function pendingInvitesQueryOptions({ clientApi, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getPendingInvitesQueryKey(),
+        queryFn: async () => {
+            return clientApi.invite.getPending();
+        },
+    });
+}

package/dist/commonjs/lib/react-query/maps.d.ts

@@ -0,0 +1,15 @@
+import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+export declare function getMapsQueryKey(): readonly ["@comapeo/core-react", "maps"];
+export declare function getStyleJsonUrlQueryKey({ refreshToken, }: {
+    refreshToken?: string;
+}): readonly ["@comapeo/core-react", "maps", "stylejson_url", {
+    readonly refreshToken: string | undefined;
+}];
+export declare function mapStyleJsonUrlQueryOptions({ clientApi, refreshToken, }: {
+    clientApi: MapeoClientApi;
+    refreshToken?: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<string, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, string>;
+};

package/dist/commonjs/lib/react-query/maps.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMapsQueryKey = getMapsQueryKey;
+exports.getStyleJsonUrlQueryKey = getStyleJsonUrlQueryKey;
+exports.mapStyleJsonUrlQueryOptions = mapStyleJsonUrlQueryOptions;
+const react_query_1 = require("@tanstack/react-query");
+const shared_js_1 = require("./shared.js");
+function getMapsQueryKey() {
+    return [shared_js_1.ROOT_QUERY_KEY, 'maps'];
+}
+function getStyleJsonUrlQueryKey({ refreshToken, }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'maps', 'stylejson_url', { refreshToken }];
+}
+function mapStyleJsonUrlQueryOptions({ clientApi, refreshToken, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getStyleJsonUrlQueryKey({ refreshToken }),
+        queryFn: async () => {
+            const result = await clientApi.getMapStyleJsonUrl();
+            return refreshToken ? result + `?refresh_token=${refreshToken}` : result;
+        },
+    });
+}

package/dist/commonjs/lib/react-query/projects.d.ts

@@ -0,0 +1,196 @@
+import type { BitmapOpts, SvgOpts } from '@comapeo/core/dist/icon-api.js' with { 'resolution-mode': 'import' };
+import type { BlobId } from '@comapeo/core/dist/types.js' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+export declare function getProjectsQueryKey(): readonly ["@comapeo/core-react", "projects"];
+export declare function getProjectByIdQueryKey({ projectId }: {
+    projectId: string;
+}): readonly ["@comapeo/core-react", "projects", string];
+export declare function getProjectSettingsQueryKey({ projectId, }: {
+    projectId: string;
+}): readonly ["@comapeo/core-react", "projects", string, "project_settings"];
+export declare function getProjectRoleQueryKey({ projectId }: {
+    projectId: string;
+}): readonly ["@comapeo/core-react", "projects", string, "role"];
+export declare function getMembersQueryKey({ projectId }: {
+    projectId: string;
+}): readonly ["@comapeo/core-react", "projects", string, "members"];
+export declare function getMemberByIdQueryKey({ projectId, deviceId, }: {
+    projectId: string;
+    deviceId: string;
+}): readonly ["@comapeo/core-react", "projects", string, "members", string];
+export declare function getIconUrlQueryKey({ projectId, iconId, ...mimeBasedOpts }: {
+    projectId: string;
+    iconId: string;
+} & (BitmapOpts | SvgOpts)): readonly ["@comapeo/core-react", "projects", string, "icons", string, {
+    mimeType: Extract<import("@comapeo/core/dist/icon-api.js", { with: { "resolution-mode": "import" } }).IconVariant["mimeType"], "image/png">;
+    pixelDensity: Extract<import("@comapeo/core/dist/icon-api.js", { with: { "resolution-mode": "import" } }).IconVariant, {
+        mimeType: "image/png";
+    }>["pixelDensity"];
+    size: import("@comapeo/core/dist/icon-api.js", { with: { "resolution-mode": "import" } }).ValidSizes;
+} | {
+    mimeType: Extract<import("@comapeo/core/dist/icon-api.js", { with: { "resolution-mode": "import" } }).IconVariant["mimeType"], "image/svg+xml">;
+    size: import("@comapeo/core/dist/icon-api.js", { with: { "resolution-mode": "import" } }).ValidSizes;
+}];
+export declare function getDocumentCreatedByQueryKey({ projectId, originalVersionId, }: {
+    projectId: string;
+    originalVersionId: string;
+}): readonly ["@comapeo/core-react", "projects", string, "document_created_by", string];
+export declare function getAttachmentUrlQueryKey({ projectId, blobId, }: {
+    projectId: string;
+    blobId: BlobId;
+}): readonly ["@comapeo/core-react", "projects", string, "attachments", BlobId];
+export declare function projectsQueryOptions({ clientApi, }: {
+    clientApi: MapeoClientApi;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<(Pick<{
+    schemaName: "projectSettings";
+    name?: string | undefined;
+    defaultPresets?: {
+        point: string[];
+        area: string[];
+        vertex: string[];
+        line: string[];
+        relation: string[];
+    } | undefined;
+    configMetadata?: {
+        name: string;
+        buildDate: string;
+        importDate: string;
+        fileVersion: string;
+    } | undefined;
+}, "name"> & {
+    projectId: string;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+})[], Error, (Pick<{
+    schemaName: "projectSettings";
+    name?: string | undefined;
+    defaultPresets?: {
+        point: string[];
+        area: string[];
+        vertex: string[];
+        line: string[];
+        relation: string[];
+    } | undefined;
+    configMetadata?: {
+        name: string;
+        buildDate: string;
+        importDate: string;
+        fileVersion: string;
+    } | undefined;
+}, "name"> & {
+    projectId: string;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+})[], import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<(Pick<{
+        schemaName: "projectSettings";
+        name?: string | undefined;
+        defaultPresets?: {
+            point: string[];
+            area: string[];
+            vertex: string[];
+            line: string[];
+            relation: string[];
+        } | undefined;
+        configMetadata?: {
+            name: string;
+            buildDate: string;
+            importDate: string;
+            fileVersion: string;
+        } | undefined;
+    }, "name"> & {
+        projectId: string;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+    })[], import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, (Pick<{
+        schemaName: "projectSettings";
+        name?: string | undefined;
+        defaultPresets?: {
+            point: string[];
+            area: string[];
+            vertex: string[];
+            line: string[];
+            relation: string[];
+        } | undefined;
+        configMetadata?: {
+            name: string;
+            buildDate: string;
+            importDate: string;
+            fileVersion: string;
+        } | undefined;
+    }, "name"> & {
+        projectId: string;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+    })[]>;
+};
+export declare function projectByIdQueryOptions({ clientApi, projectId, }: {
+    clientApi: MapeoClientApi;
+    projectId: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("rpc-reflector/lib/types.js").ClientApi<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).MapeoProject>, Error, import("rpc-reflector/lib/types.js").ClientApi<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).MapeoProject>, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("rpc-reflector/lib/types.js").ClientApi<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).MapeoProject>, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, import("rpc-reflector/lib/types.js").ClientApi<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).MapeoProject>>;
+};
+export declare function projectSettingsQueryOptions({ projectApi, projectId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings, Error, import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, import("@comapeo/core/dist/mapeo-project.js", { with: { "resolution-mode": "import" } }).EditableProjectSettings>;
+};
+export declare function projectMembersQueryOptions({ projectApi, projectId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo[], Error, import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo[], import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo[], import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo[]>;
+};
+export declare function projectMemberByIdQueryOptions({ projectApi, projectId, deviceId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    deviceId: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo, Error, import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, import("@comapeo/core/dist/member-api.js", { with: { "resolution-mode": "import" } }).MemberInfo>;
+};
+export declare function projectOwnRoleQueryOptions({ projectApi, projectId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/roles.js", { with: { "resolution-mode": "import" } }).Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">, Error, import("@comapeo/core/dist/roles.js", { with: { "resolution-mode": "import" } }).Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/roles.js", { with: { "resolution-mode": "import" } }).Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, import("@comapeo/core/dist/roles.js", { with: { "resolution-mode": "import" } }).Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">>;
+};
+export declare function iconUrlQueryOptions({ projectApi, projectId, iconId, ...mimeBasedOpts }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    iconId: Parameters<MapeoProjectApi['$icons']['getIconUrl']>[0];
+} & (BitmapOpts | SvgOpts)): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<string, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, string>;
+};
+export declare function documentCreatedByQueryOptions({ projectApi, projectId, originalVersionId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    originalVersionId: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<string, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, string>;
+};
+export declare function attachmentUrlQueryOptions({ projectApi, projectId, blobId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    blobId: BlobId;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/react-query").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<string, import("@tanstack/react-query").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/react-query").DataTag<import("@tanstack/react-query").QueryKey, string>;
+};

package/dist/commonjs/lib/react-query/projects.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectsQueryKey = getProjectsQueryKey;
+exports.getProjectByIdQueryKey = getProjectByIdQueryKey;
+exports.getProjectSettingsQueryKey = getProjectSettingsQueryKey;
+exports.getProjectRoleQueryKey = getProjectRoleQueryKey;
+exports.getMembersQueryKey = getMembersQueryKey;
+exports.getMemberByIdQueryKey = getMemberByIdQueryKey;
+exports.getIconUrlQueryKey = getIconUrlQueryKey;
+exports.getDocumentCreatedByQueryKey = getDocumentCreatedByQueryKey;
+exports.getAttachmentUrlQueryKey = getAttachmentUrlQueryKey;
+exports.projectsQueryOptions = projectsQueryOptions;
+exports.projectByIdQueryOptions = projectByIdQueryOptions;
+exports.projectSettingsQueryOptions = projectSettingsQueryOptions;
+exports.projectMembersQueryOptions = projectMembersQueryOptions;
+exports.projectMemberByIdQueryOptions = projectMemberByIdQueryOptions;
+exports.projectOwnRoleQueryOptions = projectOwnRoleQueryOptions;
+exports.iconUrlQueryOptions = iconUrlQueryOptions;
+exports.documentCreatedByQueryOptions = documentCreatedByQueryOptions;
+exports.attachmentUrlQueryOptions = attachmentUrlQueryOptions;
+const react_query_1 = require("@tanstack/react-query");
+const shared_js_1 = require("./shared.js");
+function getProjectsQueryKey() {
+    return [shared_js_1.ROOT_QUERY_KEY, 'projects'];
+}
+function getProjectByIdQueryKey({ projectId }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'projects', projectId];
+}
+function getProjectSettingsQueryKey({ projectId, }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'projects', projectId, 'project_settings'];
+}
+function getProjectRoleQueryKey({ projectId }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'projects', projectId, 'role'];
+}
+function getMembersQueryKey({ projectId }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'projects', projectId, 'members'];
+}
+function getMemberByIdQueryKey({ projectId, deviceId, }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'projects', projectId, 'members', deviceId];
+}
+function getIconUrlQueryKey({ projectId, iconId, ...mimeBasedOpts }) {
+    return [
+        shared_js_1.ROOT_QUERY_KEY,
+        'projects',
+        projectId,
+        'icons',
+        iconId,
+        mimeBasedOpts,
+    ];
+}
+function getDocumentCreatedByQueryKey({ projectId, originalVersionId, }) {
+    return [
+        shared_js_1.ROOT_QUERY_KEY,
+        'projects',
+        projectId,
+        'document_created_by',
+        originalVersionId,
+    ];
+}
+function getAttachmentUrlQueryKey({ projectId, blobId, }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'projects', projectId, 'attachments', blobId];
+}
+function projectsQueryOptions({ clientApi, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getProjectsQueryKey(),
+        queryFn: async () => {
+            return clientApi.listProjects();
+        },
+    });
+}
+function projectByIdQueryOptions({ clientApi, projectId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getProjectByIdQueryKey({ projectId }),
+        queryFn: async () => {
+            return clientApi.getProject(projectId);
+        },
+    });
+}
+function projectSettingsQueryOptions({ projectApi, projectId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getProjectSettingsQueryKey({ projectId }),
+        queryFn: async () => {
+            return projectApi.$getProjectSettings();
+        },
+    });
+}
+function projectMembersQueryOptions({ projectApi, projectId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getMembersQueryKey({ projectId }),
+        queryFn: async () => {
+            return projectApi.$member.getMany();
+        },
+    });
+}
+function projectMemberByIdQueryOptions({ projectApi, projectId, deviceId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getMemberByIdQueryKey({ projectId, deviceId }),
+        queryFn: async () => {
+            return projectApi.$member.getById(deviceId);
+        },
+    });
+}
+function projectOwnRoleQueryOptions({ projectApi, projectId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getProjectRoleQueryKey({ projectId }),
+        queryFn: async () => {
+            return projectApi.$getOwnRole();
+        },
+    });
+}
+function iconUrlQueryOptions({ projectApi, projectId, iconId, ...mimeBasedOpts }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getIconUrlQueryKey({ ...mimeBasedOpts, projectId, iconId }),
+        queryFn: async () => {
+            return projectApi.$icons.getIconUrl(iconId, mimeBasedOpts);
+        },
+    });
+}
+function documentCreatedByQueryOptions({ projectApi, projectId, originalVersionId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getDocumentCreatedByQueryKey({
+            projectId,
+            originalVersionId,
+        }),
+        queryFn: async () => {
+            return projectApi.$originalVersionIdToDeviceId(originalVersionId);
+        },
+    });
+}
+function attachmentUrlQueryOptions({ projectApi, projectId, blobId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getAttachmentUrlQueryKey({ projectId, blobId }),
+        queryFn: async () => {
+            // TODO: Might need a refresh token? (similar to map style url)
+            return projectApi.$blobs.getUrl(blobId);
+        },
+    });
+}

package/dist/commonjs/lib/react-query/shared.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROOT_QUERY_KEY = void 0;
+exports.baseQueryOptions = baseQueryOptions;
+exports.ROOT_QUERY_KEY = '@comapeo/core-react';
+// Since the API is running locally, queries should run regardless of network
+// status, and should not be retried. In React Native the API consumer would
+// have to manually set the network mode, but we still should keep these options
+// to avoid surprises. Not using the queryClient `defaultOptions` because the API
+// consumer might also use the same queryClient for network queries
+function baseQueryOptions() {
+    return {
+        networkMode: 'always',
+        retry: 0,
+    };
+}

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/{contexts → esm/contexts}/ClientApi.d.ts

@@ -1,6 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc';
+import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
 import { type ReactNode } from 'react';
-export declare const ClientApiContext: import("react").Context<import("@comapeo/ipc/dist/client").MapeoClientApi | null>;
+export declare const ClientApiContext: import("react").Context<import("@comapeo/ipc/dist/client.js").MapeoClientApi | null>;
 /**
  * Create a context provider that holds a CoMapeo API client instance.
  *
@@ -11,4 +11,4 @@ export declare const ClientApiContext: import("react").Context<import("@comapeo/
 export declare function ClientApiProvider({ children, clientApi, }: {
     children: ReactNode;
     clientApi: MapeoClientApi;
-}): import("react").FunctionComponentElement<import("react").ProviderProps<import("@comapeo/ipc/dist/client").MapeoClientApi | null>>;
+}): import("react").FunctionComponentElement<import("react").ProviderProps<import("@comapeo/ipc/dist/client.js").MapeoClientApi | null>>;

package/dist/{hooks → esm/hooks}/client.d.ts

@@ -23,7 +23,7 @@
  * ```
  *
  */
-export declare function useClientApi(): import("@comapeo/ipc/dist/client").MapeoClientApi;
+export declare function useClientApi(): import("@comapeo/ipc/dist/client.js").MapeoClientApi;
 /**
  * Retrieve info about the current device.
  *
@@ -38,7 +38,7 @@ export declare function useOwnDeviceInfo(): {
     data: {
         deviceId: string;
         deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
-    } & Partial<import("@comapeo/core/dist/schema/client").DeviceInfoParam>;
+    } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>;
     error: Error | null;
     isRefetching: boolean;
 };

package/dist/{hooks → esm/hooks}/client.js

@@ -1,7 +1,7 @@
 import { useSuspenseQuery } from '@tanstack/react-query';
 import { useContext } from 'react';
-import { ClientApiContext } from '../contexts/ClientApi';
-import { deviceInfoQueryOptions, isArchiveDeviceQueryOptions, } from '../lib/react-query/client';
+import { ClientApiContext } from '../contexts/ClientApi.js';
+import { deviceInfoQueryOptions, isArchiveDeviceQueryOptions, } from '../lib/react-query/client.js';
 /**
  * Access a client API instance. If a ClientApiContext provider is not
  * set up, it will throw an error.

package/dist/esm/hooks/documents.d.ts

@@ -0,0 +1,112 @@
+import type { MapeoDoc } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import { type DocumentType } from '../lib/react-query/documents.js';
+type ReadHookResult<D> = {
+    data: D;
+    error: Error | null;
+    isRefetching: boolean;
+};
+/**
+ * Retrieve a single document from the database based on the document's document ID.
+ *
+ * Triggers the closest error boundary if the document cannot be found
+ *
+ * @param opts.projectId Project public ID
+ * @param opts.docType Document type of interest
+ * @param opts.docId Document ID
+ * @param opts.lang Language to translate the document into
+ *
+ * @example
+ * ```tsx
+ * function SingleDocumentByDocIdExample() {
+ *   const { data } = useSingleDocByDocId({
+ *     projectId: '...',
+ *     docType: 'observation',
+ *     docId: '...',
+ *   })
+ *
+ *   console.log(data.schemaName) // logs 'observation'
+ * }
+ * ```
+ */
+export declare function useSingleDocByDocId<D extends DocumentType>({ projectId, docType, docId, lang, }: {
+    projectId: string;
+    docType: D;
+    docId: string;
+    lang?: string;
+}): ReadHookResult<Extract<MapeoDoc, {
+    schemaName: D;
+}>>;
+/**
+ * Retrieve a single document from the database based on the document's version ID.
+ *
+ * Triggers the closest error boundary if the document cannot be found.
+ *
+ * @param opts.projectId Project public ID
+ * @param opts.docType Document type of interest
+ * @param opts.versionId Document's version ID
+ * @param opts.lang Language to translate the document into
+ *
+ *  * @example
+ * ```tsx
+ * function SingleDocumentByVersionIdExample() {
+ *   const { data } = useSingleDocByVersionId({
+ *     projectId: '...',
+ *     docType: 'observation',
+ *     docId: '...',
+ *   })
+ *
+ *   console.log(data.schemaName) // logs 'observation'
+ * }
+ * ```
+ */
+export declare function useSingleDocByVersionId<D extends DocumentType>({ projectId, docType, versionId, lang, }: {
+    projectId: string;
+    docType: D;
+    versionId: string;
+    lang?: string;
+}): ReadHookResult<Extract<MapeoDoc, {
+    schemaName: D;
+}>>;
+/**
+ * Retrieve all documents of a specific `docType`.
+ *
+ * @param opts.projectId Project public ID
+ * @param opts.docType Document type of interest
+ * @param opts.includeDeleted Include documents that have been marked as deleted
+ * @param opts.lang Language to translate the documents into
+ *
+ * @example
+ * ```tsx
+ * function BasicExample() {
+ *   const { data } = useManyDocs({
+ *     projectId: '...',
+ *     docType: 'observations',
+ *   })
+ * }
+ * ```
+ *
+ * ```tsx
+ * function useAllObservations(opts) {
+ *   return useManyDocs({
+ *     ...opts,
+ *     docType: 'observations',
+ *   })
+ * }
+ *
+ * function useAllPresets(opts) {
+ *   return useManyDocs({
+ *     ...opts,
+ *     docType: 'presets',
+ *   })
+ * }
+ * ```
+ */
+export declare function useManyDocs<D extends DocumentType>({ projectId, docType, includeDeleted, lang, }: {
+    projectId: string;
+    docType: D;
+    includeDeleted?: boolean;
+    lang?: string;
+}): ReadHookResult<Extract<MapeoDoc, {
+    schemaName: D;
+}>>;
+export {};

package/dist/{hooks → esm/hooks}/documents.js

@@ -1,6 +1,6 @@
 import { useSuspenseQuery } from '@tanstack/react-query';
-import { documentByDocumentIdQueryOptions, documentByVersionIdQueryOptions, documentsQueryOptions, } from '../lib/react-query/documents';
-import { useSingleProject } from './projects';
+import { documentByDocumentIdQueryOptions, documentByVersionIdQueryOptions, documentsQueryOptions, } from '../lib/react-query/documents.js';
+import { useSingleProject } from './projects.js';
 /**
  * Retrieve a single document from the database based on the document's document ID.
  *

package/dist/esm/hooks/maps.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Get a URL that points to a StyleJSON resource served by the embedded HTTP server.
+ *
+ * If `opts.refreshToken` is specified, it will be appended to the returned URL as a search param. This is useful for forcing cache busting
+ * due to hidden internal details by consuming components (e.g. map component from MapLibre).
+ *
+ * @param opts.refreshToken String to append to the returned value as a search param
+ *
+ * @example
+ * ```tsx
+ * function ExampleWithoutRefreshToken() {
+ *   const { data, isRefetching } = useMapStyleUrl()
+ *
+ *   console.log(data) // logs something like 'http://localhost:...'
+ * }
+ * ```
+ *
+ * ```tsx
+ * function ExampleWithRefreshToken() {
+ *   const [refreshToken] = useState('foo')
+ *   const { data } = useMapStyleUrl({ refreshToken })
+ *
+ *   console.log(data) // logs something like 'http://localhost:...?refresh_token=foo'
+ * }
+ * ```
+ */
+export declare function useMapStyleUrl({ refreshToken, }?: {
+    refreshToken?: string;
+}): {
+    data: string;
+    error: Error | null;
+    isRefetching: boolean;
+};

package/dist/{hooks → esm/hooks}/maps.js

@@ -1,6 +1,6 @@
 import { useSuspenseQuery } from '@tanstack/react-query';
-import { mapStyleJsonUrlQueryOptions } from '../lib/react-query/maps';
-import { useClientApi } from './client';
+import { mapStyleJsonUrlQueryOptions } from '../lib/react-query/maps.js';
+import { useClientApi } from './client.js';
 /**
  * Get a URL that points to a StyleJSON resource served by the embedded HTTP server.
  *