@portabletext/plugin-typography 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 - 2025 Sanity.io
+
+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/README.md

@@ -0,0 +1,122 @@
+# `@portabletext/plugin-typography`
+
+> Automatically transform text to typographic variants
+
+Drop-in plugin for the [Portable Text Editor](https://www.portabletext.org/) to enable a wide variety of typographic transformations:
+
+![Typography Demo](./assets/typography-demo.gif)
+
+Automatically handles smart undo with <kbd>Backspace</kbd> right after insertion:
+
+![Smart undo with Backspace](./assets/smart-undo-with-backspace.gif)
+
+## Usage
+
+Import the `TypographyPlugin` React component and place it inside the `EditorProvider`:
+
+```tsx
+import {
+  defineSchema,
+  EditorProvider,
+  PortableTextEditable,
+} from '@portabletext/editor'
+import {TypographyPlugin} from '@portabletext/plugin-typography'
+
+const schemaDefinition = defineSchema({
+  // Your Schema
+})
+
+function App() {
+  return (
+    <EditorProvider
+      initialConfig={{
+        schemaDefinition,
+      }}
+    >
+      <PortableTextEditable />
+      <TypographyPlugin /> {/* <-- plugin added */}
+    </EditorProvider>
+  )
+}
+```
+
+## Rules Included
+
+The plugin includes the following typographic transformation rules:
+
+**Default rules:**
+
+| Name                  | Conversion    |
+| --------------------- | ------------- |
+| `emDash`              | `--` → `—`    |
+| `ellipsis`            | `...` → `…`   |
+| `openingDoubleQuote`  | `"` → `“`     |
+| `closingDoubleQuote`  | `"` → `”`     |
+| `openingSingleQuote`  | `'` → `‘`     |
+| `closingSingleQuote`  | `'` → `’`     |
+| `leftArrow`           | `<-` → `←`    |
+| `rightArrow`          | `->` → `→`    |
+| `copyright`           | `(c)` → `©`  |
+| `trademark`           | `(tm)` → `™` |
+| `servicemark`         | `(sm)` → `℠`  |
+| `registeredTrademark` | `(r)` → `®`  |
+
+**Optional rules:**
+
+| Name               | Conversion                       |
+| ------------------ | -------------------------------- |
+| `oneHalf`          | `1/2` → `½`                      |
+| `plusMinus`        | `+/-` → `±`                      |
+| `notEqual`         | `!=` → `≠`                       |
+| `laquo`            | `<<` → `«`                       |
+| `raquo`            | `>>` → `»`                       |
+| `multiplication`   | `*` or `x` between numbers → `×` |
+| `superscriptTwo`   | `^2` → `²`                       |
+| `superscriptThree` | `^3` → `³`                       |
+| `oneQuarter`       | `1/4` → `¼`                      |
+| `threeQuarters`    | `3/4` → `¾`                      |
+
+## Configuring what Rules are Enabled
+
+Use the `rules` prop on the `TypographyPlugin` to control which rules are enabled:
+
+```tsx
+return <TypographyPlugin rules={{multiplication: 'on'}} />
+```
+
+`emDash`, `ellipsis`, `openingDoubleQuote`, `closingDoubleQuote`, `openingSingleQuote`, `closingSingleQuote`, `leftArrow`, `rightArrow`, `copyright`, `trademark`, `servicemark`, and `registeredTrademark` are `'on'` by default.
+
+## Controlling when Text Transformations Run
+
+The `TypographyPlugin` has an optional `guard` prop that accepts any type of `BehaviorGuard`. Here, you'll have access to the current `EditorSnapshot` as well as information about the current rule being matched.
+
+Because disallowing text transformations inside code is a common use case, this plugin ships a built-in `createDecoratorGuard` function. use that to create a `guard` that disallows text transformations inside certain decorators:
+
+```tsx
+import {
+  createDecoratorGuard,
+  TypographyPlugin,
+} from '@portabletext/plugin-typography'
+
+return (
+  <TypographyPlugin
+    guard={createDecoratorGuard({
+      decorators: ({schema}) =>
+        schema.decorators.flatMap((decorator) =>
+          decorator.name === 'code' ? [decorator.name] : [],
+        ),
+    })}
+  />
+)
+```
+
+## Using Individual Rules with `InputRulePlugin`
+
+All included typographic rules are exported from the plugin. To use them in your own abstraction, import them from this from plugin and use them with the `InputRulePlugin`:
+
+```tsx
+import {InputRulePlugin} from '@portabletext/plugin-input-rule'
+import {ellipsisRule, emDashRule} from '@portabletext/plugin-typography'
+
+return <InputRulePlugin rules={[emDashRule, ellipsisRule]} />
+```

package/dist/index.cjs

@@ -0,0 +1,235 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: !0 });
+var selectors = require("@portabletext/editor/selectors"), pluginInputRule = require("@portabletext/plugin-input-rule"), jsxRuntime = require("react/jsx-runtime"), compilerRuntime = require("react/compiler-runtime");
+function createDecoratorGuard(config) {
+  return ({
+    snapshot,
+    event
+  }) => {
+    const decorators = config.decorators({
+      schema: snapshot.context.schema
+    });
+    if (decorators.length === 0)
+      return !0;
+    const matchedSpans = event.matches.flatMap((match) => selectors.getSelectedSpans({
+      ...snapshot,
+      context: {
+        ...snapshot.context,
+        selection: match.selection
+      }
+    }));
+    let preventInputRule = !1;
+    for (const decorator of decorators) {
+      if (selectors.isActiveDecorator(decorator)(snapshot)) {
+        preventInputRule = !0;
+        break;
+      }
+      if (matchedSpans.some((span) => span.node.marks?.includes(decorator))) {
+        preventInputRule = !0;
+        break;
+      }
+    }
+    return !preventInputRule;
+  };
+}
+const emDashRule = pluginInputRule.defineTextTransformRule({
+  on: /--/,
+  transform: () => "\u2014"
+}), ellipsisRule = pluginInputRule.defineTextTransformRule({
+  on: /\.\.\./,
+  transform: () => "\u2026"
+}), openingDoubleQuoteRule = pluginInputRule.defineTextTransformRule({
+  on: new RegExp(`(?:^|(?<=[\\s{[(<'"\\u2018\\u201C]))"`, "g"),
+  transform: () => "\u201C"
+}), closingDoubleQuoteRule = pluginInputRule.defineTextTransformRule({
+  on: /"/g,
+  transform: () => "\u201D"
+}), openingSingleQuoteRule = pluginInputRule.defineTextTransformRule({
+  on: new RegExp(`(?:^|(?<=[\\s{[(<'"\\u2018\\u201C]))'`, "g"),
+  transform: () => "\u2018"
+}), closingSingleQuoteRule = pluginInputRule.defineTextTransformRule({
+  on: /'/g,
+  transform: () => "\u2019"
+}), smartQuotesRules = [openingDoubleQuoteRule, closingDoubleQuoteRule, openingSingleQuoteRule, closingSingleQuoteRule], leftArrowRule = pluginInputRule.defineTextTransformRule({
+  on: /<-/,
+  transform: () => "\u2190"
+}), rightArrowRule = pluginInputRule.defineTextTransformRule({
+  on: /->/,
+  transform: () => "\u2192"
+}), copyrightRule = pluginInputRule.defineTextTransformRule({
+  on: /\(c\)/,
+  transform: () => "\xA9"
+}), servicemarkRule = pluginInputRule.defineTextTransformRule({
+  on: /\(sm\)/,
+  transform: () => "\u2120"
+}), trademarkRule = pluginInputRule.defineTextTransformRule({
+  on: /\(tm\)/,
+  transform: () => "\u2122"
+}), registeredTrademarkRule = pluginInputRule.defineTextTransformRule({
+  on: /\(r\)/,
+  transform: () => "\xAE"
+}), oneHalfRule = pluginInputRule.defineTextTransformRule({
+  on: /(?:^|\s)(1\/2)\s/,
+  transform: () => "\xBD"
+}), plusMinusRule = pluginInputRule.defineTextTransformRule({
+  on: /\+\/-/,
+  transform: () => "\xB1"
+}), notEqualRule = pluginInputRule.defineTextTransformRule({
+  on: /!=/,
+  transform: () => "\u2260"
+}), laquoRule = pluginInputRule.defineTextTransformRule({
+  on: /<</,
+  transform: () => "\xAB"
+}), raquoRule = pluginInputRule.defineTextTransformRule({
+  on: />>/,
+  transform: () => "\xBB"
+}), multiplicationRule = pluginInputRule.defineTextTransformRule({
+  on: /\d+\s?([*x])\s?\d+/,
+  transform: () => "\xD7"
+}), superscriptTwoRule = pluginInputRule.defineTextTransformRule({
+  on: /\^2/,
+  transform: () => "\xB2"
+}), superscriptThreeRule = pluginInputRule.defineTextTransformRule({
+  on: /\^3/,
+  transform: () => "\xB3"
+}), oneQuarterRule = pluginInputRule.defineTextTransformRule({
+  on: /(?:^|\s)(1\/4)\s/,
+  transform: () => "\xBC"
+}), threeQuartersRule = pluginInputRule.defineTextTransformRule({
+  on: /(?:^|\s)(3\/4)\s/,
+  transform: () => "\xBE"
+}), defaultRuleConfig = [{
+  name: "emDash",
+  rule: emDashRule,
+  state: "on"
+}, {
+  name: "ellipsis",
+  rule: ellipsisRule,
+  state: "on"
+}, {
+  name: "openingDoubleQuote",
+  rule: openingDoubleQuoteRule,
+  state: "on"
+}, {
+  name: "closingDoubleQuote",
+  rule: closingDoubleQuoteRule,
+  state: "on"
+}, {
+  name: "openingSingleQuote",
+  rule: openingSingleQuoteRule,
+  state: "on"
+}, {
+  name: "closingSingleQuote",
+  rule: closingSingleQuoteRule,
+  state: "on"
+}, {
+  name: "leftArrow",
+  rule: leftArrowRule,
+  state: "on"
+}, {
+  name: "rightArrow",
+  rule: rightArrowRule,
+  state: "on"
+}, {
+  name: "copyright",
+  rule: copyrightRule,
+  state: "on"
+}, {
+  name: "trademark",
+  rule: trademarkRule,
+  state: "on"
+}, {
+  name: "servicemark",
+  rule: servicemarkRule,
+  state: "on"
+}, {
+  name: "registeredTrademark",
+  rule: registeredTrademarkRule,
+  state: "on"
+}, {
+  name: "oneHalf",
+  rule: oneHalfRule,
+  state: "off"
+}, {
+  name: "plusMinus",
+  rule: plusMinusRule,
+  state: "off"
+}, {
+  name: "laquo",
+  rule: laquoRule,
+  state: "off"
+}, {
+  name: "notEqual",
+  rule: notEqualRule,
+  state: "off"
+}, {
+  name: "raquo",
+  rule: raquoRule,
+  state: "off"
+}, {
+  name: "multiplication",
+  rule: multiplicationRule,
+  state: "off"
+}, {
+  name: "superscriptTwo",
+  rule: superscriptTwoRule,
+  state: "off"
+}, {
+  name: "superscriptThree",
+  rule: superscriptThreeRule,
+  state: "off"
+}, {
+  name: "oneQuarter",
+  rule: oneQuarterRule,
+  state: "off"
+}, {
+  name: "threeQuarters",
+  rule: threeQuartersRule,
+  state: "off"
+}];
+function TypographyPlugin(props) {
+  const $ = compilerRuntime.c(6);
+  let t0;
+  $[0] !== props.guard || $[1] !== props.rules ? (t0 = defaultRuleConfig.flatMap((rule) => props.rules && props.rules[rule.name] === "on" ? {
+    ...rule.rule,
+    guard: props.guard ?? _temp
+  } : props.rules && props.rules[rule.name] === "off" || rule.state === "off" ? [] : {
+    ...rule.rule,
+    guard: props.guard ?? _temp2
+  }), $[0] = props.guard, $[1] = props.rules, $[2] = t0) : t0 = $[2];
+  const configuredInputRules = t0;
+  let t1;
+  return $[3] !== configuredInputRules || $[4] !== props ? (t1 = /* @__PURE__ */ jsxRuntime.jsx(pluginInputRule.InputRulePlugin, { ...props, rules: configuredInputRules }), $[3] = configuredInputRules, $[4] = props, $[5] = t1) : t1 = $[5], t1;
+}
+function _temp2() {
+  return !0;
+}
+function _temp() {
+  return !0;
+}
+exports.TypographyPlugin = TypographyPlugin;
+exports.closingDoubleQuoteRule = closingDoubleQuoteRule;
+exports.closingSingleQuoteRule = closingSingleQuoteRule;
+exports.copyrightRule = copyrightRule;
+exports.createDecoratorGuard = createDecoratorGuard;
+exports.ellipsisRule = ellipsisRule;
+exports.emDashRule = emDashRule;
+exports.laquoRule = laquoRule;
+exports.leftArrowRule = leftArrowRule;
+exports.multiplicationRule = multiplicationRule;
+exports.notEqualRule = notEqualRule;
+exports.oneHalfRule = oneHalfRule;
+exports.oneQuarterRule = oneQuarterRule;
+exports.openingDoubleQuoteRule = openingDoubleQuoteRule;
+exports.openingSingleQuoteRule = openingSingleQuoteRule;
+exports.plusMinusRule = plusMinusRule;
+exports.raquoRule = raquoRule;
+exports.registeredTrademarkRule = registeredTrademarkRule;
+exports.rightArrowRule = rightArrowRule;
+exports.servicemarkRule = servicemarkRule;
+exports.smartQuotesRules = smartQuotesRules;
+exports.superscriptThreeRule = superscriptThreeRule;
+exports.superscriptTwoRule = superscriptTwoRule;
+exports.threeQuartersRule = threeQuartersRule;
+exports.trademarkRule = trademarkRule;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/create-decorator-guard.ts","../src/input-rules.typography.ts","../src/plugin.typography.tsx"],"sourcesContent":["import type {EditorSchema} from '@portabletext/editor'\nimport {\n  getSelectedSpans,\n  isActiveDecorator,\n} from '@portabletext/editor/selectors'\nimport type {InputRuleGuard} from '@portabletext/plugin-input-rule'\n\n/**\n * @public\n * Create an `InputRuleGuard` that can prevent the rule from running inside\n * certain decorators.\n *\n * @example\n * ```tsx\n * const guard = createDecoratorGuard({\n *   decorators: ({schema}) => schema.decorators.flatMap((decorator) => decorator.name === 'code' ? [decorator.name] : []),\n * })\n *\n * <TypographyPlugin guard={guard} />\n * ```\n */\nexport function createDecoratorGuard(config: {\n  decorators: ({schema}: {schema: EditorSchema}) => Array<string>\n}): InputRuleGuard {\n  return ({snapshot, event}) => {\n    const decorators = config.decorators({schema: snapshot.context.schema})\n\n    if (decorators.length === 0) {\n      return true\n    }\n\n    const matchedSpans = event.matches.flatMap((match) =>\n      getSelectedSpans({\n        ...snapshot,\n        context: {\n          ...snapshot.context,\n          selection: match.selection,\n        },\n      }),\n    )\n\n    let preventInputRule = false\n\n    for (const decorator of decorators) {\n      if (isActiveDecorator(decorator)(snapshot)) {\n        preventInputRule = true\n        break\n      }\n\n      if (matchedSpans.some((span) => span.node.marks?.includes(decorator))) {\n        preventInputRule = true\n        break\n      }\n    }\n\n    return !preventInputRule\n  }\n}\n","import {\n  defineTextTransformRule,\n  type InputRule,\n} from '@portabletext/plugin-input-rule'\n\n/**\n * @public\n */\nexport const emDashRule = defineTextTransformRule({\n  on: /--/,\n  transform: () => '—',\n})\n\n/**\n * @public\n */\nexport const ellipsisRule = defineTextTransformRule({\n  on: /\\.\\.\\./,\n  transform: () => '…',\n})\n\n/**\n * @public\n */\nexport const openingDoubleQuoteRule = defineTextTransformRule({\n  on: /(?:^|(?<=[\\s{[(<'\"\\u2018\\u201C]))\"/g,\n  transform: () => '“',\n})\n\n/**\n * @public\n */\nexport const closingDoubleQuoteRule = defineTextTransformRule({\n  on: /\"/g,\n  transform: () => '”',\n})\n\n/**\n * @public\n */\nexport const openingSingleQuoteRule = defineTextTransformRule({\n  on: /(?:^|(?<=[\\s{[(<'\"\\u2018\\u201C]))'/g,\n  transform: () => '‘',\n})\n\n/**\n * @public\n */\nexport const closingSingleQuoteRule = defineTextTransformRule({\n  on: /'/g,\n  transform: () => '’',\n})\n\n/**\n * @public\n */\nexport const smartQuotesRules: Array<InputRule> = [\n  openingDoubleQuoteRule,\n  closingDoubleQuoteRule,\n  openingSingleQuoteRule,\n  closingSingleQuoteRule,\n]\n\n/**\n * @public\n */\nexport const leftArrowRule = defineTextTransformRule({\n  on: /<-/,\n  transform: () => '←',\n})\n\n/**\n * @public\n */\nexport const rightArrowRule = defineTextTransformRule({\n  on: /->/,\n  transform: () => '→',\n})\n\n/**\n * @public\n */\nexport const copyrightRule = defineTextTransformRule({\n  on: /\\(c\\)/,\n  transform: () => '©',\n})\n\n/**\n * @public\n */\nexport const servicemarkRule = defineTextTransformRule({\n  on: /\\(sm\\)/,\n  transform: () => '℠',\n})\n\n/**\n * @public\n */\nexport const trademarkRule = defineTextTransformRule({\n  on: /\\(tm\\)/,\n  transform: () => '™',\n})\n\n/**\n * @beta\n */\nexport const registeredTrademarkRule = defineTextTransformRule({\n  on: /\\(r\\)/,\n  transform: () => '®',\n})\n\n/**\n * @public\n */\nexport const oneHalfRule = defineTextTransformRule({\n  on: /(?:^|\\s)(1\\/2)\\s/,\n  transform: () => '½',\n})\n\n/**\n * @public\n */\nexport const plusMinusRule = defineTextTransformRule({\n  on: /\\+\\/-/,\n  transform: () => '±',\n})\n\n/**\n * @public\n */\nexport const notEqualRule = defineTextTransformRule({\n  on: /!=/,\n  transform: () => '≠',\n})\n\n/**\n * @public\n */\nexport const laquoRule = defineTextTransformRule({\n  on: /<</,\n  transform: () => '«',\n})\n\n/**\n * @public\n */\nexport const raquoRule = defineTextTransformRule({\n  on: />>/,\n  transform: () => '»',\n})\n\n/**\n * @public\n */\nexport const multiplicationRule = defineTextTransformRule({\n  on: /\\d+\\s?([*x])\\s?\\d+/,\n  transform: () => '×',\n})\n\n/**\n * @public\n */\nexport const superscriptTwoRule = defineTextTransformRule({\n  on: /\\^2/,\n  transform: () => '²',\n})\n\n/**\n * @public\n */\nexport const superscriptThreeRule = defineTextTransformRule({\n  on: /\\^3/,\n  transform: () => '³',\n})\n\n/**\n * @public\n */\nexport const oneQuarterRule = defineTextTransformRule({\n  on: /(?:^|\\s)(1\\/4)\\s/,\n  transform: () => '¼',\n})\n\n/**\n * @public\n */\nexport const threeQuartersRule = defineTextTransformRule({\n  on: /(?:^|\\s)(3\\/4)\\s/,\n  transform: () => '¾',\n})\n","import {\n  InputRulePlugin,\n  type InputRule,\n  type InputRuleGuard,\n} from '@portabletext/plugin-input-rule'\nimport {useMemo} from 'react'\nimport {\n  closingDoubleQuoteRule,\n  closingSingleQuoteRule,\n  copyrightRule,\n  ellipsisRule,\n  emDashRule,\n  laquoRule,\n  leftArrowRule,\n  multiplicationRule,\n  notEqualRule,\n  oneHalfRule,\n  oneQuarterRule,\n  openingDoubleQuoteRule,\n  openingSingleQuoteRule,\n  plusMinusRule,\n  raquoRule,\n  registeredTrademarkRule,\n  rightArrowRule,\n  servicemarkRule,\n  superscriptThreeRule,\n  superscriptTwoRule,\n  threeQuartersRule,\n  trademarkRule,\n} from './input-rules.typography'\n\n/**\n * @public\n */\nexport type TypographyPluginProps = {\n  guard?: InputRuleGuard\n  /**\n   * Configure which rules to enable or disable. Ordinary rules like `emDash` and `ellipsis` are enabled by default.\n   * Less common rules like `multiplication` are disabled by default.\n   */\n  rules?: {\n    /**\n     * @defaultValue 'on'\n     */\n    emDash?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    ellipsis?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    openingDoubleQuote?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    closingDoubleQuote?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    openingSingleQuote?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    closingSingleQuote?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    leftArrow?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    rightArrow?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    copyright?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    trademark?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    servicemark?: 'on' | 'off'\n    /**\n     * @defaultValue 'on'\n     */\n    registeredTrademark?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    oneHalf?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    plusMinus?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    notEqual?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    laquo?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    raquo?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    multiplication?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    superscriptTwo?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    superscriptThree?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    oneQuarter?: 'on' | 'off'\n    /**\n     * @defaultValue 'off'\n     */\n    threeQuarters?: 'on' | 'off'\n  }\n}\n\ntype RuleName = keyof NonNullable<TypographyPluginProps['rules']>\n\nconst defaultRuleConfig: Array<{\n  name: RuleName\n  rule: InputRule\n  state: 'on' | 'off'\n}> = [\n  {name: 'emDash', rule: emDashRule, state: 'on'},\n  {name: 'ellipsis', rule: ellipsisRule, state: 'on'},\n  {name: 'openingDoubleQuote', rule: openingDoubleQuoteRule, state: 'on'},\n  {name: 'closingDoubleQuote', rule: closingDoubleQuoteRule, state: 'on'},\n  {name: 'openingSingleQuote', rule: openingSingleQuoteRule, state: 'on'},\n  {name: 'closingSingleQuote', rule: closingSingleQuoteRule, state: 'on'},\n  {name: 'leftArrow', rule: leftArrowRule, state: 'on'},\n  {name: 'rightArrow', rule: rightArrowRule, state: 'on'},\n  {name: 'copyright', rule: copyrightRule, state: 'on'},\n  {name: 'trademark', rule: trademarkRule, state: 'on'},\n  {name: 'servicemark', rule: servicemarkRule, state: 'on'},\n  {name: 'registeredTrademark', rule: registeredTrademarkRule, state: 'on'},\n  {name: 'oneHalf', rule: oneHalfRule, state: 'off'},\n  {name: 'plusMinus', rule: plusMinusRule, state: 'off'},\n  {name: 'laquo', rule: laquoRule, state: 'off'},\n  {name: 'notEqual', rule: notEqualRule, state: 'off'},\n  {name: 'raquo', rule: raquoRule, state: 'off'},\n  {name: 'multiplication', rule: multiplicationRule, state: 'off'},\n  {name: 'superscriptTwo', rule: superscriptTwoRule, state: 'off'},\n  {name: 'superscriptThree', rule: superscriptThreeRule, state: 'off'},\n  {name: 'oneQuarter', rule: oneQuarterRule, state: 'off'},\n  {name: 'threeQuarters', rule: threeQuartersRule, state: 'off'},\n]\n\n/**\n * @public\n */\nexport function TypographyPlugin(props: TypographyPluginProps) {\n  const configuredInputRules = useMemo(\n    () =>\n      defaultRuleConfig.flatMap((rule) =>\n        props.rules && props.rules[rule.name] === 'on'\n          ? {...rule.rule, guard: props.guard ?? (() => true)}\n          : (props.rules && props.rules[rule.name] === 'off') ||\n              rule.state === 'off'\n            ? []\n            : {...rule.rule, guard: props.guard ?? (() => true)},\n      ),\n    [props.guard, props.rules],\n  )\n\n  return <InputRulePlugin {...props} rules={configuredInputRules} />\n}\n"],"names":["createDecoratorGuard","config","snapshot","event","decorators","schema","context","length","matchedSpans","matches","flatMap","match","getSelectedSpans","selection","preventInputRule","decorator","isActiveDecorator","some","span","node","marks","includes","emDashRule","defineTextTransformRule","on","transform","ellipsisRule","openingDoubleQuoteRule","closingDoubleQuoteRule","openingSingleQuoteRule","closingSingleQuoteRule","smartQuotesRules","leftArrowRule","rightArrowRule","copyrightRule","servicemarkRule","trademarkRule","registeredTrademarkRule","oneHalfRule","plusMinusRule","notEqualRule","laquoRule","raquoRule","multiplicationRule","superscriptTwoRule","superscriptThreeRule","oneQuarterRule","threeQuartersRule","defaultRuleConfig","name","rule","state","TypographyPlugin","props","$","_c","t0","guard","rules","_temp","_temp2","configuredInputRules","t1","jsx","InputRulePlugin"],"mappings":";;;AAqBO,SAASA,qBAAqBC,QAElB;AACjB,SAAO,CAAC;AAAA,IAACC;AAAAA,IAAUC;AAAAA,EAAAA,MAAW;AAC5B,UAAMC,aAAaH,OAAOG,WAAW;AAAA,MAACC,QAAQH,SAASI,QAAQD;AAAAA,IAAAA,CAAO;AAEtE,QAAID,WAAWG,WAAW;AACxB,aAAO;AAGT,UAAMC,eAAeL,MAAMM,QAAQC,QAASC,WAC1CC,2BAAiB;AAAA,MACf,GAAGV;AAAAA,MACHI,SAAS;AAAA,QACP,GAAGJ,SAASI;AAAAA,QACZO,WAAWF,MAAME;AAAAA,MAAAA;AAAAA,IACnB,CACD,CACH;AAEA,QAAIC,mBAAmB;AAEvB,eAAWC,aAAaX,YAAY;AAClC,UAAIY,4BAAkBD,SAAS,EAAEb,QAAQ,GAAG;AAC1CY,2BAAmB;AACnB;AAAA,MACF;AAEA,UAAIN,aAAaS,KAAMC,CAAAA,SAASA,KAAKC,KAAKC,OAAOC,SAASN,SAAS,CAAC,GAAG;AACrED,2BAAmB;AACnB;AAAA,MACF;AAAA,IACF;AAEA,WAAO,CAACA;AAAAA,EACV;AACF;ACjDO,MAAMQ,aAAaC,gBAAAA,wBAAwB;AAAA,EAChDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYC,eAAeH,wCAAwB;AAAA,EAClDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYE,yBAAyBJ,wCAAwB;AAAA,EAC5DC,IAAI,IAAA,OAAA,yCAAA,GAAqC;AAAA,EACzCC,WAAWA,MAAM;AACnB,CAAC,GAKYG,yBAAyBL,wCAAwB;AAAA,EAC5DC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYI,yBAAyBN,wCAAwB;AAAA,EAC5DC,IAAI,IAAA,OAAA,yCAAA,GAAqC;AAAA,EACzCC,WAAWA,MAAM;AACnB,CAAC,GAKYK,yBAAyBP,wCAAwB;AAAA,EAC5DC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYM,mBAAqC,CAChDJ,wBACAC,wBACAC,wBACAC,sBAAsB,GAMXE,gBAAgBT,wCAAwB;AAAA,EACnDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYQ,iBAAiBV,wCAAwB;AAAA,EACpDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYS,gBAAgBX,wCAAwB;AAAA,EACnDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYU,kBAAkBZ,wCAAwB;AAAA,EACrDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYW,gBAAgBb,wCAAwB;AAAA,EACnDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYY,0BAA0Bd,wCAAwB;AAAA,EAC7DC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYa,cAAcf,wCAAwB;AAAA,EACjDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYc,gBAAgBhB,wCAAwB;AAAA,EACnDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYe,eAAejB,wCAAwB;AAAA,EAClDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYgB,YAAYlB,wCAAwB;AAAA,EAC/CC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYiB,YAAYnB,wCAAwB;AAAA,EAC/CC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYkB,qBAAqBpB,wCAAwB;AAAA,EACxDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYmB,qBAAqBrB,wCAAwB;AAAA,EACxDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYoB,uBAAuBtB,wCAAwB;AAAA,EAC1DC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYqB,iBAAiBvB,wCAAwB;AAAA,EACpDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GAKYsB,oBAAoBxB,wCAAwB;AAAA,EACvDC,IAAI;AAAA,EACJC,WAAWA,MAAM;AACnB,CAAC,GCvDKuB,oBAID,CACH;AAAA,EAACC,MAAM;AAAA,EAAUC,MAAM5B;AAAAA,EAAY6B,OAAO;AAAI,GAC9C;AAAA,EAACF,MAAM;AAAA,EAAYC,MAAMxB;AAAAA,EAAcyB,OAAO;AAAI,GAClD;AAAA,EAACF,MAAM;AAAA,EAAsBC,MAAMvB;AAAAA,EAAwBwB,OAAO;AAAI,GACtE;AAAA,EAACF,MAAM;AAAA,EAAsBC,MAAMtB;AAAAA,EAAwBuB,OAAO;AAAI,GACtE;AAAA,EAACF,MAAM;AAAA,EAAsBC,MAAMrB;AAAAA,EAAwBsB,OAAO;AAAI,GACtE;AAAA,EAACF,MAAM;AAAA,EAAsBC,MAAMpB;AAAAA,EAAwBqB,OAAO;AAAI,GACtE;AAAA,EAACF,MAAM;AAAA,EAAaC,MAAMlB;AAAAA,EAAemB,OAAO;AAAI,GACpD;AAAA,EAACF,MAAM;AAAA,EAAcC,MAAMjB;AAAAA,EAAgBkB,OAAO;AAAI,GACtD;AAAA,EAACF,MAAM;AAAA,EAAaC,MAAMhB;AAAAA,EAAeiB,OAAO;AAAI,GACpD;AAAA,EAACF,MAAM;AAAA,EAAaC,MAAMd;AAAAA,EAAee,OAAO;AAAI,GACpD;AAAA,EAACF,MAAM;AAAA,EAAeC,MAAMf;AAAAA,EAAiBgB,OAAO;AAAI,GACxD;AAAA,EAACF,MAAM;AAAA,EAAuBC,MAAMb;AAAAA,EAAyBc,OAAO;AAAI,GACxE;AAAA,EAACF,MAAM;AAAA,EAAWC,MAAMZ;AAAAA,EAAaa,OAAO;AAAK,GACjD;AAAA,EAACF,MAAM;AAAA,EAAaC,MAAMX;AAAAA,EAAeY,OAAO;AAAK,GACrD;AAAA,EAACF,MAAM;AAAA,EAASC,MAAMT;AAAAA,EAAWU,OAAO;AAAK,GAC7C;AAAA,EAACF,MAAM;AAAA,EAAYC,MAAMV;AAAAA,EAAcW,OAAO;AAAK,GACnD;AAAA,EAACF,MAAM;AAAA,EAASC,MAAMR;AAAAA,EAAWS,OAAO;AAAK,GAC7C;AAAA,EAACF,MAAM;AAAA,EAAkBC,MAAMP;AAAAA,EAAoBQ,OAAO;AAAK,GAC/D;AAAA,EAACF,MAAM;AAAA,EAAkBC,MAAMN;AAAAA,EAAoBO,OAAO;AAAK,GAC/D;AAAA,EAACF,MAAM;AAAA,EAAoBC,MAAML;AAAAA,EAAsBM,OAAO;AAAK,GACnE;AAAA,EAACF,MAAM;AAAA,EAAcC,MAAMJ;AAAAA,EAAgBK,OAAO;AAAK,GACvD;AAAA,EAACF,MAAM;AAAA,EAAiBC,MAAMH;AAAAA,EAAmBI,OAAO;AAAK,CAAC;AAMzD,SAAAC,iBAAAC,OAAA;AAAA,QAAAC,IAAAC,gBAAAA,EAAA,CAAA;AAAA,MAAAC;AAAAF,IAAA,CAAA,MAAAD,MAAAI,SAAAH,EAAA,CAAA,MAAAD,MAAAK,SAGDF,KAAAR,kBAAAtC,QAAAwC,UACEG,MAAKK,SAAUL,MAAKK,MAAOR,KAAID,IAAA,MAAW,OAAI;AAAA,IAAA,GACtCC,KAAIA;AAAAA,IAAAO,OAAcJ,MAAKI,SAAAE;AAAAA,EAAAA,IAC1BN,MAAKK,SAAUL,MAAKK,MAAOR,KAAID,IAAA,MAAW,SACzCC,KAAIC,UAAW,QAAK,CAAA,IAAA;AAAA,IAAA,GAEhBD,KAAIA;AAAAA,IAAAO,OAAcJ,MAAKI,SAAAG;AAAAA,EAAAA,CACnC,GAACN,EAAA,CAAA,IAAAD,MAAAI,OAAAH,EAAA,CAAA,IAAAD,MAAAK,OAAAJ,OAAAE,MAAAA,KAAAF,EAAA,CAAA;AATL,QAAAO,uBAEIL;AASH,MAAAM;AAAA,SAAAR,EAAA,CAAA,MAAAO,wBAAAP,SAAAD,SAEMS,KAAAC,2BAAAA,IAACC,gBAAAA,iBAAA,EAAe,GAAKX,OAAcQ,OAAAA,qBAAAA,CAAoB,GAAIP,OAAAO,sBAAAP,OAAAD,OAAAC,OAAAQ,MAAAA,KAAAR,EAAA,CAAA,GAA3DQ;AAA2D;AAd7D,SAAAF,SAAA;AAAA,SAAA;AAAA;AAAA,SAAAD,QAAA;AAAA,SAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.cts

@@ -0,0 +1,246 @@
+import type {EditorSchema} from '@portabletext/editor'
+import {InputRule, InputRuleGuard} from '@portabletext/plugin-input-rule'
+import {JSX} from 'react'
+
+/**
+ * @public
+ */
+export declare const closingDoubleQuoteRule: InputRule
+
+/**
+ * @public
+ */
+export declare const closingSingleQuoteRule: InputRule
+
+/**
+ * @public
+ */
+export declare const copyrightRule: InputRule
+
+/**
+ * @public
+ * Create an `InputRuleGuard` that can prevent the rule from running inside
+ * certain decorators.
+ *
+ * @example
+ * ```tsx
+ * const guard = createDecoratorGuard({
+ *   decorators: ({schema}) => schema.decorators.flatMap((decorator) => decorator.name === 'code' ? [decorator.name] : []),
+ * })
+ *
+ * <TypographyPlugin guard={guard} />
+ * ```
+ */
+export declare function createDecoratorGuard(config: {
+  decorators: ({schema}: {schema: EditorSchema}) => Array<string>
+}): InputRuleGuard
+
+/**
+ * @public
+ */
+export declare const ellipsisRule: InputRule
+
+/**
+ * @public
+ */
+export declare const emDashRule: InputRule
+
+/**
+ * @public
+ */
+export declare const laquoRule: InputRule
+
+/**
+ * @public
+ */
+export declare const leftArrowRule: InputRule
+
+/**
+ * @public
+ */
+export declare const multiplicationRule: InputRule
+
+/**
+ * @public
+ */
+export declare const notEqualRule: InputRule
+
+/**
+ * @public
+ */
+export declare const oneHalfRule: InputRule
+
+/**
+ * @public
+ */
+export declare const oneQuarterRule: InputRule
+
+/**
+ * @public
+ */
+export declare const openingDoubleQuoteRule: InputRule
+
+/**
+ * @public
+ */
+export declare const openingSingleQuoteRule: InputRule
+
+/**
+ * @public
+ */
+export declare const plusMinusRule: InputRule
+
+/**
+ * @public
+ */
+export declare const raquoRule: InputRule
+
+/**
+ * @beta
+ */
+export declare const registeredTrademarkRule: InputRule
+
+/**
+ * @public
+ */
+export declare const rightArrowRule: InputRule
+
+/**
+ * @public
+ */
+export declare const servicemarkRule: InputRule
+
+/**
+ * @public
+ */
+export declare const smartQuotesRules: Array<InputRule>
+
+/**
+ * @public
+ */
+export declare const superscriptThreeRule: InputRule
+
+/**
+ * @public
+ */
+export declare const superscriptTwoRule: InputRule
+
+/**
+ * @public
+ */
+export declare const threeQuartersRule: InputRule
+
+/**
+ * @public
+ */
+export declare const trademarkRule: InputRule
+
+/**
+ * @public
+ */
+export declare function TypographyPlugin(
+  props: TypographyPluginProps,
+): JSX.Element
+
+/**
+ * @public
+ */
+export declare type TypographyPluginProps = {
+  guard?: InputRuleGuard
+  /**
+   * Configure which rules to enable or disable. Ordinary rules like `emDash` and `ellipsis` are enabled by default.
+   * Less common rules like `multiplication` are disabled by default.
+   */
+  rules?: {
+    /**
+     * @defaultValue 'on'
+     */
+    emDash?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    ellipsis?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    openingDoubleQuote?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    closingDoubleQuote?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    openingSingleQuote?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    closingSingleQuote?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    leftArrow?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    rightArrow?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    copyright?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    trademark?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    servicemark?: 'on' | 'off'
+    /**
+     * @defaultValue 'on'
+     */
+    registeredTrademark?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    oneHalf?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    plusMinus?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    notEqual?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    laquo?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    raquo?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    multiplication?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    superscriptTwo?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    superscriptThree?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    oneQuarter?: 'on' | 'off'
+    /**
+     * @defaultValue 'off'
+     */
+    threeQuarters?: 'on' | 'off'
+  }
+}
+
+export {}