@wordpress/views 1.0.1-next.47f435fc9.0

package/README.md

@@ -0,0 +1,72 @@
+# @wordpress/views
+
+A lightweight package for managing DataViews view state with persistence using WordPress preferences.
+
+The `@wordpress/views` package provides:
+
+-   **Persistence**: Automatically saves and restores DataViews state using `@wordpress/preferences`
+-   **View Modification Detection**: Tracks when views differ from their default state
+-   **Reset Functionality**: Simple reset to default view capability
+-   **Clean Integration**: Drop-in replacement for manual view state management
+
+## Installation
+
+Install the module
+
+```bash
+npm install @wordpress/views --save
+```
+
+## API Reference
+
+<!-- START TOKEN(Autogenerated API docs) -->
+
+### loadView
+
+Async function for loading view state in route loaders with optional URL parameters.
+
+_Usage_
+
+```typescript
+// In route loader
+const view = await loadView( {
+	kind: 'taxonomy',
+	name: 'category',
+	slug: 'all',
+	defaultView,
+	queryParams: { page: search.page, search: search.search },
+} );
+```
+
+_Parameters_
+
+-   _config_ `ViewConfig`: Configuration object for loading the view.
+-   _config.kind_ `ViewConfig`: Entity kind (e.g., 'postType', 'taxonomy', 'root').
+-   _config.name_ `ViewConfig`: Specific entity name.
+-   _config.slug_ `ViewConfig`: View identifier.
+-   _config.defaultView_ `ViewConfig`: Default view configuration.
+-   _config.queryParams_ `ViewConfig`: Object with `page` and/or `search` from URL.
+
+_Returns_
+
+-   Promise resolving to the loaded view object.
+
+### useView
+
+Hook for managing DataViews view state with local persistence.
+
+_Parameters_
+
+-   _config_ `ViewConfig`: Configuration object for loading the view.
+-   _config.kind_ `ViewConfig`: Entity kind (e.g., 'postType', 'taxonomy', 'root').
+-   _config.name_ `ViewConfig`: Specific entity name.
+-   _config.slug_ `ViewConfig`: View identifier.
+-   _config.defaultView_ `ViewConfig`: Default view configuration.
+-   _config.queryParams_ `ViewConfig`: Object with `page` and/or `search` from URL.
+-   _config.onChangeQueryParams_ `ViewConfig`: Optional callback to update URL parameters.
+
+_Returns_
+
+-   `UseViewReturn`: Object with current view, modification state, and update functions.
+
+<!-- END TOKEN(Autogenerated API docs) -->

package/build/index.js

@@ -0,0 +1,32 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var index_exports = {};
+__export(index_exports, {
+  loadView: () => import_load_view.loadView,
+  useView: () => import_use_view.useView
+});
+module.exports = __toCommonJS(index_exports);
+var import_use_view = require("./use-view");
+var import_load_view = require("./load-view");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  loadView,
+  useView
+});
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["export { useView } from './use-view';\nexport { loadView } from './load-view';\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAAwB;AACxB,uBAAyB;",
+  "names": []
+}

package/build/load-view.js

@@ -0,0 +1,47 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var load_view_exports = {};
+__export(load_view_exports, {
+  loadView: () => loadView
+});
+module.exports = __toCommonJS(load_view_exports);
+var import_data = require("@wordpress/data");
+var import_preferences = require("@wordpress/preferences");
+var import_preference_keys = require("./preference-keys");
+async function loadView(config) {
+  const { kind, name, slug, defaultView, queryParams } = config;
+  const preferenceKey = (0, import_preference_keys.generatePreferenceKey)(kind, name, slug);
+  const persistedView = (0, import_data.select)(import_preferences.store).get(
+    "core/views",
+    preferenceKey
+  );
+  const baseView = persistedView ?? defaultView;
+  const page = queryParams?.page ?? 1;
+  const search = queryParams?.search ?? "";
+  return {
+    ...baseView,
+    page,
+    search
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  loadView
+});
+//# sourceMappingURL=load-view.js.map

