@portabletext/plugin-input-rule 0.1.0

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@portabletext/plugin-input-rule",
+  "version": "0.1.0",
+  "description": "Easily configure input rules in the Portable Text Editor",
+  "keywords": [
+    "portabletext",
+    "plugin",
+    "input-rule"
+  ],
+  "homepage": "https://www.portabletext.org/",
+  "bugs": {
+    "url": "https://github.com/portabletext/editor/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/portabletext/editor.git",
+    "directory": "packages/plugin-input-rule"
+  },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@xstate/react": "^6.0.0",
+    "react-compiler-runtime": "19.1.0-rc.3",
+    "xstate": "^5.22.1"
+  },
+  "devDependencies": {
+    "@sanity/pkg-utils": "^8.1.4",
+    "@types/react": "^19.1.11",
+    "@vitejs/plugin-react": "^5.0.3",
+    "babel-plugin-react-compiler": "19.1.0-rc.3",
+    "eslint": "^9.34.0",
+    "eslint-formatter-gha": "^1.6.0",
+    "eslint-plugin-react-hooks": "6.0.0-rc.2",
+    "react": "^19.1.1",
+    "typescript": "5.9.3",
+    "typescript-eslint": "^8.41.0",
+    "vitest": "^3.2.4",
+    "@portabletext/editor": "2.13.5",
+    "racejar": "1.3.1",
+    "@portabletext/schema": "1.2.0"
+  },
+  "peerDependencies": {
+    "@portabletext/editor": "^2.13.5",
+    "react": "^19.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pkg-utils build --strict --check --clean",
+    "check:lint": "biome lint .",
+    "check:react-compiler": "eslint --cache .",
+    "check:types": "tsc",
+    "check:types:watch": "tsc --watch",
+    "clean": "del .turbo && del lib && del node_modules",
+    "dev": "pkg-utils watch",
+    "lint:fix": "biome lint --write .",
+    "test": "vitest --run",
+    "test:browser": "vitest --run --project browser",
+    "test:browser:chromium": "vitest run --project \"browser (chromium)\"",
+    "test:browser:chromium:watch": "vitest watch --project \"browser (chromium)\"",
+    "test:browser:firefox": "vitest run --project \"browser (firefox)\"",
+    "test:browser:firefox:watch": "vitest watch --project \"browser (firefox)\"",
+    "test:browser:webkit": "vitest run --project \"browser (webkit)\"",
+    "test:browser:webkit:watch": "vitest watch --project \"browser (webkit)\""
+  }
+}

package/src/edge-cases.feature

@@ -0,0 +1,81 @@
+Feature: Edge Cases
+
+  Background:
+    Given the editor is focused
+    And a global keymap
+
+  Scenario Outline: Longer Transform
+    Given the text <text>
+    When <inserted text> is inserted
+    And "new" is typed
+    Then the text is <new text>
+
+    Examples:
+      | text       | inserted text | new text            |
+      | ""         | "."           | "...new"            |
+      | "foo"      | "."           | "foo...new"         |
+      | ""         | "foo."        | "foo...new"         |
+      | "foo."     | "."           | "foo....new"        |
+      | ""         | "foo.bar."    | "foo...bar...new"   |
+      | "foo.bar." | "baz."        | "foo.bar.baz...new" |
+
+  Scenario Outline: End String Rule
+    Given the text <text>
+    When <inserted text> is inserted
+    And "new" is typed
+    Then the text is <new text>
+
+    Examples:
+      | text         | inserted text | new text            |
+      | "-"          | ">"           | "→new"              |
+      | ""           | "->"          | "→new"              |
+      | "foo"        | "->"          | "foo→new"           |
+      | ""           | "foo->"       | "foo→new"           |
+      | "foo-"       | ">bar"        | "foo->barnew"       |
+      | ""           | "foo->bar->"  | "foo->bar→new"      |
+      | "foo->bar->" | "baz->"       | "foo->bar->baz→new" |
+
+  Scenario Outline: Non-Global Rule
+    Given the text <text>
+    When <inserted text> is inserted
+    And "new" is typed
+    Then the text is <new text>
+
+    Examples:
+      | text           | inserted text  | new text              |
+      | "(c"           | ")"            | "©new"                |
+      | ""             | "(c)"          | "©new"                |
+      | "foo"          | "(c)"          | "foo©new"             |
+      | ""             | "foo(c)"       | "foo©new"             |
+      | "foo(c"        | ")bar"         | "foo©barnew"          |
+      | ""             | "foo(c)bar(c)" | "foo©bar©new"         |
+      | "foo(c)bar(c)" | "baz(c)"       | "foo(c)bar(c)baz©new" |
+
+  Scenario Outline: Writing after Multiple Groups Rule
+    Given the text <text>
+    When <inserted text> is inserted
+    And "new" is typed
+    Then the text is <new text>
+
+    Examples:
+      | text    | inserted text | new text       |
+      | ""      | "xfooy"       | "zfooznew"     |
+      | "xfoo"  | "y"           | "zfooznew"     |
+      | "xfooy" | "z"           | "xfooyznew"    |
+      | ""      | "xfyxoy"      | "zfzzoznew"    |
+      | ""      | "xfyxoyxoy"   | "zfzzozzoznew" |
+
+  Scenario Outline: Undoing Multiple Groups Rule
+    Given the text <text>
+    When <inserted text> is inserted
+    Then the text is <before undo>
+    When undo is performed
+    Then the text is <after undo>
+
+    Examples:
+      | text    | inserted text | before undo | after undo  |
+      | ""      | "xfooy"       | "zfooz"     | "xfooy"     |
+      | "xfoo"  | "y"           | "zfooz"     | "xfooy"     |
+      | "xfooy" | "z"           | "xfooyz"    | "xfooy"     |
+      | ""      | "xfyxoy"      | "zfzzoz"    | "xfyxoy"    |
+      | ""      | "xfyxoyxoy"   | "zfzzozzoz" | "xfyxoyxoy" |

