@kubex/zinc 1.1.150 → 1.1.152

package/dist/custom-elements.json

@@ -8983,6 +8983,16 @@
               "description": "When set, the table's non-default state (search, filter, sort, page, per-page and field values)\nis mirrored to the URL query string and restored from it on load, so the view is shareable.",
               "attribute": "sharable"
             },
+            {
+              "kind": "field",
+              "name": "wrapSearchFields",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When set, extra request params (search-component field values) are nested under a\n`searchFields` object - with `q` mirroring the search text - instead of being merged at the\nroot of the request body.",
+              "attribute": "wrap-search-fields"
+            },
             {
               "kind": "field",
               "name": "groupBy",
@@ -9165,7 +9175,7 @@
               "kind": "field",
               "name": "_dataTask",
               "privacy": "private",
-              "default": "new Task(this, { task: async ([dataUri, requestParams], {signal}) => { // Every request path funnels through the task, so this is the single place to mirror the // current (non-default) state to the URL when `sharable` is set. this._updateSharableUrl(); if (dataUri === undefined || this.noInitialLoad && this._initialLoad) { return {rows: [], page: 1, perPage: this.itemsPerPage, total: 0}; } if (this.groupBy) { // we want to load all the data possible so we can group and show multiple tables this.itemsPerPage = 1000; } const requestData: DataRequest = { page: this.page, perPage: this.itemsPerPage, sortColumn: this.sortColumn, sortDirection: this.sortDirection, filter: this.filter, search: this.search, }; // Inputs-slot values are context/system params (e.g. csrf token, package name) sent with // every request - they stay at the root of the payload. const inputs = this.hasSlotController.getSlots(ActionSlots.inputs.valueOf()); const params: Record<string, any> = {}; if (inputs) { inputs.forEach((input) => { const allowedInputs = ['zn-input', 'zn-select', 'zn-query-builder', 'zn-multiselect', 'zn-params-select', 'zn-datepicker', 'input', 'select', 'textarea']; if (allowedInputs.includes(input.tagName.toLowerCase())) { const value = (input as AllowedInputElement).value as string || input.getAttribute('value'); const name = (input as AllowedInputElement).name || input.getAttribute('name'); if (name) { params[name] = value; } } }); Object.assign(requestData, params); } // Search-related fields (from <zn-data-table-search>'s `fields` slot, delivered via // requestParams) are wrapped under `searchFields` so the backend can bind them to a single // map rather than arbitrary root-level keys. `q` mirrors the search text; the root `search` // key is still sent for back-compatibility. Empty values are dropped, and `searchFields` is // null when nothing meaningful remains so the backend can treat it as \"no search\". const searchFields: Record<string, any> = {}; if (requestParams && typeof requestParams === 'object') { for (const [key, value] of Object.entries(requestParams as Record<string, unknown>)) { if (value !== undefined && value !== null && value !== '') { searchFields[key] = value; } } } if (this.search || Object.keys(searchFields).length > 0) { searchFields.q = this.search; } requestData.searchFields = Object.keys(searchFields).length > 0 ? searchFields : null; // This is also used for Rubix, so it may not work for your application. const response = await fetch(dataUri, { method: this.method, headers: { 'x-kx-fetch-style': 'zn-data-table', }, signal, credentials: 'same-origin', body: this.method === 'POST' ? JSON.stringify(requestData) : undefined }); if (!response.ok) throw new Error(response.statusText); return response.json(); }, args: () => [this.dataUri, this.requestParams] })"
+              "default": "new Task(this, { task: async ([dataUri, requestParams], {signal}) => { // Every request path funnels through the task, so this is the single place to mirror the // current (non-default) state to the URL when `sharable` is set. this._updateSharableUrl(); if (dataUri === undefined || this.noInitialLoad && this._initialLoad) { return {rows: [], page: 1, perPage: this.itemsPerPage, total: 0}; } if (this.groupBy) { // we want to load all the data possible so we can group and show multiple tables this.itemsPerPage = 1000; } const requestData: DataRequest = { page: this.page, perPage: this.itemsPerPage, sortColumn: this.sortColumn, sortDirection: this.sortDirection, filter: this.filter, search: this.search, }; // Inputs-slot values are context/system params (e.g. csrf token, package name) sent with // every request. const inputs = this.hasSlotController.getSlots(ActionSlots.inputs.valueOf()); const params: Record<string, any> = {}; if (inputs) { inputs.forEach((input) => { const allowedInputs = ['zn-input', 'zn-select', 'zn-query-builder', 'zn-multiselect', 'zn-params-select', 'zn-datepicker', 'input', 'select', 'textarea']; if (allowedInputs.includes(input.tagName.toLowerCase())) { const value = (input as AllowedInputElement).value as string || input.getAttribute('value'); const name = (input as AllowedInputElement).name || input.getAttribute('name'); if (name) { params[name] = value; } } }); Object.assign(requestData, params); } // Add any extra request params const extraParams = requestParams && typeof requestParams === 'object' ? requestParams as Record<string, unknown> : {}; if (this.wrapSearchFields) { // Opt-in shape: field values nested under `searchFields`, with `q` mirroring the search // text, so a backend can bind them to one map. Empty values are dropped, and the key is // null when nothing is set. The root `search` key is sent either way. const searchFields: Record<string, any> = {}; for (const [key, value] of Object.entries(extraParams)) { if (value !== undefined && value !== null && value !== '') { searchFields[key] = value; } } if (this.search || Object.keys(searchFields).length > 0) { searchFields.q = this.search; } requestData.searchFields = Object.keys(searchFields).length > 0 ? searchFields : null; } else { Object.assign(requestData, extraParams); } // This is also used for Rubix, so it may not work for your application. const response = await fetch(dataUri, { method: this.method, headers: { 'x-kx-fetch-style': 'zn-data-table', }, signal, credentials: 'same-origin', body: this.method === 'POST' ? JSON.stringify(requestData) : undefined }); if (!response.ok) throw new Error(response.statusText); return response.json(); }, args: () => [this.dataUri, this.requestParams] })"
             },
             {
               "kind": "field",
@@ -10184,6 +10194,15 @@
               "description": "When set, the table's non-default state (search, filter, sort, page, per-page and field values)\nis mirrored to the URL query string and restored from it on load, so the view is shareable.",
               "fieldName": "sharable"
             },
