ricos-types - npm Package Compare versions

Comparing version 10.8.0 to 10.9.0

dist/src/context.d.ts

@@ -14,6 +14,6 @@ import type { AvailableExperiments, TextDirection, TFunction } from './commonTypes';
     theme: RicosTheme;
-    portal: RicosPortal;
+    portal: RicosPortal | null;
     debugMode: DebugMode[];
     jsdomMode: boolean;
-    editorExternalContainer?: HTMLElement | (() => HTMLElement | null);
+    editorExternalContainer?: HTMLElement;
     platform: Platform;
@@ -20,0 +20,0 @@ content: RicosServices['content'];

dist/src/pluginTypes.d.ts

 import type { ComponentType, FC, PropsWithChildren, ReactElement, Ref } from 'react';
-import type { ACTION_BUTTON_TYPE, AUDIO_TYPE, CODE_BLOCK_TYPE, COLLAPSIBLE_LIST_TYPE, DIVIDER_TYPE, EMOJI_TYPE, EXTERNAL, EXTERNAL_LINK_TYPE, EXTERNAL_MENTIONS_TYPE, FILE_UPLOAD_TYPE, GALLERY_TYPE, GIPHY_TYPE, HASHTAG_TYPE, HEADERS_MARKDOWN_TYPE, HEADINGS_DROPDOWN_TYPE, HTML_TYPE, IMAGE_TYPE, IMAGE_TYPE_LEGACY, INDENT_TYPE, LINE_SPACING_TYPE, LINK_BUTTON_TYPE, LINK_PREVIEW_TYPE, LINK_TYPE, MAP_TYPE, MENTION_TYPE, POLL_TYPE, PREVIEW, RICOS_COLLAPSIBLE_LIST_TYPE, RICOS_DIVIDER_TYPE, RICOS_FILE_TYPE, RICOS_GALLERY_TYPE, RICOS_GIPHY_TYPE, RICOS_HTML_TYPE, RICOS_IMAGE_TYPE, RICOS_LINK_TYPE, RICOS_MAP_TYPE, RICOS_MENTION_TYPE, RICOS_POLL_TYPE, RICOS_VIDEO_TYPE, SPOILER_TYPE, TABLE_TYPE, TEXT_COLOR_TYPE, TEXT_HIGHLIGHT_TYPE, UNDO_REDO_TYPE, VERTICAL_EMBED_TYPE, VIDEO_TYPE, VIDEO_TYPE_LEGACY } from 'ricos-content';
-import type { AudioData, ButtonData, CollapsibleListData, DividerData, FileData, GalleryData, GIFData, HTMLData, ImageData, LinkPreviewData, MapData, MentionData as MentionPluginData, Node, PollData, VideoData } from 'ricos-schema';
+import type { ACTION_BUTTON_TYPE, AUDIO_TYPE, CODE_BLOCK_TYPE, COLLAPSIBLE_LIST_TYPE, DIVIDER_TYPE, EMOJI_TYPE, EXTERNAL_LINK_TYPE, EXTERNAL_MENTIONS_TYPE, FILE_UPLOAD_TYPE, GALLERY_TYPE, GIPHY_TYPE, HASHTAG_TYPE, HEADERS_MARKDOWN_TYPE, HEADINGS_DROPDOWN_TYPE, HTML_TYPE, IMAGE_TYPE, IMAGE_TYPE_LEGACY, INDENT_TYPE, LINE_SPACING_TYPE, LINK_BUTTON_TYPE, LINK_PREVIEW_TYPE, LINK_TYPE, MAP_TYPE, MENTION_TYPE, POLL_TYPE, PREVIEW, SPOILER_TYPE, TABLE_TYPE, TEXT_COLOR_TYPE, TEXT_HIGHLIGHT_TYPE, UNDO_REDO_TYPE, VERTICAL_EMBED_TYPE, VIDEO_TYPE, VIDEO_TYPE_LEGACY } from 'ricos-content';
+import type { MentionData as MentionPluginData, Node } from 'ricos-schema';
 import { Decoration_Type, LinkData, Node_Type } from 'ricos-schema';
@@ -14,3 +14,2 @@ import type { ClassNameStrategy, GetToolbarSettings, ThemeData } from '.';
 export { Decoration_Type, LinkData, Node_Type };
-export type CreatePluginData<PluginData> = (pluginData?: PluginData, isRicosSchema?: boolean) => Record<string, any>;
 export type MentionData = {
@@ -20,31 +19,2 @@ mention: MentionPluginData;
 };
