@atlaskit/adf-utils 19.13.2 → 19.14.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/adf-utils
 
+## 19.14.0
+
+### Minor Changes
+
+- [#169499](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/169499)
+  [`7d83c833bbcb1`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/7d83c833bbcb1) -
+  Remove v16->v17 codemod, and associated jscodeshift/codemod-utils dependencies.
+
 ## 19.13.2
 
 ### Patch Changes

package/afm-cc/tsconfig.json

@@ -16,9 +16,5 @@
         "../src/**/*.test.*",
         "../src/**/test.*"
     ],
-    "references": [
-        {
-            "path": "../../../monorepo-tooling/codemod-utils/afm-cc/tsconfig.json"
-        }
-    ]
+    "references": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/adf-utils",
-	"version": "19.13.2",
+	"version": "19.14.0",
 	"description": "Set of utilities to traverse, modify and create ADF documents.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -37,12 +37,10 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^46.1.0",
-		"@atlaskit/codemod-utils": "^4.2.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"devDependencies": {
 		"@atlassian/adf-schema-json": "^1.22.0",
-		"jscodeshift": "^0.13.0",
 		"react": "^16.8.0",
 		"typescript": "~5.4.2",
 		"wait-for-expect": "^1.2.0"

package/codemods/17.0.0-update-imports-to-new-entry-points.ts

