@atlaskit/icon-lab 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/icon-lab
 
+## 1.1.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.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.0.2
 
 ### Patch Changes

package/build/index.tsx

@@ -3,10 +3,14 @@ import path from 'path';
 import fs from 'fs-extra';
 import pkgDir from 'pkg-dir';
 
-import { UNSAFE_buildNew as buildIcons, UNSAFE_createIconDocsNew } from '@af/icon-build-process';
-import type { UNSAFE_NewIconBuildConfig } from '@af/icon-build-process';
-
-import iconMetadata from '../icons_raw/metadata-core';
+import {
+	UNSAFE_buildNew as buildIcons,
+	UNSAFE_createDeprecatedIconDocs,
+	UNSAFE_createIconDocsNew,
+	type UNSAFE_NewIconBuildConfig,
+} from '@af/icon-build-process';
+
+import coreIconMetadata from '../icons_raw/metadata-core';
 import migrationMap from '../src/migration-map';
 
 const root = pkgDir.sync();
@@ -28,7 +32,7 @@ const config: UNSAFE_NewIconBuildConfig = {
 	iconType: 'core',
 	packageName: '@atlaskit/icon-lab',
 	baseIconEntryPoint: '@atlaskit/icon/UNSAFE_base-new',
-	metadata: iconMetadata,
+	metadata: coreIconMetadata,
 	migrationMap: migrationMap,
 };
 
@@ -39,9 +43,19 @@ buildIcons(config).then((icons) => {
 		'core',
 		{},
 		['icon', 'icon-lab', 'core'],
-		iconMetadata,
+		coreIconMetadata,
+		migrationMap,
+	);
+
+	fs.outputFile(path.resolve(root, 'src/metadata-core.tsx'), iconDocs);
+
+	const deprecatedDocs = UNSAFE_createDeprecatedIconDocs(
+		icons,
+		'@atlaskit/icon-lab',
+		'core',
+		coreIconMetadata,
 		migrationMap,
 	);
 
-	return fs.outputFile(path.resolve(root, 'src/metadata-core.tsx'), iconDocs);
+	fs.outputFile(path.resolve(root, 'src/deprecated-core.tsx'), deprecatedDocs);
 });

package/deprecated-map/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/icon-lab/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/entry-points/deprecated-map.js

@@ -0,0 +1,13 @@
+"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;
+  }
+});
+var _deprecatedCore = _interopRequireDefault(require("../deprecated-core"));

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::fb64e80f33776bd1206895e95a86eaa6>>
+ * @codegen <<SignedSource::d67ababae6561c34c361bb99f053f31d>>
  * @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/entry-points/deprecated-map.js

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

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::fb64e80f33776bd1206895e95a86eaa6>>
+ * @codegen <<SignedSource::d67ababae6561c34c361bb99f053f31d>>
  * @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/entry-points/deprecated-map.js

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

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::fb64e80f33776bd1206895e95a86eaa6>>
+ * @codegen <<SignedSource::d67ababae6561c34c361bb99f053f31d>>
  * @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/entry-points/deprecated-map.d.ts

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

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::fb64e80f33776bd1206895e95a86eaa6>>
+ * @codegen <<SignedSource::d67ababae6561c34c361bb99f053f31d>>
  * @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/entry-points/deprecated-map.d.ts

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

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::fb64e80f33776bd1206895e95a86eaa6>>
+ * @codegen <<SignedSource::d67ababae6561c34c361bb99f053f31d>>
  * @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-lab",
-	"version": "1.0.2",
+	"version": "1.1.0",
 	"description": "An icon package for public icon contributions",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -32,7 +32,7 @@
 		"build-glyphs": "ts-node --project ../../../tsconfig.node.json ./build/index.tsx"
 	},
 	"dependencies": {
-		"@atlaskit/icon": "^22.24.0",
+		"@atlaskit/icon": "^22.25.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -82,6 +82,7 @@
 		}
 	},
 	"af:exports": {
+		"./deprecated-map": "./src/entry-points/deprecated-map.tsx",
 		"./metadata": "./src/entry-points/metadata.tsx",
 		"./UNSAFE_migration-map": "./src/migration-map.tsx",
 		"./core": "./core",