@atlaskit/icon 22.24.3 → 22.25.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/icon
 
+## 22.25.0
+
+### Minor Changes
+
+- [#162725](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/162725)
+  [`b2449424247a3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/b2449424247a3) -
+  New deprecation endpoint to identify icons that have been deprecated. Used with the
+  `no-deprecated-imports` lint rule to assist with displaying errors and auto-fixing those icons
+  with a defined replacement.
+
 ## 22.24.3
 
 ### Patch Changes

package/build/index.tsx

@@ -7,6 +7,7 @@ import buildIcons, {
 	UNSAFE_buildNew as buildIconsNew,
 	createIconDocs,
 	type IconBuildConfig,
+	UNSAFE_createDeprecatedIconDocs,
 	UNSAFE_createIconDocsNew,
 	type UNSAFE_NewIconBuildConfig,
 } from '@af/icon-build-process';
@@ -75,7 +76,17 @@ buildIconsNew(configCore).then((icons) => {
 		migrationMap,
 	);
 
-	return fs.outputFile(path.resolve(root, 'src/metadata-core.tsx'), iconDocs);
+	fs.outputFile(path.resolve(root, 'src/metadata-core.tsx'), iconDocs);
+
+	const deprecatedDocs = UNSAFE_createDeprecatedIconDocs(
+		icons,
+		'@atlaskit/icon',
+		'core',
+		coreIconMetadata,
+		migrationMap,
+	);
+
+	fs.outputFile(path.resolve(root, 'src/deprecated-core.tsx'), deprecatedDocs);
 });
 
 /**
@@ -107,5 +118,15 @@ buildIconsNew(configUtility).then((icons) => {
 		migrationMap,
 	);
 
-	return fs.outputFile(path.resolve(root, 'src/metadata-utility.tsx'), iconDocs);
+	fs.outputFile(path.resolve(root, 'src/metadata-utility.tsx'), iconDocs);
+
+	const deprecatedDocs = UNSAFE_createDeprecatedIconDocs(
+		icons,
+		'@atlaskit/icon',
+		'utility',
+		utilityIconMetadata,
+		migrationMap,
+	);
+
+	fs.outputFile(path.resolve(root, 'src/deprecated-utility.tsx'), deprecatedDocs);
 });

package/deprecated-map/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/icon/deprecated-map",
+  "main": "../dist/cjs/entry-points/deprecated-map.js",
+  "module": "../dist/esm/entry-points/deprecated-map.js",
+  "module:es2019": "../dist/es2019/entry-points/deprecated-map.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../dist/types/entry-points/deprecated-map.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/entry-points/deprecated-map.d.ts"
+      ]
+    }
+  }
+}

package/dist/cjs/deprecated-core.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+var deprecatedIcons = {};
+var _default = exports.default = deprecatedIcons;

package/dist/cjs/deprecated-utility.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+var deprecatedIcons = {};
+var _default = exports.default = deprecatedIcons;

package/dist/cjs/entry-points/deprecated-map.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "deprecatedCore", {
+  enumerable: true,
+  get: function get() {
+    return _deprecatedCore.default;
+  }
+});
+Object.defineProperty(exports, "deprecatedUtility", {
+  enumerable: true,
+  get: function get() {
+    return _deprecatedUtility.default;
+  }
+});
+var _deprecatedCore = _interopRequireDefault(require("../deprecated-core"));
+var _deprecatedUtility = _interopRequireDefault(require("../deprecated-utility"));

package/dist/cjs/metadata-core.js

@@ -9,7 +9,7 @@ exports.default = void 0;
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::c4b8aee35aca4112c22d6141c23cd08f>>
+ * @codegen <<SignedSource::3e4b0e69c4beda61c98a08ff1b371463>>
  * @codegenCommand yarn build:icon-glyphs
  */
 

package/dist/cjs/metadata-utility.js

@@ -9,7 +9,7 @@ exports.default = void 0;
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::f026d0766e98fc87a4d6b2f4471f5379>>
+ * @codegen <<SignedSource::eae29e6af1dc94a7dd24d2f620ae9efc>>
  * @codegenCommand yarn build:icon-glyphs
  */
 

package/dist/es2019/deprecated-core.js

@@ -0,0 +1,10 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+const deprecatedIcons = {};
+export default deprecatedIcons;

package/dist/es2019/deprecated-utility.js

@@ -0,0 +1,10 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+const deprecatedIcons = {};
+export default deprecatedIcons;

package/dist/es2019/entry-points/deprecated-map.js

@@ -0,0 +1,2 @@
+export { default as deprecatedCore } from '../deprecated-core';
+export { default as deprecatedUtility } from '../deprecated-utility';

package/dist/es2019/metadata-core.js

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::c4b8aee35aca4112c22d6141c23cd08f>>
+ * @codegen <<SignedSource::3e4b0e69c4beda61c98a08ff1b371463>>
  * @codegenCommand yarn build:icon-glyphs
  */
 

package/dist/es2019/metadata-utility.js

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::f026d0766e98fc87a4d6b2f4471f5379>>
+ * @codegen <<SignedSource::eae29e6af1dc94a7dd24d2f620ae9efc>>
  * @codegenCommand yarn build:icon-glyphs
  */
 

package/dist/esm/deprecated-core.js

@@ -0,0 +1,10 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+var deprecatedIcons = {};
+export default deprecatedIcons;

package/dist/esm/deprecated-utility.js

@@ -0,0 +1,10 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+var deprecatedIcons = {};
+export default deprecatedIcons;

package/dist/esm/entry-points/deprecated-map.js

@@ -0,0 +1,2 @@
+export { default as deprecatedCore } from '../deprecated-core';
+export { default as deprecatedUtility } from '../deprecated-utility';

package/dist/esm/metadata-core.js

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::c4b8aee35aca4112c22d6141c23cd08f>>
+ * @codegen <<SignedSource::3e4b0e69c4beda61c98a08ff1b371463>>
  * @codegenCommand yarn build:icon-glyphs
  */
 

package/dist/esm/metadata-utility.js

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::f026d0766e98fc87a4d6b2f4471f5379>>
+ * @codegen <<SignedSource::eae29e6af1dc94a7dd24d2f620ae9efc>>
  * @codegenCommand yarn build:icon-glyphs
  */
 

package/dist/types/deprecated-core.d.ts

@@ -0,0 +1,13 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+declare const deprecatedIcons: Record<string, {
+    message: string;
+    unfixable?: boolean;
+}>;
+export default deprecatedIcons;

package/dist/types/deprecated-utility.d.ts

@@ -0,0 +1,13 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+declare const deprecatedIcons: Record<string, {
+    message: string;
+    unfixable?: boolean;
+}>;
+export default deprecatedIcons;

package/dist/types/entry-points/deprecated-map.d.ts

@@ -0,0 +1,2 @@
+export { default as deprecatedCore } from '../deprecated-core';
+export { default as deprecatedUtility } from '../deprecated-utility';

package/dist/types/metadata-core.d.ts

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::c4b8aee35aca4112c22d6141c23cd08f>>
+ * @codegen <<SignedSource::3e4b0e69c4beda61c98a08ff1b371463>>
  * @codegenCommand yarn build:icon-glyphs
  */
 interface metadata {
@@ -38,6 +38,10 @@ interface metadata {
      * The name of the team owning the icon
      */
     team: string;
+    /**
+     * The status of the icon
+     */
+    status?: 'draft' | 'ready-to-publish' | 'published' | 'modified' | 'deprecated';
     /**
      * Contact slack channel for the team owning the icon
      */
@@ -46,6 +50,14 @@ interface metadata {
      * A list of keys for old icons that have been replaced by this icon
      */
     oldName?: string[];
+    /**
+     * A replacement icon if this icon has been deprecated
+     */
+    replacement?: {
+        name: string;
+        type: 'core' | 'utility';
+        location: '@atlaskit/icon' | '@atlaskit/icon-lab' | '@atlassian/icon-private';
+    };
 }
 declare const metadata: Record<string, metadata>;
 export default metadata;

package/dist/types/metadata-utility.d.ts

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::f026d0766e98fc87a4d6b2f4471f5379>>
+ * @codegen <<SignedSource::eae29e6af1dc94a7dd24d2f620ae9efc>>
  * @codegenCommand yarn build:icon-glyphs
  */
 interface metadata {
@@ -38,6 +38,10 @@ interface metadata {
      * The name of the team owning the icon
      */
     team: string;
+    /**
+     * The status of the icon
+     */
+    status?: 'draft' | 'ready-to-publish' | 'published' | 'modified' | 'deprecated';
     /**
      * Contact slack channel for the team owning the icon
      */
@@ -46,6 +50,14 @@ interface metadata {
      * A list of keys for old icons that have been replaced by this icon
      */
     oldName?: string[];
+    /**
+     * A replacement icon if this icon has been deprecated
+     */
+    replacement?: {
+        name: string;
+        type: 'core' | 'utility';
+        location: '@atlaskit/icon' | '@atlaskit/icon-lab' | '@atlassian/icon-private';
+    };
 }
 declare const metadata: Record<string, metadata>;
 export default metadata;

package/dist/types-ts4.5/deprecated-core.d.ts

@@ -0,0 +1,13 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+declare const deprecatedIcons: Record<string, {
+    message: string;
+    unfixable?: boolean;
+}>;
+export default deprecatedIcons;

package/dist/types-ts4.5/deprecated-utility.d.ts

@@ -0,0 +1,13 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `UNSAFE_createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::bdbeb289627e24a55c8fe9daf29c6b55>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+declare const deprecatedIcons: Record<string, {
+    message: string;
+    unfixable?: boolean;
+}>;
+export default deprecatedIcons;

package/dist/types-ts4.5/entry-points/deprecated-map.d.ts

@@ -0,0 +1,2 @@
+export { default as deprecatedCore } from '../deprecated-core';
+export { default as deprecatedUtility } from '../deprecated-utility';

package/dist/types-ts4.5/metadata-core.d.ts

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::c4b8aee35aca4112c22d6141c23cd08f>>
+ * @codegen <<SignedSource::3e4b0e69c4beda61c98a08ff1b371463>>
  * @codegenCommand yarn build:icon-glyphs
  */
 interface metadata {
@@ -38,6 +38,10 @@ interface metadata {
      * The name of the team owning the icon
      */
     team: string;
+    /**
+     * The status of the icon
+     */
+    status?: 'draft' | 'ready-to-publish' | 'published' | 'modified' | 'deprecated';
     /**
      * Contact slack channel for the team owning the icon
      */
@@ -46,6 +50,14 @@ interface metadata {
      * A list of keys for old icons that have been replaced by this icon
      */
     oldName?: string[];
+    /**
+     * A replacement icon if this icon has been deprecated
+     */
+    replacement?: {
+        name: string;
+        type: 'core' | 'utility';
+        location: '@atlaskit/icon' | '@atlaskit/icon-lab' | '@atlassian/icon-private';
+    };
 }
 declare const metadata: Record<string, metadata>;
 export default metadata;

package/dist/types-ts4.5/metadata-utility.d.ts

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `UNSAFE_createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::f026d0766e98fc87a4d6b2f4471f5379>>
+ * @codegen <<SignedSource::eae29e6af1dc94a7dd24d2f620ae9efc>>
  * @codegenCommand yarn build:icon-glyphs
  */
 interface metadata {
@@ -38,6 +38,10 @@ interface metadata {
      * The name of the team owning the icon
      */
     team: string;
+    /**
+     * The status of the icon
+     */
+    status?: 'draft' | 'ready-to-publish' | 'published' | 'modified' | 'deprecated';
     /**
      * Contact slack channel for the team owning the icon
      */
@@ -46,6 +50,14 @@ interface metadata {
      * A list of keys for old icons that have been replaced by this icon
      */
     oldName?: string[];
+    /**
+     * A replacement icon if this icon has been deprecated
+     */
+    replacement?: {
+        name: string;
+        type: 'core' | 'utility';
+        location: '@atlaskit/icon' | '@atlaskit/icon-lab' | '@atlassian/icon-private';
+    };
 }
 declare const metadata: Record<string, metadata>;
 export default metadata;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/icon",
-	"version": "22.24.3",
+	"version": "22.25.0",
 	"description": "An icon is a visual representation of a command, device, directory, or common action.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -68,7 +68,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/platform-feature-flags": "^0.3.0",
-		"@atlaskit/tokens": "^2.2.0",
+		"@atlaskit/tokens": "^2.3.0",
 		"@babel/runtime": "^7.0.0",
 		"@emotion/react": "^11.7.1"
 	},
@@ -138,6 +138,7 @@
 		"./UNSAFE_base-new": "./src/entry-points/base-new.tsx",
 		"./UNSAFE_migration-map": "./src/entry-points/migration-map.tsx",
 		"./constants": "./src/entry-points/constants.tsx",
+		"./deprecated-map": "./src/entry-points/deprecated-map.tsx",
 		"./metadata": "./src/entry-points/metadata.tsx",
 		"./svg": "./src/entry-points/svg.tsx",
 		"./types": "./src/entry-points/types.tsx",