@pulse-editor/react-api 0.1.1-beta.82 → 0.1.1-beta.84

package/dist/hooks/editor/use-app-settings.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Hook to access and update persisted settings for a specific app in the editor.
+ * @param appId The ID of the app whose settings should be retrieved and updated.
+ * @returns `isReady`, the current `settings` object, and an `updateSettings` function.
+ */
+export default function useAppSettings(appId: string): {
+    isReady: boolean;
+    isLoaded: boolean;
+    settings: Record<string, any>;
+    refetch: () => Promise<void>;
+    updateSettings: (newSettings: Record<string, any>) => Promise<void>;
+    deleteSetting: (key: string) => Promise<void>;
+};

package/dist/hooks/editor/use-oauth.d.ts

@@ -0,0 +1,36 @@
+import { OAuthConnectConfig } from "@pulse-editor/shared-utils";
+export type OAuthState = {
+    accessToken?: string;
+    refreshToken?: string;
+    tokenType?: string;
+    scope?: string;
+    expiresAt?: string | number;
+    idToken?: string;
+    [key: string]: any;
+};
+/**
+ * Hook to manage OAuth credentials for a Pulse App.
+ *
+ * Handles the full OAuth flow automatically:
+ * - Dynamic client registration (RFC 7591) when `registrationEndpoint` is provided
+ * - PKCE code challenge generation
+ * - Opening the authorization modal
+ * - Token exchange and storage (via the Pulse Editor backend)
+ *
+ * @param appId The ID of the app.
+ * @param provider A provider identifier used to namespace the OAuth state.
+ */
+export default function useOAuth(appId: string, provider?: string): {
+    isReady: boolean;
+    isLoading: boolean;
+    oauth: OAuthState | null;
+    isAuthenticated: boolean;
+    connect: (config: OAuthConnectConfig) => Promise<void>;
+    disconnect: () => Promise<void>;
+    refetchOAuth: () => Promise<void>;
+    refreshToken: (params: {
+        tokenEndpoint: string;
+        clientId: string;
+        clientSecret?: string;
+    }) => Promise<OAuthState | null>;
+};

package/dist/hooks/editor/use-snapshot-state.d.ts

@@ -1 +1,9 @@
-export default function useSnapShotState<T>(key: string, initialValue?: T, onRestore?: (value: T) => void): readonly [T, import("react").Dispatch<import("react").SetStateAction<T>>];
+/**
+ * A hook that syncs state with a snapshot context,
+ * allowing for state restoration across component unmounts and remounts.
+ * @param key
+ * @param initialValue
+ * @param onRestore
+ * @returns
+ */
+export default function useSnapshotState<T>(key: string, initialValue?: T, onRestore?: (value: T) => void): readonly [T, import("react").Dispatch<import("react").SetStateAction<T>>];

package/dist/main.d.ts

@@ -1,8 +1,8 @@
 import useAgentTools from "./hooks/agent/use-agent-tools";
 import useAgents from "./hooks/agent/use-agents";
+import useActionEffect from "./hooks/editor/use-action-effect";
 import useLoading from "./hooks/editor/use-loading";
 import useNotification from "./hooks/editor/use-notification";
-import useActionEffect from "./hooks/editor/use-action-effect";
 import useTheme from "./hooks/editor/use-theme";
 import useFile from "./hooks/workspace/use-file";
 import useImageGen from "./hooks/ai-modality/use-image-gen";
@@ -11,11 +11,14 @@ import useOCR from "./hooks/ai-modality/use-ocr";
 import useSTT from "./hooks/ai-modality/use-stt";
 import useTTS from "./hooks/ai-modality/use-tts";
 import useVideoGen from "./hooks/ai-modality/use-video-gen";
+import useAppSettings from "./hooks/editor/use-app-settings";
 import { useArtifact } from "./hooks/editor/use-artifact";
 import useEditorEnv from "./hooks/editor/use-editor-env";
 import useOpenApp from "./hooks/editor/use-open-app";
 import useOpenLink from "./hooks/editor/use-open-link";
 import useOwnedAppView from "./hooks/editor/use-owned-app-view";
+import useOAuth from "./hooks/editor/use-oauth";
+export type { OAuthState } from "./hooks/editor/use-oauth";
 import useSnapshotState from "./hooks/editor/use-snapshot-state";
 import { useTranslations } from "./hooks/editor/use-translations";
 import useFileSystem from "./hooks/workspace/use-file-system";
@@ -24,4 +27,4 @@ import useTerminal from "./hooks/workspace/use-terminal";
 import useWorkspaceInfo from "./hooks/workspace/use-workspace-info";
 import ReceiveFileProvider from "./providers/receive-file-provider";
 import SnapshotProvider from "./providers/snapshot-provider";
-export { ReceiveFileProvider, SnapshotProvider, useAgents, useAgentTools, useArtifact, useEditorEnv, useFile, useFileSystem, useImageGen, useLLM, useLoading, useNotification, useOCR, useOpenApp, useOpenLink, useOwnedAppView, useReceiveFile, useActionEffect, useSnapshotState, useSTT, useTerminal, useTheme, useTranslations, useTTS, useVideoGen, useWorkspaceInfo, };
+export { ReceiveFileProvider, SnapshotProvider, useActionEffect, useAgents, useAgentTools, useAppSettings, useArtifact, useEditorEnv, useFile, useFileSystem, useImageGen, useLLM, useLoading, useNotification, useOCR, useOpenApp, useOpenLink, useOAuth, useOwnedAppView, useReceiveFile, useSnapshotState, useSTT, useTerminal, useTheme, useTranslations, useTTS, useVideoGen, useWorkspaceInfo, };