@jackuait/blok 0.4.1 → 0.4.3-beta.1

package/dist/vendor.LICENSE.txt

@@ -34,138 +34,6 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ---
 
-Name: nanoid
-Version: 5.1.6
-License: MIT
-Private: false
-Description: A tiny (118 bytes), secure URL-friendly unique string ID generator
-Repository: undefined
-Author: Andrey Sitnik <andrey@sitnik.ru>
-License Copyright:
-===
-
-The MIT License (MIT)
-
-Copyright 2017 Andrey Sitnik <andrey@sitnik.ru>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----
-
-Name: lodash
-Version: 4.17.21
-License: MIT
-Private: false
-Description: Lodash modular utilities.
-Repository: undefined
-Homepage: https://lodash.com/
-Author: John-David Dalton <john.david.dalton@gmail.com>
-Contributors:
-  John-David Dalton <john.david.dalton@gmail.com>
-  Mathias Bynens <mathias@qiwi.be>
-License Copyright:
-===
-
-Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
-
-Based on Underscore.js, copyright Jeremy Ashkenas,
-DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
-
-This software consists of voluntary contributions made by many
-individuals. For exact contribution history, see the revision history
-available at https://github.com/lodash/lodash
-
-The following license applies to all parts of this software except as
-documented below:
-
-====
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-====
-
-Copyright and related rights for sample code are waived via CC0. Sample
-code is defined as all source code displayed within the prose of the
-documentation.
-
-CC0: http://creativecommons.org/publicdomain/zero/1.0/
-
-====
-
-Files located in the node_modules and vendor directories are externally
-maintained libraries used by this software which have their own
-licenses; we recommend you read them, as their terms may differ from the
-terms above.
-
----
-
-Name: tailwind-merge
-Version: 3.4.0
-License: MIT
-Private: false
-Description: Merge Tailwind CSS classes without style conflicts
-Repository: https://github.com/dcastil/tailwind-merge.git
-Homepage: https://github.com/dcastil/tailwind-merge
-Author: Dany Castillo
-License Copyright:
-===
-
-MIT License
-
-Copyright (c) 2021 Dany Castillo
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
----
-
 Name: html-janitor
 Version: 2.0.4
 License: null
@@ -378,33 +246,68 @@ Apache License
 
 ---
 
-Name: sortablejs
-Version: 1.15.6
+Name: nanoid
+Version: 5.1.6
+License: MIT
+Private: false
+Description: A tiny (118 bytes), secure URL-friendly unique string ID generator
+Repository: undefined
+Author: Andrey Sitnik <andrey@sitnik.ru>
+License Copyright:
+===
+
+The MIT License (MIT)
+
+Copyright 2017 Andrey Sitnik <andrey@sitnik.ru>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+Name: i18next
+Version: 25.7.3
 License: MIT
 Private: false
