@flipdish/ui-library 0.42.0 → 0.43.1

package/dist/utilities/searchParamsUtils/index.js

@@ -0,0 +1,64 @@
+/**
+ * The search param names every list page uses for its view tab, search, table sort, page and page size, so links and
+ * analytics read the same across apps. A page adds its own params, such as a filter or the open record, beside them.
+ */
+const LIST_PARAMS = {
+    view: 'view',
+    search: 'q',
+    sort: 'sort',
+    page: 'page',
+    pageSize: 'pageSize',
+};
+function parseEnumParam(value, allowed, fallback) {
+    return value !== null && allowed.includes(value) ? value : fallback;
+}
+/**
+ * Reads a page number out of a search param.
+ * @param value - The param's value, `null` when it is absent.
+ * @returns A whole number of at least 1; anything absent, fractional, negative or not a number is page 1.
+ */
+const parsePageParam = (value) => {
+    const page = Number(value);
+    return Number.isInteger(page) && page > 1 ? page : 1;
+};
+/**
+ * Reads a page size out of a search param, accepting only the sizes the page offers.
+ * @param value - The param's value, `null` when it is absent.
+ * @param allowed - The page sizes the pager's selector offers.
+ * @param fallback - The size to use when the value is absent or not one of `allowed`.
+ * @returns The page size.
+ */
+const parsePageSizeParam = (value, allowed, fallback) => {
+    const size = Number(value);
+    return value !== null && allowed.includes(size) ? size : fallback;
+};
+/**
+ * Reads a table sort out of a search param written by `sortToParam`: the column id, with a leading `-` for descending.
+ * @param value - The param's value, `null` when it is absent.
+ * @param columns - The columns that can be sorted.
+ * @param fallback - The sort to use when the value is absent or names a column that cannot be sorted.
+ * @returns The sort the value describes, or `fallback`.
+ */
+const parseSortParam = (value, columns, fallback) => {
+    if (!value)
+        return fallback;
+    const descending = value.startsWith('-');
+    const column = parseEnumParam(descending ? value.slice(1) : value, columns, null);
+    return column === null ? fallback : { column, direction: descending ? 'descending' : 'ascending' };
+};
+/**
+ * Writes a table sort as a search param value: the column id, with a leading `-` for descending, e.g. `-name`.
+ * @param sort - The table's sort; any `{ column, direction }`, such as react-aria's `SortDescriptor`.
+ * @param fallback - The page's default sort, which stays out of the URL.
+ * @returns The param value, or `null` when the sort is the default and the param should be left out.
+ */
+const sortToParam = (sort, fallback) => {
+    if (sort.column === undefined)
+        return null;
+    if (fallback && sort.column === fallback.column && sort.direction === fallback.direction)
+        return null;
+    return `${sort.direction === 'descending' ? '-' : ''}${String(sort.column)}`;
+};
+
+export { LIST_PARAMS, parseEnumParam, parsePageParam, parsePageSizeParam, parseSortParam, sortToParam };
+//# sourceMappingURL=index.js.map

package/dist/utilities/searchParamsUtils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../src/utilities/searchParamsUtils/index.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;AAGG;AACI,MAAM,WAAW,GAAG;AACzB,IAAA,IAAI,EAAE,MAAM;AACZ,IAAA,MAAM,EAAE,GAAG;AACX,IAAA,IAAI,EAAE,MAAM;AACZ,IAAA,IAAI,EAAE,MAAM;AACZ,IAAA,QAAQ,EAAE,UAAU;;SAkBN,cAAc,CAAmB,KAAoB,EAAE,OAAqB,EAAE,QAAkB,EAAA;AAC9G,IAAA,OAAO,KAAK,KAAK,IAAI,IAAK,OAA6B,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAI,KAAW,GAAG,QAAQ;AACnG;AAEA;;;;AAIG;AACI,MAAM,cAAc,GAAG,CAAC,KAAoB,KAAY;AAC7D,IAAA,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;AAC1B,IAAA,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC;AACtD;AAEA;;;;;;AAMG;AACI,MAAM,kBAAkB,GAAG,CAAC,KAAoB,EAAE,OAA0B,EAAE,QAAgB,KAAY;AAC/G,IAAA,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;AAC1B,IAAA,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,QAAQ;AACnE;AAEA;;;;;;AAMG;AACI,MAAM,cAAc,GAAG,CAC5B,KAAoB,EACpB,OAA0B,EAC1B,QAA2B,KACN;AACrB,IAAA,IAAI,CAAC,KAAK;AAAE,QAAA,OAAO,QAAQ;IAC3B,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;IACxC,MAAM,MAAM,GAAG,cAAc,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC;IACjF,OAAO,MAAM,KAAK,IAAI,GAAG,QAAQ,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,GAAG,YAAY,GAAG,WAAW,EAAE;AACpG;AAEA;;;;;AAKG;MACU,WAAW,GAAG,CAAC,IAA8C,EAAE,QAAiD,KAAmB;AAC9I,IAAA,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;AAAE,QAAA,OAAO,IAAI;AAC1C,IAAA,IAAI,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,SAAS;AAAE,QAAA,OAAO,IAAI;IACrG,OAAO,CAAA,EAAG,IAAI,CAAC,SAAS,KAAK,YAAY,GAAG,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA,CAAE;AAC9E;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flipdish/ui-library",
-  "version": "0.42.0",
+  "version": "0.43.1",
   "description": "Flipdish Design System — atomic-design component library (Tailwind v4 + UntitledUI + React Aria).",
   "type": "module",
   "imports": {
@@ -233,6 +233,7 @@
     "@storybook/addon-vitest": "10.6.3",
     "@storybook/react-vite": "^10.5.8",
     "@tailwindcss/vite": "^4.3.1",
+    "@tanstack/react-query": "^5.104.3",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.2",
     "@tiptap/core": "^3.27.1",
@@ -258,6 +259,7 @@
     "motion": "^12.40.0",
     "nativewind": "^5.0.0-rc.0",
     "playwright": "^1.61.1",
+    "prettier": "^3.9.10",
     "qr-code-styling": "^1.9.2",
     "react": "^19.0.0",
     "react-aria": "3.50.0",