@crashbytes/contentful-richtext-editor 1.0.7 → 1.0.9

package/dist/testData/samples.d.ts

@@ -0,0 +1,11 @@
+import { Document } from '@contentful/rich-text-types';
+export declare const blogPostSample: Document;
+export declare const marketingCopySample: Document;
+export declare const technicalDocSample: Document;
+export declare const recipeSample: Document;
+export declare const testDataSamples: {
+    blogPost: Document;
+    marketingCopy: Document;
+    technicalDoc: Document;
+    recipe: Document;
+};

package/dist/utils/configParser.d.ts

@@ -0,0 +1,37 @@
+export interface ContentfulFieldValidation {
+    enabledMarks?: string[];
+    enabledNodeTypes?: string[];
+}
+export interface ContentfulFieldConfiguration {
+    validations?: ContentfulFieldValidation[];
+    settings?: {
+        helpText?: string;
+    };
+}
+export interface ParsedEditorConfig {
+    availableHeadings: Array<1 | 2 | 3 | 4 | 5 | 6>;
+    availableMarks: Array<'bold' | 'italic' | 'underline'>;
+    disabledFeatures: string[];
+    allowHyperlinks: boolean;
+    allowEmbeddedEntries: boolean;
+    allowEmbeddedAssets: boolean;
+    allowInlineEntries: boolean;
+    allowTables: boolean;
+    allowQuotes: boolean;
+    allowLists: boolean;
+}
+/**
+ * Parses Contentful field configuration to determine editor capabilities
+ */
+export declare const parseContentfulFieldConfig: (fieldConfiguration?: ContentfulFieldConfiguration) => ParsedEditorConfig;
+/**
+ * Helper function to fetch Contentful field configuration from Management API
+ */
+export declare const fetchContentfulFieldConfig: (spaceId: string, contentTypeId: string, fieldId: string, accessToken: string) => Promise<ContentfulFieldConfiguration | null>;
+/**
+ * Creates a mock field configuration for testing purposes
+ */
+export declare const createMockFieldConfig: (options: {
+    enabledMarks?: string[];
+    enabledNodeTypes?: string[];
+}) => ContentfulFieldConfiguration;

package/dist/utils/contentfulTransform.d.ts

@@ -10,27 +10,39 @@ interface TiptapNode {
     }>;
 }
 /**
- * Creates a professional-grade empty Tiptap document
+ * Converts a Contentful Rich Text Document to Tiptap JSON format
  */
-export declare const createEmptyTiptapDocument: () => TiptapNode;
+export declare const contentfulToTiptap: (document: Document) => TiptapNode;
 /**
- * Enhanced validation with comprehensive error reporting
+ * Converts Tiptap JSON format to Contentful Rich Text Document
+ */
+export declare const tiptapToContentful: (tiptapDoc: any) => Document;
+/**
+ * Validates if a Contentful document is properly formatted
  */
 export declare const validateContentfulDocument: (document: any) => document is Document;
 /**
- * Production-grade Contentful to Tiptap conversion with comprehensive error handling
+ * Creates an empty Contentful document
  */
-export declare const contentfulToTiptap: (document: Document) => TiptapNode;
+export declare const createEmptyDocument: () => Document;
 /**
- * Safe wrapper for Contentful to Tiptap conversion with fallback
+ * Sanitizes a Contentful document by removing invalid nodes/marks based on configuration
  */
-export declare const safeContentfulToTiptap: (document: Document) => TiptapNode;
+export declare const sanitizeContentfulDocument: (document: Document, allowedNodeTypes: string[], allowedMarks: string[]) => Document;
 /**
- * Strategic Tiptap to Contentful conversion with enhanced error handling
+ * Extracts plain text from a Contentful document
  */
-export declare const tiptapToContentful: (tiptapDoc: any) => Document;
+export declare const extractPlainText: (document: Document) => string;
 /**
- * Creates an empty Contentful document with professional structure
+ * Counts words in a Contentful document
  */
-export declare const createEmptyDocument: () => Document;
+export declare const countWords: (document: Document) => number;
+/**
+ * Finds all embedded entries/assets in a document
+ */
+export declare const findEmbeddedContent: (document: Document) => {
+    entries: string[];
+    assets: string[];
+    inlineEntries: string[];
+};
 export {};

package/dist/utils/contentfulTransform.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+declare const TransformationDemo: () => import("react/jsx-runtime").JSX.Element;
+declare const meta: Meta<typeof TransformationDemo>;
+export default meta;
+type Story = StoryObj<typeof meta>;
+export declare const InteractiveDemo: Story;

package/dist/utils/types.d.ts

@@ -26,3 +26,116 @@ export interface EmbeddedAsset {
         };
     };
 }
