superleap-code-editor 1.0.0 → 1.0.2

package/TYPES.md

@@ -0,0 +1,140 @@
+# TypeScript Types Reference
+
+This document shows how to import and use all TypeScript types available in the `superleap-code-editor` package.
+
+## Importing Types
+
+### Option 1: Import from main package
+```typescript
+import type { 
+  CodeEditorConfig, 
+  FileNode, 
+  FileProvider,
+  UseFileManagerReturn 
+} from 'superleap-code-editor';
+```
+
+### Option 2: Import comprehensive types file
+```typescript
+import type { 
+  CodeEditorProps,
+  FileExplorerProps,
+  WorkflowConfig,
+  FormConfig,
+  URLConfig,
+  SupportedLanguage,
+  FileExtension,
+  CodeEditorError
+} from 'superleap-code-editor/types';
+```
+
+## Available Types
+
+### Core Types
+- `FileNode` - Represents a file or folder
+- `FileProvider` - Interface for file data providers  
+- `CodeEditorConfig` - Configuration for the code editor
+- `UseFileManagerReturn` - Return type from useFileManager hook
+
+### Component Props
+- `CodeEditorProps` - Props for CodeEditor component
+- `FileExplorerProps` - Props for FileExplorer component
+- `EditorLayoutProps` - Props for EditorLayout component
+- `CodeEditorWrapperProps` - Props for CodeEditorWrapper component
+
+### Configuration Types
+- `WorkflowConfig` - Configuration for workflow-based files
+- `FormConfig` - Configuration for form-based files
+- `URLConfig` - Configuration for URL-based files
+- `EnhancedCodeEditorConfig` - Enhanced configuration with settings
+
+### Hook Types
+- `UseFileManagerOptions` - Options for useFileManager hook
+- `FileManagerState` - State from useFileManager hook
+- `FileManagerActions` - Actions from useFileManager hook
+
+### Utility Types
+- `SupportedLanguage` - Supported programming languages
+- `FileExtension` - Supported file extensions
+- `FileType` - File or folder type
+- `CodeEditorTheme` - Theme configuration
+
+### Error Classes
+- `CodeEditorError` - Base error class
+- `FileProviderError` - File provider errors
+- `FileNotFoundError` - File not found errors
+
+### Constants
+- `SUPPORTED_LANGUAGES` - Array of supported languages
+- `DEFAULT_THEME` - Default theme configuration
+- `DEFAULT_SETTINGS` - Default editor settings
+
+## Usage Examples
+
+### Basic Component Usage
+```typescript
+import { CodeEditorWrapper } from 'superleap-code-editor';
+import type { CodeEditorConfig } from 'superleap-code-editor';
+
+const config: CodeEditorConfig = {
+  formConfig: {
+    codeContent: 'console.log("Hello World!");',
+    fileName: 'example.js',
+    language: 'javascript'
+  }
+};
+
+function App() {
+  return <CodeEditorWrapper config={config} />;
+}
+```
+
+### Advanced Type Usage
+```typescript
+import type { 
+  CodeEditorProps, 
+  SupportedLanguage,
+  WorkflowConfig 
+} from 'superleap-code-editor/types';
+
+const codeEditorProps: CodeEditorProps = {
+  value: 'const x = 1;',
+  onChange: (value) => console.log(value),
+  language: 'typescript' as SupportedLanguage,
+  readOnly: false
+};
+
+const workflowConfig: WorkflowConfig = {
+  functionId: 'func-123',
+  version: '1.0.0',
+  versionList: ['1.0.0', '1.1.0'],
+  fetchFunction: async (id, version) => {
+    // Your fetch logic
+    return 'function example() { return "Hello"; }';
+  },
+  fetchVersionList: async (id) => {
+    // Your version fetch logic
+    return ['1.0.0', '1.1.0'];
+  }
+};
+```
+
+### Hook Usage with Types
+```typescript
+import { useFileManager } from 'superleap-code-editor';
+import type { UseFileManagerReturn } from 'superleap-code-editor';
+
+function MyComponent() {
+  const fileManager: UseFileManagerReturn = useFileManager(fileProvider);
+  
+  return (
+    <div>
+      {fileManager.loading && <div>Loading...</div>}
+      {fileManager.error && <div>Error: {fileManager.error}</div>}
+      {/* ... */}
+    </div>
+  );
+}
+```
+
+This comprehensive type system ensures full TypeScript support and IntelliSense for all package features!

