@comapeo/core-react 9.0.2 → 10.0.0

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

@@ -1,137 +0,0 @@
-import { queryOptions, } from '@tanstack/react-query';
-import { baseMutationOptions, baseQueryOptions, ROOT_QUERY_KEY, } from './shared.js';
-export function getDocumentsQueryKey({ projectId, docType, }) {
-    return [ROOT_QUERY_KEY, 'projects', projectId, docType];
-}
-export function getManyDocumentsQueryKey({ projectId, docType, includeDeleted, lang, }) {
-    return [
-        ROOT_QUERY_KEY,
-        'projects',
-        projectId,
-        docType,
-        { includeDeleted, lang },
-    ];
-}
-export function getDocumentByDocIdQueryKey({ projectId, docType, docId, lang, }) {
-    return [
-        ROOT_QUERY_KEY,
-        'projects',
-        projectId,
-        docType,
-        docId,
-        { lang },
-    ];
-}
-export function getDocumentByVersionIdQueryKey({ projectId, docType, versionId, lang, }) {
-    return [
-        ROOT_QUERY_KEY,
-        'projects',
-        projectId,
-        docType,
-        versionId,
-        { lang },
-    ];
-}
-export function documentsQueryOptions({ projectApi, projectId, docType, includeDeleted, lang, }) {
-    return queryOptions({
-        ...baseQueryOptions(),
-        queryKey: getManyDocumentsQueryKey({
-            projectId,
-            docType,
-            includeDeleted,
-            lang,
-        }),
-        queryFn: async () => {
-            return projectApi[docType].getMany({
-                includeDeleted,
-                lang,
-            });
-        },
-    });
-}
-export function documentByDocumentIdQueryOptions({ projectApi, projectId, docType, docId, lang, }) {
-    return queryOptions({
-        ...baseQueryOptions(),
-        queryKey: getDocumentByDocIdQueryKey({
-            projectId,
-            docType,
-            docId,
-            lang,
-        }),
-        queryFn: async () => {
-            return projectApi[docType].getByDocId(docId, {
-                lang,
-                // 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, lang, }) {
-    return queryOptions({
-        ...baseQueryOptions(),
-        queryKey: getDocumentByVersionIdQueryKey({
-            projectId,
-            docType,
-            versionId,
-            lang,
-        }),
-        queryFn: async () => {
-            return projectApi[docType].getByVersionId(versionId, { lang });
-        },
-    });
-}
-export function createDocumentMutationOptions({ docType, projectApi, projectId, queryClient, }) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ value }) => {
-            // @ts-expect-error TS not handling this well
-            return projectApi[docType].create({
-                ...value,
-                schemaName: docType,
-            });
-        },
-        onSuccess: () => {
-            queryClient.invalidateQueries({
-                queryKey: getDocumentsQueryKey({
-                    projectId,
-                    docType,
-                }),
-            });
-        },
-    };
-}
-export function updateDocumentMutationOptions({ docType, projectApi, projectId, queryClient, }) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ versionId, value }) => {
-            // @ts-expect-error TS not handling this well
-            return projectApi[docType].update(versionId, value);
-        },
-        onSuccess: () => {
-            queryClient.invalidateQueries({
-                queryKey: getDocumentsQueryKey({
-                    projectId,
-                    docType,
-                }),
-            });
-        },
-    };
-}
-export function deleteDocumentMutationOptions({ docType, projectApi, projectId, queryClient, }) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ docId }) => {
-            // @ts-expect-error TS not handling this well
-            return projectApi[docType].delete(docId);
-        },
-        onSuccess: () => {
-            queryClient.invalidateQueries({
-                queryKey: getDocumentsQueryKey({
-                    projectId,
-                    docType,
-                }),
-            });
-        },
-    };
-}

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

