@pushwoosh/smart-components-kit 1.10.0 → 1.11.0

package/PickerSort/constants.d.ts

@@ -1,4 +1,6 @@
 import { type PickerSortOrder } from './types';
 /** Every order a picker may offer, in menu order. */
 export declare const PICKER_SORT_ORDERS: readonly PickerSortOrder[];
+/** Orders `popupFormsContents.List` can serve; it has no created date. */
+export declare const POPUP_CONTENTS_SORT_ORDERS: readonly PickerSortOrder[];
 export declare const PICKER_SORT_STORAGE_PREFIX = "picker-sort";

package/PickerSort/constants.js

@@ -1,3 +1,5 @@
 /** Every order a picker may offer, in menu order. */
 export const PICKER_SORT_ORDERS = ['created-desc', 'created-asc', 'updated-desc', 'name-asc', 'name-desc'];
+/** Orders `popupFormsContents.List` can serve; it has no created date. */
+export const POPUP_CONTENTS_SORT_ORDERS = ['updated-desc', 'name-asc', 'name-desc'];
 export const PICKER_SORT_STORAGE_PREFIX = 'picker-sort';

package/PickerSort/helpers.d.ts

@@ -1,6 +1,12 @@
-import { type PickerContentType, type PickerSortOrder, type PresetListOrder } from './types';
+import { type PickerContentType, type PickerSortAccessors, type PickerSortOrder, type PopupContentsListOrder, type PresetListOrder, type RichMediaListOrder } from './types';
 /** Map a picker order to the `orderBy` / `orderDirection` of the preset `List` RPCs. */
 export declare function toPresetListOrder(order: PickerSortOrder): PresetListOrder;
+/** Map a picker order to the `orderBy` / `orderType` of `richMedia.List`. */
+export declare function toRichMediaListOrder(order: PickerSortOrder): RichMediaListOrder;
+/** Map a picker order to `popupFormsContents.List`; created orders, which it lacks, fall back to the updated date. */
+export declare function toPopupContentsListOrder(order: PickerSortOrder): PopupContentsListOrder;
+/** Sort a list the source returns whole, as the picker order asks; stable, returns a new array. */
+export declare function sortItemsByPickerOrder<T>(items: readonly T[], order: PickerSortOrder, { getName, getCreated, getUpdated }: PickerSortAccessors<T>): T[];
 export declare function isPickerSortOrder(value: unknown): value is PickerSortOrder;
 export declare function resolvePickerSortOrder(stored: unknown, defaultOrder: PickerSortOrder, supportedOrders: readonly PickerSortOrder[]): PickerSortOrder;
 export declare function pickerSortStorageKey(userEmail: string, contentType: PickerContentType): string;

package/PickerSort/helpers.js

@@ -21,10 +21,109 @@ const PRESET_LIST_ORDERS = {
     orderDirection: 'DESC'
   }
 };
+const RICH_MEDIA_LIST_ORDERS = {
+  'created-desc': {
+    orderBy: 'CREATED_DATE',
+    orderType: 'DESC'
+  },
+  'created-asc': {
+    orderBy: 'CREATED_DATE',
+    orderType: 'ASC'
+  },
+  'updated-desc': {
+    orderBy: 'UPDATED_DATE',
+    orderType: 'DESC'
+  },
+  'name-asc': {
+    orderBy: 'NAME',
+    orderType: 'ASC'
+  },
+  'name-desc': {
+    orderBy: 'NAME',
+    orderType: 'DESC'
+  }
+};
+const POPUP_CONTENTS_LIST_ORDERS = {
+  'created-desc': {
+    orderBy: 'UPDATED',
+    orderDirection: 'DESC'
+  },
+  'created-asc': {
+    orderBy: 'UPDATED',
+    orderDirection: 'ASC'
+  },
+  'updated-desc': {
+    orderBy: 'UPDATED',
+    orderDirection: 'DESC'
+  },
+  'name-asc': {
+    orderBy: 'NAME',
+    orderDirection: 'ASC'
+  },
+  'name-desc': {
+    orderBy: 'NAME',
+    orderDirection: 'DESC'
+  }
+};
+const nameCollator = new Intl.Collator(undefined, {
+  numeric: true,
+  sensitivity: 'base'
+});
 /** Map a picker order to the `orderBy` / `orderDirection` of the preset `List` RPCs. */
 export function toPresetListOrder(order) {
   return PRESET_LIST_ORDERS[order];
 }
+/** Map a picker order to the `orderBy` / `orderType` of `richMedia.List`. */
+export function toRichMediaListOrder(order) {
+  return RICH_MEDIA_LIST_ORDERS[order];
+}
+/** Map a picker order to `popupFormsContents.List`; created orders, which it lacks, fall back to the updated date. */
+export function toPopupContentsListOrder(order) {
+  return POPUP_CONTENTS_LIST_ORDERS[order];
+}
+function toTime(date) {
+  if (date === null || date === undefined || date === '') {
+    return undefined;
+  }
+  const time = date instanceof Date ? date.getTime() : new Date(date).getTime();
+  return Number.isNaN(time) ? undefined : time;
+}
+function sortByDate(items, getDate, direction) {
+  if (!getDate) {
+    return [...items];
+  }
+  const dated = items.map(item => ({
+    item,
+    time: toTime(getDate(item))
+  }));
+  return dated.sort((a, b) => {
+    if (a.time === undefined || b.time === undefined) {
+      return Number(a.time === undefined) - Number(b.time === undefined);
+    }
+    return (a.time - b.time) * direction;
+  }).map(({
+    item
+  }) => item);
+}
+/** Sort a list the source returns whole, as the picker order asks; stable, returns a new array. */
+export function sortItemsByPickerOrder(items, order, {
+  getName,
+  getCreated,
+  getUpdated
+}) {
+  switch (order) {
+    case 'name-asc':
+      return [...items].sort((a, b) => nameCollator.compare(getName(a), getName(b)));
+    case 'name-desc':
+      return [...items].sort((a, b) => nameCollator.compare(getName(b), getName(a)));
+    case 'created-desc':
+      return sortByDate(items, getCreated, -1);
+    case 'created-asc':
+      return sortByDate(items, getCreated, 1);
+    case 'updated-desc':
+      return sortByDate(items, getUpdated, -1);
+  }
+}
 export function isPickerSortOrder(value) {
   return typeof value === 'string' && PICKER_SORT_ORDERS.includes(value);
 }

