@comapeo/core-react 6.3.0 → 6.4.0

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

@@ -1,3 +1,4 @@
+import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
 import type { WriteableDocumentType } from '../lib/types.js';
 /**
  * Retrieve a single document from the database based on the document's document ID.
@@ -545,3 +546,37 @@ export declare function useDeleteDocument<D extends WriteableDocumentType>({ doc
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
+/**
+ * Retrieve presets for category selection, ordered by project settings.
+ *
+ * Returns presets in the order defined by `projectSettings.defaultPresets` for the
+ * specified data type. Falls back to alphabetical order (by preset name) if no defaults are configured.
+ *
+ * @param opts.projectId Project public ID
+ * @param opts.dataType Type of data being created ('observation' or 'track')
+ * @param opts.lang Language to translate presets into
+ *
+ * @example
+ * ```tsx
+ * function ObservationCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'observation',
+ *   })
+ * }
+ * ```
+ *
+ * ```tsx
+ * function TrackCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'track',
+ *   })
+ * }
+ * ```
+ */
+export declare function usePresetsSelection({ projectId, dataType, lang, }: {
+    projectId: string;
+    dataType: 'observation' | 'track';
+    lang?: string;
+}): Array<Preset>;

package/dist/commonjs/hooks/documents.js

@@ -6,7 +6,10 @@ exports.useManyDocs = useManyDocs;
 exports.useCreateDocument = useCreateDocument;
 exports.useUpdateDocument = useUpdateDocument;
 exports.useDeleteDocument = useDeleteDocument;
+exports.usePresetsSelection = usePresetsSelection;
 const react_query_1 = require("@tanstack/react-query");
+const react_1 = require("react");
+const presets_js_1 = require("../lib/presets.js");
 const documents_js_1 = require("../lib/react-query/documents.js");
 const projects_js_1 = require("./projects.js");
 /**
@@ -191,3 +194,50 @@ function useDeleteDocument({ docType, projectId, }) {
         ? { error, mutate, mutateAsync, reset, status }
         : { error: null, mutate, mutateAsync, reset, status };
 }
+const dataTypeToGeometry = {
+    observation: 'point',
+    track: 'line',
+};
+/**
+ * Retrieve presets for category selection, ordered by project settings.
+ *
+ * Returns presets in the order defined by `projectSettings.defaultPresets` for the
+ * specified data type. Falls back to alphabetical order (by preset name) if no defaults are configured.
+ *
+ * @param opts.projectId Project public ID
+ * @param opts.dataType Type of data being created ('observation' or 'track')
+ * @param opts.lang Language to translate presets into
+ *
+ * @example
+ * ```tsx
+ * function ObservationCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'observation',
+ *   })
+ * }
+ * ```
+ *
+ * ```tsx
+ * function TrackCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'track',
+ *   })
+ * }
+ * ```
+ */
+function usePresetsSelection({ projectId, dataType, lang, }) {
+    const { data: projectSettings } = (0, projects_js_1.useProjectSettings)({ projectId });
+    const { data: presets } = useManyDocs({
+        projectId,
+        docType: 'preset',
+        lang,
+    });
+    const presetsSelection = (0, react_1.useMemo)(() => {
+        const geometry = dataTypeToGeometry[dataType];
+        const defaults = projectSettings.defaultPresets?.[geometry];
+        return (0, presets_js_1.getPresetsSelection)(presets, defaults);
+    }, [presets, projectSettings.defaultPresets, dataType]);
+    return presetsSelection;
+}

package/dist/commonjs/hooks/projects.d.ts

@@ -221,6 +221,8 @@ export declare function useAttachmentUrl({ projectId, blobId, }: {
  *   })
  * }
  * ```
+ *
+ * @deprecated Use `createdBy` field from document read hooks.
  */
 export declare function useDocumentCreatedBy({ projectId, originalVersionId, }: {
     projectId: string;

package/dist/commonjs/hooks/projects.js

@@ -279,6 +279,8 @@ function useMediaServerOrigin({ projectApi }) {
  *   })
  * }
  * ```
+ *
+ * @deprecated Use `createdBy` field from document read hooks.
  */
 function useDocumentCreatedBy({ projectId, originalVersionId, }) {
     const { data: projectApi } = useSingleProject({ projectId });

package/dist/commonjs/index.d.ts

@@ -1,6 +1,6 @@
 export { ClientApiContext, ClientApiProvider } from './contexts/ClientApi.js';
 export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevice, useSetOwnDeviceInfo, } from './hooks/client.js';