package/build/load-view.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/load-view.ts"],
+  "sourcesContent": ["/**\n * WordPress dependencies\n */\nimport { select } from '@wordpress/data';\n// @ts-ignore - Preferences package is not typed\nimport { store as preferencesStore } from '@wordpress/preferences';\nimport type { View } from '@wordpress/dataviews';\n\n/**\n * Internal dependencies\n */\nimport { generatePreferenceKey } from './preference-keys';\nimport type { ViewConfig } from './types';\n\n/**\n * Async function for loading view state in route loaders with optional URL parameters.\n *\n * @example\n *\n * ```typescript\n * // In route loader\n * const view = await loadView( {\n * \tkind: 'taxonomy',\n * \tname: 'category',\n * \tslug: 'all',\n * \tdefaultView,\n * \tqueryParams: { page: search.page, search: search.search },\n * } );\n * ```\n *\n * @param config             Configuration object for loading the view.\n * @param config.kind        Entity kind (e.g., 'postType', 'taxonomy', 'root').\n * @param config.name        Specific entity name.\n * @param config.slug        View identifier.\n * @param config.defaultView Default view configuration.\n * @param config.queryParams Object with `page` and/or `search` from URL.\n *\n * @return Promise resolving to the loaded view object.\n */\nexport async function loadView( config: ViewConfig ) {\n\tconst { kind, name, slug, defaultView, queryParams } = config;\n\tconst preferenceKey = generatePreferenceKey( kind, name, slug );\n\tconst persistedView: View | undefined = select( preferencesStore ).get(\n\t\t'core/views',\n\t\tpreferenceKey\n\t) as View | undefined;\n\n\tconst baseView = persistedView ?? defaultView;\n\tconst page = queryParams?.page ?? 1;\n\tconst search = queryParams?.search ?? '';\n\n\treturn {\n\t\t...baseView,\n\t\tpage,\n\t\tsearch,\n\t};\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,kBAAuB;AAEvB,yBAA0C;AAM1C,6BAAsC;AA4BtC,eAAsB,SAAU,QAAqB;AACpD,QAAM,EAAE,MAAM,MAAM,MAAM,aAAa,YAAY,IAAI;AACvD,QAAM,oBAAgB,8CAAuB,MAAM,MAAM,IAAK;AAC9D,QAAM,oBAAkC,oBAAQ,mBAAAA,KAAiB,EAAE;AAAA,IAClE;AAAA,IACA;AAAA,EACD;AAEA,QAAM,WAAW,iBAAiB;AAClC,QAAM,OAAO,aAAa,QAAQ;AAClC,QAAM,SAAS,aAAa,UAAU;AAEtC,SAAO;AAAA,IACN,GAAG;AAAA,IACH;AAAA,IACA;AAAA,EACD;AACD;",
+  "names": ["preferencesStore"]
+}

package/build/preference-keys.js

@@ -0,0 +1,31 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var preference_keys_exports = {};
+__export(preference_keys_exports, {
+  generatePreferenceKey: () => generatePreferenceKey
+});
+module.exports = __toCommonJS(preference_keys_exports);
+function generatePreferenceKey(kind, name, slug) {
+  return `dataviews-${kind}-${name}-${slug}`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generatePreferenceKey
+});
+//# sourceMappingURL=preference-keys.js.map

package/build/preference-keys.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/preference-keys.ts"],
+  "sourcesContent": ["/**\n * Generates a unique preference key for a DataViews view.\n *\n * @param kind The entity kind (e.g., 'postType', 'root')\n * @param name The specific entity name (e.g., 'post', 'user', 'site')\n * @param slug The specific entity slug (e.g., 'category', 'post', 'all')\n * @return The preference key string\n */\nexport function generatePreferenceKey(\n\tkind: string,\n\tname: string,\n\tslug: string\n): string {\n\treturn `dataviews-${ kind }-${ name }-${ slug }`;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAQO,SAAS,sBACf,MACA,MACA,MACS;AACT,SAAO,aAAc,IAAK,IAAK,IAAK,IAAK,IAAK;AAC/C;",
+  "names": []
+}

package/build/types.js

@@ -0,0 +1,17 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/types.ts"],
+  "sourcesContent": ["/**\n * WordPress dependencies\n */\nimport type { View } from '@wordpress/dataviews';\n\nexport interface ViewConfig {\n\t/**\n\t * Entity kind (e.g. postType, root).\n\t * Similar to core-data entity kinds.\n\t */\n\tkind: string;\n\n\t/**\n\t * Entity name (e.g. post, page, user, site).\n\t * Similar to core-data entity names.\n\t */\n\tname: string;\n\n\t/**\n\t * Identifier for the current view (all, published, mine, etc.)\n\t */\n\tslug: string;\n\n\t/**\n\t * Default view configuration\n\t */\n\tdefaultView: View;\n\n\t/**\n\t * Optional query parameters from URL (page, search)\n\t */\n\tqueryParams?: {\n\t\tpage?: number;\n\t\tsearch?: string;\n\t};\n\n\t/**\n\t * Callback for when URL query parameters should change\n\t */\n\tonChangeQueryParams?: ( params: {\n\t\tpage?: number;\n\t\tsearch?: string;\n\t} ) => void;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;AAAA;AAAA;",
+  "names": []
+}