@@ -1,166 +0,0 @@
-import { createTransformer } from '@atlaskit/codemod-utils';
-import { createMigratesFromEntryPointChangeRequests } from './helpers/entry-points';
-import type { EntryPointChangeRequest } from './types/entry-points';
-
-const DEFAULT_ADF_UTILS_IMPORT = '@atlaskit/adf-utils';
-
-const types: EntryPointChangeRequest = {
-	importSpecifiers: ['ADFEntity', 'ADFEntityMark', 'Visitor', 'VisitorCollection'],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/types`,
-	shouldBeTypeImport: true,
-};
-
-const validatorTypes: EntryPointChangeRequest = {
-	importSpecifiers: [
-		'Content',
-		'ErrorCallback',
-		'Output',
-		'ValidationError',
-		'ValidationErrorMap',
-		'ValidationErrorType',
-		'ValidationMode',
-		'ValidationOptions',
-		'ErrorCallbackOptions',
-		'Validate',
-		'NodeValidationResult',
-		'ValidatorSpec',
-		'AttributesSpec',
-		'ValidatorContent',
-		'MarkValidationResult',
-		'SpecValidatorResult',
-		'Err',
-	],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT, `${DEFAULT_ADF_UTILS_IMPORT}/validator`],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/validatorTypes`,
-	shouldBeTypeImport: true,
-};
-
-const transforms: EntryPointChangeRequest = {
-	importSpecifiers: [
-		'transformMediaLinkMarks',
-		'transformTextLinkCodeMarks',
-		'transformDedupeMarks',
-		'transformNodesMissingContent',
-		'transformIndentationMarks',
-	],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/transforms`,
-	shouldBeTypeImport: false,
-};
-
-const traverse: EntryPointChangeRequest = {
-	importSpecifiers: ['traverse', 'map', 'reduce', 'filter'],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/traverse`,
-	shouldBeTypeImport: false,
-};
-
-const builders: EntryPointChangeRequest = {
-	importSpecifiers: [
-		'a',
-		'alignment',
-		'b',
-		'blockCard',
-		'blockQuote',
-		'bodiedExtension',
-		'br',
-		'breakout',
-		'bulletList',
-		'code',
-		'codeBlock',
-		'date',
-		'decisionItem',
-		'decisionList',
-		'doc',
-		'em',
-		'embedCard',
-		'emoji',
-		'expand',
-		'extension',
-		'hardBreak',
-		'heading',
-		'hr',
-		'indentation',
-		'inlineCard',
-		'inlineExtension',
-		'layoutColumn',
-		'layoutSection',
-		'li',
-		'link',
-		'listItem',
-		'media',
-		'mediaGroup',
-		'mediaSingle',
-		'mention',
-		'nestedExpand',
-		'ol',
-		'orderedList',
-		'p',
-		'panel',
-		'paragraph',
-		'placeholder',
-		'rule',
-		'status',
-		'strike',
-		'strong',
-		'subsup',
-		'table',
-		'tableCell',
-		'tableHeader',
-		'tableRow',
-		'taskItem',
-		'taskList',
-		'td',
-		'text',
-		'textColor',
-		'th',
-		'tr',
-		'u',
-		'ul',
-		'underline',
-		'dataConsumer',
-	],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/builders`,
-	shouldBeTypeImport: false,
-};
-
-const emptyAdf: EntryPointChangeRequest = {
-	importSpecifiers: ['getEmptyADF'],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/empty-adf`,
-	shouldBeTypeImport: false,
-};
-
-const validator: EntryPointChangeRequest = {
-	importSpecifiers: ['validator', 'validateAttrs'],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/validator`,
-	shouldBeTypeImport: false,
-};
-
-const scrub: EntryPointChangeRequest = {
-	importSpecifiers: ['scrubAdf'],
-	oldEntryPointsToRemove: [DEFAULT_ADF_UTILS_IMPORT],
-	newEntryPoint: `${DEFAULT_ADF_UTILS_IMPORT}/scrub`,
-	shouldBeTypeImport: false,
-};
-
-const entryPointChangeRequests: EntryPointChangeRequest[] = [
-	transforms,
-	validatorTypes,
-	types,
-	traverse,
-	builders,
-	validator,
-	emptyAdf,
-	scrub,
-];
-
-export const entryPointChangeMigrates =
-	createMigratesFromEntryPointChangeRequests(entryPointChangeRequests);
-
-const transformer = createTransformer(entryPointChangeMigrates);
-
-export default transformer;

package/codemods/__tests__/next-update-imports-to-new-entry-points.ts

@@ -1,175 +0,0 @@
-import transformer from '../17.0.0-update-imports-to-new-entry-points';
-
-const defineInlineTest = require('jscodeshift/dist/testUtils').defineInlineTest;
-
-describe('updates adf-util imports to new child entry points', () => {
-	defineInlineTest(
-		{ default: transformer, parser: 'tsx' },
-		{},
-		`
-    import { traverse } from "@atlaskit/adf-utils";
-    import { ADFEntity, ADFEntityMark } from "@atlaskit/adf-utils";
-    import { validateAttrs, validator, ValidationErrorMap } from '@atlaskit/adf-utils';
-    import type { NodeValidationResult } from '@atlaskit/adf-utils';
-    import { type ValidationMode } from '@atlaskit/adf-utils';
-
-    export default () => (
-      <div>
-        hello
-      </div>
-    );
-    `,
-		`
-    import type { ValidationErrorMap, ValidationMode, NodeValidationResult } from "@atlaskit/adf-utils/validatorTypes";
-    import type { ADFEntity, ADFEntityMark } from "@atlaskit/adf-utils/types";
-    import { traverse } from "@atlaskit/adf-utils/traverse";
-    import { validator, validateAttrs } from "@atlaskit/adf-utils/validator";
-
-    export default () => (
-      <div>
-        hello
-      </div>
-    );
-    `,
-		'should handle migrating any combination of old entry points (including type imports and imports with type modifiers) to new child entry points',
-	);
-
-	defineInlineTest(
-		{ default: transformer, parser: 'tsx' },
-		{},
-		`
-    import { traverse, teamRocketAndMeowth, scrubAdf } from "@atlaskit/adf-utils";
-    import { Pokemon, ADFEntityMark, AshKetchum } from "@atlaskit/adf-utils";
-    import type { PsyDuck } from "@atlaskit/adf-utils/pokemon-types";
-    import Boogeyman from "@deep/the-mariana-trench";
-
-    export default () => (
-      <div>
-        hello
-      </div>
-    );
-    `,
-		`
-    import type { ADFEntityMark } from "@atlaskit/adf-utils/types";
-    import { traverse } from "@atlaskit/adf-utils/traverse";
-    import { scrubAdf } from "@atlaskit/adf-utils/scrub";
-    import { teamRocketAndMeowth } from "@atlaskit/adf-utils";
-    import { Pokemon, AshKetchum } from "@atlaskit/adf-utils";
-    import type { PsyDuck } from "@atlaskit/adf-utils/pokemon-types";
-    import Boogeyman from "@deep/the-mariana-trench";
-
-    export default () => (
-      <div>
-        hello
-      </div>
-    );
-    `,
-		'should leave unknown entry points or import specifiers untouched (and unmerged if initially unmerged)',
-	);
-
-	defineInlineTest(
-		{ default: transformer, parser: 'tsx' },
-		{},
-		`
-    import { VisitorCollection } from "@atlaskit/adf-utils/types";
-    import type { Visitor } from "@atlaskit/adf-utils";
-
-    export default () => (
-      <div>
-        hello
-      </div>
-    );
-    `,
-		`
-    import type { VisitorCollection, Visitor } from "@atlaskit/adf-utils/types";
-
-    export default () => (
-      <div>
-        hello
-      </div>
-    );
-    `,
-		'should handle migrating new child entry points with mismatched importKinds (e.g. non-type when should be type import)',
-	);
-
-	defineInlineTest(
-		{ default: transformer, parser: 'tsx' },
-		{},
-		`
-      import { scrubAdf, doc, p, link } from "@atlaskit/adf-utils";
-      import { blockCard, paragraph } from "@atlaskit/adf-utils/builders";
-      import { placeholder, transformDedupeMarks } from "@atlaskit/adf-utils";
-      import { VisitorCollection } from "@atlaskit/adf-utils/types";
-      import type { Visitor } from "@atlaskit/adf-utils";
-      import { getEmptyADF } from "@atlaskit/adf-utils";
-
-      export default () => (
-        <div>
-          hello
-        </div>
-      );
-      `,
-		`
-      import { transformDedupeMarks } from "@atlaskit/adf-utils/transforms";
-      import { getEmptyADF } from "@atlaskit/adf-utils/empty-adf";
-      import { scrubAdf } from "@atlaskit/adf-utils/scrub";
-      import { blockCard, paragraph, doc, link, p, placeholder } from "@atlaskit/adf-utils/builders";
-      import type { VisitorCollection, Visitor } from "@atlaskit/adf-utils/types";
-
-      export default () => (
-        <div>
-          hello
-        </div>
-      );
-      `,
-		'should handle migrating any combination of old and new entry points to new child entry points',
-	);
-
-	defineInlineTest(
-		{ default: transformer, parser: 'tsx' },
-		{},
-		`
-    const { scrubAdf } = require("@atlaskit/adf-utils");
-    import * as adfUtils from "@atlaskit/adf-utils";
-
-    export default () => {
-        if (shouldFetchModule) {
-            import("@atlaskit/adf-utils").then(module => ({
-                something: "else"
-            }));
-            import("@atlaskit/adf-utils/traverse").then(module => {
-                const traverse = module.traverse;
-                traverse();
-            });
-        }
-        return (
-            <div>
-                hello
-            </div>
-        )
-      }
-    `,
-		`
-    const { scrubAdf } = require("@atlaskit/adf-utils");
-    import * as adfUtils from "@atlaskit/adf-utils";
-
-    export default () => {
-        if (shouldFetchModule) {
-            import("@atlaskit/adf-utils").then(module => ({
-                something: "else"
-            }));
-            import("@atlaskit/adf-utils/traverse").then(module => {
-                const traverse = module.traverse;
-                traverse();
-            });
-        }
-        return (
-            <div>
-                hello
-            </div>
-        )
-      }
-    `,
-		'should skip migrating other import syntaxes (namespace imports, CJS, dyamic imports)',
-	);
-});

package/codemods/helpers/entry-points.ts

@@ -1,25 +0,0 @@
-import { changeImportEntryPoint } from '@atlaskit/codemod-utils';
-import type { EntryPointChangeRequest, EntryPointChangeMigrates } from '../types/entry-points';
-
-export const createMigratesFromEntryPointChangeRequests = (
-	changeRequests: EntryPointChangeRequest[],
-) => {
-	const entryPointChangeMigrates: EntryPointChangeMigrates = [];
-	changeRequests.forEach(
-		({ importSpecifiers, oldEntryPointsToRemove, newEntryPoint, shouldBeTypeImport }) => {
-			oldEntryPointsToRemove.forEach((oldEntryPoint) => {
-				importSpecifiers.forEach((importSpecifier) => {
-					entryPointChangeMigrates.push(
-						changeImportEntryPoint(
-							oldEntryPoint,
-							importSpecifier,
-							newEntryPoint,
-							shouldBeTypeImport,
-						),
-					);
-				});
-			});
-		},
-	);
-	return entryPointChangeMigrates;
-};

package/codemods/types/entry-points.ts

@@ -1,12 +0,0 @@
-import type { changeImportEntryPoint } from '@atlaskit/codemod-utils';
-
-export type EntryPointChangeRequest = {
-	importSpecifiers: string[];
-	oldEntryPointsToRemove: string[];
-	newEntryPoint: string;
-	shouldBeTypeImport: boolean;
-};
-
-export type EntryPointChange = ReturnType<typeof changeImportEntryPoint>;
-
-export type EntryPointChangeMigrates = EntryPointChange[];