@@ -1,88 +0,0 @@
-import type { MemberApi } from '@comapeo/core' with {
-    'resolution-mode': 'import'
-};
-import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with {
-    'resolution-mode': 'import'
-};
-import { type QueryClient } from '@tanstack/react-query';
-export declare function getInvitesQueryKey(): readonly ["@comapeo/core-react", "invites"];
-export declare function getInvitesByIdQueryKey({ inviteId }: {
-    inviteId: string;
-}): readonly ["@comapeo/core-react", "invites", {
-    readonly inviteId: string;
-}];
-export declare function getInvitesQueryOptions({ clientApi, }: {
-    clientApi: MapeoClientApi;
-}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/invite/invite-api.js").Invite[], Error, import("@comapeo/core/dist/invite/invite-api.js").Invite[], readonly ["@comapeo/core-react", "invites"]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/invite/invite-api.js").Invite[], readonly ["@comapeo/core-react", "invites"], never> | undefined;
-} & {
-    queryKey: readonly ["@comapeo/core-react", "invites"] & {
-        [dataTagSymbol]: import("@comapeo/core/dist/invite/invite-api.js").Invite[];
-        [dataTagErrorSymbol]: Error;
-    };
-};
-export declare function getInviteByIdQueryOptions({ clientApi, inviteId, }: {
-    clientApi: MapeoClientApi;
-    inviteId: string;
-}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/invite/invite-api.js").Invite, Error, import("@comapeo/core/dist/invite/invite-api.js").Invite, readonly ["@comapeo/core-react", "invites", {
-    readonly inviteId: string;
-}]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/invite/invite-api.js").Invite, readonly ["@comapeo/core-react", "invites", {
-        readonly inviteId: string;
-    }], never> | undefined;
-} & {
-    queryKey: readonly ["@comapeo/core-react", "invites", {
-        readonly inviteId: string;
-    }] & {
-        [dataTagSymbol]: import("@comapeo/core/dist/invite/invite-api.js").Invite;
-        [dataTagErrorSymbol]: Error;
-    };
-};
-export declare function acceptInviteMutationOptions({ clientApi, queryClient, }: {
-    clientApi: MapeoClientApi;
-    queryClient: QueryClient;
-}): {
-    mutationFn: ({ inviteId }: {
-        inviteId: string;
-    }) => Promise<string>;
-    onSuccess: () => void;
-    networkMode: "always";
-    retry: false;
-};
-export declare function rejectInviteMutationOptions({ clientApi, queryClient, }: {
-    clientApi: MapeoClientApi;
-    queryClient: QueryClient;
-}): {
-    mutationFn: ({ inviteId }: {
-        inviteId: string;
-    }) => Promise<void>;
-    onSuccess: () => void;
-    networkMode: "always";
-    retry: false;
-};
-export declare function sendInviteMutationOptions({ projectApi, projectId, queryClient, }: {
-    projectApi: MapeoProjectApi;
-    projectId: string;
-    queryClient: QueryClient;
-}): {
-    mutationFn: ({ deviceId, ...role }: {
-        deviceId: string;
-        roleDescription?: string;
-        roleId: MemberApi.RoleIdForNewInvite;
-        roleName?: string;
-    }) => Promise<"ACCEPT" | "REJECT" | "ALREADY">;
-    onSuccess: () => void;
-    networkMode: "always";
-    retry: false;
-};
-export declare function requestCancelInviteMutationOptions({ projectApi, queryClient, }: {
-    projectApi: MapeoProjectApi;
-    queryClient: QueryClient;
-}): {
-    mutationFn: ({ deviceId }: {
-        deviceId: string;
-    }) => Promise<void>;
-    onSuccess: () => void;
-    networkMode: "always";
-    retry: false;
-};

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