package/build/use-view.js

@@ -0,0 +1,102 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var use_view_exports = {};
+__export(use_view_exports, {
+  useView: () => useView
+});
+module.exports = __toCommonJS(use_view_exports);
+var import_dequal = require("dequal");
+var import_preference_keys = require("./preference-keys");
+var import_element = require("@wordpress/element");
+var import_data = require("@wordpress/data");
+var import_preferences = require("@wordpress/preferences");
+function omit(obj, keys) {
+  const result = { ...obj };
+  for (const key of keys) {
+    delete result[key];
+  }
+  return result;
+}
+function useView(config) {
+  const { kind, name, slug, defaultView, queryParams, onChangeQueryParams } = config;
+  const preferenceKey = (0, import_preference_keys.generatePreferenceKey)(kind, name, slug);
+  const persistedView = (0, import_data.useSelect)(
+    (select) => {
+      return select(import_preferences.store).get(
+        "core/views",
+        preferenceKey
+      );
+    },
+    [preferenceKey]
+  );
+  const { set } = (0, import_data.useDispatch)(import_preferences.store);
+  const baseView = persistedView ?? defaultView;
+  const page = queryParams?.page ?? baseView.page ?? 1;
+  const search = queryParams?.search ?? baseView.search ?? "";
+  const view = (0, import_element.useMemo)(() => {
+    return {
+      ...baseView,
+      page,
+      search
+    };
+  }, [baseView, page, search]);
+  const isModified = !!persistedView;
+  const updateView = (0, import_element.useCallback)(
+    (newView) => {
+      const urlParams = {
+        page: newView?.page,
+        search: newView?.search
+      };
+      const preferenceView = omit(newView, ["page", "search"]);
+      if (onChangeQueryParams && !(0, import_dequal.dequal)(urlParams, { page, search })) {
+        onChangeQueryParams(urlParams);
+      }
+      if (!(0, import_dequal.dequal)(baseView, preferenceView)) {
+        if ((0, import_dequal.dequal)(preferenceView, defaultView)) {
+          set("core/views", preferenceKey, void 0);
+        } else {
+          set("core/views", preferenceKey, preferenceView);
+        }
+      }
+    },
+    [
+      onChangeQueryParams,
+      page,
+      search,
+      baseView,
+      defaultView,
+      set,
+      preferenceKey
+    ]
+  );
+  const resetToDefault = (0, import_element.useCallback)(() => {
+    set("core/views", preferenceKey, void 0);
+  }, [preferenceKey, set]);
+  return {
+    view,
+    isModified,
+    updateView,
+    resetToDefault
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useView
+});
+//# sourceMappingURL=use-view.js.map

