@atlaskit/icon 33.0.2 → 33.1.1

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/icon
 
+## 33.1.1
+
+### Patch Changes
+
+- [`af37f7d87df51`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/af37f7d87df51) -
+  Deprecate `spacing` prop on icon components via JSDoc `@deprecated` annotation, and update ADS
+  website docs (Icon > Examples, Icon > Usage) to reflect the deprecation with migration guidance.
+
+## 33.1.0
+
+### Minor Changes
+
+- [`0daada0469ab8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0daada0469ab8) -
+  Remove `@atlaskit/icon/migration-map` entry point, `IconMigrationMap` and
+  `IconMigrationSizeGuidance` types from `@atlaskit/icon`, and `@atlaskit/icon-lab/migration-map`
+  entry point. These were only needed to support the legacy glyph icon migration path which has now
+  been fully completed. Remove the `no-legacy-icons` ESLint rule from
+  `@atlaskit/eslint-plugin-design-system` as `@atlaskit/icon/glyph` and
+  `@atlaskit/icon/core/migration` no longer exist.
+
 ## 33.0.2
 
 ### Patch Changes

package/build/index.tsx

@@ -49,11 +49,7 @@ async function main() {
 
 		fs.outputFile(path.resolve(root, 'src/metadata-core.tsx'), iconDocs);
 
-		const deprecatedDocs = createDeprecatedIconDocs(
-			icons,
-			'@atlaskit/icon',
-			coreIconMetadata,
-		);
+		const deprecatedDocs = createDeprecatedIconDocs(icons, '@atlaskit/icon', coreIconMetadata);
 
 		fs.outputFile(path.resolve(root, 'src/deprecated-core.tsx'), deprecatedDocs);
 	});

package/dist/cjs/components/icon-new.js

@@ -12,8 +12,7 @@ var React = _react;
 var _runtime = require("@compiled/react/runtime");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 /**
- * We are hiding this props from consumers as it's reserved
- * for use by Icon Tile.
+ * We are hiding this props from consumers as it's reserved for use by Icon Tile.
  */
 
 var svgStyles = null;

package/dist/es2019/components/icon-new.js

@@ -5,8 +5,7 @@ import { ax, ix } from "@compiled/react/runtime";
 import { memo } from 'react';
 
 /**
- * We are hiding this props from consumers as it's reserved
- * for use by Icon Tile.
+ * We are hiding this props from consumers as it's reserved for use by Icon Tile.
  */
 
 const svgStyles = null;

package/dist/esm/components/icon-new.js

@@ -5,8 +5,7 @@ import { ax, ix } from "@compiled/react/runtime";
 import { memo } from 'react';
 
 /**
- * We are hiding this props from consumers as it's reserved
- * for use by Icon Tile.
+ * We are hiding this props from consumers as it's reserved for use by Icon Tile.
  */
 
 var svgStyles = null;

package/dist/types/components/icon-new.d.ts

@@ -1,7 +1,6 @@
 import type { UNSAFE_NewGlyphProps } from '../types';
 /**
- * We are hiding this props from consumers as it's reserved
- * for use by Icon Tile.
+ * We are hiding this props from consumers as it's reserved for use by Icon Tile.
  */
 export type InternalIconPropsNew = UNSAFE_NewGlyphProps & {
     /**

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

@@ -1 +1 @@
-export type { CustomGlyphProps, GlyphProps, IconProps, Size, SkeletonProps, SVGProps, NewIconProps, NewGlyphColorProps, NewCoreIconProps, IconMigrationMap, IconSpacing, IconSize, IconTileProps, } from '../types';
+export type { CustomGlyphProps, GlyphProps, IconProps, Size, SkeletonProps, SVGProps, NewIconProps, NewGlyphColorProps, NewCoreIconProps, IconSpacing, IconSize, IconTileProps, } from '../types';

package/dist/types/index.d.ts

@@ -4,4 +4,4 @@ export { default as SVG } from './components/svg';
 export { sizeMap as size, sizes } from './constants';
 export { default as Skeleton } from './components/skeleton';
 export { default as IconTile } from './components/icon-tile';
-export type { Size, IconSize, SkeletonProps, IconProps, GlyphProps, CustomGlyphProps, SVGProps, NewIconProps, NewCoreIconProps, IconMigrationMap, IconTileProps, } from './types';
+export type { Size, IconSize, SkeletonProps, IconProps, GlyphProps, CustomGlyphProps, SVGProps, NewIconProps, NewCoreIconProps, IconTileProps, } from './types';

package/dist/types/types.d.ts

@@ -51,10 +51,7 @@ interface GlyphSizeProps {
 }
 interface NewCoreGlyphSpacingProps {
     /**
-     * Core Icons can be displayed with additional spacing.
-     * - `none` is default, and allows the icon to be placed in buttons and allows the parent component to manage spacing.
-     * - `compact` provides accessible compact spacing between the icon and other elements. **Only available for small icons.**
-     * - `spacious` provides accessible spacing between the icon and other elements.
+     * @deprecated Use a `Flex` wrapper with `cssMap` padding tokens instead. Migrate with the `32.0.2-icon-spacing-to-flex-primitive` codemod in `npx @atlaskit/codemod-cli`, or the `no-icon-spacing-prop` ESLint rule.
      */
     spacing?: IconSpacing;
 }
@@ -205,40 +202,6 @@ export interface SVGProps extends GlyphProps {
      */
     children?: ReactNode;
 }
-/**
- * The migration outcome for a given legacy icon
- */
-type IconMigrationResult = {
-    /**
-     * The recommended new icon that the legacy icon should be migrated to
-     */
-    newIcon?: {
-        name: string;
-        package: string;
-        isMigrationUnsafe?: boolean;
-        /**
-         * Forces the new icon to be `size="small"`, even if the legacy icon was not a small icon.
-         *
-         * E.g. used for chevron icons.
-         */
-        shouldForceSmallIcon?: boolean;
-    };
-    /**
-     * Alternative new icon that the legacy icon can be migrated to
-     * Primarily used to maintain migration guidance for icons that have since had a
-     * change to the recommended migration path in "newIcon"
-     */
-    additionalIcons?: {
-        name: string;
-        package: string;
-    }[];
-    /**
-     * For each size the legacy icon can take, the per-size migration guidance
-     */
-    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
-};
-export type IconMigrationSizeGuidance = '16-icon-tile' | '24-icon-tile' | '32-icon-tile' | '48-icon-tile' | 'swap' | 'swap-slight-visual-change' | 'swap-visual-change' | 'product-icon' | 'not-recommended' | 'icon-tile' | 'top-nav' | 'icon-lab' | 'no-larger-size';
-export type IconMigrationMap = Record<string, IconMigrationResult>;
 interface LEGACY_Data {
     keywords: string[];
     componentName: string;

package/dist/types-ts4.5/components/icon-new.d.ts

@@ -1,7 +1,6 @@
 import type { UNSAFE_NewGlyphProps } from '../types';
 /**
- * We are hiding this props from consumers as it's reserved
- * for use by Icon Tile.
+ * We are hiding this props from consumers as it's reserved for use by Icon Tile.
  */
 export type InternalIconPropsNew = UNSAFE_NewGlyphProps & {
     /**

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

@@ -1 +1 @@
-export type { CustomGlyphProps, GlyphProps, IconProps, Size, SkeletonProps, SVGProps, NewIconProps, NewGlyphColorProps, NewCoreIconProps, IconMigrationMap, IconSpacing, IconSize, IconTileProps, } from '../types';
+export type { CustomGlyphProps, GlyphProps, IconProps, Size, SkeletonProps, SVGProps, NewIconProps, NewGlyphColorProps, NewCoreIconProps, IconSpacing, IconSize, IconTileProps, } from '../types';

package/dist/types-ts4.5/index.d.ts

@@ -4,4 +4,4 @@ export { default as SVG } from './components/svg';
 export { sizeMap as size, sizes } from './constants';
 export { default as Skeleton } from './components/skeleton';
 export { default as IconTile } from './components/icon-tile';
-export type { Size, IconSize, SkeletonProps, IconProps, GlyphProps, CustomGlyphProps, SVGProps, NewIconProps, NewCoreIconProps, IconMigrationMap, IconTileProps, } from './types';
+export type { Size, IconSize, SkeletonProps, IconProps, GlyphProps, CustomGlyphProps, SVGProps, NewIconProps, NewCoreIconProps, IconTileProps, } from './types';

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

@@ -51,10 +51,7 @@ interface GlyphSizeProps {
 }
 interface NewCoreGlyphSpacingProps {
     /**
-     * Core Icons can be displayed with additional spacing.
-     * - `none` is default, and allows the icon to be placed in buttons and allows the parent component to manage spacing.
-     * - `compact` provides accessible compact spacing between the icon and other elements. **Only available for small icons.**
-     * - `spacious` provides accessible spacing between the icon and other elements.
+     * @deprecated Use a `Flex` wrapper with `cssMap` padding tokens instead. Migrate with the `32.0.2-icon-spacing-to-flex-primitive` codemod in `npx @atlaskit/codemod-cli`, or the `no-icon-spacing-prop` ESLint rule.
      */
     spacing?: IconSpacing;
 }
@@ -205,40 +202,6 @@ export interface SVGProps extends GlyphProps {
      */
     children?: ReactNode;
 }
-/**
- * The migration outcome for a given legacy icon
- */
-type IconMigrationResult = {
-    /**
-     * The recommended new icon that the legacy icon should be migrated to
-     */
-    newIcon?: {
-        name: string;
-        package: string;
-        isMigrationUnsafe?: boolean;
-        /**
-         * Forces the new icon to be `size="small"`, even if the legacy icon was not a small icon.
-         *
-         * E.g. used for chevron icons.
-         */
-        shouldForceSmallIcon?: boolean;
-    };
-    /**
-     * Alternative new icon that the legacy icon can be migrated to
-     * Primarily used to maintain migration guidance for icons that have since had a
-     * change to the recommended migration path in "newIcon"
-     */
-    additionalIcons?: {
-        name: string;
-        package: string;
-    }[];
-    /**
-     * For each size the legacy icon can take, the per-size migration guidance
-     */
-    sizeGuidance: Record<Size, IconMigrationSizeGuidance>;
-};
-export type IconMigrationSizeGuidance = '16-icon-tile' | '24-icon-tile' | '32-icon-tile' | '48-icon-tile' | 'swap' | 'swap-slight-visual-change' | 'swap-visual-change' | 'product-icon' | 'not-recommended' | 'icon-tile' | 'top-nav' | 'icon-lab' | 'no-larger-size';
-export type IconMigrationMap = Record<string, IconMigrationResult>;
 interface LEGACY_Data {
     keywords: string[];
     componentName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/icon",
-	"version": "33.0.2",
+	"version": "33.1.1",
 	"description": "An icon is a symbol representing a command, device, directory, or common action.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -36,7 +36,7 @@
 	"dependencies": {
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/tile": "^1.0.0",
-		"@atlaskit/tokens": "^11.2.0",
+		"@atlaskit/tokens": "^11.4.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0"
 	},
@@ -59,8 +59,8 @@
 		"@atlaskit/link": "^3.3.0",
 		"@atlaskit/logo": "^19.10.0",
 		"@atlaskit/menu": "^8.4.0",
-		"@atlaskit/modal-dialog": "^14.12.0",
-		"@atlaskit/primitives": "^18.0.0",
+		"@atlaskit/modal-dialog": "^14.13.0",
+		"@atlaskit/primitives": "^18.1.0",
 		"@atlaskit/section-message": "^8.12.0",
 		"@atlaskit/textfield": "^8.2.0",
 		"@atlaskit/theme": "^22.0.0",

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

@@ -1,20 +0,0 @@
-"use strict";
-
-var _typeof = require("@babel/runtime/helpers/typeof");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "default", {
-  enumerable: true,
-  get: function get() {
-    return _migrationMap.default;
-  }
-});
-Object.defineProperty(exports, "migrationOutcomeDescriptionMap", {
-  enumerable: true,
-  get: function get() {
-    return _migrationMap.migrationOutcomeDescriptionMap;
-  }
-});
-var _migrationMap = _interopRequireWildcard(require("../migration-map"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }