@atlaskit/portal 4.3.1 → 4.3.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/portal
 
+## 4.3.3
+
+### Patch Changes
+
+- [`77766ad157d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/77766ad157d) - Enrol packages to push-model consumption in Jira.
+
+## 4.3.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 4.3.1
 
 ### Patch Changes

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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

package/dist/types-ts4.5/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.5/entry-points/types.d.ts

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

package/dist/types-ts4.5/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.5/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.5/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.5/internal/hooks/use-is-subsequent-render.d.ts

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

package/dist/types-ts4.5/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.5/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 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
+ */
+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 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.5/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.5/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.5/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.5/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 type PortalEvent = CustomEvent<PortalEventDetail>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/portal",
-  "version": "4.3.1",
+  "version": "4.3.3",
   "description": "A wrapper for rendering components in React portals.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -24,7 +24,10 @@
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
     "team": "Design System Team",
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
+    "productPushConsumption": [
+      "jira"
+    ],
     "website": {
       "name": "Portal",
       "category": "Libraries"

package/report.api.md

@@ -8,6 +8,7 @@
 ### Table of contents
 
 - [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
 
 ### Main Entry Types
 
@@ -55,3 +56,16 @@ export interface PortalProps {
 ```
 
 <!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+  "react": "^16.8.0",
+  "react-dom": "^16.8.0"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,46 @@
+## API Report File for "@atlaskit/portal"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+/// <reference types="react" />
+
+import type { Layers } from '@atlaskit/theme/types';
+import { default as React_2 } from 'react';
+
+// @public
+type LayerName = keyof Layers;
+
+// @public (undocumented)
+function Portal(props: PortalProps): JSX.Element | null;
+export default Portal;
+
+// @public (undocumented)
+export const PORTAL_MOUNT_EVENT = "akPortalMount";
+
+// @public (undocumented)
+export const PORTAL_UNMOUNT_EVENT = "akPortalUnmount";
+
+// @public
+export type PortalEvent = CustomEvent<PortalEventDetail>;
+
+// @public
+interface PortalEventDetail {
+    // (undocumented)
+    layer: LayerName | null;
+    // (undocumented)
+    zIndex: number;
+}
+
+// @public
+export interface PortalProps {
+    // (undocumented)
+    children: React_2.ReactNode;
+    // (undocumented)
+    zIndex?: number | string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```