@bacano/sdk 1.0.1 → 1.1.8

package/react/preview/types.d.ts

@@ -0,0 +1,60 @@
+import type { CSSProperties, ReactNode } from "react";
+import type { BacanoClient } from "../../client";
+export type BacanoPreviewStatus = "idle" | "loading" | "ready" | "error";
+export type BacanoPreviewToolbarPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right";
+export type BacanoPreviewErrorCode = "CLIENT_UNAVAILABLE" | "EMPTY_DOCUMENT" | "LOADER_FAILED" | "ROUTE_NOT_PREVIEWABLE";
+export interface BacanoPreviewError {
+    code: BacanoPreviewErrorCode;
+    message: string;
+}
+export type PreviewRouteLoader<TDocument> = (context: {
+    route: string;
+    force: boolean;
+    client: BacanoClient;
+}) => Promise<TDocument>;
+export interface BacanoPreviewContextValue<TDocument> {
+    isPreview: true;
+    websiteSlug: string;
+    route: string;
+    status: BacanoPreviewStatus;
+    document: TDocument | null;
+    error: BacanoPreviewError | null;
+    refreshedAt: Date | null;
+    isExpanded: boolean;
+    position: BacanoPreviewToolbarPosition;
+    refresh: () => Promise<void>;
+    navigate: (route: string) => void;
+    setExpanded: (expanded: boolean) => void;
+    setPosition: (position: BacanoPreviewToolbarPosition) => void;
+}
+export interface BacanoPreviewProviderProps<TDocument> {
+    websiteSlug: string;
+    route: string;
+    loadRoute: PreviewRouteLoader<TDocument>;
+    navigate: (route: string) => void;
+    normalizeRoute?: (route: string) => string;
+    isPreviewableRoute?: (route: string) => boolean;
+    initialExpanded?: boolean;
+    initialPosition?: BacanoPreviewToolbarPosition;
+    cacheMaxEntries?: number;
+    children: ReactNode;
+}
+export interface BacanoPreviewToolbarProps {
+    websiteName?: string;
+    logo?: ReactNode;
+    primaryColor?: string;
+    accentColor?: string;
+    backgroundColor?: string;
+    locale?: string;
+    zIndex?: number;
+    suggestedRoutes?: readonly string[];
+}
+export interface BacanoPreviewShellProps<TDocument> extends Omit<BacanoPreviewProviderProps<TDocument>, "children"> {
+    toolbar?: BacanoPreviewToolbarProps | false;
+    children: (state: BacanoPreviewContextValue<TDocument>) => ReactNode;
+}
+export type BacanoPreviewToolbarStyle = CSSProperties & {
+    "--bacano-preview-primary": string;
+    "--bacano-preview-accent": string;
+    "--bacano-preview-background": string;
+};