feat(base): added utils

.github/workflows/build-check.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   build:
-    name: Build notes.web
+    name: Build editorjs/utils
     runs-on: ubuntu-latest
 
     steps:
@@ -19,7 +19,7 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 20
+          node-version: 22.1.0
 
       - name: Install dependencies
         run: yarn install

.github/workflows/eslint-check.yml

@@ -16,17 +16,10 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Install dependencies
-        run: |
-          yarn install
+        run: yarn install
 
-      - name: Run ESLint
-        run: yarn lint
+      - name: Build packages
+        run: yarn build
 
-      - name: Install codex-ui dependencies
-        run: |
-          yarn install
-        working-directory: ./codex-ui
-
-      - name: Run ESLint on codex-ui
+      - name: Run ESLint
         run: yarn lint
-        working-directory: ./codex-ui

.github/workflows/npm-publish.yml

@@ -0,0 +1,13 @@
+name: Publish package to NPM
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish-and-notify:
+    uses: codex-team/github-workflows/.github/workflows/npm-publish-and-notify-reusable.yml@main
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      CODEX_BOT_NOTIFY_EDITORJS_PUBLIC_CHAT: ${{ secrets.CODEX_BOT_NOTIFY_EDITORJS_PUBLIC_CHAT }}

.gitignore

@@ -1,123 +1,8 @@
-# Created by .ignore support plugin (hsz.mobi)
-### Node template
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
+# build filse
+dist/
 
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
+# module files
 node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
 
-# TypeScript cache
+# build info lock
 *.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-
-# IDE
-.idea
-
-build

.nvmrc

@@ -0,0 +1 @@
+v22.1.0

.yarnrc

@@ -0,0 +1,5 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+yarn-path ".yarn/releases/yarn-4.4.0.cjs"

.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.4.0.cjs

eslint.config.mjs

@@ -1,25 +1,43 @@
+/** eslint-disable-next-line n/no-unpublished-import */
 import CodeX from 'eslint-config-codex';
-
+import { plugin as TsPlugin, parser as TsParser } from 'typescript-eslint';
 /**
  * @todo connect architecture config
  */
 export default [
   ...CodeX,
   {
     name: 'ts-editorjs/utils',
-
+    ignores: ['eslint.config.mjs'],
     /**
      * This are the options for typescript files
      */
     languageOptions: {
+      parser: TsParser,
       parserOptions: {
-        project: './tsconfig.json',
+        project: './tsconfig.eslint.json',
         tsconfigRootDir: './',
         sourceType: 'module', // Allows for the use of imports
       },
     },
+    plugins: {
+      '@typescript-eslint': TsPlugin,
+    },
+
     rules: {
+      'n/no-missing-import': ['off'],
+      'n/no-extraneous-import': ['error', {
+        allowModules: ['nanoid'],
+      }],
       'n/no-unpublished-import': ['off'],
+      'n/no-unsupported-features/node-builtins': ['error', {
+        version: '>=22.1.0',
+        allowExperimental: true,
+      }],
+      '@typescript-eslint/naming-convention': ['error', {
+        selector: 'property',
+        format: ['UPPER_CASE', 'camelCase', 'PascalCase'],
+      }],
     },
   },
 ];

package.json

@@ -1,21 +1,36 @@
 {
-  "name": "utils",
+  "name": "@editorjs/utils",
+  "private": true,
+  "workspaces": [
+    "packages/caret",
+    "packages/dom",
+    "packages/helpers",
+    "packages/keyboard"
+  ],
   "version": "1.0.0",
-  "description": "Utils that are used by Editor.js and it's tools",
-  "main": "build/index.js",
-  "repository": "https://github.com/editor-js/utils",
+  "description": "Useful utils for working with Editor.js",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/editor-js/utils.git"
+  },
   "author": "CodeX Team <all@codex.so>",
   "license": "MIT",
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "yarn build:helpers &&  yarn build:dom && yarn build:caret && yarn build:keyboard && tsc",
+    "build:helpers": "cd packages/helpers && yarn build",
+    "build:dom": "cd packages/dom && yarn build",
+    "build:caret": "cd packages/caret && yarn build",
+    "build:keyboard": "cd packages/keyboard && yarn build",
     "lint": "eslint",
     "lint:fix": "yarn lint --fix"
   },
   "devDependencies": {
-    "@eslint/eslintrc": "^3.1.0",
-    "eslint": "^9.3.0",
+    "@types/node": "^20.10.7",
+    "eslint": "^9.0.0",
     "eslint-config-codex": "^2.0.0",
-    "ts-node": "^9.1.1",
-    "typescript": "^5.4.5"
-  }
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.9.0"
+  },
+  "packageManager": "yarn@4.4.0"
 }

packages/caret/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@editorjs/caret",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@editorjs/dom": "workspace:*"
+  }
+}

packages/caret/src/getCaretNodeAndOffset.ts

@@ -0,0 +1,49 @@
+/**
+ * Returns TextNode containing a caret and a caret offset in it
+ * Returns null if there is no caret set
+ *
+ * Handles a case when focusNode is an ElementNode and focusOffset is a child index,
+ * returns child node with focusOffset index as a new focusNode
+ */
+export function getCaretNodeAndOffset(): [ Node | null, number ] {
+  const selection = window.getSelection();
+
+  if (selection === null) {
+    return [null, 0];
+  }
+
+  let focusNode = selection.focusNode;
+  let focusOffset = selection.focusOffset;
+
+  if (focusNode === null) {
+    return [null, 0];
+  }
+
+  /**
+   * Case when focusNode is an Element (or Document). In this case, focusOffset is a child index.
+   * We need to return child with focusOffset index as a new focusNode.
+   *
+   * <div>|hello</div> <---- Selection references to <div> instead of text node
+   *
+   *
+   */
+  if (focusNode.nodeType !== Node.TEXT_NODE && focusNode.childNodes.length > 0) {
+    /**
+     * In normal cases, focusOffset is a child index.
+     */
+    if (focusNode.childNodes[focusOffset] !== undefined) {
+      focusNode = focusNode.childNodes[focusOffset];
+      focusOffset = 0;
+    /**
+     * But in Firefox, focusOffset can be 1 with the single child.
+     */
+    } else {
+      focusNode = focusNode.childNodes[focusOffset - 1];
+      if (focusNode.textContent !== null) {
+        focusOffset = focusNode.textContent.length;
+      }
+    }
+  }
+
+  return [focusNode, focusOffset];
+}

packages/caret/src/index.ts

@@ -0,0 +1,7 @@
+import { getCaretNodeAndOffset } from './getCaretNodeAndOffset';
+import { isCaretAtEndOfInput } from './isCaretAtEndOfInput';
+import { isCaretAtStartOfInput } from './isCaretAtStartOfInput';
+
+export { getCaretNodeAndOffset,
+  isCaretAtEndOfInput,
+  isCaretAtStartOfInput };