@atlaskit/logo 15.2.1 → 15.2.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/logo
 
+## 15.2.2
+
+### Patch Changes
+
+- [#112549](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/112549)
+  [`ed68a8d2ee5f7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ed68a8d2ee5f7) -
+  Update dependencies and remove unused exports and codemods.
+
 ## 15.2.1
 
 ### Patch Changes

package/dist/types/types.d.ts

@@ -1,5 +1,5 @@
-export type Appearance = 'brand' | 'neutral' | 'inverse';
-export type Size = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
+type Appearance = 'brand' | 'neutral' | 'inverse';
+type Size = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
 export type LogoProps = {
     /**
      * The size of the icon, uses the same sizing scheme as in `@atlaskit/icon`.

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

@@ -1,5 +1,5 @@
-export type Appearance = 'brand' | 'neutral' | 'inverse';
-export type Size = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
+type Appearance = 'brand' | 'neutral' | 'inverse';
+type Size = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
 export type LogoProps = {
     /**
      * The size of the icon, uses the same sizing scheme as in `@atlaskit/icon`.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/logo",
-	"version": "15.2.1",
+	"version": "15.2.2",
 	"description": "A logo is a visual representation of a brand or product. It can be a word or an image, or a combination of both.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -37,8 +37,16 @@
 	"devDependencies": {
 		"@af/accessibility-testing": "*",
 		"@af/integration-testing": "*",
+		"@af/visual-regression": "*",
+		"@atlaskit/code": "^15.7.1",
+		"@atlaskit/docs": "*",
+		"@atlaskit/form": "^11.1.1",
+		"@atlaskit/link": "*",
+		"@atlaskit/lozenge": "^11.13.2",
+		"@atlaskit/primitives": "^13.5.0",
+		"@atlaskit/section-message": "*",
+		"@atlaskit/select": "^18.10.4",
 		"@atlaskit/ssr": "*",
-		"@atlaskit/visual-regression": "*",
 		"@testing-library/react": "^13.4.0",
 		"jscodeshift": "^0.13.0",
 		"react-dom": "^18.2.0",

package/codemods/13.6.0-rename-imports.tsx

@@ -1,80 +0,0 @@
-import {
-	type API,
-	type ASTPath,
-	type FileInfo,
-	type ImportDeclaration,
-	type ImportSpecifier,
-	type Options,
-} from 'jscodeshift';
-
-import { addCommentBefore } from './utils';
-
-const replacementMapping: { [name: string]: string } = {
-	Props: 'LogoProps',
-	DefaultProps: 'defaultLogoParams',
-	JiraCoreIcon: 'JiraWorkManagementIcon',
-	JiraCoreLogo: 'JiraWorkManagementLogo',
-	JiraCoreWordmark: 'JiraWorkManagementWordmark',
-	JiraServiceDeskIcon: 'JiraServiceManagementIcon',
-	JiraServiceDeskLogo: 'JiraServiceManagementLogo',
-	JiraServiceDeskWordmark: 'JiraServiceManagementWordmark',
-	OpsGenieIcon: 'OpsgenieIcon',
-	OpsGenieIconLogo: 'OpsgenieIconLogo',
-	OpsGenieIconWordmark: 'OpsgenieIconWordmark',
-	StrideIcon: 'NO_ALTERNATIVE_COMPONENT',
-	StrideLogo: 'NO_ALTERNATIVE_COMPONENT',
-	StrideWordmark: 'NO_ALTERNATIVE_COMPONENT',
-	HipchatIcon: 'NO_ALTERNATIVE_COMPONENT',
-	HipchatLogo: 'NO_ALTERNATIVE_COMPONENT',
-	HipchatWordmark: 'NO_ALTERNATIVE_COMPONENT',
-};
-
-export default function transform(file: FileInfo, { jscodeshift: j }: API, options: Options) {
-	const source = j(file.source);
-	const target = source.find(j.ImportDeclaration).filter((path: ASTPath<ImportDeclaration>) => {
-		const value = path.node.source.value as string;
-		return value.includes('@atlaskit/logo');
-	});
-	const logoImports = target.find(j.ImportSpecifier);
-
-	if (!logoImports.length) {
-		// Returns original source file, untouched and unformatted
-		return file.source;
-	}
-
-	logoImports.forEach((path: ASTPath<ImportSpecifier>) => {
-		const foundKey = Object.keys(replacementMapping).find((key) => key === path.node.imported.name);
-
-		if (!foundKey || !replacementMapping[foundKey] || !path.node.local) {
-			return;
-		}
-		// add comment for logo component that don't have alternatives
-		if (replacementMapping[foundKey] === 'NO_ALTERNATIVE_COMPONENT') {
-			addCommentBefore(
-				j,
-				target,
-				`This file uses the @atlaskit/logo \`${foundKey}\` 
-        which will be removed with no alternative in the next major version.`,
-			);
-			return;
-		}
-
-		// replace the import with mapping name
-		const newLogoImport: ImportSpecifier = j.importSpecifier(
-			j.identifier(replacementMapping[foundKey]),
-			// if aliased import exist, keep the alias name unchanged, i.e.
-			// before: import { JiraCoreLogo as JCLogo } from '@atlaskit/logo';
-			// after: import { JiraWorkManagementLogo as JCLogo } from '@atlaskit/logo';
-			// otherwise alias the import using the original name, i.e.
-			// before: import { JiraCoreLogo } from '@atlaskit/logo';
-			// after: import { JiraWorkManagementLogo as JiraCoreLogo } from '@atlaskit/logo';
-			j.identifier(
-				path.node.local.name !== path.node.imported.name ? path.node.local.name : foundKey,
-			),
-		);
-
-		j(path).replaceWith(newLogoImport);
-	});
-
-	return source.toSource(options.printOptions);
-}