@@ -1,85 +0,0 @@
-import { queryOptions, } from '@tanstack/react-query';
-import { getMembersQueryKey, getProjectsQueryKey } from './projects.js';
-import { baseMutationOptions, baseQueryOptions, ROOT_QUERY_KEY, } from './shared.js';
-export function getInvitesQueryKey() {
-    return [ROOT_QUERY_KEY, 'invites'];
-}
-export function getInvitesByIdQueryKey({ inviteId }) {
-    return [ROOT_QUERY_KEY, 'invites', { inviteId }];
-}
-export function getInvitesQueryOptions({ clientApi, }) {
-    return queryOptions({
-        ...baseQueryOptions(),
-        queryKey: getInvitesQueryKey(),
-        queryFn: async () => {
-            return clientApi.invite.getMany();
-        },
-    });
-}
-export function getInviteByIdQueryOptions({ clientApi, inviteId, }) {
-    return queryOptions({
-        ...baseQueryOptions(),
-        queryKey: getInvitesByIdQueryKey({ inviteId }),
-        queryFn: async () => {
-            return clientApi.invite.getById(inviteId);
-        },
-    });
-}
-export function acceptInviteMutationOptions({ clientApi, queryClient, }) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ inviteId }) => {
-            return clientApi.invite.accept({ inviteId });
-        },
-        onSuccess: () => {
-            queryClient.invalidateQueries({
-                queryKey: getInvitesQueryKey(),
-            });
-            queryClient.invalidateQueries({
-                queryKey: getProjectsQueryKey(),
-            });
-        },
-    };
-}
-export function rejectInviteMutationOptions({ clientApi, queryClient, }) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ inviteId }) => {
-            return clientApi.invite.reject({ inviteId });
-        },
-        onSuccess: () => {
-            queryClient.invalidateQueries({
-                queryKey: getInvitesQueryKey(),
-            });
-        },
-    };
-}
-export function sendInviteMutationOptions({ projectApi, projectId, queryClient, }) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ deviceId, ...role }) => {
-            return projectApi.$member.invite(deviceId, role);
-        },
-        onSuccess: () => {
-            queryClient.invalidateQueries({
-                queryKey: getInvitesQueryKey(),
-            });
-            queryClient.invalidateQueries({
-                queryKey: getMembersQueryKey({ projectId }),
-            });
-        },
-    };
-}
-export function requestCancelInviteMutationOptions({ projectApi, queryClient, }) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ deviceId }) => {
-            return projectApi.$member.requestCancelInvite(deviceId);
-        },
-        onSuccess: () => {
-            queryClient.invalidateQueries({
-                queryKey: getInvitesQueryKey(),
-            });
-        },
-    };
-}

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