package/build/use-view.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/use-view.ts"],
+  "sourcesContent": ["/**\n * External dependencies\n */\nimport { dequal } from 'dequal';\n\n/**\n * Internal dependencies\n */\nimport { generatePreferenceKey } from './preference-keys';\nimport type { ViewConfig } from './types';\n\n/**\n * WordPress dependencies\n */\nimport { useCallback, useMemo } from '@wordpress/element';\nimport { useDispatch, useSelect } from '@wordpress/data';\nimport type { View } from '@wordpress/dataviews';\n// @ts-ignore - Preferences package is not typed\nimport { store as preferencesStore } from '@wordpress/preferences';\n\ninterface UseViewReturn {\n\tview: View;\n\tisModified: boolean;\n\tupdateView: ( newView: View ) => void;\n\tresetToDefault: () => void;\n}\n\nfunction omit< T extends object, K extends keyof T >(\n\tobj: T,\n\tkeys: K[]\n): Omit< T, K > {\n\tconst result = { ...obj };\n\tfor ( const key of keys ) {\n\t\tdelete result[ key ];\n\t}\n\treturn result;\n}\n\n/**\n * Hook for managing DataViews view state with local persistence.\n *\n * @param config                     Configuration object for loading the view.\n * @param config.kind                Entity kind (e.g., 'postType', 'taxonomy', 'root').\n * @param config.name                Specific entity name.\n * @param config.slug                View identifier.\n * @param config.defaultView         Default view configuration.\n * @param config.queryParams         Object with `page` and/or `search` from URL.\n * @param config.onChangeQueryParams Optional callback to update URL parameters.\n *\n * @return Object with current view, modification state, and update functions.\n */\nexport function useView( config: ViewConfig ): UseViewReturn {\n\tconst { kind, name, slug, defaultView, queryParams, onChangeQueryParams } =\n\t\tconfig;\n\n\tconst preferenceKey = generatePreferenceKey( kind, name, slug );\n\tconst persistedView: View | undefined = useSelect(\n\t\t( select ) => {\n\t\t\treturn select( preferencesStore ).get(\n\t\t\t\t'core/views',\n\t\t\t\tpreferenceKey\n\t\t\t) as View | undefined;\n\t\t},\n\t\t[ preferenceKey ]\n\t);\n\tconst { set } = useDispatch( preferencesStore );\n\n\tconst baseView: View = persistedView ?? defaultView;\n\tconst page = queryParams?.page ?? baseView.page ?? 1;\n\tconst search = queryParams?.search ?? baseView.search ?? '';\n\n\t// Merge URL query parameters (page, search) into the view\n\tconst view: View = useMemo( () => {\n\t\treturn {\n\t\t\t...baseView,\n\t\t\tpage,\n\t\t\tsearch,\n\t\t};\n\t}, [ baseView, page, search ] );\n\n\tconst isModified = !! persistedView;\n\n\tconst updateView = useCallback(\n\t\t( newView: View ) => {\n\t\t\t// Extract URL params (page, search) from the new view\n\t\t\tconst urlParams: { page?: number; search?: string } = {\n\t\t\t\tpage: newView?.page,\n\t\t\t\tsearch: newView?.search,\n\t\t\t};\n\t\t\tconst preferenceView = omit( newView, [ 'page', 'search' ] );\n\n\t\t\t// If we have URL handling enabled, separate URL state from preference state\n\t\t\tif (\n\t\t\t\tonChangeQueryParams &&\n\t\t\t\t! dequal( urlParams, { page, search } )\n\t\t\t) {\n\t\t\t\tonChangeQueryParams( urlParams );\n\t\t\t}\n\n\t\t\t// Only persist non-URL preferences if different from baseView\n\t\t\tif ( ! dequal( baseView, preferenceView ) ) {\n\t\t\t\tif ( dequal( preferenceView, defaultView ) ) {\n\t\t\t\t\tset( 'core/views', preferenceKey, undefined );\n\t\t\t\t} else {\n\t\t\t\t\tset( 'core/views', preferenceKey, preferenceView );\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t[\n\t\t\tonChangeQueryParams,\n\t\t\tpage,\n\t\t\tsearch,\n\t\t\tbaseView,\n\t\t\tdefaultView,\n\t\t\tset,\n\t\t\tpreferenceKey,\n\t\t]\n\t);\n\n\tconst resetToDefault = useCallback( () => {\n\t\tset( 'core/views', preferenceKey, undefined );\n\t}, [ preferenceKey, set ] );\n\n\treturn {\n\t\tview,\n\t\tisModified,\n\t\tupdateView,\n\t\tresetToDefault,\n\t};\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,oBAAuB;AAKvB,6BAAsC;AAMtC,qBAAqC;AACrC,kBAAuC;AAGvC,yBAA0C;AAS1C,SAAS,KACR,KACA,MACe;AACf,QAAM,SAAS,EAAE,GAAG,IAAI;AACxB,aAAY,OAAO,MAAO;AACzB,WAAO,OAAQ,GAAI;AAAA,EACpB;AACA,SAAO;AACR;AAeO,SAAS,QAAS,QAAoC;AAC5D,QAAM,EAAE,MAAM,MAAM,MAAM,aAAa,aAAa,oBAAoB,IACvE;AAED,QAAM,oBAAgB,8CAAuB,MAAM,MAAM,IAAK;AAC9D,QAAM,oBAAkC;AAAA,IACvC,CAAE,WAAY;AACb,aAAO,OAAQ,mBAAAA,KAAiB,EAAE;AAAA,QACjC;AAAA,QACA;AAAA,MACD;AAAA,IACD;AAAA,IACA,CAAE,aAAc;AAAA,EACjB;AACA,QAAM,EAAE,IAAI,QAAI,yBAAa,mBAAAA,KAAiB;AAE9C,QAAM,WAAiB,iBAAiB;AACxC,QAAM,OAAO,aAAa,QAAQ,SAAS,QAAQ;AACnD,QAAM,SAAS,aAAa,UAAU,SAAS,UAAU;AAGzD,QAAM,WAAa,wBAAS,MAAM;AACjC,WAAO;AAAA,MACN,GAAG;AAAA,MACH;AAAA,MACA;AAAA,IACD;AAAA,EACD,GAAG,CAAE,UAAU,MAAM,MAAO,CAAE;AAE9B,QAAM,aAAa,CAAC,CAAE;AAEtB,QAAM,iBAAa;AAAA,IAClB,CAAE,YAAmB;AAEpB,YAAM,YAAgD;AAAA,QACrD,MAAM,SAAS;AAAA,QACf,QAAQ,SAAS;AAAA,MAClB;AACA,YAAM,iBAAiB,KAAM,SAAS,CAAE,QAAQ,QAAS,CAAE;AAG3D,UACC,uBACA,KAAE,sBAAQ,WAAW,EAAE,MAAM,OAAO,CAAE,GACrC;AACD,4BAAqB,SAAU;AAAA,MAChC;AAGA,UAAK,KAAE,sBAAQ,UAAU,cAAe,GAAI;AAC3C,gBAAK,sBAAQ,gBAAgB,WAAY,GAAI;AAC5C,cAAK,cAAc,eAAe,MAAU;AAAA,QAC7C,OAAO;AACN,cAAK,cAAc,eAAe,cAAe;AAAA,QAClD;AAAA,MACD;AAAA,IACD;AAAA,IACA;AAAA,MACC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACD;AAAA,EACD;AAEA,QAAM,qBAAiB,4BAAa,MAAM;AACzC,QAAK,cAAc,eAAe,MAAU;AAAA,EAC7C,GAAG,CAAE,eAAe,GAAI,CAAE;AAE1B,SAAO;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD;AACD;",
+  "names": ["preferencesStore"]
+}

