@olonjs/react 0.1.1 → 0.1.3

package/dist/index.d.ts

@@ -12,14 +12,57 @@ import { MenuItem } from '@olonjs/core';
 import { PageConfig } from '@olonjs/core';
 import { PageMeta } from '@olonjs/core';
 import { PageRendererProps } from '@olonjs/core';
+import { ProjectState } from '@olonjs/core';
 import { ReactNode } from 'react';
 import { Section } from '@olonjs/core';
 import { SiteConfig } from '@olonjs/core';
 import { StudioRouteBodyProps } from '@olonjs/studio';
 import { ThemeConfig } from '@olonjs/core';
 
+/**
+ * Prefer …/api/v1, keep raw base as fallback candidate.
+ */
+export declare function buildApiCandidates(raw: string): string[];
+
 export { buildThemeVariableMap }
 
+/**
+ * Cloud policy — single explicit contract for boot vs save.
+ *
+ * Boot and save are different:
+ * - bootSource: where content loads at startup (only Save2Repo yes/no among cloud modes)
+ * - hotSave / coldSave: what Studio may persist (Hot stays on whenever credentials exist)
+ */
+export declare type CloudBootSource = 'local' | 'live' | 'static';
+
+export declare type CloudEnvInput = {
+    /** Cloud API base URL (trimmed). Empty ⇒ no cloud credentials. */
+    apiUrl: string;
+    /** Bearer API key (trimmed). Empty ⇒ no cloud credentials. */
+    apiKey: string;
+    /** True when VITE_SAVE2REPO === 'true'. */
+    save2RepoFlag: boolean;
+};
+
+export declare type CloudPolicy = {
+    /** Has both URL and API key. */
+    isCloudMode: boolean;
+    /**
+     * Startup content source — decided only by credentials + Save2Repo:
+     * local (no cloud) | live (cloud, no Save2Repo) | static (Save2Repo on).
+     */
+    bootSource: CloudBootSource;
+    /** Hot save allowed whenever cloud credentials exist (also with Save2Repo). */
+    hotSaveEnabled: boolean;
+    /** Cold / Save2Repo save when cloud credentials exist AND save2RepoFlag. */
+    save2RepoEnabled: boolean;
+    showLocalSave: boolean;
+    showHotSave: boolean;
+    showColdSave: boolean;
+    apiUrl: string;
+    apiKey: string;
+};
+
 export declare interface ConfigContextValue {
     registry: Registry;
     schemas: Schemas;
@@ -34,6 +77,31 @@ export declare const ConfigProvider: default_2.FC<{
     children: default_2.ReactNode;
 }>;
 
+/**
+ * Studio HotSave — POST `{apiUrl}/hotSave` with Bearer key.
+ *
+ * Explicit: this only performs the live write. UI visibility is
+ * `CloudPolicy.showHotSave` / `hotSaveEnabled` (credentials ⇒ on, including dual Save2Repo).
+ */
+export declare function createHotSaveHandler(options: CreateHotSaveHandlerOptions): HotSaveHandler;
+
+export declare type CreateHotSaveHandlerOptions = {
+    apiUrl: string;
+    apiKey: string;
+    /** Injected for tests; defaults to global fetch. */
+    fetchImpl?: typeof fetch;
+    /**
+     * DNA hook after a successful hot save (e.g. local cloud cache).
+     * Not required for the HTTP contract itself.
+     */
+    onSuccess?: (ctx: {
+        state: ProjectState;
+        slug: string;
+        apiUrl: string;
+        apiKey: string;
+    }) => void | Promise<void>;
+};
+
 export declare const DefaultNotFound: default_2.FC;
 
 /**
@@ -64,6 +132,8 @@ export declare interface FormState {
 
 export declare type FormStatus = 'idle' | 'submitting' | 'success' | 'error';
 
+export declare type HotSaveHandler = (state: ProjectState, slug: string) => Promise<void>;
+
 export declare type IconRegistry = Record<string, LucideIcon>;
 
 export declare const IconRegistryContext: Context<IconRegistry>;
@@ -104,8 +174,19 @@ declare type Props = PageRendererProps & {
     onActiveSectionChange?: (sectionId: string | null) => void;
 };
 
+/**
+ * Map Vite env bag → CloudEnvInput.
+ * Caller passes `import.meta.env` from the app (keeps this package free of ImportMeta coupling).
+ */
+export declare function readCloudEnvFromVite(env: ViteCloudEnvBag): CloudEnvInput;
+
 declare type Registry = JsonPagesConfig['registry'];
 
+/**
+ * Pure policy. Pass env in — do not read import.meta.env here.
+ */
+export declare function resolveCloudPolicy(input: CloudEnvInput): CloudPolicy;
+
 declare type Schemas = JsonPagesConfig['schemas'];
 
 export declare const SectionRenderer: default_2.FC<SectionRendererProps>;
@@ -191,4 +272,7 @@ export declare interface VisitorRouteProps {
     NotFoundComponent: default_2.ComponentType;
 }
 
+/** Vite `import.meta.env` bag (caller-supplied; no ImportMeta in this package). */
+export declare type ViteCloudEnvBag = Record<string, unknown>;
+
 export { }