@comapeo/core-react 0.1.0

package/dist/lib/react-query/documents.js

@@ -0,0 +1,62 @@
+import { queryOptions } from '@tanstack/react-query';
+import { baseQueryOptions, ROOT_QUERY_KEY } from './shared';
+export function getDocumentsQueryKey({ projectId, docType, }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, docType];
+}
+export function getManyDocumentsQueryKey({ projectId, docType, opts, }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, docType, opts];
+}
+export function getDocumentByDocIdQueryKey({ projectId, docType, docId, opts, }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, docType, docId, opts];
+}
+export function getDocumentByVersionIdQueryKey({ projectId, docType, versionId, opts, }) {
+    return [
+        ROOT_QUERY_KEY,
+        'projects',
+        projectId,
+        docType,
+        versionId,
+        opts,
+    ];
+}
+export function documentsQueryOptions({ projectApi, projectId, docType, opts, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getManyDocumentsQueryKey({ projectId, docType, opts }),
+        queryFn: async () => {
+            return projectApi[docType].getMany(opts);
+        },
+    });
+}
+export function documentByDocumentIdQueryOptions({ projectApi, projectId, docType, docId, opts, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getDocumentByDocIdQueryKey({
+            projectId,
+            docType,
+            docId,
+            opts,
+        }),
+        queryFn: async () => {
+            return projectApi[docType].getByDocId(docId, {
+                ...opts,
+                // We want to make sure that this throws in the case that no match is found
+                mustBeFound: true,
+            });
+        },
+    });
+}
+export function documentByVersionIdQueryOptions({ projectApi, projectId, docType, versionId, opts, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getDocumentByVersionIdQueryKey({
+            projectId,
+            docType,
+            versionId,
+            opts,
+        }),
+        queryFn: async () => {
+            return projectApi[docType].getByVersionId(versionId, opts);
+        },
+    });
+}

package/dist/lib/react-query/invites.d.ts

@@ -0,0 +1,12 @@
+import type { MapeoClientApi } from '@comapeo/ipc';
+export declare function getInvitesQueryKey(): readonly ["@comapeo/core-react", "invites"];
+export declare function getPendingInvitesQueryKey(): readonly ["@comapeo/core-react", "invites", {
+    readonly status: "pending";
+}];
+export declare function pendingInvitesQueryOptions({ clientApi, }: {
+    clientApi: MapeoClientApi;
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/types").MapBuffers<import("@comapeo/core/dist/invite-api").InviteInternal>[], Error, import("@comapeo/core/dist/types").MapBuffers<import("@comapeo/core/dist/invite-api").InviteInternal>[], import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<import("@comapeo/core/dist/types").MapBuffers<import("@comapeo/core/dist/invite-api").InviteInternal>[], import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, import("@comapeo/core/dist/types").MapBuffers<import("@comapeo/core/dist/invite-api").InviteInternal>[]>;
+};

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

@@ -0,0 +1,17 @@
+import { queryOptions } from '@tanstack/react-query';
+import { baseQueryOptions, ROOT_QUERY_KEY } from './shared';
+export function getInvitesQueryKey() {
+    return [ROOT_QUERY_KEY, 'invites'];
+}
+export function getPendingInvitesQueryKey() {
+    return [ROOT_QUERY_KEY, 'invites', { status: 'pending' }];
+}
+export function pendingInvitesQueryOptions({ clientApi, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getPendingInvitesQueryKey(),
+        queryFn: async () => {
+            return clientApi.invite.getPending();
+        },
+    });
+}

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

@@ -0,0 +1,15 @@
+import type { MapeoClientApi } from '@comapeo/ipc';
+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/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<string, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, string>;
+};

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

@@ -0,0 +1,18 @@
+import { queryOptions } from '@tanstack/react-query';
+import { baseQueryOptions, ROOT_QUERY_KEY } from './shared';
+export function getMapsQueryKey() {
+    return [ROOT_QUERY_KEY, 'maps'];
+}
+export function getStyleJsonUrlQueryKey({ refreshToken, }) {
+    return [ROOT_QUERY_KEY, 'maps', 'stylejson_url', { refreshToken }];
+}
+export function mapStyleJsonUrlQueryOptions({ clientApi, refreshToken, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getStyleJsonUrlQueryKey({ refreshToken }),
+        queryFn: async () => {
+            const result = await clientApi.getMapStyleJsonUrl();
+            return refreshToken ? result + `?refresh_token=${refreshToken}` : result;
+        },
+    });
+}

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