+            {
+              "name": "wrap-search-fields",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "When set, extra request params (search-component field values) are nested under a\n`searchFields` object - with `q` mirroring the search text - instead of being merged at the\nroot of the request body.",
+              "fieldName": "wrapSearchFields"
+            },
             {
               "name": "group-by",
               "type": {
@@ -26695,7 +26714,7 @@
               "name": "pageSlotController",
               "privacy": "private",
               "readonly": true,
-              "default": "new HasSlotController(this, 'breadcrumb', 'actions', 'caption')"
+              "default": "new HasSlotController(this, 'breadcrumb', 'actions', 'caption', 'description')"
             },
             {
               "kind": "field",
@@ -53493,7 +53512,7 @@
   "package": {
     "name": "@kubex/zinc",
     "description": "A collection of web components for building web applications based off of @shoelace-style/Shoelace",
-    "version": "1.1.150",
+    "version": "1.1.152",
     "author": "",
     "license": "MIT"
   }

package/dist/vscode.html-custom-data.json

@@ -1234,6 +1234,11 @@
           "description": "When set, the table's non-default state (search, filter, sort, page, per-page and field values)\nis mirrored to the URL query string and restored from it on load, so the view is shareable.",
           "values": []
         },
+        {
+          "name": "wrap-search-fields",
+          "description": "When set, extra request params (search-component field values) are nested under a\n`searchFields` object - with `q` mirroring the search text - instead of being merged at the\nroot of the request body.",
+          "values": []
+        },
         { "name": "group-by", "values": [] },
         { "name": "groups", "values": [] },
         { "name": "per-page-size", "values": [] }

package/dist/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
   "name": "@kubex/zinc",
-  "version": "1.1.150",
+  "version": "1.1.152",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -2766,6 +2766,11 @@
               "description": "When set, the table's non-default state (search, filter, sort, page, per-page and field values)\nis mirrored to the URL query string and restored from it on load, so the view is shareable.",
               "value": { "type": "boolean", "default": "false" }
             },
+            {
+              "name": "wrap-search-fields",
+              "description": "When set, extra request params (search-component field values) are nested under a\n`searchFields` object - with `q` mirroring the search text - instead of being merged at the\nroot of the request body.",
+              "value": { "type": "boolean", "default": "false" }
+            },
             {
               "name": "group-by",
               "value": { "type": "string", "default": "''" }
@@ -2859,6 +2864,11 @@
                 "description": "When set, the table's non-default state (search, filter, sort, page, per-page and field values)\nis mirrored to the URL query string and restored from it on load, so the view is shareable.",
                 "type": "boolean"
               },
+              {
+                "name": "wrapSearchFields",
+                "description": "When set, extra request params (search-component field values) are nested under a\n`searchFields` object - with `q` mirroring the search text - instead of being merged at the\nroot of the request body.",
+                "type": "boolean"
+              },
               { "name": "groupBy", "type": "string" },
               { "name": "groups", "type": "string" },
               { "name": "itemsPerPage", "type": "number" },

package/dist/zn.d.ts

@@ -4192,6 +4192,12 @@ declare module "components/data-table/data-table.component" {
          *is mirrored to the URL query string and restored from it on load, so the view is shareable.
          */
         sharable: boolean;
+        /**
+         * When set, extra request params (search-component field values) are nested under a
+         * `searchFields` object - with `q` mirroring the search text - instead of being merged at the
+         * root of the request body.
+         */
+        wrapSearchFields: boolean;
         groupBy: string;
         groups: string;
         itemsPerPage: number;