package/build-module/index.js

@@ -0,0 +1,7 @@
+import { useView } from "./use-view";
+import { loadView } from "./load-view";
+export {
+  loadView,
+  useView
+};
+//# sourceMappingURL=index.js.map

package/build-module/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts"],
+  "sourcesContent": ["export { useView } from './use-view';\nexport { loadView } from './load-view';\n"],
+  "mappings": "AAAA,SAAS,eAAe;AACxB,SAAS,gBAAgB;",
+  "names": []
+}

package/build-module/load-view.js

@@ -0,0 +1,23 @@
+import { select } from "@wordpress/data";
+import { store as preferencesStore } from "@wordpress/preferences";
+import { generatePreferenceKey } from "./preference-keys";
+async function loadView(config) {
+  const { kind, name, slug, defaultView, queryParams } = config;
+  const preferenceKey = generatePreferenceKey(kind, name, slug);
+  const persistedView = select(preferencesStore).get(
+    "core/views",
+    preferenceKey
+  );
+  const baseView = persistedView ?? defaultView;
+  const page = queryParams?.page ?? 1;
+  const search = queryParams?.search ?? "";
+  return {
+    ...baseView,
+    page,
+    search
+  };
+}
+export {
+  loadView
+};
+//# sourceMappingURL=load-view.js.map

