@fileverse-dev/dsheet 2.1.2-dropIn-mri-5 → 2.1.3-package-cleanup-1

package/dist/editor/components/api-key-modal/api-key-input.d.ts

@@ -0,0 +1,5 @@
+export declare const ApiKeyInput: ({ name, onSave, onCancel, }: {
+    name: string;
+    onSave: (value: string) => void;
+    onCancel: () => void;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/editor/components/api-key-modal/api-key-modal.d.ts

@@ -0,0 +1,7 @@
+export interface ApiKeyModalProps {
+    open: boolean;
+    apiKeyName: string;
+    onSave: (key: string) => void;
+    onClose: () => void;
+}
+export declare const ApiKeyModal: ({ open, apiKeyName, onSave, onClose, }: ApiKeyModalProps) => import("react/jsx-runtime").JSX.Element;

package/dist/editor/components/api-key-modal/rate-limit-info.d.ts

@@ -0,0 +1,4 @@
+export declare const RateLimitInfo: ({ onInsertKey, name, }: {
+    onInsertKey: () => void;
+    name: string;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/editor/components/editor-workbook.d.ts

@@ -1,11 +1,11 @@
 import { default as React } from 'react';
 import { SidebarPortalRegistryHandle, SidebarPortalRenderer } from '../../sheet-engine/react';
+import { ThemeKey } from '../../sheet-engine/core/theme';
 import { SmartContractQueryHandler } from '../utils/after-update-cell';
-import { OnboardingHandlerType, DataBlockApiKeyHandlerType } from '../types';
+import { OnboardingHandlerType } from '../types';
 import { CommentsConfig } from '../types/comments';
 
 type OnboardingHandler = OnboardingHandlerType;
-type DataBlockApiKeyHandler = DataBlockApiKeyHandlerType;
 interface EditorWorkbookProps {
     setShowSmartContractModal?: React.Dispatch<React.SetStateAction<boolean>>;
     setShowFetchURLModal?: React.Dispatch<React.SetStateAction<boolean>>;
@@ -17,19 +17,17 @@ interface EditorWorkbookProps {
     onboardingComplete?: boolean;
     onboardingCompleteLocalStorageKey?: string;
     onboardingHandler?: OnboardingHandler;
-    dataBlockApiKeyHandler?: DataBlockApiKeyHandler;
     exportDropdownOpen?: boolean;
     commentsConfig?: CommentsConfig;
     setExportDropdownOpen?: React.Dispatch<React.SetStateAction<boolean>>;
     dsheetId: string;
-    storeApiKey?: (apiKeyName: string) => void;
-    onDataBlockApiResponse?: (dataBlockName: string) => void;
     onDuneChartEmbed?: () => void;
     onSheetCountChange?: (sheetCount: number) => void;
     handleSmartContractQuery?: SmartContractQueryHandler;
     sidebarActivePanel?: string | null;
     sidebarPortalRegistry?: SidebarPortalRegistryHandle | null;
     sidebarPortalRenderers?: Record<string, SidebarPortalRenderer>;
+    theme?: ThemeKey;
 }
 export declare const EditorWorkbook: React.NamedExoticComponent<EditorWorkbookProps>;
 export {};

package/dist/editor/contexts/editor-context.d.ts

@@ -1,8 +1,10 @@
 import { default as React } from 'react';
 import { LiveQueryData, Sheet, WorkbookInstance } from '../../sheet-engine/react';
 import { IndexeddbPersistence } from 'y-indexeddb';
-import { DataBlockApiKeyHandlerType, SheetUpdateData } from '../types';
+import { SheetUpdateData, DataBlockEvent } from '../types';
 import { CommentsConfig } from '../types/comments';
+import { ApiKeyStorage } from '../utils/api-key-storage';
+import { OpenApiKeyModalFn } from '../utils/data-block-error-handler';
 import { CollaborationProps, CollabState, CollabUser } from '../../sync-local/types';
 import { Awareness } from 'y-protocols/awareness';
 
@@ -49,6 +51,15 @@ export interface EditorContextType {
     terminateSession?: () => void;
     onCollaboratorsChange?: (collaborators: CollabUser[]) => void;
     handleLiveQuery: (subsheetIndex: number, data: LiveQueryData) => void;
+    apiKeyStorage: ApiKeyStorage;
+    onDataBlockEvent?: (event: DataBlockEvent) => void;
+    openApiKeyModal: OpenApiKeyModalFn;
+    apiKeyModalState: {
+        open: boolean;
+        apiKeyName: string;
+        onSave: (key: string) => void;
+        onClose: () => void;
+    } | null;
 }
 interface EditorProviderProps {
     setSelectedTemplate?: React.Dispatch<React.SetStateAction<string>>;
@@ -74,7 +85,8 @@ interface EditorProviderProps {
     } | null>;
     enableLiveQuery?: boolean;
     liveQueryRefreshRate?: number;
-    dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType;
+    apiKeyStorage?: ApiKeyStorage;
+    onDataBlockEvent?: (event: DataBlockEvent) => void;
 }
 export declare const EditorProvider: React.FC<EditorProviderProps>;
 export declare const useEditor: () => EditorContextType;

package/dist/editor/dsheet-editor.d.ts

@@ -7,5 +7,5 @@ import { DsheetProps } from './types';
  * @param props - Component properties
  * @returns The SpreadsheetEditor component
  */
-declare const SpreadsheetEditor: ({ isReadOnly, allowSheetDownload, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, onboardingComplete, onboardingCompleteLocalStorageKey, onboardingHandler, commentsConfig, dataBlockApiKeyHandler, setFetchingURLData, setShowFetchURLModal, setInputFetchURLDataBlock, sheetEditorRef: externalSheetEditorRef, storeApiKey, onDuneChartEmbed, onSheetCountChange, onDataBlockApiResponse, isAuthorized, getDocumentTitle, updateDocumentTitle, setShowSmartContractModal, editorStateRef, handleSmartContractQuery, setSelectedTemplate, isNewSheet, liveQueryRefreshRate, enableLiveQuery, collaboration, customPanels, }: DsheetProps) => JSX.Element;
+declare const SpreadsheetEditor: ({ isReadOnly, allowSheetDownload, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, onboardingComplete, onboardingCompleteLocalStorageKey, onboardingHandler, commentsConfig, setFetchingURLData, setShowFetchURLModal, setInputFetchURLDataBlock, sheetEditorRef: externalSheetEditorRef, onDuneChartEmbed, onSheetCountChange, isAuthorized, getDocumentTitle, updateDocumentTitle, setShowSmartContractModal, editorStateRef, handleSmartContractQuery, setSelectedTemplate, isNewSheet, liveQueryRefreshRate, enableLiveQuery, collaboration, customPanels, apiKeyStorage, onDataBlockEvent, theme, }: DsheetProps) => JSX.Element;
 export default SpreadsheetEditor;

package/dist/editor/hooks/live-query/use-live-query.d.ts

@@ -1,8 +1,10 @@
 import { LiveQueryData, Sheet, WorkbookInstance } from '../../../sheet-engine/react';
-import { DataBlockApiKeyHandlerType } from '../../types';
+import { ApiKeyStorage } from '../../utils/api-key-storage';
+import { OpenApiKeyModalFn } from '../../utils/data-block-error-handler';
+import { DataBlockEvent } from '../../types';
 
 export declare const LIVE_QUERY_ERROR = "LIVE_QUERY_ERROR";
-export declare const useLiveQuery: (sheetEditorRef: React.MutableRefObject<WorkbookInstance | null>, dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType, enableLiveQuery?: boolean, refreshRate?: number) => {
+export declare const useLiveQuery: (sheetEditorRef: React.MutableRefObject<WorkbookInstance | null>, apiKeyStorage?: ApiKeyStorage, openApiKeyModal?: OpenApiKeyModalFn, onDataBlockEvent?: (event: DataBlockEvent) => void, enableLiveQuery?: boolean, refreshRate?: number) => {
     handleLiveQuery: (subsheetIndex: number, queryData: LiveQueryData) => void;
     initialiseLiveQueryData: (sheets: Sheet[]) => void;
 };

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

@@ -1,5 +1,7 @@
 import { Sheet, WorkbookInstance } from '../../sheet-engine/react';
-import { DataBlockApiKeyHandlerType } from '../types';
+import { ApiKeyStorage } from '../utils/api-key-storage';
+import { OpenApiKeyModalFn } from '../utils/data-block-error-handler';
+import { DataBlockEvent } from '../types';
 
 import * as Y from 'yjs';
 /**
@@ -14,7 +16,7 @@ export declare const useEditorData: (ydocRef: React.MutableRefObject<Y.Doc | nul
     [key: string]: {
         [key: string]: any;
     };
-}>>, enableLiveQuery?: boolean, liveQueryRefreshRate?: number, dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType, allowComments?: boolean, hasCollabContentInitialised?: boolean, collabEnabled?: boolean) => {
+}>>, enableLiveQuery?: boolean, liveQueryRefreshRate?: number, apiKeyStorage?: ApiKeyStorage, openApiKeyModal?: OpenApiKeyModalFn, onDataBlockEvent?: (event: DataBlockEvent) => void, allowComments?: boolean, hasCollabContentInitialised?: boolean, collabEnabled?: boolean) => {
     sheetData: Sheet[];
     setSheetData: import('react').Dispatch<import('react').SetStateAction<Sheet[]>>;
     currentDataRef: import('react').MutableRefObject<Sheet[]>;

package/dist/editor/types.d.ts

@@ -1,11 +1,14 @@
-import { Sheet, WorkbookInstance, Cell } from '../sheet-engine/react';
+import { Sheet, WorkbookInstance } from '../sheet-engine/react';
 import { RefObject } from 'react';
 import { ERROR_MESSAGES_FLAG } from './constants/shared-constants';
 import { SmartContractQueryHandler } from './utils/after-update-cell';
 import { CollaborationProps } from '../sync-local/types';
 import { CommentsConfig } from './types/comments';
+import { ApiKeyStorage } from './utils/api-key-storage';
+import { ThemeKey } from '../sheet-engine/core/theme';
 
 import * as Y from 'yjs';
+export type { ThemeKey } from '../sheet-engine/core/theme';
 export type { CommentThread, CommentReply, CommentActionParams, CommentsConfig, } from './types/comments';
 export { CommentAction } from './types/comments';
 export interface SheetUpdateData {
@@ -36,27 +39,14 @@ export type OnboardingHandlerType = (params: {
     row: number;
     column: number;
 };
-export type DataBlockApiKeyHandlerType = (params: {
-    data: ErrorMessageHandlerReturnType;
-    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
-    executeStringFunction: ({ functionCallString, sheetEditorRef, dataBlockRow, dataBlockColumn, handleSmartContractQuery, }: {
-        functionCallString: string;
-        sheetEditorRef: React.RefObject<WorkbookInstance | null>;
-        dataBlockRow: number;
-        dataBlockColumn: number;
-        handleSmartContractQuery: SmartContractQueryHandler;
-    }) => Promise<unknown>;
-    row: number;
-    column: number;
-    newValue: Cell;
-    formulaResponseUiSync: (params: {
-        row: number;
-        column: number;
-        newValue: Record<string, string>;
-        apiData: Array<Record<string, object>>;
-        sheetEditorRef: React.RefObject<WorkbookInstance | null>;
-    }) => void;
-}) => void;
+export type DataBlockEventType = 'success' | 'error' | 'api-key-required' | 'api-key-saved' | 'retry';
+export interface DataBlockEvent {
+    type: DataBlockEventType;
+    functionName?: string;
+    errorType?: string;
+    apiKeyName?: string;
+}
+export type { ApiKeyStorage } from './utils/api-key-storage';
 export interface DsheetProps {
     isNewSheet: boolean;
     setSelectedTemplate?: React.Dispatch<React.SetStateAction<string>>;
@@ -82,15 +72,16 @@ export interface DsheetProps {
     /** When `onboardingComplete` is omitted, read `localStorage.getItem(key)==='true'` (default key `onboardingComplete`). */
     onboardingCompleteLocalStorageKey?: string;
     onboardingHandler?: OnboardingHandlerType;
-    dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType;
     setForceSheetRender?: React.Dispatch<React.SetStateAction<number>>;
     commentsConfig?: CommentsConfig;
     toggleTemplateSidebar?: () => void;
     sheetEditorRef?: RefObject<WorkbookInstance & {
         refreshIndexedDB: () => Promise<void>;
     }>;
-    storeApiKey?: (apiKeyName: string) => void;
-    onDataBlockApiResponse?: (dataBlockName: string) => void;
+    /** Override where datablock API keys are stored (default: localStorage). */
+    apiKeyStorage?: ApiKeyStorage;
+    /** Optional lifecycle events for analytics / side-effects. */
+    onDataBlockEvent?: (event: DataBlockEvent) => void;
     onDuneChartEmbed?: () => void;
     onSheetCountChange?: (sheetCount: number) => void;
     editorStateRef?: React.MutableRefObject<{
@@ -100,6 +91,8 @@ export interface DsheetProps {
     enableLiveQuery?: boolean;
     liveQueryRefreshRate?: number;
     customPanels?: PanelConfig[];
+    /** Active theme; drives the canvas/grid palette (chrome themes via the <html> class). */
+    theme?: ThemeKey;
 }
 export type BaseError = {
     message: string;

package/dist/editor/utils/after-update-cell.d.ts

@@ -1,7 +1,10 @@
 import { Cell, WorkbookInstance } from '../../sheet-engine/react';
-import { OnboardingHandlerType, DataBlockApiKeyHandlerType } from '../types';
+import { OnboardingHandlerType, DataBlockEvent } from '../types';
 import { LiveQueryData } from '../../sheet-engine/core';
+import { OpenApiKeyModalFn } from './data-block-error-handler';
+import { ApiKeyStorage } from './api-key-storage';
 
+import * as Y from 'yjs';
 export type SmartContractResponse = {
     callSignature: unknown[];
 };
@@ -22,15 +25,18 @@ interface AfterUpdateCellParams {
     oldValue?: Cell;
     newValue: Cell;
     sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+    handleContentPortal?: () => void;
+    dsheetId?: string;
+    ydocRef?: React.MutableRefObject<Y.Doc | null>;
     onboardingComplete: boolean | undefined;
-    setFetchingURLData: (fetching: boolean) => void;
+    setFetchingURLData?: (fetching: boolean) => void;
     onboardingHandler: OnboardingHandlerType | undefined;
-    dataBlockApiKeyHandler: DataBlockApiKeyHandlerType | undefined;
+    apiKeyStorage: ApiKeyStorage;
+    openApiKeyModal: OpenApiKeyModalFn;
+    onDataBlockEvent?: (event: DataBlockEvent) => void;
     handleSmartContractQuery?: SmartContractQueryHandler | undefined;
     handleLiveQueryData?: (subsheetIndex: number, queryData: LiveQueryData) => void;
-    setInputFetchURLDataBlock: React.Dispatch<React.SetStateAction<string>> | undefined;
-    storeApiKey?: (apiKeyName: string) => void;
-    onDataBlockApiResponse?: (dataBlockName: string) => void;
+    setInputFetchURLDataBlock?: React.Dispatch<React.SetStateAction<string>> | undefined;
     setDataBlockCalcFunction?: React.Dispatch<React.SetStateAction<{
         [key: string]: {
             [key: string]: any;
@@ -54,7 +60,7 @@ export declare const shouldExecuteDataBlocks: (params: {
     localUserEditRef?: React.MutableRefObject<boolean>;
     sheetEditorRef: React.RefObject<WorkbookInstance | null>;
 }) => boolean;
-export declare const isDatablockError: (value: any) => boolean;
+export { isDatablockError } from './datablock-error-utils';
 /**
  * Handles logic after a cell is updated, including processing formula results
  *
@@ -62,4 +68,3 @@ export declare const isDatablockError: (value: any) => boolean;
  * @returns Promise that resolves when processing is complete
  */
 export declare const afterUpdateCell: (params: AfterUpdateCellParams) => Promise<void>;
-export {};

package/dist/editor/utils/api-key-storage.d.ts

@@ -0,0 +1,6 @@
+export interface ApiKeyStorage {
+    get: (name: string) => string | null;
+    set: (name: string, key: string) => void;
+    remove?: (name: string) => void;
+}
+export declare const defaultApiKeyStorage: ApiKeyStorage;

package/dist/editor/utils/api-keys-local-storage.d.ts

@@ -5,6 +5,7 @@ export declare class ApiKeyStorageHelper {
     static getApiKey(keyName: string): string;
     static clearApiKeys(): void;
     static saveApiKey(keyName: string, key: string): void;
+    static removeApiKey(keyName: string): void;
     static getAllSupportedApiKeys(): Record<string, string>;
     static getListOfRateLimitedKeys(): any;
     static markKeyAsRateLimited(key: string): void;
@@ -12,6 +13,7 @@ export declare class ApiKeyStorageHelper {
 export declare const getApiKey: (keyName: string) => string;
 export declare const clearApiKeys: () => void;
 export declare const saveApiKey: (keyName: string, key: string) => void;
+export declare const removeApiKey: (keyName: string) => void;
 export declare const getListOfRateLimitedKeys: () => any;
 export declare const getAllSupportedApiKeysInLs: () => Record<string, string>;
 export declare const markKeyAsRateLimited: (key: string) => void;

package/dist/editor/utils/data-block-error-handler.d.ts

@@ -0,0 +1,21 @@
+import { Cell, WorkbookInstance } from '../../sheet-engine/react';
+import { DataBlockEvent, ErrorMessageHandlerReturnType } from '../types';
+import { ApiKeyStorage } from './api-key-storage';
+import { SmartContractQueryHandler } from './after-update-cell';
+
+export type OpenApiKeyModalFn = (apiKeyName: string, callbacks: {
+    onSave: (key: string) => void;
+    onClose: () => void;
+}) => void;
+export interface DataBlockErrorHandlerParams {
+    data: ErrorMessageHandlerReturnType;
+    sheetEditorRef: React.RefObject<WorkbookInstance | null>;
+    row: number;
+    column: number;
+    newValue: Cell;
+    apiKeyStorage: ApiKeyStorage;
+    openApiKeyModal: OpenApiKeyModalFn;
+    onDataBlockEvent?: (event: DataBlockEvent) => void;
+    handleSmartContractQuery?: SmartContractQueryHandler;
+}
+export declare const handleDataBlockError: ({ data, sheetEditorRef, row, column, newValue, apiKeyStorage, openApiKeyModal, onDataBlockEvent, handleSmartContractQuery, }: DataBlockErrorHandlerParams) => Promise<void>;

package/dist/editor/utils/datablock-error-utils.d.ts

@@ -0,0 +1 @@
+export declare const isDatablockError: (value: unknown) => boolean;