@crashbytes/contentful-richtext-editor 1.0.9 → 1.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crashbytes/contentful-richtext-editor",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "A Tiptap-based rich text editor compatible with Contentful's rich text format",
   "type": "module",
   "main": "dist/index.js",
@@ -30,7 +30,18 @@
     "clean": "rm -rf dist",
     "prepublishOnly": "npm run clean && npm run build",
     "storybook": "storybook dev -p 6006",
-    "build-storybook": "storybook build"
+    "build-storybook": "storybook build",
+    "release": "standard-version",
+    "release:minor": "standard-version --release-as minor",
+    "release:major": "standard-version --release-as major",
+    "release:patch": "standard-version --release-as patch",
+    "release:prerelease": "standard-version --prerelease",
+    "release:alpha": "standard-version --prerelease alpha",
+    "release:beta": "standard-version --prerelease beta",
+    "test": "jest",
+    "test:watch": "jest --watchAll=false",
+    "test:coverage": "jest --coverage",
+    "test:ci": "jest --ci --coverage --watchAll=false"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
@@ -50,19 +61,31 @@
     "@tiptap/starter-kit": "^2.0.0"
   },
   "devDependencies": {
+    "@babel/preset-env": "^7.27.2",
+    "@babel/preset-react": "^7.27.1",
+    "@babel/preset-typescript": "^7.27.1",
     "@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/addon-links": "^9.0.14",
+    "@storybook/react-vite": "^9.0.14",
     "@storybook/testing-library": "^0.2.2",
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/jest": "^30.0.0",
+    "babel-jest": "^30.0.2",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^30.0.3",
+    "jest-environment-jsdom": "^30.0.2",
+    "jest-transform-stub": "^2.0.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-postcss": "^4.0.2",
-    "storybook": "^7.6.20"
+    "standard-version": "^9.5.0",
+    "storybook": "^9.0.14",
+    "ts-jest": "^29.4.0",
+    "vite": "^5.4.19",
+    "@storybook/addon-docs": "^9.0.14"
   }
 }

package/dist/components/ContentfulDocument.d.ts

@@ -1,2 +0,0 @@
-import { Extension } from '@tiptap/core';
-export declare const ContentfulDocument: Extension<any, any>;

package/dist/components/ContentfulEditor.d.ts

@@ -1,34 +0,0 @@
-import React from 'react';
-import { Document } from '@contentful/rich-text-types';
-import type { ContentfulFieldConfiguration } from '../utils/configParser';
-import '../styles/editor.css';
-export interface ContentfulRichTextEditorProps {
-    /** Initial Contentful rich text document */
-    initialValue?: Document;
-    /** Callback when content changes - returns Contentful Document */
-    onChange?: (document: Document) => void;
-    /** Callback for handling embedded entries */
-    onEmbedEntry?: () => Promise<any> | void;
-    /** Callback for handling embedded assets */
-    onEmbedAsset?: () => Promise<any> | void;
-    /** Callback for handling inline entries */
-    onEmbedInlineEntry?: () => Promise<any> | void;
-    /** Custom CSS classes */
-    className?: string;
-    /** Whether the editor is read-only */
-    readonly?: boolean;
-    /** Placeholder text */
-    placeholder?: string;
-    /** Contentful field configuration - takes precedence over manual settings */
-    fieldConfiguration?: ContentfulFieldConfiguration;
-    /** Manual disable features (fallback if no fieldConfiguration provided) */
-    disabledFeatures?: Array<'bold' | 'italic' | 'underline' | 'link' | 'lists' | 'headings' | 'quote' | 'table' | 'embed'>;
-    /** Custom styling options */
-    theme?: 'default' | 'minimal' | 'contentful';
-    /** Manual heading levels (fallback if no fieldConfiguration provided) */
-    availableHeadings?: Array<1 | 2 | 3 | 4 | 5 | 6>;
-    /** Manual text marks (fallback if no fieldConfiguration provided) */
-    availableMarks?: Array<'bold' | 'italic' | 'underline'>;
-}
-export declare const ContentfulRichTextEditor: React.FC<ContentfulRichTextEditorProps>;
-export default ContentfulRichTextEditor;

package/dist/components/ContentfulEditor.stories.d.ts

@@ -1,18 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { ContentfulRichTextEditor } from './ContentfulEditor';
-declare const meta: Meta<typeof ContentfulRichTextEditor>;
-export default meta;
-type Story = StoryObj<typeof meta>;
-export declare const Default: Story;
-export declare const BlogPostExample: Story;
-export declare const MarketingCopyExample: Story;
-export declare const TechnicalDocumentationExample: Story;
-export declare const RecipeExample: Story;
-export declare const ContentfulTheme: Story;
-export declare const MinimalTheme: Story;
-export declare const DefaultTheme: Story;
-export declare const ReadOnly: Story;
-export declare const LimitedFeatures: Story;
-export declare const SimpleEditor: Story;
-export declare const WithEmbedHandlers: Story;
-export declare const CustomStyling: Story;

package/dist/components/ContentfulEmbedded.d.ts