package/build-module/load-view.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/load-view.ts"],
+  "sourcesContent": ["/**\n * WordPress dependencies\n */\nimport { select } from '@wordpress/data';\n// @ts-ignore - Preferences package is not typed\nimport { store as preferencesStore } from '@wordpress/preferences';\nimport type { View } from '@wordpress/dataviews';\n\n/**\n * Internal dependencies\n */\nimport { generatePreferenceKey } from './preference-keys';\nimport type { ViewConfig } from './types';\n\n/**\n * Async function for loading view state in route loaders with optional URL parameters.\n *\n * @example\n *\n * ```typescript\n * // In route loader\n * const view = await loadView( {\n * \tkind: 'taxonomy',\n * \tname: 'category',\n * \tslug: 'all',\n * \tdefaultView,\n * \tqueryParams: { page: search.page, search: search.search },\n * } );\n * ```\n *\n * @param config             Configuration object for loading the view.\n * @param config.kind        Entity kind (e.g., 'postType', 'taxonomy', 'root').\n * @param config.name        Specific entity name.\n * @param config.slug        View identifier.\n * @param config.defaultView Default view configuration.\n * @param config.queryParams Object with `page` and/or `search` from URL.\n *\n * @return Promise resolving to the loaded view object.\n */\nexport async function loadView( config: ViewConfig ) {\n\tconst { kind, name, slug, defaultView, queryParams } = config;\n\tconst preferenceKey = generatePreferenceKey( kind, name, slug );\n\tconst persistedView: View | undefined = select( preferencesStore ).get(\n\t\t'core/views',\n\t\tpreferenceKey\n\t) as View | undefined;\n\n\tconst baseView = persistedView ?? defaultView;\n\tconst page = queryParams?.page ?? 1;\n\tconst search = queryParams?.search ?? '';\n\n\treturn {\n\t\t...baseView,\n\t\tpage,\n\t\tsearch,\n\t};\n}\n"],
+  "mappings": "AAGA,SAAS,cAAc;AAEvB,SAAS,SAAS,wBAAwB;AAM1C,SAAS,6BAA6B;AA4BtC,eAAsB,SAAU,QAAqB;AACpD,QAAM,EAAE,MAAM,MAAM,MAAM,aAAa,YAAY,IAAI;AACvD,QAAM,gBAAgB,sBAAuB,MAAM,MAAM,IAAK;AAC9D,QAAM,gBAAkC,OAAQ,gBAAiB,EAAE;AAAA,IAClE;AAAA,IACA;AAAA,EACD;AAEA,QAAM,WAAW,iBAAiB;AAClC,QAAM,OAAO,aAAa,QAAQ;AAClC,QAAM,SAAS,aAAa,UAAU;AAEtC,SAAO;AAAA,IACN,GAAG;AAAA,IACH;AAAA,IACA;AAAA,EACD;AACD;",
+  "names": []
+}

package/build-module/preference-keys.js

@@ -0,0 +1,7 @@
+function generatePreferenceKey(kind, name, slug) {
+  return `dataviews-${kind}-${name}-${slug}`;
+}
+export {
+  generatePreferenceKey
+};
+//# sourceMappingURL=preference-keys.js.map

package/build-module/preference-keys.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/preference-keys.ts"],
+  "sourcesContent": ["/**\n * Generates a unique preference key for a DataViews view.\n *\n * @param kind The entity kind (e.g., 'postType', 'root')\n * @param name The specific entity name (e.g., 'post', 'user', 'site')\n * @param slug The specific entity slug (e.g., 'category', 'post', 'all')\n * @return The preference key string\n */\nexport function generatePreferenceKey(\n\tkind: string,\n\tname: string,\n\tslug: string\n): string {\n\treturn `dataviews-${ kind }-${ name }-${ slug }`;\n}\n"],
+  "mappings": "AAQO,SAAS,sBACf,MACA,MACA,MACS;AACT,SAAO,aAAc,IAAK,IAAK,IAAK,IAAK,IAAK;AAC/C;",
+  "names": []
+}

package/build-module/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/build-module/types.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/build-module/use-view.js

@@ -0,0 +1,78 @@
+import { dequal } from "dequal";
+import { generatePreferenceKey } from "./preference-keys";
+import { useCallback, useMemo } from "@wordpress/element";
+import { useDispatch, useSelect } from "@wordpress/data";
+import { store as preferencesStore } from "@wordpress/preferences";
+function omit(obj, keys) {
+  const result = { ...obj };
+  for (const key of keys) {
+    delete result[key];
+  }
+  return result;
+}
+function useView(config) {
+  const { kind, name, slug, defaultView, queryParams, onChangeQueryParams } = config;
+  const preferenceKey = generatePreferenceKey(kind, name, slug);
+  const persistedView = useSelect(
+    (select) => {
+      return select(preferencesStore).get(
+        "core/views",
+        preferenceKey
+      );
+    },
+    [preferenceKey]
+  );
+  const { set } = useDispatch(preferencesStore);
+  const baseView = persistedView ?? defaultView;
+  const page = queryParams?.page ?? baseView.page ?? 1;
+  const search = queryParams?.search ?? baseView.search ?? "";
+  const view = useMemo(() => {
+    return {
+      ...baseView,
+      page,
+      search
+    };
+  }, [baseView, page, search]);
+  const isModified = !!persistedView;
+  const updateView = useCallback(
+    (newView) => {
+      const urlParams = {
+        page: newView?.page,
+        search: newView?.search
+      };
+      const preferenceView = omit(newView, ["page", "search"]);
+      if (onChangeQueryParams && !dequal(urlParams, { page, search })) {
+        onChangeQueryParams(urlParams);
+      }
+      if (!dequal(baseView, preferenceView)) {
+        if (dequal(preferenceView, defaultView)) {
+          set("core/views", preferenceKey, void 0);
+        } else {
+          set("core/views", preferenceKey, preferenceView);
+        }
+      }
+    },
+    [
+      onChangeQueryParams,
+      page,
+      search,
+      baseView,
+      defaultView,
+      set,
+      preferenceKey
+    ]
+  );
+  const resetToDefault = useCallback(() => {
+    set("core/views", preferenceKey, void 0);
+  }, [preferenceKey, set]);
+  return {
+    view,
+    isModified,
+    updateView,
+    resetToDefault
+  };
+}
+export {
+  useView
+};
+//# sourceMappingURL=use-view.js.map