-Description: JavaScript library for reorderable drag-and-drop lists on modern browsers and touch devices. No jQuery required. Supports Meteor, AngularJS, React, Polymer, Vue, Knockout and any CSS library, e.g. Bootstrap.
-Repository: git://github.com/SortableJS/Sortable.git
+Description: i18next internationalization framework
+Repository: https://github.com/i18next/i18next.git
+Homepage: https://www.i18next.com
+Author: Jan Mühlemann <jan.muehlemann@gmail.com> (https://github.com/jamuhl)
 License Copyright:
 ===
 
-MIT License
-
-Copyright (c) 2019 All contributors to Sortable
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+The MIT License (MIT)
+
+Copyright (c) 2025 i18next
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/package.json

@@ -1,21 +1,55 @@
 {
   "name": "@jackuait/blok",
-  "version": "0.4.1",
+  "version": "0.4.3-beta.1",
   "description": "Blok — headless, highly extensible rich text editor built for developers who need to implement a block-based editing experience (similar to Notion) without building it from scratch",
-  "main": "dist/blok.umd.js",
   "module": "dist/blok.mjs",
   "types": "./types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "tools": [
+        "./types/tools-entry.d.ts"
+      ],
+      "full": [
+        "./types/full.d.ts"
+      ],
+      "locales": [
+        "./types/locales.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./dist/blok.mjs"
+    },
+    "./tools": {
+      "types": "./types/tools-entry.d.ts",
+      "import": "./dist/tools.mjs"
+    },
+    "./full": {
+      "types": "./types/full.d.ts",
+      "import": "./dist/full.mjs"
+    },
+    "./locales": {
+      "types": "./types/locales.d.ts",
+      "import": "./dist/locales.mjs"
+    }
+  },
   "bin": {
     "migrate-from-editorjs": "./codemod/migrate-editorjs-to-blok.js"
   },
   "files": [
     "dist",
     "types",
+    "src",
     "codemod"
   ],
   "publishConfig": {
     "access": "public"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "keywords": [
     "blok",
     "text editor",
@@ -25,15 +59,21 @@
     "headless editor",
     "extensible editor"
   ],
+  "sideEffects": [
+    "./src/components/polyfills.ts",
+    "*.css"
+  ],
   "scripts": {
     "serve": "vite --no-open",
-    "build": "vite build --mode production",
-    "build:test": "vite build --mode test",
+    "build": "vite build --mode production && node scripts/build-locales.mjs",
+    "build:test": "vite build --mode test && node scripts/build-locales.mjs test",
     "lint": "sh -c 'eslint .; ESLINT_EXIT=$?; tsc --noEmit; TSC_EXIT=$?; if [ $ESLINT_EXIT -ne 0 ] || [ $TSC_EXIT -ne 0 ]; then exit 1; fi'",
     "lint:fix": "eslint . --fix",
     "lint:tests": "eslint test/",
     "lint:types": "tsc --noEmit",
+    "i18n:check": "node scripts/i18n/check-translations.mjs",
     "e2e": "playwright test",
+    "e2e:smoke": "playwright test --project=chromium --grep=\"@smoke\"",
     "e2e:chrome": "playwright test --project=chromium",
     "e2e:firefox": "playwright test --project=firefox",
     "e2e:safari": "playwright test --project=webkit",
@@ -48,16 +88,22 @@
     "jscpd:report": "jscpd . --reporters html,json --output .jscpd-report",
     "prepublishOnly": "yarn build",
     "prepare": "husky",
-    "release": "./scripts/release.sh release",
-    "release:alpha": "./scripts/release.sh prerelease alpha",
-    "release:rc": "./scripts/release.sh prerelease rc",
-    "release:dry": "./scripts/release.sh release beta true",
     "storybook": "storybook dev -p 6006 --no-open",
     "storybook:build": "storybook build --stats-json",
     "storybook:test": "vitest --project=storybook --run",
     "chromatic": "chromatic --exit-zero-on-changes",
-    "release:beta": "npm version prerelease --preid=beta",
-    "publish:beta": "npm publish --tag beta"
+    "verify:package": "node scripts/verify-published-package.mjs",
+    "verify:package:local": "npm pack && node scripts/verify-published-package.mjs --local",
+    "verify:version": "node scripts/verify-version.mjs",
+    "unpublish": "node scripts/unpublish-package.mjs",
+    "bundle:track": "node scripts/track-bundle-size.mjs --verbose",
+    "bundle:variants": "node scripts/build-bundle-variants.mjs --verbose",
+    "bundle:trends": "node scripts/view-bundle-trends.mjs --trends",
+    "bundle:history": "node scripts/view-bundle-trends.mjs",
+    "perf:analyze": "node scripts/analyze-performance.mjs",
+    "perf:compare": "node scripts/analyze-performance.mjs --baseline",
+    "perf:dashboard": "node scripts/generate-performance-dashboard.mjs",
+    "e2e:validate-categories": "node scripts/validate-test-categories.mjs"
   },
   "author": "JackUait",
   "contributors": [
@@ -75,13 +121,14 @@
     "@commitlint/cli": "20.1.0",
     "@commitlint/config-conventional": "20.0.0",
     "@playwright/test": "1.57.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
     "@storybook/addon-a11y": "10.1.1",
     "@storybook/addon-vitest": "10.1.1",
     "@storybook/global": "5.0.0",
     "@storybook/html-vite": "10.1.1",
     "@types/eslint-plugin-tailwindcss": "3",
     "@types/node": "22.19.0",
-    "@types/sortablejs": "1.15.9",
     "@vitest/browser-playwright": "4.0.14",
     "@vitest/coverage-v8": "4.0.14",
     "@vitest/ui": "4.0.14",
@@ -103,6 +150,7 @@
     "playwright": "1.57.0",
     "postcss": "8.5.6",
     "rollup-plugin-license": "3.6.0",
+    "semantic-release": "^25.0.2",
     "storybook": "10.1.1",
     "tailwindcss": "3",
     "tslint": "6.1.3",
@@ -114,9 +162,6 @@
     "yaml": "2.8.1"
   },
   "dependencies": {
-    "@types/lodash": "4.17.21",
-    "lodash": "4.17.21",
-    "sortablejs": "1.15.6",
-    "tailwind-merge": "3.4.0"
+    "i18next": "^25.7.3"
   }
 }