package/PickerSort/index.d.ts

@@ -1,7 +1,7 @@
 export { PickerSortMenu } from './components/PickerSortMenu';
-export { PICKER_SORT_ORDERS } from './constants';
-export { toPresetListOrder } from './helpers';
+export { PICKER_SORT_ORDERS, POPUP_CONTENTS_SORT_ORDERS } from './constants';
+export { sortItemsByPickerOrder, toPopupContentsListOrder, toPresetListOrder, toRichMediaListOrder } from './helpers';
 export { usePagedItems } from './usePagedItems';
 export { usePickerSortOrder } from './usePickerSortOrder';
 export type { PickerSortMenuProps } from './components/PickerSortMenu/types';
-export type { LoadPagedItems, PagedItemsPage, PagedItemsState, PickerContentType, PickerSortOrder, PickerSortOrderState, PresetListOrder, UsePickerSortOrderOptions, } from './types';
+export type { LoadPagedItems, PagedItemsPage, PagedItemsState, PickerContentType, PickerSortAccessors, PickerSortDate, PickerSortOrder, PickerSortOrderState, PopupContentsListOrder, PresetListOrder, RichMediaListOrder, RichMediaListOrderBy, UsePickerSortOrderOptions, } from './types';

package/PickerSort/index.js

@@ -1,5 +1,5 @@
 export { PickerSortMenu } from './components/PickerSortMenu';
-export { PICKER_SORT_ORDERS } from './constants';
-export { toPresetListOrder } from './helpers';
+export { PICKER_SORT_ORDERS, POPUP_CONTENTS_SORT_ORDERS } from './constants';
+export { sortItemsByPickerOrder, toPopupContentsListOrder, toPresetListOrder, toRichMediaListOrder } from './helpers';
 export { usePagedItems } from './usePagedItems';
 export { usePickerSortOrder } from './usePickerSortOrder';

package/PickerSort/types.d.ts

@@ -1,4 +1,6 @@
 import { type ListPresetsRequest_OrderBy, type ListPresetsRequest_OrderDirection } from '@pushwoosh/rpc-v2-http-api-data/presets';
+import { type ListRequest_OrderBy as PopupContentsListRequestOrderBy, type ListRequest_OrderDirection as PopupContentsListRequestOrderDirection } from '@pushwoosh/rpc-v2-http-api-data/pushwoosh_rpc_popup_forms_contents_v3';
+import { type ListRequest_OrderType as RichMediaListRequestOrderType } from '@pushwoosh/rpc-v2-http-api-data/rich_medias';
 /** Order a picker can list its items in. */
 export type PickerSortOrder = 'created-desc' | 'created-asc' | 'updated-desc' | 'name-asc' | 'name-desc';
 /** Content kind a picker lists; the chosen order is remembered per user and per kind. */
@@ -8,6 +10,26 @@ export type PresetListOrder = {
     readonly orderBy: ListPresetsRequest_OrderBy;
     readonly orderDirection: ListPresetsRequest_OrderDirection;
 };
+/** `orderBy` of `richMedia.List`; local until `NAME` reaches the published rpc-v2 types. */
+export type RichMediaListOrderBy = 'CREATED_DATE' | 'UPDATED_DATE' | 'NAME';
+/** `orderBy` / `orderType` pair of `richMedia.List`. */
+export type RichMediaListOrder = {
+    readonly orderBy: RichMediaListOrderBy;
+    readonly orderType: RichMediaListRequestOrderType;
+};
+/** `orderBy` / `orderDirection` pair of `popupFormsContents.List`. */
+export type PopupContentsListOrder = {
+    readonly orderBy: PopupContentsListRequestOrderBy;
+    readonly orderDirection: PopupContentsListRequestOrderDirection;
+};
+/** Date accepted by {@link sortItemsByPickerOrder}; an unparsable or missing one counts as no date. */
+export type PickerSortDate = Date | string | number | null | undefined;
+/** Getters {@link sortItemsByPickerOrder} reads; a date order without its getter keeps the input order. */
+export type PickerSortAccessors<T> = {
+    readonly getName: (item: T) => string;
+    readonly getCreated?: (item: T) => PickerSortDate;
+    readonly getUpdated?: (item: T) => PickerSortDate;
+};
 /** Options of {@link usePickerSortOrder}. */
 export type UsePickerSortOrderOptions = {
     /** Content kind the picker lists. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/smart-components-kit",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Stateful, data-connected React components shared by Pushwoosh micro-frontends",
   "repository": {
     "type": "git",