@fileverse-dev/dsheet 2.1.3-package-cleanup-2 → 2.1.3-package-cleanup-3

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

@@ -1,13 +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 } from '../types';
 import { CommentsConfig } from '../types/comments';
 
 type OnboardingHandler = OnboardingHandlerType;
 interface EditorWorkbookProps {
-    setShowSmartContractModal?: React.Dispatch<React.SetStateAction<boolean>>;
     setShowFetchURLModal?: React.Dispatch<React.SetStateAction<boolean>>;
     setFetchingURLData?: (fetching: boolean) => void;
     setInputFetchURLDataBlock?: React.Dispatch<React.SetStateAction<string>>;
@@ -23,7 +21,6 @@ interface EditorWorkbookProps {
     dsheetId: string;
     onDuneChartEmbed?: () => void;
     onSheetCountChange?: (sheetCount: number) => void;
-    handleSmartContractQuery?: SmartContractQueryHandler;
     sidebarActivePanel?: string | null;
     sidebarPortalRegistry?: SidebarPortalRegistryHandle | null;
     sidebarPortalRenderers?: Record<string, SidebarPortalRenderer>;

package/dist/editor/components/smart-contract/error-toast.d.ts

@@ -0,0 +1,11 @@
+export declare const SmartContractReadingErrorToast: ({ smartContractReadingError, setSmartContractReadingError, openPanel, }: {
+    smartContractReadingError: {
+        hasError: boolean;
+        errorMessage: string;
+    };
+    setSmartContractReadingError: (error: {
+        hasError: boolean;
+        errorMessage: string;
+    }) => void;
+    openPanel: (panel: string) => void;
+}) => import("react/jsx-runtime").JSX.Element | null;

package/dist/editor/components/smart-contract/modal/abi-input-section.d.ts

@@ -0,0 +1,11 @@
+import { default as React } from 'react';
+
+interface AbiInputSectionProps {
+    abiCode: string;
+    setAbiCode: (value: string) => void;
+    errorState: {
+        message: string;
+    } | null;
+}
+export declare const AbiInputSection: React.FC<AbiInputSectionProps>;
+export {};

package/dist/editor/components/smart-contract/modal/contract-name-section.d.ts

@@ -0,0 +1,13 @@
+import { default as React } from 'react';
+import { ContractConfig } from '../../../types/smart-contract';
+
+interface ContractNameSectionProps {
+    smartContractName: string;
+    setSmartContractName: (name: string) => void;
+    registryMap: Record<string, ContractConfig>;
+    abiCode: string;
+    isLoading: boolean;
+    onClickProceed: () => Promise<void>;
+}
+export declare const ContractNameSection: React.FC<ContractNameSectionProps>;
+export {};

package/dist/editor/components/smart-contract/modal/file-upload-section.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+
+interface FileUploadSectionProps {
+    uploadedFile: any;
+    uploadProgress: number;
+    isUploading: boolean;
+    handleRemoveFile: () => void;
+    handleFileInputChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    fileInputRef: React.RefObject<HTMLInputElement>;
+}
+export declare const FileUploadSection: React.FC<FileUploadSectionProps>;
+export {};

package/dist/editor/components/smart-contract/modal/import-section.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+
+interface ImportSectionProps {
+    isImporting: boolean;
+    handleImport: () => void;
+}
+export declare const ImportSection: React.FC<ImportSectionProps>;
+export {};

package/dist/editor/components/smart-contract/modal/modal-header.d.ts

@@ -0,0 +1,17 @@
+import { default as React } from 'react';
+import { SupportedChain } from '../../../types/smart-contract';
+
+interface ModalHeaderProps {
+    inputAddress: string;
+    setFormStep: (step: number) => void;
+    onAddressChange: (url: string) => void;
+    setSelectedChain: (chain: SupportedChain) => void;
+    networks: {
+        label: string;
+        value: SupportedChain;
+    }[];
+    selectedChain: SupportedChain;
+    showHint: boolean;
+}
+export declare const ModalHeader: React.FC<ModalHeaderProps>;
+export {};

package/dist/editor/components/smart-contract/smart-contract-list-item.d.ts

@@ -0,0 +1,8 @@
+import { Abi } from 'viem';
+import { ContractConfig } from '../../types/smart-contract';
+
+export declare const SmartContractListItem: ({ contract, onDelete, fetchContractAbi, }: {
+    contract: ContractConfig;
+    onDelete?: (name: string) => void;
+    fetchContractAbi: (contract: ContractConfig) => Promise<Abi>;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/editor/components/smart-contract/smart-contract-modal-ui.d.ts

@@ -0,0 +1,33 @@
+import { default as React, MutableRefObject } from 'react';
+import { ContractConfig, SupportedChain } from '../../types/smart-contract';
+
+interface SmartContractModalUIProps {
+    abiCode: string;
+    smartContractName: string;
+    setSmartContractName: React.Dispatch<React.SetStateAction<string>>;
+    setAbiCode: React.Dispatch<React.SetStateAction<string>>;
+    uploadedFile: any;
+    setUploadedFile: React.Dispatch<React.SetStateAction<any>>;
+    uploadProgress: number;
+    isUploading: boolean;
+    handleRemoveFile: () => void;
+    handleUploadAreaClick: () => void;
+    handleFileInputChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    fileInputRef: React.RefObject<HTMLInputElement>;
+    selectedChain: SupportedChain;
+    setSelectedChain: React.Dispatch<React.SetStateAction<SupportedChain>>;
+    formStep: number;
+    setFormStep: React.Dispatch<React.SetStateAction<number>>;
+    onClickProceed: (abi?: any) => Promise<void>;
+    inputAddress: string;
+    isValidURL: boolean;
+    modalDivRef: React.RefObject<HTMLDivElement>;
+    onAddressChange: (url: string) => void;
+    isImportingRef: MutableRefObject<boolean>;
+    registryMapRef: MutableRefObject<Record<string, ContractConfig>>;
+    errorState: {
+        message: string;
+    } | null;
+}
+export declare const SmartContractModalUI: React.FC<SmartContractModalUIProps>;
+export {};

package/dist/editor/components/smart-contract/smart-contract-modal.d.ts

@@ -0,0 +1,12 @@
+import { default as React, MutableRefObject } from 'react';
+import { ContractConfig, SupportedChain } from '../../types/smart-contract';
+import { Hex } from 'viem';
+
+interface FetchUrlDataBlockProps {
+    showSmartContractModal: boolean;
+    setShowSmartContractModal: (show: boolean) => void;
+    onSaveContract: (address: Hex, chain: SupportedChain, abi: string, smartContractName: string) => Promise<void>;
+    registryMapRef: MutableRefObject<Record<string, ContractConfig>>;
+}
+export declare const SmartContractModal: React.FC<FetchUrlDataBlockProps>;
+export {};

package/dist/editor/components/smart-contract/smart-contract-reading-intro.d.ts

@@ -0,0 +1,4 @@
+export declare const SmartContractReadingIntro: ({ isAuthorized, onOpenPanel, }: {
+    isAuthorized: boolean;
+    onOpenPanel: (panelId: string) => void;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/editor/components/smart-contract/smart-contract-view-list.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+import { SmartContractListViewProps, MyContractsProps, PopularContractsProps } from '../../types/smart-contract';
+
+export declare const MyContracts: React.FC<MyContractsProps>;
+export declare const PopularContracts: React.FC<PopularContractsProps>;
+export declare const SmartContractListView: React.FC<SmartContractListViewProps>;

package/dist/editor/components/smart-contract/use-address-validation.d.ts

@@ -0,0 +1,5 @@
+export declare const useAddressValidation: () => {
+    isValidAddress: boolean;
+    handleAddressChange: (address: string) => address is `0x${string}`;
+    resetValidation: () => void;
+};

package/dist/editor/components/smart-contract/use-modal-outside-click.d.ts

@@ -0,0 +1,18 @@
+import { MutableRefObject } from 'react';
+
+interface UseFetchUrlModalProps {
+    onClose?: () => void;
+    setInputAddress?: React.Dispatch<React.SetStateAction<string>>;
+    shouldPreventClose?: MutableRefObject<boolean>;
+}
+export declare const useModalOutsideClick: ({ onClose, setInputAddress, shouldPreventClose, }?: UseFetchUrlModalProps) => {
+    rowCount: number;
+    setRowCount: import('react').Dispatch<import('react').SetStateAction<number>>;
+    includeHeaders: boolean;
+    setIncludeHeaders: import('react').Dispatch<import('react').SetStateAction<boolean>>;
+    abortCall: boolean;
+    modalDivRef: import('react').RefObject<HTMLDivElement>;
+    resetModalState: () => void;
+    handleClose: () => void;
+};
+export {};

package/dist/editor/components/smart-contract/use-smart-contract-modal.d.ts

@@ -0,0 +1,38 @@
+import { Hex } from 'viem';
+import { ContractConfig, SupportedChain } from '../../types/smart-contract';
+
+export declare function useSmartContractModal({ onSaveContract, setShowSmartContractModal, registryMapRef, }: {
+    onSaveContract: (address: Hex, chain: SupportedChain, abi: string, smartContractName: string) => Promise<void>;
+    setShowSmartContractModal: (show: boolean) => void;
+    registryMapRef: React.MutableRefObject<Record<string, ContractConfig>>;
+}): {
+    inputAddress: string;
+    setInputAddress: import('react').Dispatch<import('react').SetStateAction<string>>;
+    selectedChain: SupportedChain;
+    setSelectedChain: import('react').Dispatch<import('react').SetStateAction<SupportedChain>>;
+    formStep: number;
+    setFormStep: import('react').Dispatch<import('react').SetStateAction<number>>;
+    abiCode: string;
+    setAbiCode: import('react').Dispatch<import('react').SetStateAction<string>>;
+    uploadedFile: any;
+    setUploadedFile: import('react').Dispatch<any>;
+    uploadProgress: number;
+    setUploadProgress: import('react').Dispatch<import('react').SetStateAction<number>>;
+    isUploading: boolean;
+    setIsUploading: import('react').Dispatch<import('react').SetStateAction<boolean>>;
+    fileInputRef: import('react').MutableRefObject<any>;
+    smartContractName: string;
+    setSmartContractName: import('react').Dispatch<import('react').SetStateAction<string>>;
+    isImportingRef: import('react').MutableRefObject<boolean>;
+    modalDivRef: import('react').RefObject<HTMLDivElement>;
+    handleFileInputChange: (e: any) => void;
+    handleUploadAreaClick: () => void;
+    handleRemoveFile: () => void;
+    handleAddressInputChange: (url: string) => void;
+    onClickProceed: (abi?: any) => Promise<void>;
+    isValidAddress: boolean;
+    registryMapRef: import('react').MutableRefObject<Record<string, ContractConfig>>;
+    errorState: {
+        message: string;
+    } | null;
+};

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

@@ -5,6 +5,8 @@ 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 { SmartContractConfig } from '../types/smart-contract';
+import { UseSmartContractReturn } from '../hooks/use-smart-contract';
 import { CollaborationProps, CollabState, CollabUser } from '../../sync-local/types';
 import { Awareness } from 'y-protocols/awareness';
 
@@ -60,10 +62,10 @@ export interface EditorContextType {
         onSave: (key: string) => void;
         onClose: () => void;
     } | null;
+    smartContract: UseSmartContractReturn;
 }
 interface EditorProviderProps {
     setSelectedTemplate?: React.Dispatch<React.SetStateAction<string>>;
-    setShowSmartContractModal?: React.Dispatch<React.SetStateAction<boolean>>;
     getDocumentTitle?: (dsheetId: string) => Promise<string>;
     updateDocumentTitle?: (title: string) => void;
     isAuthorized: boolean;
@@ -87,6 +89,7 @@ interface EditorProviderProps {
     liveQueryRefreshRate?: number;
     apiKeyStorage?: ApiKeyStorage;
     onDataBlockEvent?: (event: DataBlockEvent) => void;
+    smartContracts?: SmartContractConfig;
 }
 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, renderNavbar, enableIndexeddbSync, dsheetId, portalContent, onChange, username, selectedTemplate, toggleTemplateSidebar, isTemplateOpen, onboardingComplete, onboardingCompleteLocalStorageKey, onboardingHandler, commentsConfig, setFetchingURLData, setShowFetchURLModal, setInputFetchURLDataBlock, sheetEditorRef: externalSheetEditorRef, onDuneChartEmbed, onSheetCountChange, isAuthorized, getDocumentTitle, updateDocumentTitle, editorStateRef, setSelectedTemplate, isNewSheet, liveQueryRefreshRate, enableLiveQuery, collaboration, customPanels, apiKeyStorage, onDataBlockEvent, smartContracts, theme, }: DsheetProps) => JSX.Element;
 export default SpreadsheetEditor;

package/dist/editor/hooks/use-smart-contract.d.ts

@@ -0,0 +1,26 @@
+import { Abi, Hex } from 'viem';
+import { ContractConfig, ContractRegistry, SmartContractConfig, SupportedChain } from '../types/smart-contract';
+import { SmartContractQueryHandler } from '../utils/after-update-cell';
+
+export declare const useSmartContract: (config?: SmartContractConfig) => {
+    enabled: boolean;
+    showSmartContractModal: boolean;
+    setShowSmartContractModal: import('react').Dispatch<import('react').SetStateAction<boolean>>;
+    userSmartContracts: ContractConfig[];
+    allUserContracts: ContractConfig[];
+    registryMapRef: import('react').MutableRefObject<ContractRegistry>;
+    handleSmartContractQuery: SmartContractQueryHandler | undefined;
+    onImportContract: (address: Hex, network: SupportedChain, abiJson: string, smartContractName: string) => Promise<void>;
+    onDelete: (name: string) => Promise<void>;
+    handleSearch: (searchText: string) => void;
+    smartContractReadingError: {
+        hasError: boolean;
+        errorMessage: string;
+    };
+    setSmartContractReadingError: import('react').Dispatch<import('react').SetStateAction<{
+        hasError: boolean;
+        errorMessage: string;
+    }>>;
+    fetchContractAbi: (contract: ContractConfig) => Promise<Abi>;
+};
+export type UseSmartContractReturn = ReturnType<typeof useSmartContract>;

package/dist/editor/types/smart-contract.d.ts

@@ -0,0 +1,88 @@
+import { Abi, Hex } from 'viem';
+import { default as React } from 'react';
+
+export declare enum SupportedChain {
+    Ethereum = "Ethereum",
+    Sepolia = "Sepolia",
+    Gnosis = "Gnosis",
+    Base = "Base"
+}
+export interface ContractConfig {
+    address: Hex;
+    abiHash: string;
+    network: SupportedChain;
+    name: string;
+}
+export type ContractRegistry = Record<string, ContractConfig>;
+export interface NewContractInput {
+    name: string;
+    address: Hex;
+    network: SupportedChain;
+    abi: Abi;
+}
+export type SmartContractEventType = 'query-success' | 'query-error' | 'contract-added' | 'contract-deleted';
+export interface SmartContractEvent {
+    type: SmartContractEventType;
+    contractName?: string;
+    functionName?: string;
+    chainName?: string;
+    errorMessage?: string;
+}
+export interface SmartContractConfig {
+    /** User's persisted private contracts from consumer keystore. Defaults to []. */
+    contracts?: ContractConfig[];
+    /** RPC URL per chain. Falls back to bundled defaults when omitted. */
+    rpcConfig?: Partial<Record<SupportedChain, string>>;
+    /** Resolve ABI from stored reference (e.g. IPFS hash). Required for user-saved contracts with abiHash. */
+    resolveAbi?: (abiHash: string) => Promise<Abi>;
+    /** Persist a new contract. When omitted, package keeps it in session memory only. */
+    onAddContract?: (input: NewContractInput) => Promise<void>;
+    /** Remove a persisted contract. When omitted, package removes from session memory only. */
+    onDeleteContract?: (contractName: string) => Promise<void>;
+    validateAddress?: (address: string, chain: SupportedChain) => boolean | Promise<boolean>;
+    onSmartContractEvent?: (event: SmartContractEvent) => void;
+}
+export interface CallerParams {
+    abi: Abi;
+    contractAddress: Hex;
+    chain: import('viem').Chain;
+    functionName?: string;
+    args?: unknown[];
+}
+export interface FetchAbiParams {
+    contractAddress: Hex;
+    chain: import('viem').Chain;
+    ipfsHash?: string;
+}
+export type ParsedFunction = {
+    functionName: string;
+    output: string;
+};
+export interface SmartContractListViewProps {
+    userSmartContracts: ContractConfig[];
+    onDelete: (name: string) => void;
+    handleSearch: (searchText: string) => void;
+    onOpenImportModal: () => void;
+    fetchContractAbi: (contract: ContractConfig) => Promise<Abi>;
+    isAuthorized: boolean;
+}
+export interface MyContractsProps {
+    contracts: ContractConfig[];
+    onDelete: (name: string) => void;
+    fetchContractAbi: (contract: ContractConfig) => Promise<Abi>;
+    setActiveTab?: React.Dispatch<React.SetStateAction<string>>;
+}
+export interface PopularContractsProps {
+    contracts: ContractConfig[];
+    onInsert: (name: string) => void;
+    fetchContractAbi: (contract: ContractConfig) => Promise<Abi>;
+}
+export interface CodeBlockProps {
+    code: React.ReactNode;
+    copyText: string;
+}
+export interface ParameterDescriptionProps {
+    paramName: string;
+    description: string;
+    optional?: boolean;
+}

package/dist/editor/types.d.ts

@@ -1,9 +1,9 @@
 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 { SmartContractConfig } from './types/smart-contract';
 import { ApiKeyStorage } from './utils/api-key-storage';
 import { ThemeKey } from '../sheet-engine/core/theme';
 
@@ -50,7 +50,6 @@ export type { ApiKeyStorage } from './utils/api-key-storage';
 export interface DsheetProps {
     isNewSheet: boolean;
     setSelectedTemplate?: React.Dispatch<React.SetStateAction<string>>;
-    setShowSmartContractModal?: React.Dispatch<React.SetStateAction<boolean>>;
     getDocumentTitle?: (dsheetId: string) => Promise<string>;
     updateDocumentTitle?: (title: string) => void;
     isAuthorized: boolean;
@@ -87,7 +86,8 @@ export interface DsheetProps {
     editorStateRef?: React.MutableRefObject<{
         refreshIndexedDB: () => Promise<void>;
     } | null>;
-    handleSmartContractQuery?: SmartContractQueryHandler;
+    /** Smart contract config: execution + UI in package; consumer owns persistence via callbacks. */
+    smartContracts?: SmartContractConfig;
     enableLiveQuery?: boolean;
     liveQueryRefreshRate?: number;
     customPanels?: PanelConfig[];