@atlaskit/pagination 14.3.0 → 14.3.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/pagination
 
+## 14.3.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
+## 14.3.1
+
+### Patch Changes
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+
 ## 14.3.0
 
 ### Minor Changes

package/dist/cjs/pagination.js

@@ -28,7 +28,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 var analyticsAttributes = {
   componentName: 'pagination',
   packageName: "@atlaskit/pagination",
-  packageVersion: "14.3.0"
+  packageVersion: "14.3.2"
 };
 function InnerPagination(_ref, ref) {
   var _ref$components = _ref.components,

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/pagination",
-	"version": "14.3.0",
+	"version": "14.3.2",
 	"sideEffects": false
 }

package/dist/es2019/pagination.js

@@ -14,7 +14,7 @@ import collapseRange from './internal/utils/collapse-range';
 const analyticsAttributes = {
   componentName: 'pagination',
   packageName: "@atlaskit/pagination",
-  packageVersion: "14.3.0"
+  packageVersion: "14.3.2"
 };
 function InnerPagination({
   components = emptyObject,

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/pagination",
-	"version": "14.3.0",
+	"version": "14.3.2",
 	"sideEffects": false
 }

package/dist/esm/pagination.js

@@ -18,7 +18,7 @@ import collapseRange from './internal/utils/collapse-range';
 var analyticsAttributes = {
   componentName: 'pagination',
   packageName: "@atlaskit/pagination",
-  packageVersion: "14.3.0"
+  packageVersion: "14.3.2"
 };
 function InnerPagination(_ref, ref) {
   var _ref$components = _ref.components,

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/pagination",
-	"version": "14.3.0",
+	"version": "14.3.2",
 	"sideEffects": false
 }

package/dist/types/internal/components/navigator.d.ts

@@ -1,5 +1,5 @@
 import React, { ReactElement, SyntheticEvent } from 'react';
-export declare type NavigatorProps<T> = {
+export type NavigatorProps<T> = {
     /**
      * This will be passed in as aria-label to button. This is what screen reader will read
      */

package/dist/types/internal/components/page.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import { ButtonProps } from '@atlaskit/button/standard-button';
 import type { Appearance } from '@atlaskit/button/types';
-declare type Diff<T, U> = T extends U ? never : T;
-declare type PageProps = Diff<ButtonProps, {
+type Diff<T, U> = T extends U ? never : T;
+type PageProps = Diff<ButtonProps, {
     appearance?: Appearance;
     autoFocus: boolean;
     isDisabled: boolean;

package/dist/types/internal/components/render-ellipsis.d.ts

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-export declare type EllipsisProp = {
+export type EllipsisProp = {
     key: string;
     testId?: string;
 };

package/dist/types/internal/utils/collapse-range.d.ts

@@ -5,6 +5,6 @@ declare const collapseRange: <T>(pages: T[], current: number, { max, ellipsis, t
         key: string;
         testId: string;
     }) => ReactElement;
-    transform: (page: T, index: number, testId?: string | undefined) => ReactElement;
-}, testId?: string | undefined) => ReactElement[];
+    transform: (page: T, index: number, testId?: string) => ReactElement;
+}, testId?: string) => ReactElement[];
 export default collapseRange;

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

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

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

@@ -0,0 +1,2 @@
+export { default } from './pagination';
+export type { PaginationPropTypes } from './types';

package/dist/types-ts4.5/internal/components/navigator.d.ts

@@ -0,0 +1,20 @@
+import React, { ReactElement, SyntheticEvent } from 'react';
+export type NavigatorProps<T> = {
+    /**
+     * This will be passed in as aria-label to button. This is what screen reader will read
+     */
+    'aria-label'?: string;
+    /**
+     * Is the navigator disabled
+     */
+    isDisabled?: boolean;
+    iconBefore: ReactElement;
+    pages: T[];
+    testId?: string;
+    /**
+     * This function is called with the when user clicks on navigator
+     */
+    onClick?: (event: SyntheticEvent) => void;
+    component?: React.ElementType<any>;
+};
+export default function Navigator<T>(props: NavigatorProps<T>): JSX.Element;

package/dist/types-ts4.5/internal/components/page.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="react" />
+import { ButtonProps } from '@atlaskit/button/standard-button';
+import type { Appearance } from '@atlaskit/button/types';
+type Diff<T, U> = T extends U ? never : T;
+type PageProps = Diff<ButtonProps, {
+    appearance?: Appearance;
+    autoFocus: boolean;
+    isDisabled: boolean;
+    isLoading: boolean;
+    spacing: 'compact' | 'default' | 'none';
+    shouldFitContainer: boolean;
+    type: 'button' | 'submit';
+}> & {
+    page?: any;
+};
+export default function Page(props: PageProps): JSX.Element;
+export {};

package/dist/types-ts4.5/internal/components/render-ellipsis.d.ts

@@ -0,0 +1,6 @@
+import { ReactElement } from 'react';
+export type EllipsisProp = {
+    key: string;
+    testId?: string;
+};
+export default function renderEllipsis({ key, testId, }: EllipsisProp): ReactElement;

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

@@ -0,0 +1 @@
+export declare const emptyObject: {};

package/dist/types-ts4.5/internal/utils/collapse-range.d.ts

@@ -0,0 +1,10 @@
+import { ReactElement } from 'react';
+declare const collapseRange: <T>(pages: T[], current: number, { max, ellipsis, transform, }: {
+    max: number;
+    ellipsis: (arg: {
+        key: string;
+        testId: string;
+    }) => ReactElement;
+    transform: (page: T, index: number, testId?: string) => ReactElement;
+}, testId?: string) => ReactElement[];
+export default collapseRange;

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

@@ -0,0 +1,5 @@
+import React from 'react';
+import { PaginationPropTypes } from './types';
+declare function InnerPagination<T>({ components, defaultSelectedIndex, selectedIndex, label, previousLabel, nextLabel, style, max, onChange, pages, getPageLabel, renderEllipsis, analyticsContext, testId, }: PaginationPropTypes<T>, ref: React.Ref<HTMLDivElement>): JSX.Element;
+declare const _default: typeof InnerPagination;
+export default _default;

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

@@ -0,0 +1,75 @@
+import type { CSSProperties, ReactElement, SyntheticEvent } from 'react';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+export interface PaginationPropTypes<T = unknown> {
+    /**
+     * Replace the built-in Page, Previous, Next and/ or Ellipsis component
+     */
+    components?: {
+        Page?: React.ElementType;
+        Previous?: React.ElementType;
+        Next?: React.ElementType;
+    };
+    /**
+     * Index of the page to be selected by default
+     */
+    defaultSelectedIndex?: number;
+    /**
+     * Helper function to get text displayed on the page button. It is helpful in scenarios when page the page passed in is an object
+     */
+    getPageLabel?: (page: T, pageIndex: number) => number | string;
+    /**
+     * The aria-label for the pagination wrapper
+     */
+    label?: string;
+    /**
+     * The aria-label for the next button
+     */
+    nextLabel?: string;
+    /**
+     * The aria-label for the previous button
+     */
+    previousLabel?: string;
+    /**
+     * Style to spread on the container element
+     */
+    style?: CSSProperties;
+    /**
+     * Maximum number of pages to be displayed in the pagination
+     */
+    max?: number;
+    /**
+     * The onChange handler which is called when the page is changed
+     */
+    onChange?: (event: SyntheticEvent, page: T, analyticsEvent?: UIAnalyticsEvent) => void;
+    /**
+     * Array of the pages to display
+     */
+    pages: T[];
+    /**
+     * Index of the selected page. This will make this pagination controlled
+     */
+    selectedIndex?: number;
+    /**
+     * The react Node returned from the function is rendered instead of the default ellipsis node
+     */
+    renderEllipsis?: (arg: {
+        key: string;
+    }) => ReactElement;
+    /**
+     * Additional information to be included in the `context` of analytics events
+     */
+    analyticsContext?: Record<string, any>;
+    /**
+     * A `testId` prop is provided for specified elements,
+     * which is a unique string that appears as a data attribute `data-testid`
+     * in the rendered code, serving as a hook for automated tests.
+     *
+     * Will set data-testid on these elements when defined:
+     * - Pagination nav wrapper - {testId}
+     * - Page - {testId}--page-{page index}
+     * - Current page - {testId}--current-page-{page index}
+     * - Left navigator - {testId}--left-navigator
+     * - Right navigator - {testId}--right-navigator
+     */
+    testId?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/pagination",
-  "version": "14.3.0",
+  "version": "14.3.2",
   "description": "Pagination allows you to divide large amounts of content into smaller chunks across multiple pages.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -13,6 +13,14 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "af:exports": {
@@ -60,7 +68,7 @@
     "react-router-dom": "^4.2.2",
     "storybook-addon-performance": "^0.16.0",
     "tiny-invariant": "^1.2.0",
-    "typescript": "4.5.5",
+    "typescript": "~4.9.5",
     "wait-for-expect": "^1.2.0"
   },
   "techstack": {

package/types/package.json

@@ -6,9 +6,9 @@
   "sideEffects": false,
   "types": "../dist/types/entry-points/types.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "../dist/types-ts4.0/entry-points/types.d.ts"
+        "../dist/types-ts4.5/entry-points/types.d.ts"
       ]
     }
   }