package/src/edge-cases.test.tsx

@@ -0,0 +1,59 @@
+import {parameterTypes} from '@portabletext/editor/test'
+import {
+  createTestEditor,
+  stepDefinitions,
+  type Context,
+} from '@portabletext/editor/test/vitest'
+import {defineSchema} from '@portabletext/schema'
+import {Before} from 'racejar'
+import {Feature} from 'racejar/vitest'
+import edgeCasesFeature from './edge-cases.feature?raw'
+import {InputRulePlugin} from './plugin.input-rule'
+import {defineTextTransformRule} from './text-transform-rule'
+
+const longerTransformRule = defineTextTransformRule({
+  on: /\./,
+  transform: () => '...',
+})
+
+const endStringRule = defineTextTransformRule({
+  on: /->$/,
+  transform: () => '→',
+})
+
+const nonGlobalRule = defineTextTransformRule({
+  on: /\(c\)/,
+  transform: () => '©',
+})
+
+const multipleGroupsRule = defineTextTransformRule({
+  on: /(x)[fo]+(y)/,
+  transform: () => 'z',
+})
+
+Feature({
+  hooks: [
+    Before(async (context: Context) => {
+      const {editor, locator} = await createTestEditor({
+        children: (
+          <>
+            <InputRulePlugin rules={[longerTransformRule]} />
+            <InputRulePlugin rules={[endStringRule]} />
+            <InputRulePlugin rules={[nonGlobalRule]} />
+            <InputRulePlugin rules={[multipleGroupsRule]} />
+          </>
+        ),
+        schemaDefinition: defineSchema({
+          decorators: [{name: 'strong'}],
+          annotations: [{name: 'link'}],
+        }),
+      })
+
+      context.locator = locator
+      context.editor = editor
+    }),
+  ],
+  featureText: edgeCasesFeature,
+  stepDefinitions,
+  parameterTypes,
+})

package/src/global.d.ts

@@ -0,0 +1,4 @@
+declare module '*.feature?raw' {
+  const content: string
+  export default content
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './input-rule'
+export * from './plugin.input-rule'
+export * from './text-transform-rule'

package/src/input-rule.ts

@@ -0,0 +1,82 @@
+import type {
+  BlockOffset,
+  BlockPath,
+  EditorSelection,
+  PortableTextTextBlock,
+} from '@portabletext/editor'
+import type {
+  BehaviorActionSet,
+  BehaviorGuard,
+} from '@portabletext/editor/behaviors'
+
+type InputRuleMatchLocation = {
+  /**
+   * Estimated selection of where in the original text the match is located.
+   * The selection is estimated since the match is found in the text after
+   * insertion.
+   */
+  selection: NonNullable<EditorSelection>
+  /**
+   * Block offsets of the match in the text after the insertion
+   */
+  targetOffsets: {
+    anchor: BlockOffset
+    focus: BlockOffset
+    backward: boolean
+  }
+}
+
+/**
+ * Match found in the text after the insertion
+ * @alpha
+ */
+export type InputRuleMatch = InputRuleMatchLocation & {
+  groupMatches: Array<InputRuleMatchLocation>
+}
+
+/**
+ * @alpha
+ */
+export type InputRuleEvent = {
+  type: 'custom.input rule'
+  /**
+   * Matches found by the input rule
+   */
+  matches: Array<InputRuleMatch>
+  /**
+   * The text before the insertion
+   */
+  textBefore: string
+  /**
+   * The text is destined to be inserted
+   */
+  textInserted: string
+  /**
+   * The text block where the insertion takes place
+   */
+  focusTextBlock: {
+    path: BlockPath
+    node: PortableTextTextBlock
+  }
+}
+
+/**
+ * @alpha
+ */
+export type InputRuleGuard = BehaviorGuard<InputRuleEvent, boolean>
+
+/**
+ * @alpha
+ */
+export type InputRule = {
+  on: RegExp
+  guard?: InputRuleGuard
+  actions: Array<BehaviorActionSet<InputRuleEvent, boolean>>
+}
+
+/**
+ * @alpha
+ */
+export function defineInputRule(config: InputRule): InputRule {
+  return config
+}