@@ -0,0 +1,188 @@
+import type { BlobId } from '@comapeo/core/dist/types.js';
+import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc';
+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, opts, }: {
+    projectId: string;
+    iconId: Parameters<MapeoProjectApi['$icons']['getIconUrl']>[0];
+    opts: Parameters<MapeoProjectApi['$icons']['getIconUrl']>[1];
+}): readonly ["@comapeo/core-react", "projects", string, "icons", string, import("@comapeo/core/dist/icon-api").BitmapOpts | import("@comapeo/core/dist/icon-api").SvgOpts];
+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/query-core").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/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").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/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").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/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>, Error, import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>>;
+};
+export declare function projectSettingsQueryOptions({ projectApi, projectId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/mapeo-project").EditableProjectSettings, Error, import("@comapeo/core/dist/mapeo-project").EditableProjectSettings, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<import("@comapeo/core/dist/mapeo-project").EditableProjectSettings, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, import("@comapeo/core/dist/mapeo-project").EditableProjectSettings>;
+};
+export declare function projectMembersQueryOptions({ projectApi, projectId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/member-api").MemberInfo[], Error, import("@comapeo/core/dist/member-api").MemberInfo[], import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<import("@comapeo/core/dist/member-api").MemberInfo[], import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, import("@comapeo/core/dist/member-api").MemberInfo[]>;
+};
+export declare function projectMemberByIdQueryOptions({ projectApi, projectId, deviceId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    deviceId: string;
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/member-api").MemberInfo, Error, import("@comapeo/core/dist/member-api").MemberInfo, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<import("@comapeo/core/dist/member-api").MemberInfo, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, import("@comapeo/core/dist/member-api").MemberInfo>;
+};
+export declare function projectOwnRoleQueryOptions({ projectApi, projectId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/roles").Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">, Error, import("@comapeo/core/dist/roles").Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<import("@comapeo/core/dist/roles").Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, import("@comapeo/core/dist/roles").Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">>;
+};
+export declare function iconUrlQueryOptions({ projectApi, projectId, iconId, opts, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    iconId: Parameters<MapeoProjectApi['$icons']['getIconUrl']>[0];
+    opts: Parameters<MapeoProjectApi['$icons']['getIconUrl']>[1];
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<string, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, string>;
+};
+export declare function documentCreatedByQueryOptions({ projectApi, projectId, originalVersionId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    originalVersionId: string;
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<string, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, string>;
+};
+export declare function attachmentUrlQueryOptions({ projectApi, projectId, blobId, }: {
+    projectApi: MapeoProjectApi;
+    projectId: string;
+    blobId: BlobId;
+}): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, import("@tanstack/query-core").QueryKey>, "queryFn"> & {
+    queryFn?: import("@tanstack/query-core").QueryFunction<string, import("@tanstack/query-core").QueryKey, never> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core").DataTag<import("@tanstack/query-core").QueryKey, string>;
+};

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

@@ -0,0 +1,120 @@
+import { queryOptions } from '@tanstack/react-query';
+import { baseQueryOptions, ROOT_QUERY_KEY } from './shared';
+export function getProjectsQueryKey() {
+    return [ROOT_QUERY_KEY, 'projects'];
+}
+export function getProjectByIdQueryKey({ projectId }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId];
+}
+export function getProjectSettingsQueryKey({ projectId, }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, 'project_settings'];
+}
+export function getProjectRoleQueryKey({ projectId }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, 'role'];
+}
+export function getMembersQueryKey({ projectId }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, 'members'];
+}
+export function getMemberByIdQueryKey({ projectId, deviceId, }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, 'members', deviceId];
+}
+export function getIconUrlQueryKey({ projectId, iconId, opts, }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, 'icons', iconId, opts];
+}
+export function getDocumentCreatedByQueryKey({ projectId, originalVersionId, }) {
+    return [
+        ROOT_QUERY_KEY,
+        'projects',
+        projectId,
+        'document_created_by',
+        originalVersionId,
+    ];
+}
+export function getAttachmentUrlQueryKey({ projectId, blobId, }) {
+    return [ROOT_QUERY_KEY, 'projects', projectId, 'attachments', blobId];
+}
+export function projectsQueryOptions({ clientApi, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getProjectsQueryKey(),
+        queryFn: async () => {
+            return clientApi.listProjects();
+        },
+    });
+}
+export function projectByIdQueryOptions({ clientApi, projectId, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getProjectByIdQueryKey({ projectId }),
+        queryFn: async () => {
+            return clientApi.getProject(projectId);
+        },
+    });
+}
+export function projectSettingsQueryOptions({ projectApi, projectId, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getProjectSettingsQueryKey({ projectId }),
+        queryFn: async () => {
+            return projectApi.$getProjectSettings();
+        },
+    });
+}
+export function projectMembersQueryOptions({ projectApi, projectId, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getMembersQueryKey({ projectId }),
+        queryFn: async () => {
+            return projectApi.$member.getMany();
+        },
+    });
+}
+export function projectMemberByIdQueryOptions({ projectApi, projectId, deviceId, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getMemberByIdQueryKey({ projectId, deviceId }),
+        queryFn: async () => {
+            return projectApi.$member.getById(deviceId);
+        },
+    });
+}
+export function projectOwnRoleQueryOptions({ projectApi, projectId, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getProjectRoleQueryKey({ projectId }),
+        queryFn: async () => {
+            return projectApi.$getOwnRole();
+        },
+    });
+}
+export function iconUrlQueryOptions({ projectApi, projectId, iconId, opts, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getIconUrlQueryKey({ projectId, iconId, opts }),
+        queryFn: async () => {
+            return projectApi.$icons.getIconUrl(iconId, opts);
+        },
+    });
+}
+export function documentCreatedByQueryOptions({ projectApi, projectId, originalVersionId, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getDocumentCreatedByQueryKey({
+            projectId,
+            originalVersionId,
+        }),
+        queryFn: async () => {
+            return projectApi.$originalVersionIdToDeviceId(originalVersionId);
+        },
+    });
+}
+export function attachmentUrlQueryOptions({ projectApi, projectId, blobId, }) {
+    return queryOptions({
+        ...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/lib/react-query/shared.d.ts

@@ -0,0 +1,5 @@
+export declare const ROOT_QUERY_KEY = "@comapeo/core-react";
+export declare function baseQueryOptions(): {
+    networkMode: "always";
+    retry: number;
+};

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

@@ -0,0 +1,12 @@
+export const 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
+export function baseQueryOptions() {
+    return {
+        networkMode: 'always',
+        retry: 0,
+    };
+}