-export interface CreatePluginsDataMap {
-    [RICOS_DIVIDER_TYPE]?: CreatePluginData<DividerData>;
-    [DIVIDER_TYPE]?: CreatePluginData<DividerData>;
-    [RICOS_GIPHY_TYPE]?: CreatePluginData<GIFData>;
-    [GIPHY_TYPE]?: CreatePluginData<GIFData>;
-    [RICOS_HTML_TYPE]?: CreatePluginData<HTMLData>;
-    [HTML_TYPE]?: CreatePluginData<HTMLData>;
-    [RICOS_GALLERY_TYPE]?: CreatePluginData<GalleryData>;
-    [GALLERY_TYPE]?: CreatePluginData<GalleryData>;
-    [RICOS_POLL_TYPE]?: CreatePluginData<PollData>;
-    [POLL_TYPE]?: CreatePluginData<PollData>;
-    [RICOS_VIDEO_TYPE]?: CreatePluginData<VideoData>;
-    [VIDEO_TYPE]?: CreatePluginData<VideoData>;
-    [AUDIO_TYPE]?: CreatePluginData<AudioData>;
-    [RICOS_FILE_TYPE]?: CreatePluginData<FileData>;
-    [FILE_UPLOAD_TYPE]?: CreatePluginData<FileData>;
-    [RICOS_IMAGE_TYPE]?: CreatePluginData<ImageData>;
-    [IMAGE_TYPE]?: CreatePluginData<ImageData>;
-    [RICOS_LINK_TYPE]?: CreatePluginData<LinkData>;
-    [LINK_TYPE]?: CreatePluginData<LinkData>;
-    [RICOS_MENTION_TYPE]?: CreatePluginData<MentionData>;
-    [MENTION_TYPE]?: CreatePluginData<MentionData>;
-    [EXTERNAL]?: CreatePluginData<Record<string, any>>;
-    [LINK_BUTTON_TYPE]?: CreatePluginData<ButtonData>;
-    [ACTION_BUTTON_TYPE]?: CreatePluginData<ButtonData>;
-    [RICOS_MAP_TYPE]?: CreatePluginData<MapData>;
-    [RICOS_COLLAPSIBLE_LIST_TYPE]?: CreatePluginData<CollapsibleListData>;
-    [LINK_PREVIEW_TYPE]?: CreatePluginData<LinkPreviewData>;
-}
 export type PluginMapping = Partial<{
@@ -103,5 +73,4 @@ [type: string]: {
 };
-export interface EditorPlugin<PluginConfig extends EditorPluginConfig = Record<string, any>> extends BasePluginConfig {
+export interface EditorPlugin<PluginConfig extends EditorPluginConfig = Record<string, any>, Exports = object> extends BasePluginConfig {
     config: PluginConfig;
-    createPluginData?: CreatePluginData<PluginConfig>;
     getAddButtons?: (config?: any, services?: RicosServices) => AddButton[];
@@ -114,2 +83,7 @@ textButtons?: FormattingToolbarButtonConfig[];
     };
+    /**
+     * @deprecated
+     * @internal
+     * */
+    __exports?: Exports;
 }
@@ -123,3 +97,3 @@ export interface ViewerPlugin<PluginConfig = Record<string, any>> extends BasePluginConfig {
 export type BasePlugin = EditorPlugin & ViewerPlugin;
-export type EditorPluginCreator<PluginConfig extends EditorPluginConfig = Record<string, any>> = (config?: PluginConfig) => EditorPlugin<PluginConfig>;
+export type EditorPluginCreator<PluginConfig extends EditorPluginConfig = Record<string, any>, Exports = object> = (config?: PluginConfig) => EditorPlugin<PluginConfig, Exports>;
 export type ViewerPluginCreator<PluginConfig> = (config?: PluginConfig) => ViewerPlugin<PluginConfig>;
@@ -126,0 +100,0 @@ export interface EditorPluginConfig {

dist/src/shortcuts.d.ts

@@ -14,3 +14,3 @@ import type { TFunction } from 'i18next';
 };
-type KeyboardShortcutId = 'AddHorizontalTabulation' | 'Enter' | 'NewLine' | 'SoftNewLine' | 'SoftNewLineMeta' | 'SoftNewLineShift' | 'MoveToNextCellTab' | 'MoveToNextCellArrow' | 'MoveToPreviousCellTab' | 'MoveToPreviousCellArrow' | 'EnterExitCell' | 'AddNewLineShift' | 'AddNewLineAlt' | 'DropLineInList' | 'SelectContentInCell' | 'SelectColumn' | 'SelectRow' | 'SelectTable' | 'AddNewColumnRow' | 'DeleteColumnRow' | 'ExitToolbar' | 'EnterToolbar' | 'ApplySelection' | 'MoveSelectionToNextOption' | 'MoveSelectionToPreviousOption' | 'SelectNextBlock' | 'SelectPrevBlock' | 'MoveSelectionThroughElements' | 'OpenBlocksMenu' | 'SelectAll' | 'SelectTextBlocks' | 'ClearSelection' | 'MoveSelectedBlockUp' | 'MoveSelectedBlockDown' | 'OpenBlocksMenu' | 'OpenShortcutsSheet' | 'SelectNextBlockWithTab' | 'SelectNextBlockArrows' | 'ApplySelection' | 'ExitBlocksMenu' | 'MoveToNextElementTab' | 'MoveToNextElementEnter' | 'SelectEntireList' | 'TextAlignment.LEFT' | 'TextAlignment.CENTER' | 'TextAlignment.RIGHT' | 'TextAlignment.JUSTIFY' | 'UNDO' | 'REDO' | 'INDENT.increase' | 'INDENT.decrease' | 'PasteWithoutFormatting' | keyof typeof Node_Type | keyof typeof Decoration_Type | `${Decoration_Type.FONT_SIZE}.increase` | `${Decoration_Type.FONT_SIZE}.decrease` | `${Node_Type.HEADING}.${1 | 2 | 3 | 4 | 5 | 6}` | 'Empty';
+type KeyboardShortcutId = 'AddHorizontalTabulation' | 'Enter' | 'NewLine' | 'SoftNewLine' | 'SoftNewLineMeta' | 'SoftNewLineShift' | 'MoveToNextCellTab' | 'MoveToNextCellArrow' | 'MoveToPreviousCellTab' | 'MoveToPreviousCellArrow' | 'EnterExitCell' | 'AddNewLineShift' | 'AddNewLineAlt' | 'DropLineInList' | 'SelectContentInCell' | 'SelectColumn' | 'SelectRow' | 'SelectTable' | 'AddNewColumnRow' | 'DeleteColumnRow' | 'ExitToolbar' | 'EnterToolbar' | 'ApplySelection' | 'MoveSelectionToNextOption' | 'MoveSelectionToPreviousOption' | 'SelectNextBlock' | 'SelectPrevBlock' | 'MoveSelectionThroughElements' | 'OpenBlocksMenu' | 'SelectAll' | 'SelectTextBlocks' | 'ClearSelection' | 'MoveSelectedBlockUp' | 'MoveSelectedBlockDown' | 'OpenBlocksMenu' | 'OpenShortcutsSheet' | 'SelectNextBlockWithTab' | 'SelectNextBlockArrows' | 'ApplySelection' | 'ExitBlocksMenu' | 'MoveToNextElementTab' | 'MoveToNextElementEnter' | 'SelectEntireList' | 'TextAlignment.LEFT' | 'TextAlignment.CENTER' | 'TextAlignment.RIGHT' | 'TextAlignment.JUSTIFY' | 'UNDO' | 'REDO' | 'INDENT.increase' | 'INDENT.decrease' | 'PasteWithoutFormatting' | keyof typeof Node_Type | keyof typeof Decoration_Type | `${Decoration_Type.FONT_SIZE}.increase` | `${Decoration_Type.FONT_SIZE}.decrease` | `${Node_Type.HEADING}.${1 | 2 | 3 | 4 | 5 | 6}` | 'Empty' | 'OpenAiModal';
 /**
@@ -17,0 +17,0 @@ * Customizable keyboard shortcut for Return API, currently limited to `Enter`-related shortcuts.

package.json

 {
   "name": "ricos-types",
-  "version": "10.8.0",
+  "version": "10.9.0",
   "author": {
@@ -34,4 +34,4 @@ "name": "Oded Soffrin",
     "@wix/unidriver-core": "^1.1.8",
-    "ricos-content": "10.8.0",
-    "ricos-schema": "10.8.0"
+    "ricos-content": "10.9.0",
+    "ricos-schema": "10.9.0"
   },
@@ -66,3 +66,3 @@ "unpkg": true,
   },
-  "falconPackageHash": "dfa68e9f74d3b5ffe48f44bdb063d720a7aafb2a0c2c2064cdafd480"
+  "falconPackageHash": "8937710474ccbe962c5c57586ad57485565c6a6a93cea176485e8902"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

536666

decreased by-0.72%

Lines of code

4023

decreased by-0.64%

Dependency changes

• + Addedricos-content@10.9.0(transitive)

• + Addedricos-schema@10.9.0(transitive)

• - Removedricos-content@10.8.0(transitive)

• - Removedricos-schema@10.8.0(transitive)

• Updatedricos-content@10.9.0

• Updatedricos-schema@10.9.0