@atlaskit/prosemirror-input-rules 3.4.0 → 3.4.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/prosemirror-input-rules
 
+## 3.4.1
+
+### Patch Changes
+
+- [`098cfbb01dc36`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/098cfbb01dc36) -
+  Add missing npmignore files to remove unnecessary files from published package
+
 ## 3.4.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/prosemirror-input-rules",
-	"version": "3.4.0",
+	"version": "3.4.1",
 	"description": "A package that contains helpers to create autoformatting rules for ProseMirror",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -31,7 +31,7 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"devDependencies": {
-		"@atlaskit/editor-common": "^107.17.0"
+		"@atlaskit/editor-common": "^107.28.0"
 	},
 	"techstack": {
 		"@atlassian/frontend": {

package/afm-cc/tsconfig.json

@@ -1,26 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.confluence.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"composite": true,
-		"outDir": "../../../../../confluence/tsDist/@atlaskit__prosemirror-input-rules",
-		"rootDir": "../"
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": []
-}

package/afm-dev-agents/tsconfig.json

@@ -1,26 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.dev-agents.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../dev-agents/tsDist/@atlaskit__prosemirror-input-rules/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": []
-}

package/afm-jira/tsconfig.json

@@ -1,26 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.jira.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../tsDist/@atlaskit__prosemirror-input-rules/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": []
-}

package/afm-post-office/tsconfig.json

@@ -1,26 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.post-office.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../post-office/tsDist/@atlaskit__prosemirror-input-rules/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": []
-}

package/afm-rovo-extension/tsconfig.json

@@ -1,26 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.rovo-extension.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../rovo-extension/tsDist/@atlaskit__prosemirror-input-rules/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": []
-}

package/afm-townsquare/tsconfig.json

@@ -1,26 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.townsquare.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../townsquare/tsDist/@atlaskit__prosemirror-input-rules/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": []
-}

package/afm-volt/tsconfig.json

@@ -1,20 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.volt.json",
-	"compilerOptions": {
-		"declaration": true,
-		"target": "es5",
-		"outDir": "../../../../../volt/tsDist/@atlaskit__prosemirror-input-rules/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*"
-	],
-	"references": []
-}

package/build/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "declaration": true,
-    "target": "es5",
-    "paths": {}
-  },
-  "include": [
-    "../src/**/*.ts",
-    "../src/**/*.tsx"
-  ],
-  "exclude": [
-    "../src/**/__tests__/*",
-    "../src/**/*.test.*",
-    "../src/**/test.*",
-    "../src/**/examples.*",
-    "../src/**/examples/*",
-    "../src/**/examples/**/*",
-    "../src/**/*.stories.*",
-    "../src/**/stories/*",
-    "../src/**/stories/**/*"
-  ]
-}

package/src/__tests__/unit/handler.ts

