@comapeo/core-react 1.0.1 → 2.0.0

package/dist/commonjs/index.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectRoleQueryKey = exports.getProjectByIdQueryKey = exports.getMembersQueryKey = exports.getMemberByIdQueryKey = exports.getIconUrlQueryKey = exports.getDocumentCreatedByQueryKey = exports.getAttachmentUrlQueryKey = exports.getStyleJsonUrlQueryKey = exports.getMapsQueryKey = exports.getPendingInvitesQueryKey = exports.getInvitesQueryKey = exports.getManyDocumentsQueryKey = exports.getDocumentsQueryKey = exports.getDocumentByVersionIdQueryKey = exports.getDocumentByDocIdQueryKey = exports.getIsArchiveDeviceQueryKey = exports.getDeviceInfoQueryKey = exports.getClientQueryKey = exports.useUpdateProjectSettings = exports.useSingleProject = exports.useSingleMember = exports.useProjectSettings = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useCreateProject = exports.useCreateBlob = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = 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.ROOT_QUERY_KEY = exports.getProjectsQueryKey = exports.getProjectSettingsQueryKey = 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; } });
+var client_js_1 = require("./hooks/client.js");
+Object.defineProperty(exports, "useClientApi", { enumerable: true, get: function () { return client_js_1.useClientApi; } });
+Object.defineProperty(exports, "useIsArchiveDevice", { enumerable: true, get: function () { return client_js_1.useIsArchiveDevice; } });
+Object.defineProperty(exports, "useOwnDeviceInfo", { enumerable: true, get: function () { return client_js_1.useOwnDeviceInfo; } });
+Object.defineProperty(exports, "useSetIsArchiveDevice", { enumerable: true, get: function () { return client_js_1.useSetIsArchiveDevice; } });
+Object.defineProperty(exports, "useSetOwnDeviceInfo", { enumerable: true, get: function () { return client_js_1.useSetOwnDeviceInfo; } });
+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, "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; } });
+var invites_js_1 = require("./hooks/invites.js");
+Object.defineProperty(exports, "useAcceptInvite", { enumerable: true, get: function () { return invites_js_1.useAcceptInvite; } });
+Object.defineProperty(exports, "useRejectInvite", { enumerable: true, get: function () { return invites_js_1.useRejectInvite; } });
+Object.defineProperty(exports, "useRequestCancelInvite", { enumerable: true, get: function () { return invites_js_1.useRequestCancelInvite; } });
+Object.defineProperty(exports, "useSendInvite", { enumerable: true, get: function () { return invites_js_1.useSendInvite; } });
+var maps_js_1 = require("./hooks/maps.js");
+Object.defineProperty(exports, "useMapStyleUrl", { enumerable: true, get: function () { return maps_js_1.useMapStyleUrl; } });
+var projects_js_1 = require("./hooks/projects.js");
+Object.defineProperty(exports, "useAddServerPeer", { enumerable: true, get: function () { return projects_js_1.useAddServerPeer; } });
+Object.defineProperty(exports, "useAttachmentUrl", { enumerable: true, get: function () { return projects_js_1.useAttachmentUrl; } });
+Object.defineProperty(exports, "useCreateBlob", { enumerable: true, get: function () { return projects_js_1.useCreateBlob; } });
+Object.defineProperty(exports, "useCreateProject", { enumerable: true, get: function () { return projects_js_1.useCreateProject; } });
+Object.defineProperty(exports, "useDocumentCreatedBy", { enumerable: true, get: function () { return projects_js_1.useDocumentCreatedBy; } });
+Object.defineProperty(exports, "useIconUrl", { enumerable: true, get: function () { return projects_js_1.useIconUrl; } });
+Object.defineProperty(exports, "useImportProjectConfig", { enumerable: true, get: function () { return projects_js_1.useImportProjectConfig; } });
+Object.defineProperty(exports, "useLeaveProject", { enumerable: true, get: function () { return projects_js_1.useLeaveProject; } });
+Object.defineProperty(exports, "useManyMembers", { enumerable: true, get: function () { return projects_js_1.useManyMembers; } });
+Object.defineProperty(exports, "useManyProjects", { enumerable: true, get: function () { return projects_js_1.useManyProjects; } });
+Object.defineProperty(exports, "useProjectSettings", { enumerable: true, get: function () { return projects_js_1.useProjectSettings; } });
+Object.defineProperty(exports, "useSingleMember", { enumerable: true, get: function () { return projects_js_1.useSingleMember; } });
+Object.defineProperty(exports, "useSingleProject", { enumerable: true, get: function () { return projects_js_1.useSingleProject; } });
+Object.defineProperty(exports, "useUpdateProjectSettings", { enumerable: true, get: function () { return projects_js_1.useUpdateProjectSettings; } });
+var client_js_2 = require("./lib/react-query/client.js");
+Object.defineProperty(exports, "getClientQueryKey", { enumerable: true, get: function () { return client_js_2.getClientQueryKey; } });
+Object.defineProperty(exports, "getDeviceInfoQueryKey", { enumerable: true, get: function () { return client_js_2.getDeviceInfoQueryKey; } });
+Object.defineProperty(exports, "getIsArchiveDeviceQueryKey", { enumerable: true, get: function () { return client_js_2.getIsArchiveDeviceQueryKey; } });
+var documents_js_2 = require("./lib/react-query/documents.js");
+Object.defineProperty(exports, "getDocumentByDocIdQueryKey", { enumerable: true, get: function () { return documents_js_2.getDocumentByDocIdQueryKey; } });
+Object.defineProperty(exports, "getDocumentByVersionIdQueryKey", { enumerable: true, get: function () { return documents_js_2.getDocumentByVersionIdQueryKey; } });
+Object.defineProperty(exports, "getDocumentsQueryKey", { enumerable: true, get: function () { return documents_js_2.getDocumentsQueryKey; } });
+Object.defineProperty(exports, "getManyDocumentsQueryKey", { enumerable: true, get: function () { return documents_js_2.getManyDocumentsQueryKey; } });
+var invites_js_2 = require("./lib/react-query/invites.js");
+Object.defineProperty(exports, "getInvitesQueryKey", { enumerable: true, get: function () { return invites_js_2.getInvitesQueryKey; } });
+Object.defineProperty(exports, "getPendingInvitesQueryKey", { enumerable: true, get: function () { return invites_js_2.getPendingInvitesQueryKey; } });
+var maps_js_2 = require("./lib/react-query/maps.js");
+Object.defineProperty(exports, "getMapsQueryKey", { enumerable: true, get: function () { return maps_js_2.getMapsQueryKey; } });
+Object.defineProperty(exports, "getStyleJsonUrlQueryKey", { enumerable: true, get: function () { return maps_js_2.getStyleJsonUrlQueryKey; } });
+var projects_js_2 = require("./lib/react-query/projects.js");
+Object.defineProperty(exports, "getAttachmentUrlQueryKey", { enumerable: true, get: function () { return projects_js_2.getAttachmentUrlQueryKey; } });
+Object.defineProperty(exports, "getDocumentCreatedByQueryKey", { enumerable: true, get: function () { return projects_js_2.getDocumentCreatedByQueryKey; } });
+Object.defineProperty(exports, "getIconUrlQueryKey", { enumerable: true, get: function () { return projects_js_2.getIconUrlQueryKey; } });
+Object.defineProperty(exports, "getMemberByIdQueryKey", { enumerable: true, get: function () { return projects_js_2.getMemberByIdQueryKey; } });
+Object.defineProperty(exports, "getMembersQueryKey", { enumerable: true, get: function () { return projects_js_2.getMembersQueryKey; } });
+Object.defineProperty(exports, "getProjectByIdQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectByIdQueryKey; } });
+Object.defineProperty(exports, "getProjectRoleQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectRoleQueryKey; } });
+Object.defineProperty(exports, "getProjectSettingsQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectSettingsQueryKey; } });
+Object.defineProperty(exports, "getProjectsQueryKey", { enumerable: true, get: function () { return projects_js_2.getProjectsQueryKey; } });
+var shared_js_1 = require("./lib/react-query/shared.js");
+Object.defineProperty(exports, "ROOT_QUERY_KEY", { enumerable: true, get: function () { return shared_js_1.ROOT_QUERY_KEY; } });

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

@@ -0,0 +1,61 @@
+import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { DeviceInfo } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import { type QueryClient } from '@tanstack/react-query';
+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_archive_device"];
+export declare function deviceInfoQueryOptions({ clientApi, }: {
+    clientApi: MapeoClientApi;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+    deviceId: string;
+    deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+} & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>, Error, {
+    deviceId: string;
+    deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+} & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>, readonly ["@comapeo/core-react", "client", "device_info"]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<{
+        deviceId: string;
+        deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+    } & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>, readonly ["@comapeo/core-react", "client", "device_info"], never> | undefined;
+} & {
+    queryKey: readonly ["@comapeo/core-react", "client", "device_info"] & {
+        [dataTagSymbol]: {
+            deviceId: string;
+            deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+        } & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>;
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare function isArchiveDeviceQueryOptions({ clientApi, }: {
+    clientApi: MapeoClientApi;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<boolean, Error, boolean, readonly ["@comapeo/core-react", "client", "is_archive_device"]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<boolean, readonly ["@comapeo/core-react", "client", "is_archive_device"], never> | undefined;
+} & {
+    queryKey: readonly ["@comapeo/core-react", "client", "is_archive_device"] & {
+        [dataTagSymbol]: boolean;
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare function setOwnDeviceInfoMutationOptions({ clientApi, queryClient, }: {
+    clientApi: MapeoClientApi;
+    queryClient: QueryClient;
+}): {
+    mutationFn: ({ name, deviceType }: {
+        name: string;
+        deviceType: DeviceInfo["deviceType"];
+    }) => Promise<void>;
+    onSuccess: () => void;
+    networkMode: "always";
+    retry: false;
+};
+export declare function setIsArchiveDeviceMutationOptions({ clientApi, queryClient, }: {
+    clientApi: MapeoClientApi;
+    queryClient: QueryClient;
+}): {
+    mutationFn: ({ isArchiveDevice }: {
+        isArchiveDevice: boolean;
+    }) => Promise<void>;
+    onSuccess: () => void;
+    networkMode: "always";
+    retry: false;
+};

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

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClientQueryKey = getClientQueryKey;
+exports.getDeviceInfoQueryKey = getDeviceInfoQueryKey;
+exports.getIsArchiveDeviceQueryKey = getIsArchiveDeviceQueryKey;
+exports.deviceInfoQueryOptions = deviceInfoQueryOptions;
+exports.isArchiveDeviceQueryOptions = isArchiveDeviceQueryOptions;
+exports.setOwnDeviceInfoMutationOptions = setOwnDeviceInfoMutationOptions;
+exports.setIsArchiveDeviceMutationOptions = setIsArchiveDeviceMutationOptions;
+const react_query_1 = require("@tanstack/react-query");
+const projects_js_1 = require("./projects.js");
+const shared_js_1 = require("./shared.js");
+function getClientQueryKey() {
+    return [shared_js_1.ROOT_QUERY_KEY, 'client'];
+}
+function getDeviceInfoQueryKey() {
+    return [shared_js_1.ROOT_QUERY_KEY, 'client', 'device_info'];
+}
+function getIsArchiveDeviceQueryKey() {
+    return [shared_js_1.ROOT_QUERY_KEY, 'client', 'is_archive_device'];
+}
+function deviceInfoQueryOptions({ clientApi, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getDeviceInfoQueryKey(),
+        queryFn: async () => {
+            return clientApi.getDeviceInfo();
+        },
+    });
+}
+function isArchiveDeviceQueryOptions({ clientApi, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getIsArchiveDeviceQueryKey(),
+        queryFn: async () => {
+            return clientApi.getIsArchiveDevice();
+        },
+    });
+}
+function setOwnDeviceInfoMutationOptions({ clientApi, queryClient, }) {
+    return {
+        ...(0, shared_js_1.baseMutationOptions)(),
+        mutationFn: async ({ name, deviceType }) => {
+            return clientApi.setDeviceInfo({ name, deviceType });
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getDeviceInfoQueryKey(),
+            });
+            queryClient.invalidateQueries({
+                queryKey: (0, projects_js_1.getProjectsQueryKey)(),
+            });
+        },
+    };
+}
+function setIsArchiveDeviceMutationOptions({ clientApi, queryClient, }) {
+    return {
+        ...(0, shared_js_1.baseMutationOptions)(),
+        mutationFn: async ({ isArchiveDevice }) => {
+            return clientApi.setIsArchiveDevice(isArchiveDevice);
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: getIsArchiveDeviceQueryKey(),
+            });
+        },
+    };
+}