@fileverse-dev/dsheet 2.1.3-package-cleanup-2 → 2.1.3-rtc-debug-1

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

@@ -1,11 +1,10 @@
-import { default as React } from 'react';
-import { SidebarPortalRegistryHandle, SidebarPortalRenderer } from '../../sheet-engine/react';
-import { ThemeKey } from '../../sheet-engine/core/theme';
+import { default as React, ComponentProps } from 'react';
+import { Workbook } from '../../sheet-engine/react';
 import { SmartContractQueryHandler } from '../utils/after-update-cell';
-import { OnboardingHandlerType } from '../types';
-import { CommentsConfig } from '../types/comments';
+import { OnboardingHandlerType, DataBlockApiKeyHandlerType } from '../types';
 
 type OnboardingHandler = OnboardingHandlerType;
+type DataBlockApiKeyHandler = DataBlockApiKeyHandlerType;
 interface EditorWorkbookProps {
     setShowSmartContractModal?: React.Dispatch<React.SetStateAction<boolean>>;
     setShowFetchURLModal?: React.Dispatch<React.SetStateAction<boolean>>;
@@ -13,21 +12,25 @@ interface EditorWorkbookProps {
     setInputFetchURLDataBlock?: React.Dispatch<React.SetStateAction<string>>;
     isReadOnly?: boolean;
     allowSheetDownload?: boolean;
+    allowComments?: boolean;
     toggleTemplateSidebar?: () => void;
     onboardingComplete?: boolean;
     onboardingCompleteLocalStorageKey?: string;
     onboardingHandler?: OnboardingHandler;
+    dataBlockApiKeyHandler?: DataBlockApiKeyHandler;
     exportDropdownOpen?: boolean;
-    commentsConfig?: CommentsConfig;
+    commentData?: Object;
+    getCommentCellUI?: ComponentProps<typeof Workbook>['getCommentCellUI'];
     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>;
+/**
+ * EditorWorkbook component handles rendering the Fortune Workbook with proper configuration
+ */
+export declare const EditorWorkbook: React.FC<EditorWorkbookProps>;
 export {};

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

@@ -1,10 +1,7 @@
 import { default as React } from 'react';
 import { LiveQueryData, Sheet, WorkbookInstance } from '../../sheet-engine/react';
 import { IndexeddbPersistence } from 'y-indexeddb';
-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 { DataBlockApiKeyHandlerType, SheetUpdateData } from '../types';
 import { CollaborationProps, CollabState, CollabUser } from '../../sync-local/types';
 import { Awareness } from 'y-protocols/awareness';
 
@@ -51,17 +48,9 @@ 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 {
+    allowComments?: boolean;
     setSelectedTemplate?: React.Dispatch<React.SetStateAction<string>>;
     setShowSmartContractModal?: React.Dispatch<React.SetStateAction<boolean>>;
     getDocumentTitle?: (dsheetId: string) => Promise<string>;
@@ -76,7 +65,7 @@ interface EditorProviderProps {
     onChange?: (data: SheetUpdateData, encodedUpdate?: string) => void;
     collaboration?: CollaborationProps;
     externalEditorRef?: React.MutableRefObject<WorkbookInstance | null>;
-    commentsConfig?: CommentsConfig;
+    commentData?: object;
     editorStateRef?: React.MutableRefObject<{
         refreshIndexedDB: () => Promise<void>;
         terminateSession?: () => void;
@@ -85,8 +74,7 @@ interface EditorProviderProps {
     } | null>;
     enableLiveQuery?: boolean;
     liveQueryRefreshRate?: number;
-    apiKeyStorage?: ApiKeyStorage;
-    onDataBlockEvent?: (event: DataBlockEvent) => void;
+    dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType;
 }
 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, 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;
+declare const SpreadsheetEditor: ({ isReadOnly, allowSheetDownload, allowComments, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, onboardingComplete, onboardingCompleteLocalStorageKey, onboardingHandler, commentData, getCommentCellUI, dataBlockApiKeyHandler, setFetchingURLData, setShowFetchURLModal, setInputFetchURLDataBlock, sheetEditorRef: externalSheetEditorRef, storeApiKey, onDuneChartEmbed, onSheetCountChange, onDataBlockApiResponse, isAuthorized, getDocumentTitle, updateDocumentTitle, setShowSmartContractModal, editorStateRef, handleSmartContractQuery, setSelectedTemplate, isNewSheet, liveQueryRefreshRate, enableLiveQuery, collaboration, }: DsheetProps) => JSX.Element;
 export default SpreadsheetEditor;

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

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

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

@@ -1,7 +1,5 @@
 import { Sheet, WorkbookInstance } from '../../sheet-engine/react';
-import { ApiKeyStorage } from '../utils/api-key-storage';
-import { OpenApiKeyModalFn } from '../utils/data-block-error-handler';
-import { DataBlockEvent } from '../types';
+import { DataBlockApiKeyHandlerType } from '../types';
 
 import * as Y from 'yjs';
 /**
@@ -16,7 +14,7 @@ export declare const useEditorData: (ydocRef: React.MutableRefObject<Y.Doc | nul
     [key: string]: {
         [key: string]: any;
     };
-}>>, enableLiveQuery?: boolean, liveQueryRefreshRate?: number, apiKeyStorage?: ApiKeyStorage, openApiKeyModal?: OpenApiKeyModalFn, onDataBlockEvent?: (event: DataBlockEvent) => void, allowComments?: boolean, hasCollabContentInitialised?: boolean, collabEnabled?: boolean) => {
+}>>, enableLiveQuery?: boolean, liveQueryRefreshRate?: number, dataBlockApiKeyHandler?: DataBlockApiKeyHandlerType, 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,16 +1,10 @@
-import { Sheet, WorkbookInstance } from '../sheet-engine/react';
-import { RefObject } from 'react';
+import { Sheet, Workbook, WorkbookInstance, Cell } from '../sheet-engine/react';
+import { ComponentProps, 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 {
     data: Sheet[];
 }
@@ -18,19 +12,7 @@ export interface EditorValues {
     sheetEditorRef: RefObject<WorkbookInstance>;
     currentDataRef: React.MutableRefObject<Sheet[] | null>;
     ydocRef: React.RefObject<Y.Doc | null>;
-    openPanel: (panelId: string) => void;
-    closePanel: () => void;
 }
-export interface PanelConfig {
-    id: string;
-    header: {
-        title: string;
-        subtitle?: string;
-    };
-    width?: string;
-    content: React.ReactNode;
-}
-export type { PanelId, BuiltInPanelType, } from './components/sidebar/use-right-panels';
 export type OnboardingHandlerType = (params: {
     row: number;
     column: number;
@@ -39,14 +21,27 @@ export type OnboardingHandlerType = (params: {
     row: number;
     column: number;
 };
-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 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 interface DsheetProps {
     isNewSheet: boolean;
     setSelectedTemplate?: React.Dispatch<React.SetStateAction<string>>;
@@ -72,16 +67,17 @@ 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;
+    getCommentCellUI?: ComponentProps<typeof Workbook>['getCommentCellUI'];
+    commentData?: Object;
     toggleTemplateSidebar?: () => void;
     sheetEditorRef?: RefObject<WorkbookInstance & {
         refreshIndexedDB: () => Promise<void>;
     }>;
-    /** Override where datablock API keys are stored (default: localStorage). */
-    apiKeyStorage?: ApiKeyStorage;
-    /** Optional lifecycle events for analytics / side-effects. */
-    onDataBlockEvent?: (event: DataBlockEvent) => void;
+    storeApiKey?: (apiKeyName: string) => void;
+    allowComments?: boolean;
+    onDataBlockApiResponse?: (dataBlockName: string) => void;
     onDuneChartEmbed?: () => void;
     onSheetCountChange?: (sheetCount: number) => void;
     editorStateRef?: React.MutableRefObject<{
@@ -90,9 +86,6 @@ export interface DsheetProps {
     handleSmartContractQuery?: SmartContractQueryHandler;
     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,10 +1,7 @@
 import { Cell, WorkbookInstance } from '../../sheet-engine/react';
-import { OnboardingHandlerType, DataBlockEvent } from '../types';
+import { OnboardingHandlerType, DataBlockApiKeyHandlerType } 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[];
 };
@@ -25,18 +22,15 @@ 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;
-    apiKeyStorage: ApiKeyStorage;
-    openApiKeyModal: OpenApiKeyModalFn;
-    onDataBlockEvent?: (event: DataBlockEvent) => void;
+    dataBlockApiKeyHandler: DataBlockApiKeyHandlerType | undefined;
     handleSmartContractQuery?: SmartContractQueryHandler | undefined;
     handleLiveQueryData?: (subsheetIndex: number, queryData: LiveQueryData) => void;
-    setInputFetchURLDataBlock?: React.Dispatch<React.SetStateAction<string>> | undefined;
+    setInputFetchURLDataBlock: React.Dispatch<React.SetStateAction<string>> | undefined;
+    storeApiKey?: (apiKeyName: string) => void;
+    onDataBlockApiResponse?: (dataBlockName: string) => void;
     setDataBlockCalcFunction?: React.Dispatch<React.SetStateAction<{
         [key: string]: {
             [key: string]: any;
@@ -60,7 +54,7 @@ export declare const shouldExecuteDataBlocks: (params: {
     localUserEditRef?: React.MutableRefObject<boolean>;
     sheetEditorRef: React.RefObject<WorkbookInstance | null>;
 }) => boolean;
-export { isDatablockError } from './datablock-error-utils';
+export declare const isDatablockError: (value: any) => boolean;
 /**
  * Handles logic after a cell is updated, including processing formula results
  *
@@ -68,3 +62,4 @@ export { isDatablockError } from './datablock-error-utils';
  * @returns Promise that resolves when processing is complete
  */
 export declare const afterUpdateCell: (params: AfterUpdateCellParams) => Promise<void>;
+export {};