@comapeo/core-react 0.1.1 → 1.0.0

package/dist/hooks/maps.js

@@ -7,8 +7,7 @@ import { useClientApi } from './client';
  * 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 {Object} opts
- * @param {string} opts.refreshToken String to append to the returned value as a search param
+ * @param opts.refreshToken String to append to the returned value as a search param
  *
  * @example
  * ```tsx

package/dist/hooks/projects.d.ts

@@ -1,10 +1,9 @@
+import type { BitmapOpts, SvgOpts } from '@comapeo/core/dist/icon-api';
 import type { BlobId } from '@comapeo/core/dist/types';
-import { iconUrlQueryOptions } from '../lib/react-query/projects';
 /**
  * Retrieve the project settings for a project.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
+ * @param opts.projectId Project public ID
  *
  * @example
  * ```tsx
@@ -27,8 +26,7 @@ export declare function useProjectSettings({ projectId }: {
  *
  * This is mostly used internally by the other hooks and should only be used if certain project APIs are not exposed via the hooks.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
+ * @param opts.projectId Project public ID
  *
  * @example
  * ```tsx
@@ -84,9 +82,8 @@ export declare function useManyProjects(): {
 /**
  * Retrieve a single member of a project.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
- * @param {deviceId} opts.projectId Device ID of interest
+ * @param opts.projectId Project public ID
+ * @param opts.projectId Device ID of interest
  *
  * @example
  * ```tsx
@@ -108,8 +105,7 @@ export declare function useSingleMember({ projectId, deviceId, }: {
 /**
  * Retrieve all members of a project.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
+ * @param opts.projectId Project public ID
  *
  * @example
  * ```tsx
@@ -132,10 +128,11 @@ export declare function useManyMembers({ projectId }: {
  *
  * _TODO: Explain bitmap opts vs svg opts_
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
- * @param {string} opts.iconId Icon ID of interest
- * @param {BitmapOpts | SvgOpts} opts.opts Parameters related to the mime type of the icon of interest
+ * @param opts.projectId Project public ID
+ * @param opts.iconId Icon ID of interest
+ * @param opts.mimeType MIME type of desired resource
+ * @param opts.pixelDensity Pixel density resource (only applicable when `mimeType` is `'image/png'`)
+ * @param opts.size Size of desired resource
  *
  * @example
  * ```tsx
@@ -143,11 +140,9 @@ export declare function useManyMembers({ projectId }: {
  *   const { data } = useIconUrl({
  *     projectId: '...',
  *     iconId: '...',
- *     opts: {
- *       mimeType: 'image/png',
- *       pixelDensity: 1,
- *       size: 'medium'
- *     }
+ *     mimeType: 'image/png',
+ *     pixelDensity: 1,
+ *     size: 'medium'
  *   })
  * }
  * ```
@@ -157,19 +152,16 @@ export declare function useManyMembers({ projectId }: {
  *   const { data } = useIconUrl({
  *     projectId: '...',
  *     iconId: '...',
- *     opts: {
- *       mimeType: 'image/svg',
- *       size: 'medium'
- *     }
+ *     mimeType: 'image/svg',
+ *     size: 'medium'
  *   })
  * }
  * ```
  */
-export declare function useIconUrl({ projectId, iconId, opts, }: {
+export declare function useIconUrl({ projectId, iconId, ...mimeBasedOpts }: {
     projectId: string;
     iconId: string;
-    opts: Parameters<typeof iconUrlQueryOptions>[0]['opts'];
-}): {
+} & (BitmapOpts | SvgOpts)): {
     data: string;
     error: Error | null;
     isRefetching: boolean;
@@ -179,9 +171,8 @@ export declare function useIconUrl({ projectId, iconId, opts, }: {
  *
  * _TODO: Explain BlobId in more depth_
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public Id
- * @param {BlobId} opts.blobId Blob ID of the desired resource
+ * @param opts.projectId Project public Id
+ * @param opts.blobId Blob ID of the desired resource
  *
  * @example
  * ```tsx
@@ -237,9 +228,8 @@ export declare function useAttachmentUrl({ projectId, blobId, }: {
 /**
  * Retrieve the device ID that created a document.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
- * @param {string} opts.originalVersionId Version ID of document
+ * @param opts.projectId Project public ID
+ * @param opts.originalVersionId Version ID of document
  *
  * @example
  * ```tsx

package/dist/hooks/projects.js

@@ -4,8 +4,7 @@ import { useClientApi } from './client';
 /**
  * Retrieve the project settings for a project.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
+ * @param opts.projectId Project public ID
  *
  * @example
  * ```tsx
@@ -33,8 +32,7 @@ export function useProjectSettings({ projectId }) {
  *
  * This is mostly used internally by the other hooks and should only be used if certain project APIs are not exposed via the hooks.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
+ * @param opts.projectId Project public ID
  *
  * @example
  * ```tsx
@@ -81,9 +79,8 @@ export function useManyProjects() {
 /**
  * Retrieve a single member of a project.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
- * @param {deviceId} opts.projectId Device ID of interest
+ * @param opts.projectId Project public ID
+ * @param opts.projectId Device ID of interest
  *
  * @example
  * ```tsx
@@ -106,8 +103,7 @@ export function useSingleMember({ projectId, deviceId, }) {
 /**
  * Retrieve all members of a project.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
+ * @param opts.projectId Project public ID
  *
  * @example
  * ```tsx
@@ -128,10 +124,11 @@ export function useManyMembers({ projectId }) {
  *
  * _TODO: Explain bitmap opts vs svg opts_
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
- * @param {string} opts.iconId Icon ID of interest
- * @param {BitmapOpts | SvgOpts} opts.opts Parameters related to the mime type of the icon of interest
+ * @param opts.projectId Project public ID
+ * @param opts.iconId Icon ID of interest
+ * @param opts.mimeType MIME type of desired resource
+ * @param opts.pixelDensity Pixel density resource (only applicable when `mimeType` is `'image/png'`)
+ * @param opts.size Size of desired resource
  *
  * @example
  * ```tsx
@@ -139,11 +136,9 @@ export function useManyMembers({ projectId }) {
  *   const { data } = useIconUrl({
  *     projectId: '...',
  *     iconId: '...',
- *     opts: {
- *       mimeType: 'image/png',
- *       pixelDensity: 1,
- *       size: 'medium'
- *     }
+ *     mimeType: 'image/png',
+ *     pixelDensity: 1,
+ *     size: 'medium'
  *   })
  * }
  * ```
@@ -153,21 +148,19 @@ export function useManyMembers({ projectId }) {
  *   const { data } = useIconUrl({
  *     projectId: '...',
  *     iconId: '...',
- *     opts: {
- *       mimeType: 'image/svg',
- *       size: 'medium'
- *     }
+ *     mimeType: 'image/svg',
+ *     size: 'medium'
  *   })
  * }
  * ```
  */
-export function useIconUrl({ projectId, iconId, opts, }) {
+export function useIconUrl({ projectId, iconId, ...mimeBasedOpts }) {
     const { data: projectApi } = useSingleProject({ projectId });
     const { data, error, isRefetching } = useSuspenseQuery(iconUrlQueryOptions({
+        ...mimeBasedOpts,
         projectApi,
         projectId,
         iconId,
-        opts,
     }));
     return { data, error, isRefetching };
 }
@@ -176,9 +169,8 @@ export function useIconUrl({ projectId, iconId, opts, }) {
  *
  * _TODO: Explain BlobId in more depth_
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public Id
- * @param {BlobId} opts.blobId Blob ID of the desired resource
+ * @param opts.projectId Project public Id
+ * @param opts.blobId Blob ID of the desired resource
  *
  * @example
  * ```tsx
@@ -236,9 +228,8 @@ export function useAttachmentUrl({ projectId, blobId, }) {
 /**
  * Retrieve the device ID that created a document.
  *
- * @param {Object} opts
- * @param {string} opts.projectId Project public ID
- * @param {string} opts.originalVersionId Version ID of document
+ * @param opts.projectId Project public ID
+ * @param opts.originalVersionId Version ID of document
  *
  * @example
  * ```tsx

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

@@ -1,7 +1,7 @@
 import type { MapeoClientApi } from '@comapeo/ipc';
 export declare function getClientQueryKey(): readonly ["@comapeo/core-react", "client"];
 export declare function getDeviceInfoQueryKey(): readonly ["@comapeo/core-react", "client", "device_info"];
-export declare function getIsArchiveDeviceQueryKey(): readonly ["@comapeo/core-react", "client", "is_remote_archive"];
+export declare function getIsArchiveDeviceQueryKey(): readonly ["@comapeo/core-react", "client", "is_archive_device"];
 export declare function deviceInfoQueryOptions({ clientApi, }: {
     clientApi: MapeoClientApi;
 }): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{

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

@@ -7,7 +7,7 @@ export function getDeviceInfoQueryKey() {
     return [ROOT_QUERY_KEY, 'client', 'device_info'];
 }
 export function getIsArchiveDeviceQueryKey() {
-    return [ROOT_QUERY_KEY, 'client', 'is_remote_archive'];
+    return [ROOT_QUERY_KEY, 'client', 'is_archive_device'];
 }
 export function deviceInfoQueryOptions({ clientApi, }) {
     return queryOptions({

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

@@ -5,28 +5,37 @@ export declare function getDocumentsQueryKey<D extends DocumentType>({ projectId
     projectId: string;
     docType: D;
 }): readonly ["@comapeo/core-react", "projects", string, D];
-export declare function getManyDocumentsQueryKey<D extends DocumentType>({ projectId, docType, opts, }: {
+export declare function getManyDocumentsQueryKey<D extends DocumentType>({ projectId, docType, includeDeleted, lang, }: {
     projectId: string;
     docType: D;
-    opts?: Parameters<MapeoProjectApi[D]['getMany']>[0];
-}): readonly ["@comapeo/core-react", "projects", string, D, Parameters<import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>[D]["getMany"]>[0] | undefined];
-export declare function getDocumentByDocIdQueryKey<D extends DocumentType>({ projectId, docType, docId, opts, }: {
+    includeDeleted?: boolean;
+    lang?: string;
+}): readonly ["@comapeo/core-react", "projects", string, D, {
+    readonly includeDeleted: boolean | undefined;
+    readonly lang: string | undefined;
+}];
+export declare function getDocumentByDocIdQueryKey<D extends DocumentType>({ projectId, docType, docId, lang, }: {
     projectId: string;
     docType: D;
-    docId: Parameters<MapeoProjectApi[D]['getByDocId']>[0];
-    opts?: Parameters<MapeoProjectApi[D]['getByDocId']>[1];
-}): readonly ["@comapeo/core-react", "projects", string, D, Parameters<import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>[D]["getByDocId"]>[0], Parameters<import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>[D]["getByDocId"]>[1] | undefined];
-export declare function getDocumentByVersionIdQueryKey<D extends DocumentType>({ projectId, docType, versionId, opts, }: {
+    docId: string;
+    lang?: string;
+}): readonly ["@comapeo/core-react", "projects", string, D, string, {
+    readonly lang: string | undefined;
+}];
+export declare function getDocumentByVersionIdQueryKey<D extends DocumentType>({ projectId, docType, versionId, lang, }: {
     projectId: string;
     docType: D;
-    versionId: Parameters<MapeoProjectApi[D]['getByVersionId']>[0];
-    opts?: Parameters<MapeoProjectApi[D]['getByVersionId']>[1];
-}): readonly ["@comapeo/core-react", "projects", string, D, Parameters<import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>[D]["getByVersionId"]>[0], Parameters<import("rpc-reflector/lib/types").ClientApi<import("@comapeo/core/dist/mapeo-project").MapeoProject>[D]["getByVersionId"]>[1] | undefined];
-export declare function documentsQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, opts, }: {
+    versionId: string;
+    lang?: string;
+}): readonly ["@comapeo/core-react", "projects", string, D, string, {
+    readonly lang: string | undefined;
+}];
+export declare function documentsQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, includeDeleted, lang, }: {
     projectApi: MapeoProjectApi;
     projectId: string;
     docType: D;
-    opts?: Parameters<MapeoProjectApi[D]['getMany']>[0];
+    includeDeleted?: boolean;
+    lang?: string;
 }): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<({
     schemaName: "track";
     locations: import("@comapeo/schema/dist/schema/track").Position[];
@@ -524,12 +533,12 @@ export declare function documentsQueryOptions<D extends DocumentType>({ projectA
         forks: string[];
     })[]>;
 };
-export declare function documentByDocumentIdQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, docId, opts, }: {
+export declare function documentByDocumentIdQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, docId, lang, }: {
     projectApi: MapeoProjectApi;
     projectId: string;
     docType: D;
-    docId: Parameters<MapeoProjectApi[D]['getByDocId']>[0];
-    opts?: Omit<Parameters<MapeoProjectApi[D]['getByDocId']>[1], 'mustBeFound'>;
+    docId: string;
+    lang?: string;
 }): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<({
     schemaName: "track";
     locations: import("@comapeo/schema/dist/schema/track").Position[];
@@ -1027,12 +1036,12 @@ export declare function documentByDocumentIdQueryOptions<D extends DocumentType>
         forks: string[];
     })>;
 };
-export declare function documentByVersionIdQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, versionId, opts, }: {
+export declare function documentByVersionIdQueryOptions<D extends DocumentType>({ projectApi, projectId, docType, versionId, lang, }: {
     projectApi: MapeoProjectApi;
     projectId: string;
     docType: D;
-    versionId: Parameters<MapeoProjectApi[D]['getByVersionId']>[0];
-    opts?: Parameters<MapeoProjectApi[D]['getByVersionId']>[1];
+    versionId: string;
+    lang?: string;
 }): import("@tanstack/query-core").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
     schemaName: "track";
     locations: import("@comapeo/schema/dist/schema/track").Position[];

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

@@ -3,60 +3,81 @@ 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 getManyDocumentsQueryKey({ projectId, docType, includeDeleted, lang, }) {
+    return [
+        ROOT_QUERY_KEY,
+        'projects',
+        projectId,
+        docType,
+        { includeDeleted, lang },
+    ];
 }
-export function getDocumentByDocIdQueryKey({ projectId, docType, docId, opts, }) {
-    return [ROOT_QUERY_KEY, 'projects', projectId, docType, docId, opts];
+export function getDocumentByDocIdQueryKey({ projectId, docType, docId, lang, }) {
+    return [
+        ROOT_QUERY_KEY,
+        'projects',
+        projectId,
+        docType,
+        docId,
+        { lang },
+    ];
 }
-export function getDocumentByVersionIdQueryKey({ projectId, docType, versionId, opts, }) {
+export function getDocumentByVersionIdQueryKey({ projectId, docType, versionId, lang, }) {
     return [
         ROOT_QUERY_KEY,
         'projects',
         projectId,
         docType,
         versionId,
-        opts,
+        { lang },
     ];
 }
-export function documentsQueryOptions({ projectApi, projectId, docType, opts, }) {
+export function documentsQueryOptions({ projectApi, projectId, docType, includeDeleted, lang, }) {
     return queryOptions({
         ...baseQueryOptions(),
-        queryKey: getManyDocumentsQueryKey({ projectId, docType, opts }),
+        queryKey: getManyDocumentsQueryKey({
+            projectId,
+            docType,
+            includeDeleted,
+            lang,
+        }),
         queryFn: async () => {
-            return projectApi[docType].getMany(opts);
+            return projectApi[docType].getMany({
+                includeDeleted,
+                lang,
+            });
         },
     });
 }
-export function documentByDocumentIdQueryOptions({ projectApi, projectId, docType, docId, opts, }) {
+export function documentByDocumentIdQueryOptions({ projectApi, projectId, docType, docId, lang, }) {
     return queryOptions({
         ...baseQueryOptions(),
         queryKey: getDocumentByDocIdQueryKey({
             projectId,
             docType,
             docId,
-            opts,
+            lang,
         }),
         queryFn: async () => {
             return projectApi[docType].getByDocId(docId, {
-                ...opts,
+                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, opts, }) {
+export function documentByVersionIdQueryOptions({ projectApi, projectId, docType, versionId, lang, }) {
     return queryOptions({
         ...baseQueryOptions(),
         queryKey: getDocumentByVersionIdQueryKey({
             projectId,
             docType,
             versionId,
-            opts,
+            lang,
         }),
         queryFn: async () => {
-            return projectApi[docType].getByVersionId(versionId, opts);
+            return projectApi[docType].getByVersionId(versionId, { lang });
         },
     });
 }

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

@@ -1,3 +1,4 @@
+import type { BitmapOpts, SvgOpts } from '@comapeo/core/dist/icon-api';
 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"];
@@ -17,11 +18,19 @@ 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 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").IconVariant["mimeType"], "image/png">;
+    pixelDensity: Extract<import("@comapeo/core/dist/icon-api").IconVariant, {
+        mimeType: "image/png";
+    }>["pixelDensity"];
+    size: import("@comapeo/core/dist/icon-api").ValidSizes;
+} | {
+    mimeType: Extract<import("@comapeo/core/dist/icon-api").IconVariant["mimeType"], "image/svg+xml">;
+    size: import("@comapeo/core/dist/icon-api").ValidSizes;
+}];
 export declare function getDocumentCreatedByQueryKey({ projectId, originalVersionId, }: {
     projectId: string;
     originalVersionId: string;
@@ -158,12 +167,11 @@ export declare function projectOwnRoleQueryOptions({ projectApi, projectId, }: {
 } & {
     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, }: {
+export declare function iconUrlQueryOptions({ projectApi, projectId, iconId, ...mimeBasedOpts }: {
     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"> & {
+} & (BitmapOpts | SvgOpts)): 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

@@ -18,8 +18,15 @@ export function getMembersQueryKey({ projectId }) {
 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 getIconUrlQueryKey({ projectId, iconId, ...mimeBasedOpts }) {
+    return [
+        ROOT_QUERY_KEY,
+        'projects',
+        projectId,
+        'icons',
+        iconId,
+        mimeBasedOpts,
+    ];
 }
 export function getDocumentCreatedByQueryKey({ projectId, originalVersionId, }) {
     return [
@@ -87,12 +94,12 @@ export function projectOwnRoleQueryOptions({ projectApi, projectId, }) {
         },
     });
 }
-export function iconUrlQueryOptions({ projectApi, projectId, iconId, opts, }) {
+export function iconUrlQueryOptions({ projectApi, projectId, iconId, ...mimeBasedOpts }) {
     return queryOptions({
         ...baseQueryOptions(),
-        queryKey: getIconUrlQueryKey({ projectId, iconId, opts }),
+        queryKey: getIconUrlQueryKey({ ...mimeBasedOpts, projectId, iconId }),
         queryFn: async () => {
-            return projectApi.$icons.getIconUrl(iconId, opts);
+            return projectApi.$icons.getIconUrl(iconId, mimeBasedOpts);
         },
     });
 }