@atlaskit/icon-lab 4.12.1 → 4.13.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/icon-lab
 
+## 4.13.0
+
+### Minor Changes
+
+- [#149822](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/149822)
+  [`f9ab0e846ae21`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f9ab0e846ae21) -
+  Updated to support `size` prop for new icons from `@atlaskit/icon`.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 4.12.1
 
 ### Patch Changes

package/build/index.tsx

@@ -4,7 +4,7 @@ import fs from 'fs-extra';
 import pkgDir from 'pkg-dir';
 
 import {
-	buildNew as buildIcons,
+	buildNew as buildIconsNew,
 	createDeprecatedIconDocs,
 	createIconDocsNew,
 	createVRTest,
@@ -12,62 +12,129 @@ import {
 } from '@af/icon-build-process';
 
 import coreIconMetadata from '../icons_raw/metadata-core';
+import utilityIconMetadata from '../icons_raw/metadata-utility';
 import migrationMap from '../src/migration-map';
 
-const root = pkgDir.sync();
+async function main() {
+	const root = pkgDir.sync();
 
-if (!root) {
-	throw new Error('Root directory was not found');
+	if (!root) {
+		throw new Error('Root directory was not found');
+	}
+
+	/**
+	 * The updated icon build process for the new icons under `@atlaskit/icon/core/*`
+	 */
+	const configCore: NewIconBuildConfig = {
+		srcDir: path.resolve(root, 'icons_raw/core'),
+		processedDir: path.resolve(root, 'svgs/core'),
+		destDir: path.resolve(root, 'core'),
+		maxWidth: 24,
+		maxHeight: 24,
+		glob: '**/*.svg',
+		iconType: 'core',
+		packageName: '@atlaskit/icon-lab',
+		baseIconEntryPoint: '@atlaskit/icon/base-new',
+		metadata: coreIconMetadata,
+		migrationMap: migrationMap,
+	};
+
+	await buildIconsNew(configCore).then((icons) => {
+		const iconDocs = createIconDocsNew(
+			icons,
+			'@atlaskit/icon-lab',
+			'core',
+			{},
+			['icon', 'icon-lab', 'core'],
+			coreIconMetadata,
+			migrationMap,
+		);
+
+		fs.outputFile(path.resolve(root, 'src/metadata-core.tsx'), iconDocs);
+
+		const deprecatedDocs = createDeprecatedIconDocs(
+			icons,
+			'@atlaskit/icon-lab',
+			'core',
+			coreIconMetadata,
+			migrationMap,
+		);
+
+		fs.outputFile(path.resolve(root, 'src/deprecated-core.tsx'), deprecatedDocs);
+
+		// Generate VR tests
+		const [vrExampleCore, vrTestCore] = createVRTest(coreIconMetadata, '../../../..', 20, 'core');
+		fs.outputFile(
+			path.resolve(root, 'src/__tests__/vr-tests/examples/all-core-icons.tsx'),
+			vrExampleCore,
+		);
+		fs.outputFile(
+			path.resolve(root, 'src/__tests__/vr-tests/all-core-icons.test.vr.tsx'),
+			vrTestCore,
+		);
+	});
+
+	/**
+	 * The updated icon build process for the new icons under `@atlaskit/icon/core/*`
+	 */
+	const configUtility: NewIconBuildConfig = {
+		srcDir: path.resolve(root, 'icons_raw/utility'),
+		processedDir: path.resolve(root, 'svgs/utility'),
+		destDir: path.resolve(root, 'utility'),
+		maxWidth: 24,
+		maxHeight: 24,
+		glob: '**/*.svg',
+		iconType: 'utility',
+		packageName: '@atlaskit/icon-lab',
+		baseIconEntryPoint: '@atlaskit/icon/base-new',
+		metadata: utilityIconMetadata,
+		migrationMap: migrationMap,
+	};
+
+	await buildIconsNew(configUtility).then((icons) => {
+		const iconDocs = createIconDocsNew(
+			icons,
+			'@atlaskit/icon-lab',
+			'utility',
+			{},
+			['icon', 'icon-lab', 'utility'],
+			utilityIconMetadata,
+			migrationMap,
+		);
+
+		fs.outputFile(path.resolve(root, 'src/metadata-utility.tsx'), iconDocs);
+
+		const deprecatedDocs = createDeprecatedIconDocs(
+			icons,
+			'@atlaskit/icon-lab',
+			'utility',
+			utilityIconMetadata,
+			migrationMap,
+		);
+
+		fs.outputFile(path.resolve(root, 'src/deprecated-utility.tsx'), deprecatedDocs);
+
+		// Generate VR tests
+		if (Object.entries(utilityIconMetadata).length > 0) {
+			const [vrExampleUtility, vrTestUtility] = createVRTest(
+				utilityIconMetadata,
+				'../../../..',
+				20,
+				'utility',
+			);
+			fs.outputFile(
+				path.resolve(root, 'src/__tests__/vr-tests/examples/all-utility-icons.tsx'),
+				vrExampleUtility,
+			);
+			fs.outputFile(
+				path.resolve(root, 'src/__tests__/vr-tests/all-utility-icons.test.vr.tsx'),
+				vrTestUtility,
+			);
+		}
+	});
 }
 
-/**
- * The updated icon build process for the new icons under `@atlaskit/icon/core/*`
- */
-const config: NewIconBuildConfig = {
-	srcDir: path.resolve(root, 'icons_raw/core'),
-	processedDir: path.resolve(root, 'svgs/core'),
-	destDir: path.resolve(root, 'core'),
-	maxWidth: 24,
-	maxHeight: 24,
-	glob: '**/*.svg',
-	iconType: 'core',
-	packageName: '@atlaskit/icon-lab',
-	baseIconEntryPoint: '@atlaskit/icon/base-new',
-	metadata: coreIconMetadata,
-	migrationMap: migrationMap,
-};
-
-buildIcons(config).then((icons) => {
-	const iconDocs = createIconDocsNew(
-		icons,
-		'@atlaskit/icon-lab',
-		'core',
-		{},
-		['icon', 'icon-lab', 'core'],
-		coreIconMetadata,
-		migrationMap,
-	);
-
-	fs.outputFile(path.resolve(root, 'src/metadata-core.tsx'), iconDocs);
-
-	const deprecatedDocs = createDeprecatedIconDocs(
-		icons,
-		'@atlaskit/icon-lab',
-		'core',
-		coreIconMetadata,
-		migrationMap,
-	);
-
-	fs.outputFile(path.resolve(root, 'src/deprecated-core.tsx'), deprecatedDocs);
-
-	// Generate VR tests
-	const [vrExampleCore, vrTestCore] = createVRTest(coreIconMetadata, '../../../..', 20, 'core');
-	fs.outputFile(
-		path.resolve(root, 'src/__tests__/vr-tests/examples/all-core-icons.tsx'),
-		vrExampleCore,
-	);
-	fs.outputFile(
-		path.resolve(root, 'src/__tests__/vr-tests/all-core-icons.test.vr.tsx'),
-		vrTestCore,
-	);
+main().catch((error) => {
+	console.error(error);
+	process.exit(1);
 });

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 `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::8445ed95dffea52ddea417fc5752ff90>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+var deprecatedIcons = {};
+var _default = exports.default = deprecatedIcons;

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

@@ -10,4 +10,11 @@ Object.defineProperty(exports, "deprecatedCore", {
     return _deprecatedCore.default;
   }
 });
-var _deprecatedCore = _interopRequireDefault(require("../deprecated-core"));
+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-utility.js

@@ -0,0 +1,17 @@
+"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 `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::541c2012ded80fd7b8bb50e7c15e9333>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+
+var metadata = {};
+var _default = exports.default = metadata;

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 `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::8445ed95dffea52ddea417fc5752ff90>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+const deprecatedIcons = {};
+export default deprecatedIcons;

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

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

package/dist/es2019/metadata-utility.js

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

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 `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::8445ed95dffea52ddea417fc5752ff90>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+var deprecatedIcons = {};
+export default deprecatedIcons;

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

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

package/dist/esm/metadata-utility.js

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

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 `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::8445ed95dffea52ddea417fc5752ff90>>
+ * @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

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

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

@@ -0,0 +1,63 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::541c2012ded80fd7b8bb50e7c15e9333>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+interface metadata {
+    /**
+     * Default component name for the icon
+     */
+    componentName: string;
+    /**
+     * Package path to the icon component
+     */
+    package: string;
+    /**
+     * The category of the icon:
+     * - 'single-purpose' icons should only be used for the purposes listed in the 'usage' field
+     * - 'multi-purpose' icons are designed for various use cases and don't have the same usage restrictions
+     * - 'utility' icons are used for utility purposes
+     */
+    categorization: 'single-purpose' | 'multi-purpose' | 'utility';
+    /**
+     * The type of the icon - either a 16px 'core' icon, or a 12px 'utility' icon
+     */
+    type: 'core' | 'utility';
+    /**
+     * Usage guidelines for the icon. For single-purpose icons,
+     */
+    usage?: string;
+    /**
+     * Additional keywords used to assist in search/lookup of an icon
+     */
+    keywords: string[];
+    /**
+     * 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
+     */
+    slackChannel?: string;
+    /**
+     * 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-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 `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::8445ed95dffea52ddea417fc5752ff90>>
+ * @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

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

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

@@ -0,0 +1,63 @@
+/**
+ * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
+ *
+ * To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
+ *
+ * @codegen <<SignedSource::541c2012ded80fd7b8bb50e7c15e9333>>
+ * @codegenCommand yarn build:icon-glyphs
+ */
+interface metadata {
+    /**
+     * Default component name for the icon
+     */
+    componentName: string;
+    /**
+     * Package path to the icon component
+     */
+    package: string;
+    /**
+     * The category of the icon:
+     * - 'single-purpose' icons should only be used for the purposes listed in the 'usage' field
+     * - 'multi-purpose' icons are designed for various use cases and don't have the same usage restrictions
+     * - 'utility' icons are used for utility purposes
+     */
+    categorization: 'single-purpose' | 'multi-purpose' | 'utility';
+    /**
+     * The type of the icon - either a 16px 'core' icon, or a 12px 'utility' icon
+     */
+    type: 'core' | 'utility';
+    /**
+     * Usage guidelines for the icon. For single-purpose icons,
+     */
+    usage?: string;
+    /**
+     * Additional keywords used to assist in search/lookup of an icon
+     */
+    keywords: string[];
+    /**
+     * 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
+     */
+    slackChannel?: string;
+    /**
+     * 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": "4.12.1",
+	"version": "4.13.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": "^26.0.0",
+		"@atlaskit/icon": "^26.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
@@ -41,14 +41,14 @@
 	"devDependencies": {
 		"@af/icon-build-process": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/button": "^23.0.0",
-		"@atlaskit/code": "^17.1.0",
+		"@atlaskit/button": "^23.1.0",
+		"@atlaskit/code": "^17.2.0",
 		"@atlaskit/ds-lib": "^4.0.0",
 		"@atlaskit/heading": "^5.2.0",
-		"@atlaskit/modal-dialog": "^14.1.0",
+		"@atlaskit/modal-dialog": "^14.2.0",
 		"@atlaskit/primitives": "^14.7.0",
 		"@atlaskit/textfield": "^8.0.0",
-		"@atlaskit/tokens": "^4.8.0",
+		"@atlaskit/tokens": "^4.9.0",
 		"@atlaskit/tooltip": "^20.0.0",
 		"@atlassian/ssr-tests": "^0.2.0",
 		"@compiled/react": "^0.18.3",