package/src/blok.ts

@@ -0,0 +1,267 @@
+'use strict';
+
+import type { BlokConfig, API } from '../types';
+import type { BlokModules } from './types-internal/blok-modules';
+
+/**
+ * Apply polyfills
+ */
+import '@babel/register';
+
+import './components/polyfills';
+import { Core } from './components/core';
+import { getBlokVersion, isObject, isFunction } from './components/utils';
+import { destroy as destroyTooltip } from './components/utils/tooltip';
+import { DATA_ATTR } from './components/constants/data-attributes';
+
+/**
+ * Export version as a named export
+ */
+export const version = getBlokVersion();
+
+/**
+ * Re-export DATA_ATTR for querying editor elements
+ */
+export { DATA_ATTR } from './components/constants/data-attributes';
+
+/**
+ * Blok
+ * @license Apache-2.0
+ */
+class Blok {
+  /**
+   * Store user-provided configuration for later export
+   */
+  private readonly initialConfiguration: BlokConfig|string|undefined;
+
+  /**
+   * Promise that resolves when core modules are ready and UI is rendered on the page
+   */
+  public isReady: Promise<void>;
+
+  /**
+   * Stores destroy method implementation.
+   * Clear heap occupied by Blok and remove UI components from the DOM.
+   */
+  public destroy: () => void;
+
+  /** Blok version */
+  public static get version(): string {
+    return getBlokVersion();
+  }
+
+  /**
+   * Data attributes used by the editor.
+   * Single source of truth for all data-blok-* attributes.
+   *
+   * @example
+   * // Query editor elements
+   * document.querySelectorAll(`[${Blok.DATA_ATTR.element}]`);
+   *
+   * // Check if block is selected
+   * block.getAttribute(Blok.DATA_ATTR.selected) === 'true';
+   */
+  public static DATA_ATTR = DATA_ATTR;
+
+  /**
+   * @param {BlokConfig|string|undefined} [configuration] - user configuration
+   */
+  constructor(configuration?: BlokConfig|string) {
+    this.initialConfiguration = isObject(configuration)
+      ? { ...configuration }
+      : configuration;
+
+    /**
+     * Set default onReady function or use the one from configuration if provided
+     */
+
+    const onReady = (isObject(configuration) && isFunction(configuration.onReady))
+      ? configuration.onReady
+      : () => {};
+
+    /**
+     * Create a Blok instance
+     */
+    const blok = new Core(configuration);
+
+    /**
+     * Initialize destroy with a no-op function that will be replaced in exportAPI
+     */
+
+    this.destroy = (): void => {};
+
+    /**
+     * We need to export isReady promise in the constructor
+     * as it can be used before other API methods are exported
+     * @type {Promise<void>}
+     */
+    this.isReady = blok.isReady.then(() => {
+      this.exportAPI(blok);
+      /**
+       * @todo pass API as an argument. It will allow to use Blok's API when blok is ready
+       */
+      onReady();
+    });
+  }
+
+  /**
+   * Export external API methods
+   * @param {Core} blok — Blok's instance
+   */
+  public exportAPI(blok: Core): void {
+    const fieldsToExport = [ 'configuration' ];
+    const destroy = (): void => {
+      Object.values(blok.moduleInstances)
+        .forEach((moduleInstance) => {
+          if (moduleInstance === undefined || moduleInstance === null) {
+            return;
+          }
+
+          if (isFunction((moduleInstance as { destroy?: () => void }).destroy)) {
+            (moduleInstance as { destroy: () => void }).destroy();
+          }
+
+          const listeners = (moduleInstance as { listeners?: { removeAll?: () => void } }).listeners;
+
+          if (listeners && isFunction(listeners.removeAll)) {
+            listeners.removeAll();
+          }
+        });
+
+      destroyTooltip();
+
+      for (const field in this) {
+        if (Object.prototype.hasOwnProperty.call(this, field)) {
+          delete (this as Record<string, unknown>)[field];
+        }
+      }
+
+      Object.setPrototypeOf(this, null);
+    };
+
+    fieldsToExport.forEach((field) => {
+      if (field !== 'configuration') {
+        (this as Record<string, unknown>)[field] = (blok as unknown as Record<string, unknown>)[field];
+
+        return;
+      }
+
+      const coreConfiguration = (blok as unknown as { configuration?: BlokConfig|string|undefined }).configuration;
+      const configurationToExport = isObject(this.initialConfiguration)
+        ? this.initialConfiguration
+        : coreConfiguration ?? this.initialConfiguration;
+
+      if (configurationToExport === undefined) {
+        return;
+      }
+
+      (this as Record<string, unknown>)[field] = configurationToExport as BlokConfig|string;
+    });
+
+    this.destroy = destroy;
+
+    const apiMethods = blok.moduleInstances.API.methods;
+    const eventsDispatcherApi = blok.moduleInstances.EventsAPI?.methods ?? apiMethods.events;
+
+    if (eventsDispatcherApi !== undefined) {
+      const defineDispatcher = (target: object): void => {
+        if (!Object.prototype.hasOwnProperty.call(target, 'eventsDispatcher')) {
+          Object.defineProperty(target, 'eventsDispatcher', {
+            value: eventsDispatcherApi,
+            configurable: true,
+            enumerable: true,
+            writable: false,
+          });
+        }
+      };
+
+      defineDispatcher(apiMethods);
+      defineDispatcher(this as Record<string, unknown>);
+    }
+
+    if (Object.getPrototypeOf(apiMethods) !== Blok.prototype) {
+      Object.setPrototypeOf(apiMethods, Blok.prototype);
+    }
+
+    Object.setPrototypeOf(this, apiMethods);
+
+    const moduleAliases = Object.create(null) as Record<string, unknown>;
+    const moduleInstances = blok.moduleInstances as Partial<BlokModules>;
+    const moduleInstancesRecord = moduleInstances as unknown as Record<string, unknown>;
+
+    const getAliasName = (name: string): string => (
+      /^[A-Z]+$/.test(name)
+        ? name.toLowerCase()
+        : name.charAt(0).toLowerCase() + name.slice(1)
+    );
+
+    Object.keys(moduleInstancesRecord)
+      .forEach((name) => {
+        const alias = getAliasName(name);
+
+        Object.defineProperty(moduleAliases, alias, {
+          configurable: true,
+          enumerable: true,
+          get: () => moduleInstancesRecord[name],
+        });
+      });
+
+    type ToolbarModuleWithSettings = {
+      blockSettings?: unknown;
+      inlineToolbar?: unknown;
+    };
+
+    const toolbarModule = moduleInstances.Toolbar as unknown as ToolbarModuleWithSettings | undefined;
+    const blockSettingsModule = moduleInstances.BlockSettings;
+
+    if (toolbarModule !== undefined && blockSettingsModule !== undefined && toolbarModule.blockSettings === undefined) {
+      toolbarModule.blockSettings = blockSettingsModule;
+    }
+
+    const inlineToolbarModule = moduleInstances.InlineToolbar;
+
+    if (toolbarModule !== undefined && inlineToolbarModule !== undefined && toolbarModule.inlineToolbar === undefined) {
+      toolbarModule.inlineToolbar = inlineToolbarModule;
+    }
+
+    Object.defineProperty(this, 'module', {
+      value: moduleAliases,
+      configurable: true,
+      enumerable: false,
+      writable: false,
+    });
+
+    delete (this as Partial<Blok>).exportAPI;
+
+    const shorthands = {
+      blocks: {
+        clear: 'clear',
+        render: 'render',
+      },
+      caret: {
+        focus: 'focus',
+      },
+      events: {
+        on: 'on',
+        off: 'off',
+        emit: 'emit',
+      },
+      saver: {
+        save: 'save',
+      },
+    };
+
+    Object.entries(shorthands)
+      .forEach(([key, methods]) => {
+        Object.entries(methods)
+          .forEach(([name, alias]) => {
+            const apiKey = key as keyof API;
+            const apiMethodGroup = blok.moduleInstances.API.methods[apiKey] as unknown as Record<string, unknown>;
+
+            (this as Record<string, unknown>)[alias] = apiMethodGroup[name];
+          });
+      });
+  }
+}
+
+export { Blok };