@@ -1,104 +0,0 @@
-import { type QueryClient, type UseMutationOptions } from '@tanstack/react-query';
-import type { MapServerApi } from '../../contexts/MapServer.js';
-import type { ReceivedMapSharesStore, SentMapSharesStore } from '../map-shares-stores.js';
-type CompatFile = Omit<File, 'lastModified' | 'webkitRelativePath'>;
-type ExpoFileDuckType = CompatFile & {
-    exists: boolean;
-};
-export declare function getMapQueryKey({ mapId }: {
-    mapId: string;
-}): readonly ["@comapeo/core-react", "maps", string];
-export declare function getStyleJsonUrlQueryKey({ mapId }: {
-    mapId: string;
-}): readonly ["@comapeo/core-react", "maps", string, "stylejson_url"];
-/**
- * Invalidate queries for this map and the default map (which internally
- * redirects to custom) so that they will be refetched with the new map data.
- */
-export declare function invalidateMapQueries(queryClient: QueryClient, { mapId }: {
-    mapId: string;
-}): Promise<void>;
-export declare function mapStyleJsonUrlQueryOptions({ mapServerApi, mapId, }: {
-    mapServerApi: MapServerApi;
-    mapId?: string;
-}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, readonly ["@comapeo/core-react", "maps", string, "stylejson_url"]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<string, readonly ["@comapeo/core-react", "maps", string, "stylejson_url"], never> | undefined;
-} & {
-    queryKey: readonly ["@comapeo/core-react", "maps", string, "stylejson_url"] & {
-        [dataTagSymbol]: string;
-        [dataTagErrorSymbol]: Error;
-    };
-};
-export declare function mapInfoQueryOptions({ mapServerApi, mapId, }: {
-    mapServerApi: MapServerApi;
-    mapId?: string;
-}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
-    mapId: string;
-    mapName: string;
-    estimatedSizeBytes: number;
-    bounds: readonly [number, number, number, number];
-    minzoom: number;
-    maxzoom: number;
-    mapCreatedAt: number;
-}, Error, {
-    mapId: string;
-    mapName: string;
-    estimatedSizeBytes: number;
-    bounds: readonly [number, number, number, number];
-    minzoom: number;
-    maxzoom: number;
-    mapCreatedAt: number;
-}, readonly ["@comapeo/core-react", "maps", string, "info"]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<{
-        mapId: string;
-        mapName: string;
-        estimatedSizeBytes: number;
-        bounds: readonly [number, number, number, number];
-        minzoom: number;
-        maxzoom: number;
-        mapCreatedAt: number;
-    }, readonly ["@comapeo/core-react", "maps", string, "info"], never> | undefined;
-} & {
-    queryKey: readonly ["@comapeo/core-react", "maps", string, "info"] & {
-        [dataTagSymbol]: {
-            mapId: string;
-            mapName: string;
-            estimatedSizeBytes: number;
-            bounds: readonly [number, number, number, number];
-            minzoom: number;
-            maxzoom: number;
-            mapCreatedAt: number;
-        };
-        [dataTagErrorSymbol]: Error;
-    };
-};
-export declare function mapImportMutationOptions({ mapServerApi, queryClient, }: {
-    mapServerApi: MapServerApi;
-    queryClient: QueryClient;
-}): {
-    mutationFn: ({ file }: {
-        file: File | ExpoFileDuckType;
-    }) => Promise<Response>;
-    onSuccess: () => Promise<void>;
-    networkMode: "always";
-    retry: false;
-};
-export declare function mapRemoveMutationOptions({ mapServerApi, queryClient, }: {
-    mapServerApi: MapServerApi;
-    queryClient: QueryClient;
-}): {
-    mutationFn: () => Promise<Response>;
-    onSuccess: () => Promise<void>;
-    networkMode: "always";
-    retry: false;
-};
-/**
- * Mutation options for actions on sent map shares
- */
-export declare function mapSharesMutationOptions<TAction extends SentMapSharesStore['actions'][keyof SentMapSharesStore['actions']] | keyof ReceivedMapSharesStore['actions'][keyof ReceivedMapSharesStore['actions']]>(options: {
-    action: Exclude<TAction, SentMapSharesStore['actions']['createAndSend']>;
-} | {
-    action: SentMapSharesStore['actions']['createAndSend'];
-    projectId: string;
-}): UseMutationOptions<ReturnType<TAction>, Error, TAction extends SentMapSharesStore['actions']['createAndSend'] ? Parameters<TAction>[0] : Omit<Parameters<TAction>[0], 'projectId'>>;
-export {};

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