package/dist/index.d.ts

@@ -1,12 +1,12 @@
-export { CodeEditorWrapper } from './components/codeEditorWrapper';
-export { CodeEditor } from './components/editor/codeEditor';
-export { EditorLayout } from './components/layout/editorLayout';
-export { FileExplorer } from './components/panels/fileExplorer';
-export { WorkflowFileProvider, FormFileProvider, URLFileProvider, createFileProvider } from './providers/fileProviders';
-export { useFileManager } from './hooks/useFileManager';
-export type { FileNode, FileProvider, CodeEditorConfig } from './types/fileTypes';
-export type { UseFileManagerReturn } from './hooks/useFileManager';
-export { WorkflowCodeEditor, FormCodeEditor, URLCodeEditor } from './components/codeEditorWrapper';
-export { Splitter, Tree, Button, Tooltip, Alert } from 'antd';
+export { CodeEditorWrapper } from "./components/codeEditorWrapper";
+export { CodeEditor } from "./components/editor/codeEditor";
+export { EditorLayout } from "./components/layout/editorLayout";
+export { FileExplorer } from "./components/panels/fileExplorer";
+export { createFileProvider, FormFileProvider, URLFileProvider, WorkflowFileProvider, } from "./providers/fileProviders";
+export { useFileManager } from "./hooks/useFileManager";
+export type { CodeEditorConfig, FileNode, FileProvider, } from "./types/fileTypes";
+export type { UseFileManagerReturn } from "./hooks/useFileManager";
+export { FormCodeEditor, URLCodeEditor, WorkflowCodeEditor, } from "./components/codeEditorWrapper";
+export { Alert, Button, Splitter, Tooltip, Tree } from "antd";
 export declare const VERSION = "1.0.0";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAGhE,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EACnB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAGxD,YAAY,EACV,QAAQ,EACR,YAAY,EACZ,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAGnE,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,aAAa,EACd,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAG9D,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAGhE,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,GACrB,MAAM,2BAA2B,CAAC;AAGnC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAGxD,YAAY,EACV,gBAAgB,EAChB,QAAQ,EACR,YAAY,GACb,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAGnE,OAAO,EACL,cAAc,EACd,aAAa,EACb,kBAAkB,GACnB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAG9D,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "superleap-code-editor",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A flexible, reusable code editor component with multiple file handling modes",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "TYPES.md"
   ],
   "exports": {
     ".": {
@@ -15,6 +16,7 @@
       "import": "./dist/index.esm.js",
       "require": "./dist/index.js"
     },
+    "./types": "./dist/types.d.ts",
     "./styles": "./dist/style.css"
   },
   "scripts": {
@@ -61,21 +63,21 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.33.0",
-    "@types/react": "^19.1.10",
-    "@types/react-dom": "^19.1.7",
+    "@tailwindcss/vite": "^4.1.13",
+    "@types/react": "^18.0.0 || ^19.0.0",
+    "@types/react-dom": "^18.0.0 || ^19.0.0",
     "@vitejs/plugin-react": "^5.0.0",
     "eslint": "^9.33.0",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-react-refresh": "^0.4.20",
     "globals": "^16.3.0",
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "tailwindcss": "^4.1.13",
     "typescript": "~5.8.3",
     "typescript-eslint": "^8.39.1",
     "vite": "^7.1.2",
     "vite-plugin-dts": "^4.3.0",
-    "vite-plugin-lib-inject-css": "^1.3.0",
-    "react": "^19.1.1",
-    "react-dom": "^19.1.1",
-    "tailwindcss": "^4.1.13",
-    "@tailwindcss/vite": "^4.1.13"
+    "vite-plugin-lib-inject-css": "^1.3.0"
   }
 }