@tiptap/extension-gapcursor 3.0.0-next.3 → 3.0.0-next.4

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, Tiptap GmbH
+
+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

@@ -1,14 +1,18 @@
 # @tiptap/extension-gapcursor
+
 [![Version](https://img.shields.io/npm/v/@tiptap/extension-gapcursor.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-gapcursor)
 [![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-gapcursor.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
 [![License](https://img.shields.io/npm/l/@tiptap/extension-gapcursor.svg)](https://www.npmjs.com/package/@tiptap/extension-gapcursor)
 [![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
 
 ## Introduction
-Tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
+
+Tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as _New York Times_, _The Guardian_ or _Atlassian_.
 
 ## Official Documentation
+
 Documentation can be found on the [Tiptap website](https://tiptap.dev).
 
 ## License
+
 Tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md).

package/dist/index.cjs

@@ -18,38 +18,15 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  Gapcursor: () => Gapcursor,
-  default: () => src_default
+var index_exports = {};
+__export(index_exports, {
+  Gapcursor: () => import_extensions2.Gapcursor,
+  default: () => index_default
 });
-module.exports = __toCommonJS(src_exports);
-
-// src/gapcursor.ts
-var import_core = require("@tiptap/core");
-var import_gapcursor = require("@tiptap/pm/gapcursor");
-var Gapcursor = import_core.Extension.create({
-  name: "gapCursor",
-  addProseMirrorPlugins() {
-    return [
-      (0, import_gapcursor.gapCursor)()
-    ];
-  },
-  extendNodeSchema(extension) {
-    var _a;
-    const context = {
-      name: extension.name,
-      options: extension.options,
-      storage: extension.storage
-    };
-    return {
-      allowGapCursor: (_a = (0, import_core.callOrReturn)((0, import_core.getExtensionField)(extension, "allowGapCursor", context))) != null ? _a : null
-    };
-  }
-});
-
-// src/index.ts
-var src_default = Gapcursor;
+module.exports = __toCommonJS(index_exports);
+var import_extensions = require("@tiptap/extensions");
+var import_extensions2 = require("@tiptap/extensions");
+var index_default = import_extensions.Gapcursor;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Gapcursor

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/gapcursor.ts"],"sourcesContent":["import { Gapcursor } from './gapcursor.js'\n\nexport * from './gapcursor.js'\n\nexport default Gapcursor\n","import {\n  callOrReturn,\n  Extension,\n  getExtensionField,\n  ParentConfig,\n} from '@tiptap/core'\nimport { gapCursor } from '@tiptap/pm/gapcursor'\n\ndeclare module '@tiptap/core' {\n  interface NodeConfig<Options, Storage> {\n    /**\n     * A function to determine whether the gap cursor is allowed at the current position. Must return `true` or `false`.\n     * @default null\n     */\n    allowGapCursor?:\n      | boolean\n      | null\n      | ((this: {\n        name: string,\n        options: Options,\n        storage: Storage,\n        parent: ParentConfig<NodeConfig<Options>>['allowGapCursor'],\n      }) => boolean | null),\n  }\n}\n\n/**\n * This extension allows you to add a gap cursor to your editor.\n * A gap cursor is a cursor that appears when you click on a place\n * where no content is present, for example inbetween nodes.\n * @see https://tiptap.dev/api/extensions/gapcursor\n */\nexport const Gapcursor = Extension.create({\n  name: 'gapCursor',\n\n  addProseMirrorPlugins() {\n    return [\n      gapCursor(),\n    ]\n  },\n\n  extendNodeSchema(extension) {\n    const context = {\n      name: extension.name,\n      options: extension.options,\n      storage: extension.storage,\n    }\n\n    return {\n      allowGapCursor: callOrReturn(getExtensionField(extension, 'allowGapCursor', context)) ?? null,\n    }\n  },\n})\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAKO;AACP,uBAA0B;AA0BnB,IAAM,YAAY,sBAAU,OAAO;AAAA,EACxC,MAAM;AAAA,EAEN,wBAAwB;AACtB,WAAO;AAAA,UACL,4BAAU;AAAA,IACZ;AAAA,EACF;AAAA,EAEA,iBAAiB,WAAW;AAzC9B;AA0CI,UAAM,UAAU;AAAA,MACd,MAAM,UAAU;AAAA,MAChB,SAAS,UAAU;AAAA,MACnB,SAAS,UAAU;AAAA,IACrB;AAEA,WAAO;AAAA,MACL,iBAAgB,uCAAa,+BAAkB,WAAW,kBAAkB,OAAO,CAAC,MAApE,YAAyE;AAAA,IAC3F;AAAA,EACF;AACF,CAAC;;;ADhDD,IAAO,cAAQ;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { Gapcursor } from '@tiptap/extensions'\n\nexport { Gapcursor } from '@tiptap/extensions'\n\nexport default Gapcursor\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAA0B;AAE1B,IAAAA,qBAA0B;AAE1B,IAAO,gBAAQ;","names":["import_extensions"]}

package/dist/index.d.cts

@@ -1,25 +1,2 @@
-import { ParentConfig, Extension } from '@tiptap/core';
-
-declare module '@tiptap/core' {
-    interface NodeConfig<Options, Storage> {
-        /**
-         * A function to determine whether the gap cursor is allowed at the current position. Must return `true` or `false`.
-         * @default null
-         */
-        allowGapCursor?: boolean | null | ((this: {
-            name: string;
-            options: Options;
-            storage: Storage;
-            parent: ParentConfig<NodeConfig<Options>>['allowGapCursor'];
-        }) => boolean | null);
-    }
-}
-/**
- * This extension allows you to add a gap cursor to your editor.
- * A gap cursor is a cursor that appears when you click on a place
- * where no content is present, for example inbetween nodes.
- * @see https://tiptap.dev/api/extensions/gapcursor
- */
-declare const Gapcursor: Extension<any, any>;
-
-export { Gapcursor, Gapcursor as default };
+import { Gapcursor } from '@tiptap/extensions';
+export { Gapcursor, Gapcursor as default } from '@tiptap/extensions';

package/dist/index.d.ts

@@ -1,25 +1,2 @@
-import { ParentConfig, Extension } from '@tiptap/core';
-
-declare module '@tiptap/core' {
-    interface NodeConfig<Options, Storage> {
-        /**
-         * A function to determine whether the gap cursor is allowed at the current position. Must return `true` or `false`.
-         * @default null
-         */
-        allowGapCursor?: boolean | null | ((this: {
-            name: string;
-            options: Options;
-            storage: Storage;
-            parent: ParentConfig<NodeConfig<Options>>['allowGapCursor'];
-        }) => boolean | null);
-    }
-}
-/**
- * This extension allows you to add a gap cursor to your editor.
- * A gap cursor is a cursor that appears when you click on a place
- * where no content is present, for example inbetween nodes.
- * @see https://tiptap.dev/api/extensions/gapcursor
- */
-declare const Gapcursor: Extension<any, any>;
-
-export { Gapcursor, Gapcursor as default };
+import { Gapcursor } from '@tiptap/extensions';
+export { Gapcursor, Gapcursor as default } from '@tiptap/extensions';

package/dist/index.js

@@ -1,34 +1,9 @@
-// src/gapcursor.ts
-import {
-  callOrReturn,
-  Extension,
-  getExtensionField
-} from "@tiptap/core";
-import { gapCursor } from "@tiptap/pm/gapcursor";
-var Gapcursor = Extension.create({
-  name: "gapCursor",
-  addProseMirrorPlugins() {
-    return [
-      gapCursor()
-    ];
-  },
-  extendNodeSchema(extension) {
-    var _a;
-    const context = {
-      name: extension.name,
-      options: extension.options,
-      storage: extension.storage
-    };
-    return {
-      allowGapCursor: (_a = callOrReturn(getExtensionField(extension, "allowGapCursor", context))) != null ? _a : null
-    };
-  }
-});
-
 // src/index.ts
-var src_default = Gapcursor;
+import { Gapcursor } from "@tiptap/extensions";
+import { Gapcursor as Gapcursor2 } from "@tiptap/extensions";
+var index_default = Gapcursor;
 export {
-  Gapcursor,
-  src_default as default
+  Gapcursor2 as Gapcursor,
+  index_default as default
 };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/gapcursor.ts","../src/index.ts"],"sourcesContent":["import {\n  callOrReturn,\n  Extension,\n  getExtensionField,\n  ParentConfig,\n} from '@tiptap/core'\nimport { gapCursor } from '@tiptap/pm/gapcursor'\n\ndeclare module '@tiptap/core' {\n  interface NodeConfig<Options, Storage> {\n    /**\n     * A function to determine whether the gap cursor is allowed at the current position. Must return `true` or `false`.\n     * @default null\n     */\n    allowGapCursor?:\n      | boolean\n      | null\n      | ((this: {\n        name: string,\n        options: Options,\n        storage: Storage,\n        parent: ParentConfig<NodeConfig<Options>>['allowGapCursor'],\n      }) => boolean | null),\n  }\n}\n\n/**\n * This extension allows you to add a gap cursor to your editor.\n * A gap cursor is a cursor that appears when you click on a place\n * where no content is present, for example inbetween nodes.\n * @see https://tiptap.dev/api/extensions/gapcursor\n */\nexport const Gapcursor = Extension.create({\n  name: 'gapCursor',\n\n  addProseMirrorPlugins() {\n    return [\n      gapCursor(),\n    ]\n  },\n\n  extendNodeSchema(extension) {\n    const context = {\n      name: extension.name,\n      options: extension.options,\n      storage: extension.storage,\n    }\n\n    return {\n      allowGapCursor: callOrReturn(getExtensionField(extension, 'allowGapCursor', context)) ?? null,\n    }\n  },\n})\n","import { Gapcursor } from './gapcursor.js'\n\nexport * from './gapcursor.js'\n\nexport default Gapcursor\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AACP,SAAS,iBAAiB;AA0BnB,IAAM,YAAY,UAAU,OAAO;AAAA,EACxC,MAAM;AAAA,EAEN,wBAAwB;AACtB,WAAO;AAAA,MACL,UAAU;AAAA,IACZ;AAAA,EACF;AAAA,EAEA,iBAAiB,WAAW;AAzC9B;AA0CI,UAAM,UAAU;AAAA,MACd,MAAM,UAAU;AAAA,MAChB,SAAS,UAAU;AAAA,MACnB,SAAS,UAAU;AAAA,IACrB;AAEA,WAAO;AAAA,MACL,iBAAgB,kBAAa,kBAAkB,WAAW,kBAAkB,OAAO,CAAC,MAApE,YAAyE;AAAA,IAC3F;AAAA,EACF;AACF,CAAC;;;AChDD,IAAO,cAAQ;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { Gapcursor } from '@tiptap/extensions'\n\nexport { Gapcursor } from '@tiptap/extensions'\n\nexport default Gapcursor\n"],"mappings":";AAAA,SAAS,iBAAiB;AAE1B,SAAS,aAAAA,kBAAiB;AAE1B,IAAO,gBAAQ;","names":["Gapcursor"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/extension-gapcursor",
   "description": "gapcursor extension for tiptap",
-  "version": "3.0.0-next.3",
+  "version": "3.0.0-next.4",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -15,7 +15,10 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
+      },
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     }
@@ -28,12 +31,10 @@
     "dist"
   ],
   "devDependencies": {
-    "@tiptap/core": "^3.0.0-next.3",
-    "@tiptap/pm": "^3.0.0-next.3"
+    "@tiptap/extensions": "^3.0.0-next.4"
   },
   "peerDependencies": {
-    "@tiptap/core": "^3.0.0-next.1",
-    "@tiptap/pm": "^3.0.0-next.1"
+    "@tiptap/extensions": "^3.0.0-next.3"
   },
   "repository": {
     "type": "git",
@@ -41,6 +42,7 @@
     "directory": "packages/extension-gapcursor"
   },
   "scripts": {
-    "build": "tsup"
+    "build": "tsup",
+    "lint": "prettier ./src/ --check && eslint --cache --quiet --no-error-on-unmatched-pattern ./src/"
   }
-}
+}

package/src/index.ts

@@ -1,5 +1,5 @@
-import { Gapcursor } from './gapcursor.js'
+import { Gapcursor } from '@tiptap/extensions'
 
-export * from './gapcursor.js'
+export { Gapcursor } from '@tiptap/extensions'
 
 export default Gapcursor

package/src/gapcursor.ts

@@ -1,53 +0,0 @@
-import {
-  callOrReturn,
-  Extension,
-  getExtensionField,
-  ParentConfig,
-} from '@tiptap/core'
-import { gapCursor } from '@tiptap/pm/gapcursor'
-
-declare module '@tiptap/core' {
-  interface NodeConfig<Options, Storage> {
-    /**
-     * A function to determine whether the gap cursor is allowed at the current position. Must return `true` or `false`.
-     * @default null
-     */
-    allowGapCursor?:
-      | boolean
-      | null
-      | ((this: {
-        name: string,
-        options: Options,
-        storage: Storage,
-        parent: ParentConfig<NodeConfig<Options>>['allowGapCursor'],
-      }) => boolean | null),
-  }
-}
-
-/**
- * This extension allows you to add a gap cursor to your editor.
- * A gap cursor is a cursor that appears when you click on a place
- * where no content is present, for example inbetween nodes.
- * @see https://tiptap.dev/api/extensions/gapcursor
- */
-export const Gapcursor = Extension.create({
-  name: 'gapCursor',
-
-  addProseMirrorPlugins() {
-    return [
-      gapCursor(),
-    ]
-  },
-
-  extendNodeSchema(extension) {
-    const context = {
-      name: extension.name,
-      options: extension.options,
-      storage: extension.storage,
-    }
-
-    return {
-      allowGapCursor: callOrReturn(getExtensionField(extension, 'allowGapCursor', context)) ?? null,
-    }
-  },
-})