@oxyhq/auth 2.0.5 → 2.0.6

package/dist/cjs/hooks/mutations/index.js

@@ -6,7 +6,7 @@
  * All mutations handle authentication, error handling, and query invalidation.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useRemoveDevice = exports.useUpdateDeviceName = exports.useLogoutAll = exports.useLogoutSession = exports.useSwitchSession = exports.useUploadFile = exports.useUpdatePrivacySettings = exports.useUpdateAccountSettings = exports.useUploadAvatar = exports.useUpdateProfile = void 0;
+exports.useDeleteAppData = exports.useSetAppData = exports.useRemoveDevice = exports.useUpdateDeviceName = exports.useLogoutAll = exports.useLogoutSession = exports.useSwitchSession = exports.useUploadFile = exports.useUpdatePrivacySettings = exports.useUpdateAccountSettings = exports.useUploadAvatar = exports.useUpdateProfile = void 0;
 // Account mutation hooks
 var useAccountMutations_1 = require("./useAccountMutations");
 Object.defineProperty(exports, "useUpdateProfile", { enumerable: true, get: function () { return useAccountMutations_1.useUpdateProfile; } });
@@ -21,3 +21,7 @@ Object.defineProperty(exports, "useLogoutSession", { enumerable: true, get: func
 Object.defineProperty(exports, "useLogoutAll", { enumerable: true, get: function () { return useServicesMutations_1.useLogoutAll; } });
 Object.defineProperty(exports, "useUpdateDeviceName", { enumerable: true, get: function () { return useServicesMutations_1.useUpdateDeviceName; } });
 Object.defineProperty(exports, "useRemoveDevice", { enumerable: true, get: function () { return useServicesMutations_1.useRemoveDevice; } });
+// App-data KV store mutation hooks
+var useAppData_1 = require("./useAppData");
+Object.defineProperty(exports, "useSetAppData", { enumerable: true, get: function () { return useAppData_1.useSetAppData; } });
+Object.defineProperty(exports, "useDeleteAppData", { enumerable: true, get: function () { return useAppData_1.useDeleteAppData; } });

package/dist/cjs/hooks/mutations/useAppData.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * App-Data Mutation Hooks
+ *
+ * Write side of the per-user JSON KV store. Both `useSetAppData` and
+ * `useDeleteAppData` apply optimistic updates against the two query keys
+ * that observe this data (`appDataQueryKeys.value` and the surrounding
+ * `appDataQueryKeys.namespace`) and roll back on error.
+ *
+ * When the underlying request fails because the endpoint isn't reachable
+ * (404 / network), the mutation still surfaces the error — write attempts
+ * are user-initiated and the caller may want to retry or fall back to
+ * local persistence. Reads are silent about missing endpoints; writes are
+ * not.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useDeleteAppData = exports.useSetAppData = void 0;
+const react_query_1 = require("@tanstack/react-query");
+const core_1 = require("@oxyhq/core");
+const WebOxyProvider_1 = require("../../WebOxyProvider");
+const appDataQueryKeys_1 = require("../queries/appDataQueryKeys");
+/**
+ * Upsert a per-user JSON value. Returns the value the server confirmed it
+ * stored — typically identical to the input but consumers should prefer the
+ * returned value (the server is the source of truth).
+ *
+ * Applies optimistic updates against both the single-value query key and
+ * the surrounding namespace query key, then rolls back on error.
+ */
+const useSetAppData = () => {
+    const { oxyServices, activeSessionId } = (0, WebOxyProvider_1.useWebOxy)();
+    const queryClient = (0, react_query_1.useQueryClient)();
+    return (0, react_query_1.useMutation)({
+        mutationKey: ['appData', 'set'],
+        mutationFn: async ({ namespace, key, value }) => {
+            return (0, core_1.authenticatedApiCall)(oxyServices, activeSessionId, () => oxyServices.setAppData(namespace, key, value));
+        },
+        onMutate: async ({ namespace, key, value }) => {
+            const valueKey = appDataQueryKeys_1.appDataQueryKeys.value(namespace, key);
+            const namespaceKey = appDataQueryKeys_1.appDataQueryKeys.namespace(namespace);
+            await Promise.all([
+                queryClient.cancelQueries({ queryKey: valueKey }),
+                queryClient.cancelQueries({ queryKey: namespaceKey }),
+            ]);
+            const previousValue = queryClient.getQueryData(valueKey);
+            const previousNamespace = queryClient.getQueryData(namespaceKey);
+            queryClient.setQueryData(valueKey, value);
+            if (previousNamespace) {
+                queryClient.setQueryData(namespaceKey, {
+                    ...previousNamespace,
+                    [key]: value,
+                });
+            }
+            return { previousValue, previousNamespace };
+        },
+        onError: (_error, { namespace, key }, context) => {
+            if (!context)
+                return;
+            const valueKey = appDataQueryKeys_1.appDataQueryKeys.value(namespace, key);
+            const namespaceKey = appDataQueryKeys_1.appDataQueryKeys.namespace(namespace);
+            // Restore exactly the snapshots we captured in onMutate. Don't merge
+            // with whatever's currently in the cache — that could splice in writes
+            // from concurrent mutations and undo their state.
+            queryClient.setQueryData(valueKey, context.previousValue ?? null);
+            if (context.previousNamespace !== undefined) {
+                queryClient.setQueryData(namespaceKey, context.previousNamespace);
+            }
+        },
+        onSuccess: (data, { namespace, key }) => {
+            const valueKey = appDataQueryKeys_1.appDataQueryKeys.value(namespace, key);
+            const namespaceKey = appDataQueryKeys_1.appDataQueryKeys.namespace(namespace);
+            queryClient.setQueryData(valueKey, data);
+            const existingNamespace = queryClient.getQueryData(namespaceKey);
+            if (existingNamespace) {
+                queryClient.setQueryData(namespaceKey, {
+                    ...existingNamespace,
+                    [key]: data,
+                });
+            }
+        },
+    });
+};
+exports.useSetAppData = useSetAppData;
+/**
+ * Delete a per-user JSON value. Optimistically removes the entry from the
+ * single-value cache and from the surrounding namespace map, then rolls back
+ * on error.
+ */
+const useDeleteAppData = () => {
+    const { oxyServices, activeSessionId } = (0, WebOxyProvider_1.useWebOxy)();
+    const queryClient = (0, react_query_1.useQueryClient)();
+    return (0, react_query_1.useMutation)({
+        mutationKey: ['appData', 'delete'],
+        mutationFn: async ({ namespace, key }) => {
+            await (0, core_1.authenticatedApiCall)(oxyServices, activeSessionId, () => oxyServices.deleteAppData(namespace, key));
+        },
+        onMutate: async ({ namespace, key }) => {
+            const valueKey = appDataQueryKeys_1.appDataQueryKeys.value(namespace, key);
+            const namespaceKey = appDataQueryKeys_1.appDataQueryKeys.namespace(namespace);
+            await Promise.all([
+                queryClient.cancelQueries({ queryKey: valueKey }),
+                queryClient.cancelQueries({ queryKey: namespaceKey }),
+            ]);
+            const previousValue = queryClient.getQueryData(valueKey);
+            const previousNamespace = queryClient.getQueryData(namespaceKey);
+            queryClient.setQueryData(valueKey, null);
+            if (previousNamespace && key in previousNamespace) {
+                const next = { ...previousNamespace };
+                delete next[key];
+                queryClient.setQueryData(namespaceKey, next);
+            }
+            return { previousValue, previousNamespace };
+        },
+        onError: (_error, { namespace, key }, context) => {
+            if (!context)
+                return;
+            const valueKey = appDataQueryKeys_1.appDataQueryKeys.value(namespace, key);
+            const namespaceKey = appDataQueryKeys_1.appDataQueryKeys.namespace(namespace);
+            queryClient.setQueryData(valueKey, context.previousValue ?? null);
+            if (context.previousNamespace !== undefined) {
+                queryClient.setQueryData(namespaceKey, context.previousNamespace);
+            }
+        },
+        onSuccess: (_data, { namespace, key }) => {
+            queryClient.setQueryData(appDataQueryKeys_1.appDataQueryKeys.value(namespace, key), null);
+            // Confirm the value is gone from the namespace cache too. If the
+            // optimistic update wasn't applied (e.g. cache was empty), this is a
+            // no-op; if it was, we already removed it in onMutate, so this is also
+            // a no-op. The work happens in onMutate — onSuccess is the commit point.
+        },
+    });
+};
+exports.useDeleteAppData = useDeleteAppData;

package/dist/cjs/hooks/queries/appDataQueryKeys.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * Query keys + error utilities for `useAppData` hooks.
+ *
+ * Lives next to the hook file so consumers can import the keys directly
+ * when they need to imperatively invalidate a value (e.g. after a non-React
+ * write through `oxyServices.setAppData`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appDataQueryKeys = void 0;
+exports.isMissingAppDataEndpointError = isMissingAppDataEndpointError;
+exports.appDataQueryKeys = {
+    all: ['appData'],
+    namespaces: () => [...exports.appDataQueryKeys.all, 'namespace'],
+    namespace: (namespace) => [...exports.appDataQueryKeys.namespaces(), namespace],
+    values: () => [...exports.appDataQueryKeys.all, 'value'],
+    value: (namespace, key) => [...exports.appDataQueryKeys.values(), namespace, key],
+};
+/**
+ * True when `error` indicates the app-data endpoint isn't reachable — either
+ * because the API deployment doesn't have it yet (404) or there's a network
+ * failure with no response. We treat these as "no value stored" so consumers
+ * fall back to local persistence without surfacing a user-facing error.
+ *
+ * Anything else (401, 403, 500) propagates normally — those are real bugs
+ * the auth or retry pipeline needs to see.
+ */
+function isMissingAppDataEndpointError(error) {
+    if (!error || typeof error !== 'object') {
+        return false;
+    }
+    const candidate = error;
+    const status = candidate.status ?? candidate.statusCode ?? candidate.response?.status;
+    // 404: endpoint not deployed on this API instance yet.
+    if (status === 404)
+        return true;
+    // Network errors: no response received at all. Common during local dev
+    // when the API server is down, or when offline.
+    if (candidate.code === 'NETWORK_ERROR')
+        return true;
+    const message = typeof candidate.message === 'string' ? candidate.message : '';
+    if (message.includes('Network Error') || message.includes('Failed to fetch')) {
+        return true;
+    }
+    return false;
+}

package/dist/cjs/hooks/queries/index.js

@@ -6,7 +6,7 @@
  * All hooks follow the same pattern with optional `enabled` parameter.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.invalidateSessionQueries = exports.invalidateUserQueries = exports.invalidateAccountQueries = exports.queryKeys = exports.useRecentSecurityActivity = exports.useSecurityActivity = exports.useSecurityInfo = exports.useUserDevices = exports.useDeviceSessions = exports.useSession = exports.useSessions = exports.usePrivacySettings = exports.useUsersBySessions = exports.useUserByUsername = exports.useUserById = exports.useCurrentUser = exports.useUserProfiles = exports.useUserProfile = void 0;
+exports.isMissingAppDataEndpointError = exports.appDataQueryKeys = exports.useAppDataNamespace = exports.useAppData = exports.invalidateSessionQueries = exports.invalidateUserQueries = exports.invalidateAccountQueries = exports.queryKeys = exports.useRecentSecurityActivity = exports.useSecurityActivity = exports.useSecurityInfo = exports.useUserDevices = exports.useDeviceSessions = exports.useSession = exports.useSessions = exports.usePrivacySettings = exports.useUsersBySessions = exports.useUserByUsername = exports.useUserById = exports.useCurrentUser = exports.useUserProfiles = exports.useUserProfile = void 0;
 // Account and user query hooks
 var useAccountQueries_1 = require("./useAccountQueries");
 Object.defineProperty(exports, "useUserProfile", { enumerable: true, get: function () { return useAccountQueries_1.useUserProfile; } });
@@ -33,3 +33,10 @@ Object.defineProperty(exports, "queryKeys", { enumerable: true, get: function ()
 Object.defineProperty(exports, "invalidateAccountQueries", { enumerable: true, get: function () { return queryKeys_1.invalidateAccountQueries; } });
 Object.defineProperty(exports, "invalidateUserQueries", { enumerable: true, get: function () { return queryKeys_1.invalidateUserQueries; } });
 Object.defineProperty(exports, "invalidateSessionQueries", { enumerable: true, get: function () { return queryKeys_1.invalidateSessionQueries; } });
+// App-data KV store query hooks
+var useAppData_1 = require("./useAppData");
+Object.defineProperty(exports, "useAppData", { enumerable: true, get: function () { return useAppData_1.useAppData; } });
+Object.defineProperty(exports, "useAppDataNamespace", { enumerable: true, get: function () { return useAppData_1.useAppDataNamespace; } });
+var appDataQueryKeys_1 = require("./appDataQueryKeys");
+Object.defineProperty(exports, "appDataQueryKeys", { enumerable: true, get: function () { return appDataQueryKeys_1.appDataQueryKeys; } });
+Object.defineProperty(exports, "isMissingAppDataEndpointError", { enumerable: true, get: function () { return appDataQueryKeys_1.isMissingAppDataEndpointError; } });

package/dist/cjs/hooks/queries/useAppData.js

@@ -0,0 +1,87 @@
+"use strict";
+/**
+ * App-Data Query Hooks
+ *
+ * Read side of the `/users/me/app-data/...` per-user JSON KV store. Gated on
+ * `isAuthenticated` — when signed out the query stays `enabled: false` and
+ * `data` is `null`, so consumers can fall back to localStorage without ever
+ * issuing a doomed request.
+ *
+ * Errors from the network (404 because the endpoint isn't deployed yet,
+ * 401 because the session lapsed, etc.) are not user-facing here. Hooks
+ * return `data: null` on error so the calling component renders the
+ * "nothing yet" state and the consuming app can quietly fall back to local
+ * persistence. Mutations still propagate errors so write attempts surface
+ * a toast — only reads are silent.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAppDataNamespace = exports.useAppData = void 0;
+const react_query_1 = require("@tanstack/react-query");
+const core_1 = require("@oxyhq/core");
+const WebOxyProvider_1 = require("../../WebOxyProvider");
+const appDataQueryKeys_1 = require("./appDataQueryKeys");
+/**
+ * Read a single per-user JSON value.
+ *
+ * @param namespace - kebab/snake-case identifier (e.g. `"academy"`).
+ * @param key       - kebab/snake-case identifier (e.g. course slug).
+ * @param options   - optional `enabled`/`staleTime`/`gcTime` overrides.
+ *
+ * @returns A `useQuery` result with `data` of type `T | null`. The query
+ *   stays disabled when the user is signed out; when enabled but the server
+ *   has no stored value, `data` is `null`. Reads that fail because the
+ *   endpoint isn't reachable also resolve to `null` so the consumer can
+ *   fall back to local persistence.
+ */
+const useAppData = (namespace, key, options) => {
+    const { oxyServices, activeSessionId, isAuthenticated } = (0, WebOxyProvider_1.useWebOxy)();
+    return (0, react_query_1.useQuery)({
+        queryKey: appDataQueryKeys_1.appDataQueryKeys.value(namespace, key),
+        queryFn: async () => {
+            try {
+                return await (0, core_1.authenticatedApiCall)(oxyServices, activeSessionId, () => oxyServices.getAppData(namespace, key));
+            }
+            catch (error) {
+                // Endpoint not deployed yet, no network, etc. — return null so the
+                // consumer falls back to localStorage rather than rendering a broken
+                // UI state. Authentication errors still bubble up so the auth retry
+                // pipeline can surface them at the provider level.
+                if ((0, appDataQueryKeys_1.isMissingAppDataEndpointError)(error)) {
+                    return null;
+                }
+                throw error;
+            }
+        },
+        enabled: (options?.enabled !== false) && isAuthenticated,
+        staleTime: options?.staleTime ?? 60 * 1000,
+        gcTime: options?.gcTime ?? 30 * 60 * 1000,
+    });
+};
+exports.useAppData = useAppData;
+/**
+ * Read every value in a namespace.
+ *
+ * @returns A `useQuery` result with `data` as a `Record<string, T>`. Empty
+ *   object when the namespace contains nothing (or when fetching failed).
+ */
+const useAppDataNamespace = (namespace, options) => {
+    const { oxyServices, activeSessionId, isAuthenticated } = (0, WebOxyProvider_1.useWebOxy)();
+    return (0, react_query_1.useQuery)({
+        queryKey: appDataQueryKeys_1.appDataQueryKeys.namespace(namespace),
+        queryFn: async () => {
+            try {
+                return await (0, core_1.authenticatedApiCall)(oxyServices, activeSessionId, () => oxyServices.listAppData(namespace));
+            }
+            catch (error) {
+                if ((0, appDataQueryKeys_1.isMissingAppDataEndpointError)(error)) {
+                    return {};
+                }
+                throw error;
+            }
+        },
+        enabled: (options?.enabled !== false) && isAuthenticated,
+        staleTime: options?.staleTime ?? 60 * 1000,
+        gcTime: options?.gcTime ?? 30 * 60 * 1000,
+    });
+};
+exports.useAppDataNamespace = useAppDataNamespace;

package/dist/cjs/index.js

@@ -24,8 +24,8 @@
  * ```
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAssets = exports.useSessionSocket = exports.isWebBrowser = exports.useWebSSO = exports.createGenericMutation = exports.createProfileMutation = exports.useRemoveDevice = exports.useUpdateDeviceName = exports.useLogoutAll = exports.useLogoutSession = exports.useSwitchSession = exports.useUploadFile = exports.useUpdatePrivacySettings = exports.useUpdateAccountSettings = exports.useUploadAvatar = exports.useUpdateProfile = exports.useRecentSecurityActivity = exports.useSecurityActivity = exports.useSecurityInfo = exports.useUserDevices = exports.useDeviceSessions = exports.useSession = exports.useSessions = exports.usePrivacySettings = exports.useUsersBySessions = exports.useUserByUsername = exports.useUserById = exports.useCurrentUser = exports.useUserProfiles = exports.useUserProfile = exports.useFollowStore = exports.useAccountLoadingSession = exports.useAccountError = exports.useAccountLoading = exports.useAccounts = exports.useAccountStore = exports.useIsAssetLinked = exports.useAssetUsageCount = exports.useAssetsByEntity = exports.useAssetsByApp = exports.useAssetErrors = exports.useAssetLoading = exports.useUploadProgress = exports.useAsset = exports.useAssetsStore = exports.useAssetStore = exports.useAuthStore = exports.useAuth = exports.useWebOxy = exports.WebOxyProvider = void 0;
-exports.extractErrorMessage = exports.isTimeoutOrNetworkError = exports.isInvalidSessionError = exports.handleAuthError = exports.useFileFiltering = exports.useFollowerCounts = exports.useFollow = exports.useFileDownloadUrl = exports.setOxyAssetInstance = void 0;
+exports.useDeleteAppData = exports.useSetAppData = exports.useRemoveDevice = exports.useUpdateDeviceName = exports.useLogoutAll = exports.useLogoutSession = exports.useSwitchSession = exports.useUploadFile = exports.useUpdatePrivacySettings = exports.useUpdateAccountSettings = exports.useUploadAvatar = exports.useUpdateProfile = exports.isMissingAppDataEndpointError = exports.appDataQueryKeys = exports.useAppDataNamespace = exports.useAppData = exports.useRecentSecurityActivity = exports.useSecurityActivity = exports.useSecurityInfo = exports.useUserDevices = exports.useDeviceSessions = exports.useSession = exports.useSessions = exports.usePrivacySettings = exports.useUsersBySessions = exports.useUserByUsername = exports.useUserById = exports.useCurrentUser = exports.useUserProfiles = exports.useUserProfile = exports.useFollowStore = exports.useAccountLoadingSession = exports.useAccountError = exports.useAccountLoading = exports.useAccounts = exports.useAccountStore = exports.useIsAssetLinked = exports.useAssetUsageCount = exports.useAssetsByEntity = exports.useAssetsByApp = exports.useAssetErrors = exports.useAssetLoading = exports.useUploadProgress = exports.useAsset = exports.useAssetsStore = exports.useAssetStore = exports.useAuthStore = exports.useAuth = exports.useWebOxy = exports.WebOxyProvider = void 0;
+exports.extractErrorMessage = exports.isTimeoutOrNetworkError = exports.isInvalidSessionError = exports.handleAuthError = exports.useFileFiltering = exports.useFollowerCounts = exports.useFollow = exports.useFileDownloadUrl = exports.setOxyAssetInstance = exports.useAssets = exports.useSessionSocket = exports.isWebBrowser = exports.useWebSSO = exports.createGenericMutation = exports.createProfileMutation = void 0;
 // --- Provider & Hooks ---
 var WebOxyProvider_1 = require("./WebOxyProvider");
 Object.defineProperty(exports, "WebOxyProvider", { enumerable: true, get: function () { return WebOxyProvider_1.WebOxyProvider; } });
@@ -69,6 +69,10 @@ Object.defineProperty(exports, "useUserDevices", { enumerable: true, get: functi
 Object.defineProperty(exports, "useSecurityInfo", { enumerable: true, get: function () { return queries_1.useSecurityInfo; } });
 Object.defineProperty(exports, "useSecurityActivity", { enumerable: true, get: function () { return queries_1.useSecurityActivity; } });
 Object.defineProperty(exports, "useRecentSecurityActivity", { enumerable: true, get: function () { return queries_1.useRecentSecurityActivity; } });
+Object.defineProperty(exports, "useAppData", { enumerable: true, get: function () { return queries_1.useAppData; } });
+Object.defineProperty(exports, "useAppDataNamespace", { enumerable: true, get: function () { return queries_1.useAppDataNamespace; } });
+Object.defineProperty(exports, "appDataQueryKeys", { enumerable: true, get: function () { return queries_1.appDataQueryKeys; } });
+Object.defineProperty(exports, "isMissingAppDataEndpointError", { enumerable: true, get: function () { return queries_1.isMissingAppDataEndpointError; } });
 // --- Mutation Hooks ---
 var mutations_1 = require("./hooks/mutations");
 Object.defineProperty(exports, "useUpdateProfile", { enumerable: true, get: function () { return mutations_1.useUpdateProfile; } });
@@ -81,6 +85,8 @@ Object.defineProperty(exports, "useLogoutSession", { enumerable: true, get: func
 Object.defineProperty(exports, "useLogoutAll", { enumerable: true, get: function () { return mutations_1.useLogoutAll; } });
 Object.defineProperty(exports, "useUpdateDeviceName", { enumerable: true, get: function () { return mutations_1.useUpdateDeviceName; } });
 Object.defineProperty(exports, "useRemoveDevice", { enumerable: true, get: function () { return mutations_1.useRemoveDevice; } });
+Object.defineProperty(exports, "useSetAppData", { enumerable: true, get: function () { return mutations_1.useSetAppData; } });
+Object.defineProperty(exports, "useDeleteAppData", { enumerable: true, get: function () { return mutations_1.useDeleteAppData; } });
 var mutationFactory_1 = require("./hooks/mutations/mutationFactory");
 Object.defineProperty(exports, "createProfileMutation", { enumerable: true, get: function () { return mutationFactory_1.createProfileMutation; } });
 Object.defineProperty(exports, "createGenericMutation", { enumerable: true, get: function () { return mutationFactory_1.createGenericMutation; } });