-export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
+export { useCreateDocument, useDeleteDocument, useManyDocs, usePresetsSelection, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
 export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';

package/dist/commonjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useExportZipFile = exports.useExportGeoJSON = exports.useChangeMemberRole = exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useSetAutostopDataSyncTimeout = exports.useRemoveServerPeer = exports.useProjectSettings = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDisconnectSyncServers = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useConnectSyncServers = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSingleInvite = exports.useSetUpInvitesListeners = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useManyInvites = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = exports.ClientApiContext = void 0;
+exports.useExportZipFile = exports.useExportGeoJSON = exports.useChangeMemberRole = exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useSetAutostopDataSyncTimeout = exports.useRemoveServerPeer = exports.useProjectSettings = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDisconnectSyncServers = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useConnectSyncServers = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSingleInvite = exports.useSetUpInvitesListeners = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useManyInvites = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.usePresetsSelection = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = exports.ClientApiContext = void 0;
 var ClientApi_js_1 = require("./contexts/ClientApi.js");
 Object.defineProperty(exports, "ClientApiContext", { enumerable: true, get: function () { return ClientApi_js_1.ClientApiContext; } });
 Object.defineProperty(exports, "ClientApiProvider", { enumerable: true, get: function () { return ClientApi_js_1.ClientApiProvider; } });
@@ -14,6 +14,7 @@ var documents_js_1 = require("./hooks/documents.js");
 Object.defineProperty(exports, "useCreateDocument", { enumerable: true, get: function () { return documents_js_1.useCreateDocument; } });
 Object.defineProperty(exports, "useDeleteDocument", { enumerable: true, get: function () { return documents_js_1.useDeleteDocument; } });
 Object.defineProperty(exports, "useManyDocs", { enumerable: true, get: function () { return documents_js_1.useManyDocs; } });
+Object.defineProperty(exports, "usePresetsSelection", { enumerable: true, get: function () { return documents_js_1.usePresetsSelection; } });
 Object.defineProperty(exports, "useSingleDocByDocId", { enumerable: true, get: function () { return documents_js_1.useSingleDocByDocId; } });
 Object.defineProperty(exports, "useSingleDocByVersionId", { enumerable: true, get: function () { return documents_js_1.useSingleDocByVersionId; } });
 Object.defineProperty(exports, "useUpdateDocument", { enumerable: true, get: function () { return documents_js_1.useUpdateDocument; } });

package/dist/commonjs/lib/presets.d.ts

@@ -0,0 +1,2 @@
+import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+export declare function getPresetsSelection(presets: Array<Preset>, orderedPresetIds?: Array<string>): Array<Preset>;

package/dist/commonjs/lib/presets.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPresetsSelection = getPresetsSelection;
+/**
+ * Internal helper to sort presets alphabetically by name (case-insensitive).
+ */
+function sortByName(presets) {
+    return [...presets].sort((a, b) => a.name.toLowerCase().localeCompare(b.name.toLowerCase()));
+}
+function getPresetsSelection(presets, orderedPresetIds = []) {
+    if (orderedPresetIds.length === 0) {
+        return sortByName(presets);
+    }
+    const presetsSelection = [];
+    for (const presetId of orderedPresetIds) {
+        const preset = presets.find((p) => p.docId === presetId);
+        if (preset) {
+            presetsSelection.push(preset);
+        }
+    }
+    if (presetsSelection.length === 0) {
+        return sortByName(presets);
+    }
+    return presetsSelection;
+}

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

@@ -1,3 +1,4 @@
+import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
 import type { WriteableDocumentType } from '../lib/types.js';
 /**
  * Retrieve a single document from the database based on the document's document ID.
@@ -545,3 +546,37 @@ export declare function useDeleteDocument<D extends WriteableDocumentType>({ doc
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
+/**
+ * Retrieve presets for category selection, ordered by project settings.
+ *
+ * Returns presets in the order defined by `projectSettings.defaultPresets` for the
+ * specified data type. Falls back to alphabetical order (by preset name) if no defaults are configured.
+ *
+ * @param opts.projectId Project public ID
+ * @param opts.dataType Type of data being created ('observation' or 'track')
+ * @param opts.lang Language to translate presets into
+ *
+ * @example
+ * ```tsx
+ * function ObservationCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'observation',
+ *   })
+ * }
+ * ```
+ *
+ * ```tsx
+ * function TrackCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'track',
+ *   })
+ * }
+ * ```
+ */
+export declare function usePresetsSelection({ projectId, dataType, lang, }: {
+    projectId: string;
+    dataType: 'observation' | 'track';
+    lang?: string;
+}): Array<Preset>;

package/dist/esm/hooks/documents.js

@@ -1,6 +1,8 @@
 import { useMutation, useQueryClient, useSuspenseQuery, } from '@tanstack/react-query';
+import { useMemo } from 'react';
+import { getPresetsSelection } from '../lib/presets.js';
 import { createDocumentMutationOptions, deleteDocumentMutationOptions, documentByDocumentIdQueryOptions, documentByVersionIdQueryOptions, documentsQueryOptions, updateDocumentMutationOptions, } from '../lib/react-query/documents.js';
-import { useSingleProject } from './projects.js';
+import { useProjectSettings, useSingleProject } from './projects.js';
 /**
  * Retrieve a single document from the database based on the document's document ID.
  *
@@ -183,3 +185,50 @@ export function useDeleteDocument({ docType, projectId, }) {
         ? { error, mutate, mutateAsync, reset, status }
         : { error: null, mutate, mutateAsync, reset, status };
 }
+const dataTypeToGeometry = {
+    observation: 'point',
+    track: 'line',
+};
+/**
+ * Retrieve presets for category selection, ordered by project settings.
+ *
+ * Returns presets in the order defined by `projectSettings.defaultPresets` for the
+ * specified data type. Falls back to alphabetical order (by preset name) if no defaults are configured.
+ *
+ * @param opts.projectId Project public ID
+ * @param opts.dataType Type of data being created ('observation' or 'track')
+ * @param opts.lang Language to translate presets into
+ *
+ * @example
+ * ```tsx
+ * function ObservationCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'observation',
+ *   })
+ * }
+ * ```
+ *
+ * ```tsx
+ * function TrackCategoryChooser() {
+ *   const presets = usePresetsSelection({
+ *     projectId: '...',
+ *     dataType: 'track',
+ *   })
+ * }
+ * ```
+ */
+export function usePresetsSelection({ projectId, dataType, lang, }) {
+    const { data: projectSettings } = useProjectSettings({ projectId });
+    const { data: presets } = useManyDocs({
+        projectId,
+        docType: 'preset',
+        lang,
+    });
+    const presetsSelection = useMemo(() => {
+        const geometry = dataTypeToGeometry[dataType];
+        const defaults = projectSettings.defaultPresets?.[geometry];
+        return getPresetsSelection(presets, defaults);
+    }, [presets, projectSettings.defaultPresets, dataType]);
+    return presetsSelection;
+}

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

@@ -221,6 +221,8 @@ export declare function useAttachmentUrl({ projectId, blobId, }: {
  *   })
  * }
  * ```
+ *
+ * @deprecated Use `createdBy` field from document read hooks.
  */
 export declare function useDocumentCreatedBy({ projectId, originalVersionId, }: {
     projectId: string;

package/dist/esm/hooks/projects.js

@@ -251,6 +251,8 @@ function useMediaServerOrigin({ projectApi }) {
  *   })
  * }
  * ```