+export type { ContentfulFieldValidation, ContentfulFieldConfiguration, ParsedEditorConfig, } from './configParser';
+export interface EditorFeatureConfig {
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    code?: boolean;
+    link?: boolean;
+    headings?: Array<1 | 2 | 3 | 4 | 5 | 6>;
+    lists?: boolean;
+    quote?: boolean;
+    table?: boolean;
+    embeddedEntries?: boolean;
+    embeddedAssets?: boolean;
+    inlineEntries?: boolean;
+}
+export interface ContentfulNode {
+    nodeType: string;
+    data: Record<string, any>;
+    content?: Array<ContentfulNode | ContentfulText>;
+}
+export interface ContentfulText {
+    nodeType: 'text';
+    value: string;
+    marks?: Array<{
+        type: string;
+    }>;
+    data: Record<string, any>;
+}
+export interface ContentfulDocument extends ContentfulNode {
+    nodeType: 'document';
+    content: ContentfulNode[];
+}
+export interface TiptapNode {
+    type: string;
+    attrs?: Record<string, any>;
+    content?: TiptapNode[];
+    text?: string;
+    marks?: Array<{
+        type: string;
+        attrs?: Record<string, any>;
+    }>;
+}
+export interface TiptapDocument extends TiptapNode {
+    type: 'doc';
+    content: TiptapNode[];
+}
+export interface EditorState {
+    canUndo: boolean;
+    canRedo: boolean;
+    activeMarks: string[];
+    activeNodes: string[];
+    currentHeading?: number;
+}
+export type OnChangeCallback = (document: any) => void;
+export type OnEmbedCallback = () => Promise<EmbeddedEntry | EmbeddedAsset | null> | void;
+export interface ThemeConfig {
+    name: ContentfulEditorTheme;
+    className: string;
+    toolbarStyle?: 'minimal' | 'full' | 'compact';
+    showBorders?: boolean;
+    customStyles?: Record<string, string>;
+}
+export interface ValidationRule {
+    type: 'required' | 'minLength' | 'maxLength' | 'pattern' | 'custom';
+    value?: any;
+    message?: string;
+    validator?: (value: any) => boolean | string;
+}
+export interface FieldValidationConfig {
+    rules?: ValidationRule[];
+    showErrors?: boolean;
+    validateOnBlur?: boolean;
+    validateOnChange?: boolean;
+}
+export interface LocalizationConfig {
+    locale: string;
+    messages: Record<string, string>;
+    rtl?: boolean;
+}
+export interface A11yConfig {
+    ariaLabel?: string;
+    ariaDescribedBy?: string;
+    announceChanges?: boolean;
+    keyboardShortcuts?: Record<string, string>;
+}
+export interface AdvancedEditorConfig {
+    autofocus?: boolean;
+    spellcheck?: boolean;
+    autocomplete?: boolean;
+    wordWrap?: boolean;
+    lineNumbers?: boolean;
+    minimap?: boolean;
+    dragDrop?: boolean;
+    paste?: {
+        plainTextOnly?: boolean;
+        cleanupPaste?: boolean;
+        preserveWhitespace?: boolean;
+    };
+    history?: {
+        depth?: number;
+        newGroupDelay?: number;
+    };
+}
+export interface PluginConfig {
+    name: string;
+    enabled: boolean;
+    options?: Record<string, any>;
+}
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
+export type OptionalFields<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crashbytes/contentful-richtext-editor",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A Tiptap-based rich text editor compatible with Contentful's rich text format",
   "type": "module",
   "main": "dist/index.js",
@@ -28,7 +28,9 @@
     "build:watch": "rollup -c -w",
     "dev": "rollup -c -w",
     "clean": "rm -rf dist",
-    "prepublishOnly": "npm run clean && npm run build"
+    "prepublishOnly": "npm run clean && npm run build",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -48,15 +50,19 @@
     "@tiptap/starter-kit": "^2.0.0"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^24.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.0",
-    "@rollup/plugin-typescript": "^11.0.0",
-    "@types/react": "^18.0.0",
-    "@types/react-dom": "^18.0.0",
-    "rollup": "^3.0.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@storybook/addon-essentials": "^7.6.20",
+    "@storybook/addon-interactions": "^7.6.20",
+    "@storybook/addon-links": "^7.6.20",
+    "@storybook/blocks": "^7.6.20",
+    "@storybook/react": "^7.6.20",
+    "@storybook/react-vite": "^7.6.20",
+    "@storybook/testing-library": "^0.2.2",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-postcss": "^4.0.2",
-    "tslib": "^2.8.1",
-    "typescript": "^5.0.0"
+    "storybook": "^7.6.20"
   }
-}
+}