package/codemods/__tests__/13.6.0-rename-imports.test.tsx

@@ -1,233 +0,0 @@
-jest.autoMockOff();
-
-import transformer from '../13.6.0-rename-imports';
-
-const defineInlineTest = require('jscodeshift/dist/testUtils').defineInlineTest;
-
-describe('Rename Logo import code-mods', () => {
-	['tsx', 'babylon'].forEach((parser) => {
-		describe(`parser: ${parser}`, () => {
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { JiraCoreLogo } from '@atlaskit/logo';
-
-        const Logo = () => (<JiraCoreLogo />);
-        `,
-				`
-        import React from 'react';
-        import { JiraWorkManagementLogo as JiraCoreLogo } from '@atlaskit/logo';
-
-        const Logo = () => (<JiraCoreLogo />);
-        `,
-				'should alias the import using alternative components',
-			);
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import {
-          AtlassianIcon,
-          JiraCoreLogo
-        } from '@atlaskit/logo';
-        const getProductIcon = (productId: string) => {
-          switch (productId) {
-            case 'jira-core':
-              return JiraCoreIcon;
-            default:
-              return AtlassianIcon;
-          }
-        }
-        const Logo = () => getProductIcon();
-        `,
-				`
-        import React from 'react';
-        import {
-          AtlassianIcon,
-          JiraWorkManagementLogo as JiraCoreLogo
-        } from '@atlaskit/logo';
-        const getProductIcon = (productId: string) => {
-          switch (productId) {
-            case 'jira-core':
-              return JiraCoreIcon;
-            default:
-              return AtlassianIcon;
-          }
-        }
-        const Logo = () => getProductIcon();
-        `,
-				'should alias the import using alternative components, and keep other logo components unchanged',
-			);
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { JiraCoreLogo } from '@atlaskit/logo';
-
-        const Logo = ({textColor}) => (<JiraCoreLogo textColor={textColor} />);
-        `,
-				`
-        import React from 'react';
-        import { JiraWorkManagementLogo as JiraCoreLogo } from '@atlaskit/logo';
-
-        const Logo = ({textColor}) => (<JiraCoreLogo textColor={textColor} />);
-        `,
-				'should replace imports with alternative component with props unchanged',
-			);
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import {
-          JiraCoreWordmark,
-          JiraCoreIcon
-        } from '@atlaskit/logo';
-
-        const Logo = () => (<><JiraCoreIcon /><JiraCoreWordmark /></>);
-        `,
-				`
-        import React from 'react';
-        import {
-          JiraWorkManagementWordmark as JiraCoreWordmark,
-          JiraWorkManagementIcon as JiraCoreIcon
-        } from '@atlaskit/logo';
-
-        const Logo = () => (<><JiraCoreIcon /><JiraCoreWordmark /></>);
-        `,
-				'should alias multiple imports using alternative components',
-			);
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { JiraCoreLogo as JCLogo } from '@atlaskit/logo';
-
-        const Logo = () => (<JCLogo />);
-        `,
-				`
-        import React from 'react';
-        import { JiraWorkManagementLogo as JCLogo } from '@atlaskit/logo';
-
-        const Logo = () => (<JCLogo />);
-        `,
-				'should replace aliased import and JSX element with alternative components',
-			);
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { StrideIcon } from '@atlaskit/logo';
-
-        const Logo = () => (<StrideIcon />);
-        `,
-				`
-        import React from 'react';
-        /* TODO: (from codemod) This file uses the @atlaskit/logo \`StrideIcon\` 
-        which will be removed with no alternative in the next major version. */
-        import { StrideIcon } from '@atlaskit/logo';
-
-        const Logo = () => (<StrideIcon />);
-        `,
-				'should prompt user when using logo components with no alternatives',
-			);
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { JiraCoreIcon, HipchatIcon } from '@atlaskit/logo';
-        const Logo = () => (<><JiraCoreIcon /><HipchatIcon /></>);
-        `,
-				`
-        import React from 'react';
-        /* TODO: (from codemod) This file uses the @atlaskit/logo \`HipchatIcon\` 
-        which will be removed with no alternative in the next major version. */
-        import { JiraWorkManagementIcon as JiraCoreIcon, HipchatIcon } from '@atlaskit/logo';
-        const Logo = () => (<><JiraCoreIcon /><HipchatIcon /></>);
-        `,
-				'should alias imports using alternative component and propt user when using logo compontns with no alternatives',
-			);
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-
-        const MyComponent = () => (<div />);
-        `,
-				`
-        import React from 'react';
-
-        const MyComponent = () => (<div />);
-        `,
-				'should not modify files that are not using @atlaskit/logo',
-			);
-		});
-		describe(`parser: ${parser}`, () => {
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { Props } from '@atlaskit/logo/constants';
-
-        const ExampleLogoProps = Props;
-        `,
-				`
-        import React from 'react';
-        import { LogoProps as Props } from '@atlaskit/logo/constants';
-
-        const ExampleLogoProps = Props;
-        `,
-				'should alias the Props import using LogoProps',
-			);
-		});
-		describe(`parser: ${parser}`, () => {
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { DefaultProps } from '@atlaskit/logo/constants';
-
-        const ExampleLogoProps = DefaultProps;
-        `,
-				`
-        import React from 'react';
-        import { defaultLogoParams as DefaultProps } from '@atlaskit/logo/constants';
-
-        const ExampleLogoProps = DefaultProps;
-        `,
-				'should alias the DefaultProps import using defaultLogoParams',
-			);
-		});
-		describe(`parser: ${parser}`, () => {
-			defineInlineTest(
-				{ default: transformer, parser },
-				{},
-				`
-        import React from 'react';
-        import { JiraCoreIcon } from '@atlaskit/logo';
-        import { DefaultProps } from '@atlaskit/logo/constants';
-
-        const Logo = (DefaultProps) => (<JiraCoreIcon />);
-        `,
-				`
-        import React from 'react';
-        import { JiraWorkManagementIcon as JiraCoreIcon } from '@atlaskit/logo';
-        import { defaultLogoParams as DefaultProps } from '@atlaskit/logo/constants';
-
-        const Logo = (DefaultProps) => (<JiraCoreIcon />);
-        `,
-				'should alias imports from both @atlaskit/logo and the /constants entrypoint at the same time',
-			);
-		});
-	});
-});

package/codemods/utils.tsx

@@ -1,26 +0,0 @@
-import type { ASTPath, default as core } from 'jscodeshift';
-import { type Collection } from 'jscodeshift/src/Collection';
-
-// not replacing newlines (which \s does)
-const spacesAndTabs: RegExp = /[ \t]{2,}/g;
-const lineStartWithSpaces: RegExp = /^[ \t]*/gm;
-
-function clean(value: string): string {
-	return value.replace(spacesAndTabs, ' ').replace(lineStartWithSpaces, '').trim();
-}
-
-export function addCommentBefore(j: core.JSCodeshift, target: Collection<any>, message: string) {
-	const content: string = ` TODO: (from codemod) ${clean(message)} `;
-	target.forEach((path: ASTPath<any>) => {
-		path.value.comments = path.value.comments || [];
-
-		const exists = path.value.comments.find((comment: any) => comment.value === content);
-
-		// avoiding duplicates of the same comment
-		if (exists) {
-			return;
-		}
-
-		path.value.comments.push(j.commentBlock(content));
-	});
-}