+ *
+ * @deprecated Use `createdBy` field from document read hooks.
  */
 export function useDocumentCreatedBy({ projectId, originalVersionId, }) {
     const { data: projectApi } = useSingleProject({ projectId });

package/dist/esm/index.d.ts

@@ -1,6 +1,6 @@
 export { ClientApiContext, ClientApiProvider } from './contexts/ClientApi.js';
 export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevice, useSetOwnDeviceInfo, } from './hooks/client.js';
-export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
+export { useCreateDocument, useDeleteDocument, useManyDocs, usePresetsSelection, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
 export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';

package/dist/esm/index.js

@@ -1,6 +1,6 @@
 export { ClientApiContext, ClientApiProvider } from './contexts/ClientApi.js';
 export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevice, useSetOwnDeviceInfo, } from './hooks/client.js';
-export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
+export { useCreateDocument, useDeleteDocument, useManyDocs, usePresetsSelection, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
 export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useRemoveServerPeer, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';

package/dist/esm/lib/presets.d.ts

@@ -0,0 +1,2 @@
+import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+export declare function getPresetsSelection(presets: Array<Preset>, orderedPresetIds?: Array<string>): Array<Preset>;

package/dist/esm/lib/presets.js

@@ -0,0 +1,22 @@
+/**
+ * Internal helper to sort presets alphabetically by name (case-insensitive).
+ */
+function sortByName(presets) {
+    return [...presets].sort((a, b) => a.name.toLowerCase().localeCompare(b.name.toLowerCase()));
+}
+export function getPresetsSelection(presets, orderedPresetIds = []) {
+    if (orderedPresetIds.length === 0) {
+        return sortByName(presets);
+    }
+    const presetsSelection = [];
+    for (const presetId of orderedPresetIds) {
+        const preset = presets.find((p) => p.docId === presetId);
+        if (preset) {
+            presetsSelection.push(preset);
+        }
+    }
+    if (presetsSelection.length === 0) {
+        return sortByName(presets);
+    }
+    return presetsSelection;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@comapeo/core-react",
-	"version": "6.3.0",
+	"version": "6.4.0",
 	"description": "React wrapper for working with @comapeo/core",
 	"repository": {
 		"type": "git",
@@ -71,6 +71,8 @@
 		"@eslint/js": "9.35.0",
 		"@ianvs/prettier-plugin-sort-imports": "4.7.0",
 		"@mapeo/crypto": "1.0.0-alpha.10",
+		"@mapeo/default-config": "5.0.0",
+		"@mapeo/mock-data": "5.0.0",
 		"@tanstack/eslint-plugin-query": "5.89.0",
 		"@tanstack/react-query": "5.89.0",
 		"@testing-library/dom": "10.4.1",