@@ -1,15 +0,0 @@
-import { Node } from '@tiptap/core';
-export declare const EmbeddedEntry: Node<any, any>;
-export declare const InlineEmbeddedEntry: Node<any, any>;
-export declare const EmbeddedAsset: Node<any, any>;
-export declare const createEmbeddedEntryFromContentful: (entry: any) => {
-    entryId: any;
-    contentType: any;
-    title: any;
-};
-export declare const createEmbeddedAssetFromContentful: (asset: any) => {
-    assetId: any;
-    title: any;
-    url: any;
-    mimeType: any;
-};

package/dist/components/Toolbar.d.ts

@@ -1,14 +0,0 @@
-import React from 'react';
-import { Editor } from '@tiptap/react';
-interface ToolbarProps {
-    editor: Editor;
-    onEmbedEntry?: () => void;
-    onEmbedAsset?: () => void;
-    onEmbedInlineEntry?: () => void;
-    disabledFeatures?: Array<string>;
-    availableHeadings?: Array<1 | 2 | 3 | 4 | 5 | 6>;
-    availableMarks?: Array<'bold' | 'italic' | 'underline'>;
-    allowHyperlinks?: boolean;
-}
-export declare const ContentfulToolbar: React.FC<ToolbarProps>;
-export {};

package/dist/components/Toolbar.stories.d.ts

@@ -1,10 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-declare const MockToolbarWrapper: ({ disabledFeatures, availableHeadings, availableMarks, onEmbedEntry, onEmbedAsset, }: any) => import("react/jsx-runtime").JSX.Element;
-declare const meta: Meta<typeof MockToolbarWrapper>;
-export default meta;
-type Story = StoryObj<typeof meta>;
-export declare const Default: Story;
-export declare const LimitedFeatures: Story;
-export declare const MinimalToolbar: Story;
-export declare const OnlyHeadings: Story;
-export declare const NoEmbedControls: Story;

package/dist/index.d.ts

@@ -1,8 +0,0 @@
-export { ContentfulRichTextEditor } from './components/ContentfulEditor';
-export type { ContentfulRichTextEditorProps } from './components/ContentfulEditor';
-export { ContentfulToolbar } from './components/Toolbar';
-export { contentfulToTiptap, tiptapToContentful, validateContentfulDocument, createEmptyDocument, sanitizeContentfulDocument, extractPlainText, countWords, findEmbeddedContent } from './utils/contentfulTransform';
-export { parseContentfulFieldConfig, fetchContentfulFieldConfig, createMockFieldConfig, } from './utils/configParser';
-export type { ContentfulEditorTheme, EmbeddedEntry, EmbeddedAsset, ContentfulFieldValidation, ContentfulFieldConfiguration, ParsedEditorConfig, EditorFeatureConfig, ContentfulNode, ContentfulText, ContentfulDocument, TiptapNode, TiptapDocument, EditorState, OnChangeCallback, OnEmbedCallback, ThemeConfig, ValidationRule, FieldValidationConfig, LocalizationConfig, A11yConfig, AdvancedEditorConfig, PluginConfig, DeepPartial, RequiredFields, OptionalFields, } from './utils/types';
-export type { Document, Block, Inline, Text } from '@contentful/rich-text-types';
-export { BLOCKS, MARKS, INLINES } from '@contentful/rich-text-types';

package/dist/testData/samples.d.ts

@@ -1,11 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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

@@ -1,48 +0,0 @@
-import { Document } from '@contentful/rich-text-types';
-interface TiptapNode {
-    type: string;
-    attrs?: Record<string, any>;
-    content?: TiptapNode[];
-    text?: string;
-    marks?: Array<{
-        type: string;
-        attrs?: Record<string, any>;
-    }>;
-}
-/**
- * Converts a Contentful Rich Text Document to Tiptap JSON format
- */
-export declare const contentfulToTiptap: (document: Document) => TiptapNode;
-/**
- * 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;
-/**
- * Creates an empty Contentful document
- */
-export declare const createEmptyDocument: () => Document;
-/**
- * Sanitizes a Contentful document by removing invalid nodes/marks based on configuration
- */
-export declare const sanitizeContentfulDocument: (document: Document, allowedNodeTypes: string[], allowedMarks: string[]) => Document;
-/**
- * Extracts plain text from a Contentful document
- */
-export declare const extractPlainText: (document: Document) => string;
-/**
- * Counts words in a Contentful 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

@@ -1,6 +0,0 @@
-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

@@ -1,141 +0,0 @@
-export type ContentfulEditorTheme = 'default' | 'minimal' | 'contentful';
-export interface EmbeddedEntry {
-    sys: {
-        id: string;
-        type: string;
-        contentType: {
-            sys: {
-                id: string;
-            };
-        };
-    };
-    fields: Record<string, any>;
-}
-export interface EmbeddedAsset {
-    sys: {
-        id: string;
-        type: string;
-    };
-    fields: {
-        title?: string;
-        description?: string;
-        file?: {
-            url: string;
-            fileName: string;
-            contentType: string;
-        };
-    };
-}
-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>>;