@@ -1,390 +0,0 @@
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
-import { EditorState, PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { EditorView } from '@atlaskit/editor-prosemirror/view';
-// eslint-disable-next-line import/no-extraneous-dependencies -- Removed import for fixing circular dependencies
-import { createEditorState } from '@atlaskit/editor-test-helpers/create-editor-state';
-// eslint-disable-next-line import/no-extraneous-dependencies -- Removed import for fixing circular dependencies
-import { code_block, doc, p } from '@atlaskit/editor-test-helpers/doc-builder';
-
-import type { InputRuleWrapper } from '../../editor-common';
-import { createInputEventHandler } from '../../handler';
-import type { HandleInputEvent } from '../../types';
-
-describe('input-tule/handles/createInputEventHandler', () => {
-	let inputEvent: HandleInputEvent;
-	let editorView: EditorView;
-	let dispatchSpy: jest.SpyInstance<void, [Transaction]>;
-	let rules: InputRuleWrapper[] = [];
-	let initialEditorState: EditorState;
-	let RULE_BEFORE: InputRuleWrapper;
-
-	type FROM_TYPE = number;
-	type TO_TYPE = number;
-	let ruleHandlerMock: jest.Mock<
-		Transaction | null,
-		[EditorState, RegExpExecArray, FROM_TYPE, TO_TYPE]
-	>;
-
-	const pluginKey = new PluginKey('lol');
-	const TEXT_INSERTED = 'a';
-
-	beforeEach(() => {
-		initialEditorState = createEditorState(doc(p('before{<>}')));
-		editorView = new EditorView(null, {
-			state: initialEditorState,
-		});
-
-		dispatchSpy = jest.spyOn(editorView, 'dispatch');
-
-		ruleHandlerMock = jest.fn().mockImplementation((state) => {
-			return state.tr;
-		});
-
-		RULE_BEFORE = {
-			// Ignored via go/ees005
-			// eslint-disable-next-line require-unicode-regexp
-			match: /^(before).*/,
-			handler: ruleHandlerMock,
-		};
-	});
-
-	afterEach(() => {
-		dispatchSpy.mockReset();
-		rules = [];
-	});
-
-	describe('when selection is inside of code node', () => {
-		let inputHandleResult: boolean;
-		beforeEach(() => {
-			const newEditorState = createEditorState(doc(code_block()('before{<>}')));
-			editorView = new EditorView(null, {
-				state: newEditorState,
-			});
-
-			dispatchSpy = jest.spyOn(editorView, 'dispatch');
-
-			const {
-				selection: { from, to },
-			} = newEditorState;
-
-			inputEvent = createInputEventHandler({
-				rules,
-				pluginKey,
-				allowInsertTextOnDocument: true,
-			});
-
-			inputHandleResult = inputEvent({
-				view: editorView,
-				from,
-				to,
-				text: TEXT_INSERTED,
-			});
-		});
-
-		it('should return false', () => {
-			expect(inputHandleResult).toBeFalsy();
-		});
-
-		it('should not call the editorView dispatch function', () => {
-			expect(dispatchSpy).not.toHaveBeenCalled();
-		});
-	});
-
-	describe('when there is no rule match', () => {
-		let inputHandleResult: boolean;
-		beforeEach(() => {
-			const RULE_AFTER = {
-				// Ignored via go/ees005
-				// eslint-disable-next-line require-unicode-regexp
-				match: /^(after).*/,
-				handler: jest.fn().mockImplementation((state) => {
-					return state.tr;
-				}),
-			};
-
-			rules = [RULE_AFTER];
-
-			const {
-				selection: { from, to },
-			} = initialEditorState;
-
-			inputEvent = createInputEventHandler({
-				rules,
-				pluginKey,
-				allowInsertTextOnDocument: true,
-			});
-
-			inputHandleResult = inputEvent({
-				view: editorView,
-				from,
-				to,
-				text: TEXT_INSERTED,
-			});
-		});
-
-		it('should return false', () => {
-			expect(inputHandleResult).toBeFalsy();
-		});
-
-		it('should not call the editorView dispatch function', () => {
-			expect(dispatchSpy).not.toHaveBeenCalled();
-		});
-	});
-
-	describe('when there is rule match', () => {
-		beforeEach(() => {
-			rules = [RULE_BEFORE];
-		});
-
-		describe.each([true, false])(
-			'and when allowInsertTextOnDocument is %s',
-			(allowInsertTextOnDocument) => {
-				beforeEach(() => {
-					const {
-						selection: { from, to },
-					} = initialEditorState;
-
-					inputEvent = createInputEventHandler({
-						rules,
-						pluginKey,
-						allowInsertTextOnDocument,
-					});
-
-					inputEvent({
-						view: editorView,
-						from,
-						to,
-						text: TEXT_INSERTED,
-					});
-				});
-
-				it('should call the dispatch function', () => {
-					expect(editorView.dispatch).toHaveBeenCalled();
-				});
-
-				it('should call the rule handler function', () => {
-					expect(RULE_BEFORE.handler).toHaveBeenCalled();
-				});
-
-				it('should add the InputRulePluginState inside of the transaction', () => {
-					const tr = dispatchSpy.mock.calls[0][0];
-
-					expect(tr.getMeta(pluginKey)).toBeDefined();
-				});
-
-				it('should fill InputRulePluginState', () => {
-					const tr = dispatchSpy.mock.calls[0][0];
-
-					expect(tr.getMeta(pluginKey)).toEqual({
-						from: 1,
-						to: 7,
-						textInserted: TEXT_INSERTED,
-						matchedRule: {
-							...RULE_BEFORE,
-							result: expect.any(Array),
-						},
-					});
-				});
-
-				it('should return true', () => {
-					const {
-						selection: { from, to },
-					} = initialEditorState;
-
-					inputEvent = createInputEventHandler({
-						rules,
-						pluginKey,
-						allowInsertTextOnDocument: true,
-					});
-
-					const result = inputEvent({
-						view: editorView,
-						from,
-						to,
-						text: TEXT_INSERTED,
-					});
-
-					expect(result).toBeTruthy();
-				});
-
-				it('should call the rule handler with the from position calculated', () => {
-					const handlerArgs = ruleHandlerMock.mock.calls[0];
-					const fromArg: number = handlerArgs[2];
-
-					expect(fromArg).toBe(1);
-				});
-
-				describe('when onBeforeRegexMatch is given', () => {
-					let onBeforeRegexMatchMock: jest.Mock;
-
-					beforeEach(() => {
-						onBeforeRegexMatchMock = jest.fn();
-						const {
-							selection: { from, to },
-						} = initialEditorState;
-
-						inputEvent = createInputEventHandler({
-							rules,
-							pluginKey,
-							allowInsertTextOnDocument,
-							onBeforeRegexMatch: onBeforeRegexMatchMock,
-						});
-
-						inputEvent({
-							view: editorView,
-							from,
-							to,
-							text: TEXT_INSERTED,
-						});
-					});
-
-					it('should be called', () => {
-						expect(onBeforeRegexMatchMock).toHaveBeenCalled();
-					});
-				});
-
-				describe('and when onInputEvent return false', () => {
-					let inputHandleResult: boolean;
-					let onInputEventMock: jest.Mock;
-
-					beforeEach(() => {
-						dispatchSpy.mockReset();
-						onInputEventMock = jest.fn().mockReturnValue(false);
-
-						const {
-							selection: { from, to },
-						} = initialEditorState;
-
-						inputEvent = createInputEventHandler({
-							rules,
-							pluginKey,
-							allowInsertTextOnDocument,
-							onInputEvent: onInputEventMock,
-						});
-
-						inputHandleResult = inputEvent({
-							view: editorView,
-							from,
-							to,
-							text: TEXT_INSERTED,
-						});
-					});
-
-					it('should return false', () => {
-						expect(inputHandleResult).toBeFalsy();
-					});
-
-					it('should call onInputEvent', () => {
-						expect(onInputEventMock).toHaveBeenCalled();
-					});
-
-					it('should not call the editorView dispatch function', () => {
-						expect(dispatchSpy).not.toHaveBeenCalled();
-					});
-				});
-			},
-		);
-
-		describe('and when allowInsertTextOnDocument is true', () => {
-			beforeEach(() => {
-				const {
-					selection: { from, to },
-				} = editorView.state;
-
-				inputEvent = createInputEventHandler({
-					rules,
-					pluginKey,
-					allowInsertTextOnDocument: true,
-				});
-
-				inputEvent({
-					view: editorView,
-					from,
-					to,
-					text: TEXT_INSERTED,
-				});
-			});
-
-			it('should dispatch a transaction with the text inserted', () => {
-				const tr = dispatchSpy.mock.calls[0][0];
-
-				const { doc: docExpected } = createEditorState(doc(p(`before${TEXT_INSERTED}`)));
-
-				expect(tr.doc.toJSON()).toEqual(docExpected.toJSON());
-			});
-
-			it('should call the rule handler with the original document', () => {
-				const handlerArgs = ruleHandlerMock.mock.calls[0];
-				const nextEditorState: EditorState = handlerArgs[0];
-
-				const { doc: docExpected } = createEditorState(doc(p(`before`)));
-
-				expect(nextEditorState.doc.toJSON()).toEqual(docExpected.toJSON());
-			});
-
-			it('should call the rule handler with the same to position', () => {
-				const handlerArgs = ruleHandlerMock.mock.calls[0];
-				const {
-					selection: { to },
-				} = initialEditorState;
-
-				expect(handlerArgs).toEqual([
-					expect.any(EditorState),
-					expect.any(Array),
-					expect.any(Number),
-					to,
-				]);
-			});
-		});
-
-		describe('and when allowInsertTextOnDocument is false', () => {
-			beforeEach(() => {
-				const {
-					selection: { from, to },
-				} = editorView.state;
-
-				inputEvent = createInputEventHandler({
-					rules,
-					pluginKey,
-					allowInsertTextOnDocument: false,
-				});
-
-				inputEvent({
-					view: editorView,
-					from,
-					to,
-					text: TEXT_INSERTED,
-				});
-			});
-
-			it('should call the rule handler using the current editor state', () => {
-				const handlerArgs = ruleHandlerMock.mock.calls[0];
-				const nextEditorState: EditorState = handlerArgs[0];
-
-				expect(nextEditorState).toBe(initialEditorState);
-			});
-
-			it('should call the rule handler without the text length at the end position', () => {
-				const handlerArgs = ruleHandlerMock.mock.calls[0];
-				const {
-					selection: { to },
-				} = initialEditorState;
-
-				expect(handlerArgs).toEqual([
-					expect.any(EditorState),
-					expect.any(Array),
-					expect.any(Number),
-					to,
-				]);
-			});
-
-			it('should dispatch a transaction without', () => {
-				const tr = dispatchSpy.mock.calls[0][0];
-
-				const { doc: docExpected } = createEditorState(doc(p(`before`)));
-
-				expect(tr.doc.toJSON()).toEqual(docExpected.toJSON());
-			});
-		});
-	});
-});