@atlaskit/popper 5.2.10 → 5.3.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/popper
 
+## 5.3.0
+
+### Minor Changes
+
+- [`6d5881c30a4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6d5881c30a4) - Introducing in-product testing entrypoints to popper.
+
+## 5.2.11
+
+### Patch Changes
+
+- [`dc53dc3201b`](https://bitbucket.org/atlassian/atlassian-frontend/commits/dc53dc3201b) - Add 'productPushConsumption' as a new optional field in package.json.
+
+  _Note_:
+  We want to track the information if the package was moved from the pull into the push model in the product.
+  Hence, we extended the `package.json` file by adding a new field e.g.: "atlassian.productPushConsumption": ["jira"]
+  This field is optional.
+
 ## 5.2.10
 
 ### Patch Changes

package/dist/cjs/__tests_external__/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "popperRendersWithPositionFixedTestCase", {
+  enumerable: true,
+  get: function get() {
+    return _popper.popperRendersWithPositionFixedTestCase;
+  }
+});
+
+var _popper = require("./test-cases/popper");

package/dist/cjs/__tests_external__/page-objects/base-popper.js

@@ -0,0 +1,49 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BasePopperPageObject = void 0;
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _inProductTesting = require("@atlaskit/in-product-testing");
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+var BasePopperPageObject = /*#__PURE__*/function (_InProductTestPageObj) {
+  (0, _inherits2.default)(BasePopperPageObject, _InProductTestPageObj);
+
+  var _super = _createSuper(BasePopperPageObject);
+
+  function BasePopperPageObject(cy) {
+    var _this;
+
+    (0, _classCallCheck2.default)(this, BasePopperPageObject);
+    _this = _super.call(this, cy);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "assertPopperStyle", function (elementSelector) {
+      return _this.cy.get(elementSelector).should('be.visbile');
+    });
+    return _this;
+  }
+
+  return (0, _createClass2.default)(BasePopperPageObject);
+}(_inProductTesting.InProductTestPageObject);
+
+exports.BasePopperPageObject = BasePopperPageObject;

package/dist/cjs/__tests_external__/test-cases/popper.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.popperRendersWithPositionFixedTestCase = void 0;
+
+var _inProductTesting = require("@atlaskit/in-product-testing");
+
+var _basePopper = require("../page-objects/base-popper");
+
+var popperRendersWithPositionFixedTestCase = function popperRendersWithPositionFixedTestCase(elementSelector) {
+  return new _inProductTesting.InProductTestCase({
+    title: 'Popped container renders with position fixed',
+    id: 'popped-container-fixed-position',
+    assertions: function assertions(cy) {
+      var popperElement = new _basePopper.BasePopperPageObject(cy);
+      popperElement.assertPopperStyle(elementSelector);
+    }
+  });
+};
+
+exports.popperRendersWithPositionFixedTestCase = popperRendersWithPositionFixedTestCase;

package/dist/cjs/in-product.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "popperRendersWithPositionFixedTestCase", {
+  enumerable: true,
+  get: function get() {
+    return _tests_external__.popperRendersWithPositionFixedTestCase;
+  }
+});
+
+var _tests_external__ = require("./__tests_external__");

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/popper",
-	"version": "5.2.10",
+	"version": "5.3.0",
 	"sideEffects": false
 }

package/dist/es2019/__tests_external__/index.js

@@ -0,0 +1 @@
+export { popperRendersWithPositionFixedTestCase } from './test-cases/popper';

package/dist/es2019/__tests_external__/page-objects/base-popper.js

@@ -0,0 +1,12 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { InProductTestPageObject } from '@atlaskit/in-product-testing';
+export class BasePopperPageObject extends InProductTestPageObject {
+  constructor(cy) {
+    super(cy);
+
+    _defineProperty(this, "assertPopperStyle", elementSelector => {
+      return this.cy.get(elementSelector).should('be.visbile');
+    });
+  }
+
+}

package/dist/es2019/__tests_external__/test-cases/popper.js

@@ -0,0 +1,10 @@
+import { InProductTestCase } from '@atlaskit/in-product-testing';
+import { BasePopperPageObject } from '../page-objects/base-popper';
+export const popperRendersWithPositionFixedTestCase = elementSelector => new InProductTestCase({
+  title: 'Popped container renders with position fixed',
+  id: 'popped-container-fixed-position',
+  assertions: cy => {
+    const popperElement = new BasePopperPageObject(cy);
+    popperElement.assertPopperStyle(elementSelector);
+  }
+});

package/dist/es2019/in-product.js

@@ -0,0 +1 @@
+export { popperRendersWithPositionFixedTestCase } from './__tests_external__';

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/popper",
-	"version": "5.2.10",
+	"version": "5.3.0",
 	"sideEffects": false
 }

package/dist/esm/__tests_external__/index.js

@@ -0,0 +1 @@
+export { popperRendersWithPositionFixedTestCase } from './test-cases/popper';

package/dist/esm/__tests_external__/page-objects/base-popper.js

@@ -0,0 +1,34 @@
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _assertThisInitialized from "@babel/runtime/helpers/assertThisInitialized";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+import { InProductTestPageObject } from '@atlaskit/in-product-testing';
+export var BasePopperPageObject = /*#__PURE__*/function (_InProductTestPageObj) {
+  _inherits(BasePopperPageObject, _InProductTestPageObj);
+
+  var _super = _createSuper(BasePopperPageObject);
+
+  function BasePopperPageObject(cy) {
+    var _this;
+
+    _classCallCheck(this, BasePopperPageObject);
+
+    _this = _super.call(this, cy);
+
+    _defineProperty(_assertThisInitialized(_this), "assertPopperStyle", function (elementSelector) {
+      return _this.cy.get(elementSelector).should('be.visbile');
+    });
+
+    return _this;
+  }
+
+  return _createClass(BasePopperPageObject);
+}(InProductTestPageObject);

package/dist/esm/__tests_external__/test-cases/popper.js

@@ -0,0 +1,12 @@
+import { InProductTestCase } from '@atlaskit/in-product-testing';
+import { BasePopperPageObject } from '../page-objects/base-popper';
+export var popperRendersWithPositionFixedTestCase = function popperRendersWithPositionFixedTestCase(elementSelector) {
+  return new InProductTestCase({
+    title: 'Popped container renders with position fixed',
+    id: 'popped-container-fixed-position',
+    assertions: function assertions(cy) {
+      var popperElement = new BasePopperPageObject(cy);
+      popperElement.assertPopperStyle(elementSelector);
+    }
+  });
+};

package/dist/esm/in-product.js

@@ -0,0 +1 @@
+export { popperRendersWithPositionFixedTestCase } from './__tests_external__';

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/popper",
-	"version": "5.2.10",
+	"version": "5.3.0",
 	"sideEffects": false
 }

package/dist/types/__tests_external__/index.d.ts

@@ -0,0 +1 @@
+export { popperRendersWithPositionFixedTestCase } from './test-cases/popper';

package/dist/types/__tests_external__/page-objects/base-popper.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="cypress" />
+import { CypressType, InProductTestPageObject } from '@atlaskit/in-product-testing';
+export declare class BasePopperPageObject extends InProductTestPageObject {
+    constructor(cy: CypressType);
+    assertPopperStyle: (elementSelector: keyof HTMLElementTagNameMap) => Cypress.Chainable<JQuery<HTMLObjectElement | HTMLElement | HTMLHeadElement | HTMLLinkElement | HTMLSourceElement | HTMLBodyElement | HTMLAnchorElement | HTMLAreaElement | HTMLAudioElement | HTMLBaseElement | HTMLQuoteElement | HTMLBRElement | HTMLButtonElement | HTMLCanvasElement | HTMLTableCaptionElement | HTMLTableColElement | HTMLDataElement | HTMLDataListElement | HTMLModElement | HTMLDetailsElement | HTMLDialogElement | HTMLDirectoryElement | HTMLDivElement | HTMLDListElement | HTMLEmbedElement | HTMLFieldSetElement | HTMLFontElement | HTMLFormElement | HTMLFrameElement | HTMLFrameSetElement | HTMLHeadingElement | HTMLHRElement | HTMLHtmlElement | HTMLIFrameElement | HTMLImageElement | HTMLInputElement | HTMLLabelElement | HTMLLegendElement | HTMLLIElement | HTMLMapElement | HTMLMarqueeElement | HTMLMenuElement | HTMLMetaElement | HTMLMeterElement | HTMLOListElement | HTMLOptGroupElement | HTMLOptionElement | HTMLOutputElement | HTMLParagraphElement | HTMLParamElement | HTMLPictureElement | HTMLPreElement | HTMLProgressElement | HTMLScriptElement | HTMLSelectElement | HTMLSlotElement | HTMLSpanElement | HTMLStyleElement | HTMLTableElement | HTMLTableSectionElement | HTMLTableCellElement | HTMLTemplateElement | HTMLTextAreaElement | HTMLTimeElement | HTMLTitleElement | HTMLTableRowElement | HTMLTrackElement | HTMLUListElement | HTMLVideoElement>>;
+}

package/dist/types/__tests_external__/test-cases/popper.d.ts

@@ -0,0 +1,2 @@
+import { InProductTestCase } from '@atlaskit/in-product-testing';
+export declare const popperRendersWithPositionFixedTestCase: (elementSelector: keyof HTMLElementTagNameMap) => InProductTestCase;

package/dist/types/in-product.d.ts

@@ -0,0 +1 @@
+export { popperRendersWithPositionFixedTestCase } from './__tests_external__';

package/in-product/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/popper/in-product",
+  "main": "../dist/cjs/in-product.js",
+  "module": "../dist/esm/in-product.js",
+  "module:es2019": "../dist/es2019/in-product.js",
+  "sideEffects": false,
+  "types": "../dist/types/in-product.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/in-product.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/popper",
-  "version": "5.2.10",
+  "version": "5.3.0",
   "description": "Wrapper for react-popper with common config and some helpers",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -23,9 +23,11 @@
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
-    "disableProductCI": true,
-    "team": "Design System Team",
-    "releaseModel": "scheduled",
+    "team": "UIP: Cycle Time Flex",
+    "releaseModel": "continuous",
+    "productPushConsumption": [
+      "jira"
+    ],
     "website": {
       "name": "Popper",
       "category": "Components"
@@ -33,9 +35,11 @@
   },
   "af:exports": {
     ".": "./src/index.tsx",
-    "./Popper": "./src/popper.tsx"
+    "./Popper": "./src/popper.tsx",
+    "./in-product": "./src/in-product.tsx"
   },
   "dependencies": {
+    "@atlaskit/in-product-testing": "^0.1.5",
     "@babel/runtime": "^7.0.0",
     "@popperjs/core": "^2.9.1",
     "react-popper": "^2.2.3"
@@ -44,7 +48,7 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/button": "^16.3.0",
+    "@atlaskit/button": "^16.4.0",
     "@atlaskit/docs": "*",
     "@atlaskit/ds-lib": "^2.1.0",
     "@atlaskit/ssr": "*",

package/report.api.md

@@ -1,8 +1,17 @@
-## API Report File for "@atlaskit/popper".
+<!-- API Report Version: 2.3 -->
 
-> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
+## API Report File for "@atlaskit/popper"
 
-[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
 
 ```ts
 import { Manager } from 'react-popper';
@@ -19,32 +28,13 @@ import { ReferenceProps } from 'react-popper';
 import { StrictModifier } from 'react-popper';
 import { VirtualElement } from '@popperjs/core';
 
-declare interface CustomPopperProps<Modifiers> {
-  /**
-   * Returns the element to be positioned.
-   */
+// @public (undocumented)
+interface CustomPopperProps<Modifiers> {
   children?: (childrenProps: PopperChildrenProps) => React_2.ReactNode;
-  /**
-   * Distance the popup should be offset from the reference in the format of [along, away] (units in px).
-   * Defaults to [0, 8] - which means the popup will be 8px away from the edge of the reference specified
-   * by the `placement` prop.
-   */
+  modifiers?: PopperProps<Modifiers>['modifiers'];
   offset?: Offset;
-  /**
-   * Which side of the Reference to show on.
-   */
   placement?: Placement;
-  /**
-   * Replacement reference element to position popper relative to.
-   */
   referenceElement?: HTMLElement | VirtualElement;
-  /**
-   * Additional modifiers and modifier overwrites.
-   */
-  modifiers?: PopperProps<Modifiers>['modifiers'];
-  /**
-   * Placement strategy used. Can be 'fixed' or 'absolute'
-   */
   strategy?: PopperProps<Modifiers>['strategy'];
 }
 
@@ -54,13 +44,15 @@ export { ManagerProps };
 
 export { Modifier };
 
-declare type Offset = [number | null | undefined, number | null | undefined];
+// @public (undocumented)
+type Offset = [null | number | undefined, null | number | undefined];
 
 export { Placement };
 
 export { placements };
 
-export declare function Popper<CustomModifiers>({
+// @public (undocumented)
+export function Popper<CustomModifiers>({
   children,
   offset,
   placement,
@@ -81,5 +73,7 @@ export { ReferenceProps };
 
 export { StrictModifier };
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```
+
+<!--SECTION END: Main Entry Types-->

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

@@ -0,0 +1,61 @@
+## API Report File for "@atlaskit/popper"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Manager } from 'react-popper';
+import { ManagerProps } from 'react-popper';
+import { Modifier } from 'react-popper';
+import { Placement } from '@popperjs/core';
+import { placements } from '@popperjs/core';
+import { PopperArrowProps } from 'react-popper';
+import { PopperChildrenProps } from 'react-popper';
+import { PopperProps } from 'react-popper';
+import { default as React_2 } from 'react';
+import { Reference } from 'react-popper';
+import { ReferenceProps } from 'react-popper';
+import { StrictModifier } from 'react-popper';
+import { VirtualElement } from '@popperjs/core';
+
+// @public (undocumented)
+interface CustomPopperProps<Modifiers> {
+    children?: (childrenProps: PopperChildrenProps) => React_2.ReactNode;
+    modifiers?: PopperProps<Modifiers>['modifiers'];
+    offset?: Offset;
+    placement?: Placement;
+    referenceElement?: HTMLElement | VirtualElement;
+    strategy?: PopperProps<Modifiers>['strategy'];
+}
+
+export { Manager }
+
+export { ManagerProps }
+
+export { Modifier }
+
+// @public (undocumented)
+type Offset = [null | number | undefined, null | number | undefined];
+
+export { Placement }
+
+export { placements }
+
+// @public (undocumented)
+export function Popper<CustomModifiers>({ children, offset, placement, referenceElement, modifiers, strategy, }: CustomPopperProps<CustomModifiers>): JSX.Element;
+
+export { PopperArrowProps }
+
+export { PopperChildrenProps }
+
+export { PopperProps }
+
+export { Reference }
+
+export { ReferenceProps }
+
+export { StrictModifier }
+
+// (No @packageDocumentation comment for this package)
+
+```

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

@@ -1,3 +0,0 @@
-export { Popper, placements } from './popper';
-export type { ManagerProps, ReferenceProps, PopperProps, PopperArrowProps, PopperChildrenProps, StrictModifier, Modifier, Placement, } from './popper';
-export { Manager, Reference } from 'react-popper';

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

@@ -1,39 +0,0 @@
-import React from 'react';
-import { Placement, VirtualElement } from '@popperjs/core';
-import { PopperChildrenProps, PopperProps } from 'react-popper';
-export { placements } from '@popperjs/core';
-export type { Placement, VirtualElement } from '@popperjs/core';
-export type { ManagerProps, ReferenceProps, PopperProps, PopperArrowProps, PopperChildrenProps, StrictModifier, Modifier, } from 'react-popper';
-declare type Offset = [
-    number | null | undefined,
-    number | null | undefined
-];
-export interface CustomPopperProps<Modifiers> {
-    /**
-     * Returns the element to be positioned.
-     */
-    children?: (childrenProps: PopperChildrenProps) => React.ReactNode;
-    /**
-     * Distance the popup should be offset from the reference in the format of [along, away] (units in px).
-     * Defaults to [0, 8] - which means the popup will be 8px away from the edge of the reference specified
-     * by the `placement` prop.
-     */
-    offset?: Offset;
-    /**
-     * Which side of the Reference to show on.
-     */
-    placement?: Placement;
-    /**
-     * Replacement reference element to position popper relative to.
-     */
-    referenceElement?: HTMLElement | VirtualElement;
-    /**
-     * Additional modifiers and modifier overwrites.
-     */
-    modifiers?: PopperProps<Modifiers>['modifiers'];
-    /**
-     * Placement strategy used. Can be 'fixed' or 'absolute'
-     */
-    strategy?: PopperProps<Modifiers>['strategy'];
-}
-export declare function Popper<CustomModifiers>({ children, offset, placement, referenceElement, modifiers, strategy, }: CustomPopperProps<CustomModifiers>): JSX.Element;