@@ -1,119 +0,0 @@
-import { CUSTOM_MAP_ID, DEFAULT_MAP_ID } from '@comapeo/map-server/constants.js';
-import { queryOptions, } from '@tanstack/react-query';
-import { baseMutationOptions, baseQueryOptions, ROOT_QUERY_KEY, } from './shared.js';
-// ============================================
-// QUERY KEYS
-// ============================================
-const MAPS_ROOT_QUERY_KEY = [ROOT_QUERY_KEY, 'maps'];
-export function getMapQueryKey({ mapId }) {
-    return [...MAPS_ROOT_QUERY_KEY, mapId];
-}
-export function getStyleJsonUrlQueryKey({ mapId }) {
-    return [...getMapQueryKey({ mapId }), 'stylejson_url'];
-}
-/**
- * Invalidate queries for this map and the default map (which internally
- * redirects to custom) so that they will be refetched with the new map data.
- */
-export async function invalidateMapQueries(queryClient, { mapId }) {
-    await Promise.all([
-        queryClient.invalidateQueries({
-            queryKey: getMapQueryKey({ mapId }),
-        }),
-        queryClient.invalidateQueries({
-            queryKey: getMapQueryKey({ mapId: DEFAULT_MAP_ID }),
-        }),
-    ]);
-}
-// ============================================
-// QUERY OPTIONS
-// ============================================
-export function mapStyleJsonUrlQueryOptions({ mapServerApi, mapId = DEFAULT_MAP_ID, }) {
-    if (mapId !== DEFAULT_MAP_ID) {
-        throw new Error('Custom map IDs are not supported yet');
-    }
-    return queryOptions({
-        ...baseQueryOptions(),
-        queryKey: getStyleJsonUrlQueryKey({ mapId }),
-        queryFn: async () => {
-            const result = await mapServerApi.getMapStyleJsonUrl(mapId);
-            const u = new URL(result);
-            // This ensures that every time this query is refetched, it will have a different search param, forcing the map to reload.
-            u.searchParams.set('refresh_token', Date.now().toString());
-            return u.href;
-        },
-        // Keep this cached until the cache is manually invalidated by a map upload
-        staleTime: Infinity,
-        gcTime: Infinity,
-    });
-}
-export function mapInfoQueryOptions({ mapServerApi, mapId = DEFAULT_MAP_ID, }) {
-    if (mapId !== CUSTOM_MAP_ID) {
-        throw new Error('Only custom map ID is currently supported');
-    }
-    return queryOptions({
-        ...baseQueryOptions(),
-        queryKey: [...getMapQueryKey({ mapId }), 'info'],
-        queryFn: async () => {
-            return mapServerApi.get(`maps/${mapId}/info`).json();
-        },
-        // Keep this cached until the cache is manually invalidated by a map upload
-        staleTime: Infinity,
-        gcTime: Infinity,
-    });
-}
-// ============================================
-// MUTATION OPTIONS
-// ============================================
-export function mapImportMutationOptions({ mapServerApi, queryClient, }) {
-    // TODO: Support importing to custom map IDs, to support multiple maps.
-    const mapId = CUSTOM_MAP_ID;
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async ({ file }) => {
-            if ('exists' in file && !file.exists) {
-                throw new Error('File does not exist or is not accessible');
-            }
-            return mapServerApi.put(`maps/${mapId}`, {
-                body: file,
-                headers: {
-                    'Content-Type': 'application/octet-stream',
-                },
-            });
-        },
-        onSuccess: async () => {
-            await invalidateMapQueries(queryClient, { mapId });
-        },
-    };
-}
-export function mapRemoveMutationOptions({ mapServerApi, queryClient, }) {
-    // TODO: Support removing from custom map IDs, to support multiple maps.
-    const mapId = CUSTOM_MAP_ID;
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async () => {
-            return mapServerApi.delete(`maps/${mapId}`);
-        },
-        onSuccess: async () => {
-            await invalidateMapQueries(queryClient, { mapId });
-        },
-    };
-}
-/**
- * Mutation options for actions on sent map shares
- */
-export function mapSharesMutationOptions(options) {
-    return {
-        ...baseMutationOptions(),
-        mutationFn: async (variables) => {
-            // For consistency with other hooks, we use `projectId` as a parameter of
-            // the hook, rather than a parameter of the mutate function.
-            const actionOptions = 'projectId' in options
-                ? { ...variables, projectId: options.projectId }
-                : variables;
-            return options.action(
-            // @ts-expect-error - TS can't help us here
-            actionOptions);
-        },
-    };
-}

package/dist/esm/lib/react-query/mutation-result.d.ts

@@ -1,8 +0,0 @@
-import type { UseMutationResult } from '@tanstack/react-query';
-import type { DistributedPick } from 'type-fest';
-/**
- * Filters a `UseMutationResult` to only include a subset of its keys, and uses
- * `DistributedPick` to preserve the discriminated union types of the mutation
- * result based on the `status` property.
- */
-export declare function filterMutationResult<TResult extends UseMutationResult<any, any, any, any>>(mutationResult: TResult): DistributedPick<TResult, "error" | "status" | "mutate" | "reset" | "mutateAsync">;

package/dist/esm/lib/react-query/mutation-result.js

@@ -1,19 +0,0 @@
-const PICKED_MUTATION_RESULT_KEYS = [
-    'error',
-    'mutate',
-    'mutateAsync',
-    'reset',
-    'status',
-];
-/**
- * Filters a `UseMutationResult` to only include a subset of its keys, and uses
- * `DistributedPick` to preserve the discriminated union types of the mutation
- * result based on the `status` property.
- */
-export function filterMutationResult(mutationResult) {
-    const filteredResult = {};
-    for (const key of PICKED_MUTATION_RESULT_KEYS) {
-        filteredResult[key] = mutationResult[key];
-    }
-    return filteredResult;
-}