ct-rich-text-editor 1.0.0 → 1.0.1

package/README.md

@@ -60,32 +60,6 @@ function App() {
 }
 ```
 
-### Configuring the API Endpoint
-
-You can configure the API endpoint by setting an environment variable:
-
-#### In Node.js environments:
-
-```js
-// Set in your environment
-process.env.VITE_APP_BACKEND_ENDPOINT = 'https://your-custom-api.com/verify-api-key';
-```
-
-#### In browser environments:
-
-```js
-// Set at the global window level
-window.VITE_APP_BACKEND_ENDPOINT = 'https://your-custom-api.com/verify-api-key';
-```
-
-Alternatively, you can use a script tag before loading your application:
-
-```html
-<script>
-  window.VITE_APP_BACKEND_ENDPOINT = 'https://your-custom-api.com/verify-api-key';
-</script>
-```
-
 ## API Reference
 
 ### EditorProvider
@@ -100,75 +74,74 @@ Provides authentication and configuration context for the editor.
 
 ### ConfigurableEditorWithAuth
 
-Main editor component with API key authentication.
+The main editor component with authentication.
 
 #### Props
 
-- `apiKey`: (required) Your API key for authentication
-- `initialContent`: Initial HTML content (optional)
-- `onChange`: Callback for content changes (optional)
-- `defaultFontFamilies`: Array of font names (optional)
-- `mentionUserList`: Array of usernames for mention functionality (optional)
-- `onAuthSuccess`: Callback when authentication succeeds (optional)
-- `onAuthError`: Callback when authentication fails (optional)
-- `customVerifyKey`: Custom function for API key verification (optional)
-
-## API Authentication
-
-The editor requires an API key for authentication. Upon providing a valid API key, the editor will fetch the configuration from the server, which determines which features are enabled.
-
-The default API endpoint is `http://localhost:3000/api/projects/verify-api-key` but you can customize it using the environment variable `VITE_APP_BACKEND_ENDPOINT`.
-
-### API Response Format
-
-```json
-{
-  "success": true,
-  "message": "API key verified successfully",
-  "data": {
-    "id": "67dbd63359550ada7d899490",
-    "name": "sampleProject",
-    "paidPlan": false,
-    "editorConfig": {
-      "enableToolbar": true,
-      "toolbarOptions": {
-        "enableUndoRedo": true,
-        "enableTextFormatting": true,
-        "enableAlignment": true,
-        "enableFontControls": true,
-        "enableTableOptions": true,
-        "enableInsertMenu": true,
-        "enableColorPicker": true,
-        "enableClearOptions": true,
-        "enableEmojiPicker": true,
-        "enableLinks": true,
-        "enableFormatTextMenu": true,
-        "enableCodeFormat": true,
-        "enableAIChat": true
-      },
-      "enableFloatingMenu": true,
-      "htmlViewOption": true,
-      "floatingMenuOptions": {
-        "bold": true,
-        "italic": true,
-        "underline": true,
-        "uppercase": true,
-        "lowercase": true,
-        "capitalize": true,
-        "strikethrough": true,
-        "subscript": true,
-        "superscript": true,
-        "code": true,
-        "link": true,
-        "aiChat": true
-      }
-    },
-    "createdAt": "2025-03-20T08:47:47.314Z",
-    "updatedAt": "2025-03-20T08:47:47.314Z"
-  }
+- `apiKey`: Your API key for authentication (required)
+- `onAuthSuccess`: Callback function when authentication is successful (optional)
+- `onAuthError`: Callback function when authentication fails (optional)
+- `showToolbar`: Boolean to show/hide the toolbar (optional, default: true)
+- `showFloatingMenu`: Boolean to show/hide the floating menu (optional, default: true)
+- `showHtmlView`: Boolean to show/hide HTML view option (optional, default: true)
+- `initialContent`: Initial content for the editor (optional)
+- `onChange`: Callback function when editor content changes (optional)
+- `readOnly`: Boolean to make editor read-only (optional, default: false)
+- `placeholder`: Placeholder text when editor is empty (optional)
+- `theme`: Custom theme object for styling (optional)
+- `plugins`: Array of custom plugins (optional)
+- `aiEnabled`: Boolean to enable/disable AI features (optional, default: false)
+- `onAiResponse`: Callback function for AI responses (optional)
+- `onAiError`: Callback function for AI errors (optional)
+
+## Examples
+
+### Basic Editor with Authentication
+
+```jsx
+import React from 'react';
+import { ConfigurableEditorWithAuth, EditorProvider } from 'ct-rich-text-editor';
+import 'ct-rich-text-editor/style.css';
+
+function App() {
+  return (
+    <EditorProvider>
+      <ConfigurableEditorWithAuth
+        apiKey="your-api-key"
+        onAuthSuccess={() => console.log('Authenticated')}
+        onAuthError={(error) => console.error(error)}
+      />
+    </EditorProvider>
+  );
+}
+```
+
+### Editor with Custom Configuration
+
+```jsx
+import React from 'react';
+import { ConfigurableEditorWithAuth, EditorProvider } from 'ct-rich-text-editor';
+import 'ct-rich-text-editor/style.css';
+
+function App() {
+  return (
+    <EditorProvider>
+      <ConfigurableEditorWithAuth
+        apiKey="your-api-key"
+        showToolbar={true}
+        showFloatingMenu={true}
+        showHtmlView={true}
+        readOnly={false}
+        placeholder="Start typing..."
+        aiEnabled={true}
+        onAiResponse={(response) => console.log('AI Response:', response)}
+        onAiError={(error) => console.error('AI Error:', error)}
+      />
+    </EditorProvider>
+  );
 }
 ```
 
 ## License
 
-MIT
+This project is licensed under the MIT License - see the LICENSE file for details.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ct-rich-text-editor",
   "private": false,
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "packageManager": "pnpm@9.0.0",
   "main": "dist/index.js",