package/build-module/use-view.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/use-view.ts"],
+  "sourcesContent": ["/**\n * External dependencies\n */\nimport { dequal } from 'dequal';\n\n/**\n * Internal dependencies\n */\nimport { generatePreferenceKey } from './preference-keys';\nimport type { ViewConfig } from './types';\n\n/**\n * WordPress dependencies\n */\nimport { useCallback, useMemo } from '@wordpress/element';\nimport { useDispatch, useSelect } from '@wordpress/data';\nimport type { View } from '@wordpress/dataviews';\n// @ts-ignore - Preferences package is not typed\nimport { store as preferencesStore } from '@wordpress/preferences';\n\ninterface UseViewReturn {\n\tview: View;\n\tisModified: boolean;\n\tupdateView: ( newView: View ) => void;\n\tresetToDefault: () => void;\n}\n\nfunction omit< T extends object, K extends keyof T >(\n\tobj: T,\n\tkeys: K[]\n): Omit< T, K > {\n\tconst result = { ...obj };\n\tfor ( const key of keys ) {\n\t\tdelete result[ key ];\n\t}\n\treturn result;\n}\n\n/**\n * Hook for managing DataViews view state with local persistence.\n *\n * @param config                     Configuration object for loading the view.\n * @param config.kind                Entity kind (e.g., 'postType', 'taxonomy', 'root').\n * @param config.name                Specific entity name.\n * @param config.slug                View identifier.\n * @param config.defaultView         Default view configuration.\n * @param config.queryParams         Object with `page` and/or `search` from URL.\n * @param config.onChangeQueryParams Optional callback to update URL parameters.\n *\n * @return Object with current view, modification state, and update functions.\n */\nexport function useView( config: ViewConfig ): UseViewReturn {\n\tconst { kind, name, slug, defaultView, queryParams, onChangeQueryParams } =\n\t\tconfig;\n\n\tconst preferenceKey = generatePreferenceKey( kind, name, slug );\n\tconst persistedView: View | undefined = useSelect(\n\t\t( select ) => {\n\t\t\treturn select( preferencesStore ).get(\n\t\t\t\t'core/views',\n\t\t\t\tpreferenceKey\n\t\t\t) as View | undefined;\n\t\t},\n\t\t[ preferenceKey ]\n\t);\n\tconst { set } = useDispatch( preferencesStore );\n\n\tconst baseView: View = persistedView ?? defaultView;\n\tconst page = queryParams?.page ?? baseView.page ?? 1;\n\tconst search = queryParams?.search ?? baseView.search ?? '';\n\n\t// Merge URL query parameters (page, search) into the view\n\tconst view: View = useMemo( () => {\n\t\treturn {\n\t\t\t...baseView,\n\t\t\tpage,\n\t\t\tsearch,\n\t\t};\n\t}, [ baseView, page, search ] );\n\n\tconst isModified = !! persistedView;\n\n\tconst updateView = useCallback(\n\t\t( newView: View ) => {\n\t\t\t// Extract URL params (page, search) from the new view\n\t\t\tconst urlParams: { page?: number; search?: string } = {\n\t\t\t\tpage: newView?.page,\n\t\t\t\tsearch: newView?.search,\n\t\t\t};\n\t\t\tconst preferenceView = omit( newView, [ 'page', 'search' ] );\n\n\t\t\t// If we have URL handling enabled, separate URL state from preference state\n\t\t\tif (\n\t\t\t\tonChangeQueryParams &&\n\t\t\t\t! dequal( urlParams, { page, search } )\n\t\t\t) {\n\t\t\t\tonChangeQueryParams( urlParams );\n\t\t\t}\n\n\t\t\t// Only persist non-URL preferences if different from baseView\n\t\t\tif ( ! dequal( baseView, preferenceView ) ) {\n\t\t\t\tif ( dequal( preferenceView, defaultView ) ) {\n\t\t\t\t\tset( 'core/views', preferenceKey, undefined );\n\t\t\t\t} else {\n\t\t\t\t\tset( 'core/views', preferenceKey, preferenceView );\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t[\n\t\t\tonChangeQueryParams,\n\t\t\tpage,\n\t\t\tsearch,\n\t\t\tbaseView,\n\t\t\tdefaultView,\n\t\t\tset,\n\t\t\tpreferenceKey,\n\t\t]\n\t);\n\n\tconst resetToDefault = useCallback( () => {\n\t\tset( 'core/views', preferenceKey, undefined );\n\t}, [ preferenceKey, set ] );\n\n\treturn {\n\t\tview,\n\t\tisModified,\n\t\tupdateView,\n\t\tresetToDefault,\n\t};\n}\n"],
+  "mappings": "AAGA,SAAS,cAAc;AAKvB,SAAS,6BAA6B;AAMtC,SAAS,aAAa,eAAe;AACrC,SAAS,aAAa,iBAAiB;AAGvC,SAAS,SAAS,wBAAwB;AAS1C,SAAS,KACR,KACA,MACe;AACf,QAAM,SAAS,EAAE,GAAG,IAAI;AACxB,aAAY,OAAO,MAAO;AACzB,WAAO,OAAQ,GAAI;AAAA,EACpB;AACA,SAAO;AACR;AAeO,SAAS,QAAS,QAAoC;AAC5D,QAAM,EAAE,MAAM,MAAM,MAAM,aAAa,aAAa,oBAAoB,IACvE;AAED,QAAM,gBAAgB,sBAAuB,MAAM,MAAM,IAAK;AAC9D,QAAM,gBAAkC;AAAA,IACvC,CAAE,WAAY;AACb,aAAO,OAAQ,gBAAiB,EAAE;AAAA,QACjC;AAAA,QACA;AAAA,MACD;AAAA,IACD;AAAA,IACA,CAAE,aAAc;AAAA,EACjB;AACA,QAAM,EAAE,IAAI,IAAI,YAAa,gBAAiB;AAE9C,QAAM,WAAiB,iBAAiB;AACxC,QAAM,OAAO,aAAa,QAAQ,SAAS,QAAQ;AACnD,QAAM,SAAS,aAAa,UAAU,SAAS,UAAU;AAGzD,QAAM,OAAa,QAAS,MAAM;AACjC,WAAO;AAAA,MACN,GAAG;AAAA,MACH;AAAA,MACA;AAAA,IACD;AAAA,EACD,GAAG,CAAE,UAAU,MAAM,MAAO,CAAE;AAE9B,QAAM,aAAa,CAAC,CAAE;AAEtB,QAAM,aAAa;AAAA,IAClB,CAAE,YAAmB;AAEpB,YAAM,YAAgD;AAAA,QACrD,MAAM,SAAS;AAAA,QACf,QAAQ,SAAS;AAAA,MAClB;AACA,YAAM,iBAAiB,KAAM,SAAS,CAAE,QAAQ,QAAS,CAAE;AAG3D,UACC,uBACA,CAAE,OAAQ,WAAW,EAAE,MAAM,OAAO,CAAE,GACrC;AACD,4BAAqB,SAAU;AAAA,MAChC;AAGA,UAAK,CAAE,OAAQ,UAAU,cAAe,GAAI;AAC3C,YAAK,OAAQ,gBAAgB,WAAY,GAAI;AAC5C,cAAK,cAAc,eAAe,MAAU;AAAA,QAC7C,OAAO;AACN,cAAK,cAAc,eAAe,cAAe;AAAA,QAClD;AAAA,MACD;AAAA,IACD;AAAA,IACA;AAAA,MACC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACD;AAAA,EACD;AAEA,QAAM,iBAAiB,YAAa,MAAM;AACzC,QAAK,cAAc,eAAe,MAAU;AAAA,EAC7C,GAAG,CAAE,eAAe,GAAI,CAAE;AAE1B,SAAO;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACD;AACD;",
+  "names": []
+}

package/build-types/index.d.ts

@@ -0,0 +1,3 @@
+export { useView } from './use-view';
+export { loadView } from './load-view';
+//# sourceMappingURL=index.d.ts.map

package/build-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC"}