@atlaskit/portal 4.2.10 → 4.2.12

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/portal
 
+## 4.2.12
+
+### Patch Changes
+
+- [`9827dcb82b8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9827dcb82b8) - No-op change to introduce spacing tokens to design system components.
+
+## 4.2.11
+
+### Patch Changes
+
+- [`8cc2f888c83`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8cc2f888c83) - Upgrade Typescript from `4.3.5` to `4.5.5`
+
 ## 4.2.10
 
 ### Patch Changes

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/portal",
-	"version": "4.2.10",
+	"version": "4.2.12",
 	"sideEffects": false
 }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/portal",
-	"version": "4.2.10",
+	"version": "4.2.12",
 	"sideEffects": false
 }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/portal",
-	"version": "4.2.10",
+	"version": "4.2.12",
 	"sideEffects": false
 }

package/dist/types-ts4.0/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const PORTAL_MOUNT_EVENT = "akPortalMount";
+export declare const PORTAL_UNMOUNT_EVENT = "akPortalUnmount";

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

@@ -0,0 +1 @@
+export type { PortalEvent, PortalProps } from '../types';

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

@@ -0,0 +1,3 @@
+export { default } from './portal';
+export type { PortalEvent, PortalProps } from './types';
+export { PORTAL_MOUNT_EVENT, PORTAL_UNMOUNT_EVENT } from './constants';

package/dist/types-ts4.0/internal/components/internal-portal.d.ts

@@ -0,0 +1,7 @@
+import { ReactPortal } from 'react';
+interface InternalPortalProps {
+    children: React.ReactNode;
+    zIndex: number | string;
+}
+export default function InternalPortal(props: InternalPortalProps): ReactPortal;
+export {};

package/dist/types-ts4.0/internal/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const portalParentClassName = "atlaskit-portal-container";
+export declare const portalParentSelector = "body > .atlaskit-portal-container";
+export declare const portalClassName = "atlaskit-portal";

package/dist/types-ts4.0/internal/hooks/use-is-subsequent-render.d.ts

@@ -0,0 +1,2 @@
+declare const useIsSubsequentRender: () => boolean;
+export default useIsSubsequentRender;

package/dist/types-ts4.0/internal/hooks/use-portal-event.d.ts

@@ -0,0 +1,2 @@
+declare const useFirePortalEvent: (zIndex: number | string) => void;
+export default useFirePortalEvent;

package/dist/types-ts4.0/internal/types.d.ts

@@ -0,0 +1,24 @@
+import type { Layers } from '@atlaskit/theme/types';
+/**
+ * Named layers of all z-index used in the Atlassian Design System.
+ */
+export declare type LayerName = keyof Layers;
+/**
+ * Creates a new type by reversing the key and values of the passed type
+ * @param {T} T - the generic type to be reversed. Each members of it should be a Record in key-value form
+ * @returns - The reversed type
+ */
+declare type ReverseMap<T extends Record<keyof T, T[keyof T]>> = {
+    [P in T[keyof T]]: {
+        [K in keyof T]: T[K] extends P ? K : never;
+    }[keyof T];
+};
+export declare type ReversedLayers = ReverseMap<Layers>;
+/**
+ * Interface for event to be fired on Atlassian Portal component mount and unmount
+ */
+export interface PortalEventDetail {
+    layer: LayerName | null;
+    zIndex: number;
+}
+export {};

package/dist/types-ts4.0/internal/utils/portal-custom-event.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Dispatches a custom event on window with given eventName, given zIndex and corresponding layer
+ * @param {string} eventName - either of Mount or Unmount event name
+ * @param {number} zIndex - z-index value which will be included in the event to be dispatched
+ */
+export default function firePortalEvent(eventName: string, zIndex: number): void;

package/dist/types-ts4.0/internal/utils/portal-dom-utils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Creates a new portal container element with provided z-index and class name 'atlaskit-portal',
+ * it is not be attached to any DOM node at this stage.
+ * @param {number | string} zIndex - the z-index value of the newly created portal container element
+ * @return {number} - The newly created container element
+ */
+export declare const createContainer: (zIndex: number | string) => HTMLDivElement;
+/**
+ * Removes portal container from portal parent container
+ *  @param {HTMLDivElement | undefined} container - portal container to be removed from portal parent container
+ */
+export declare const removePortalContainer: (container: HTMLDivElement) => void;
+/**
+ * Appends portal container to portal parent container if it hasn't already been done
+ *  @param {HTMLDivElement | undefined} container - portal container to be added to portal parent container
+ */
+export declare const appendPortalContainerIfNotAppended: (container: HTMLDivElement) => void;

package/dist/types-ts4.0/portal.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { PortalProps } from './types';
+export default function Portal(props: PortalProps): JSX.Element | null;

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

@@ -0,0 +1,13 @@
+import React from 'react';
+import { PortalEventDetail } from './internal/types';
+/**
+ * Interface for props to be passed in Atlassian Portal component
+ */
+export interface PortalProps {
+    children: React.ReactNode;
+    zIndex?: number | string;
+}
+/**
+ * Custom event object that will be fired when Atlassian Portal component is mounted and unmounted
+ */
+export declare type PortalEvent = CustomEvent<PortalEventDetail>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/portal",
-  "version": "4.2.10",
+  "version": "4.2.12",
   "description": "Atlaskit wrapper for rendering components in React portals",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,9 +12,18 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "dist/types-ts4.0/*",
+        "dist/types-ts4.0/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
+    "disableProductCI": true,
     "team": "Design System Team",
     "releaseModel": "scheduled",
     "website": {
@@ -27,7 +36,7 @@
     ".": "./src/index.tsx"
   },
   "dependencies": {
-    "@atlaskit/theme": "^12.1.0",
+    "@atlaskit/theme": "^12.2.0",
     "@babel/runtime": "^7.0.0"
   },
   "peerDependencies": {
@@ -37,22 +46,22 @@
   "devDependencies": {
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/docs": "*",
-    "@atlaskit/flag": "^14.6.0",
-    "@atlaskit/icon": "^21.10.0",
-    "@atlaskit/inline-dialog": "^13.3.0",
-    "@atlaskit/modal-dialog": "^12.2.0",
-    "@atlaskit/onboarding": "^10.5.0",
+    "@atlaskit/flag": "^14.7.0",
+    "@atlaskit/icon": "^21.11.0",
+    "@atlaskit/inline-dialog": "^13.4.0",
+    "@atlaskit/modal-dialog": "^12.4.0",
+    "@atlaskit/onboarding": "^10.6.0",
     "@atlaskit/ssr": "*",
-    "@atlaskit/tooltip": "^17.5.0",
+    "@atlaskit/tooltip": "^17.6.0",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
-    "@testing-library/react": "^8.0.1",
+    "@testing-library/react": "^12.1.5",
     "bind-event-listener": "^2.1.1",
     "enzyme": "^3.10.0",
     "raf-stub": "^2.0.1",
     "storybook-addon-performance": "^0.16.0",
-    "typescript": "4.3.5"
+    "typescript": "4.5.5"
   },
   "keywords": [
     "atlaskit",
@@ -68,6 +77,7 @@
       "design-system": "v1",
       "ui-components": "lite-mode",
       "analytics": "analytics-next",
+      "design-tokens": "spacing",
       "theming": "tokens",
       "deprecation": "no-deprecated-imports",
       "styling": [

package/report.api.md

@@ -1,6 +1,8 @@
-## API Report File for "@atlaskit/portal"
+## API Report File for "@atlaskit/portal".
 
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
 
 ```ts
 /// <reference types="react" />

package/types/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/entry-points/types.js",
   "module:es2019": "../dist/es2019/entry-points/types.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/types.d.ts"
+  "types": "../dist/types/entry-points/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/entry-points/types.d.ts"
+      ]
+    }
+  }
 }