@jskit-ai/users-web 0.1.65 → 0.1.67

package/package.descriptor.mjs

@@ -3,7 +3,7 @@ import { HOME_TOOLS_OUTLET } from "./src/shared/toolsOutletContracts.js";
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/users-web",
-  version: "0.1.65",
+  version: "0.1.67",
   kind: "runtime",
   description: "Users web module: account/profile UI plus shared users web widgets.",
   dependsOn: [
@@ -154,12 +154,12 @@ export default Object.freeze({
       runtime: {
         "@tanstack/vue-query": "5.92.12",
         "@mdi/js": "^7.4.47",
-        "@jskit-ai/http-runtime": "0.1.49",
-        "@jskit-ai/realtime": "0.1.49",
-        "@jskit-ai/kernel": "0.1.50",
-        "@jskit-ai/shell-web": "0.1.49",
-        "@jskit-ai/uploads-image-web": "0.1.28",
-        "@jskit-ai/users-core": "0.1.60",
+        "@jskit-ai/http-runtime": "0.1.51",
+        "@jskit-ai/realtime": "0.1.51",
+        "@jskit-ai/kernel": "0.1.52",
+        "@jskit-ai/shell-web": "0.1.51",
+        "@jskit-ai/uploads-image-web": "0.1.30",
+        "@jskit-ai/users-core": "0.1.62",
         vuetify: "^4.0.0"
       },
       dev: {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/users-web",
-  "version": "0.1.65",
+  "version": "0.1.67",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -35,12 +35,12 @@
   "dependencies": {
     "@tanstack/vue-query": "5.92.12",
     "@mdi/js": "^7.4.47",
-    "@jskit-ai/http-runtime": "0.1.49",
-    "@jskit-ai/kernel": "0.1.50",
-    "@jskit-ai/realtime": "0.1.49",
-    "@jskit-ai/shell-web": "0.1.49",
-    "@jskit-ai/uploads-image-web": "0.1.28",
-    "@jskit-ai/users-core": "0.1.60",
+    "@jskit-ai/http-runtime": "0.1.51",
+    "@jskit-ai/kernel": "0.1.52",
+    "@jskit-ai/realtime": "0.1.51",
+    "@jskit-ai/shell-web": "0.1.51",
+    "@jskit-ai/uploads-image-web": "0.1.30",
+    "@jskit-ai/users-core": "0.1.62",
     "vuetify": "^4.0.0"
   }
 }

package/src/client/composables/records/useView.js

@@ -6,6 +6,12 @@ import { useEndpointResource } from "../runtime/useEndpointResource.js";
 import { resolveOperationAdapter } from "../runtime/operationAdapters.js";
 import { setupOperationErrorReporting } from "../runtime/operationUiHelpers.js";
 import { createViewUiRuntime } from "../runtime/viewUiRuntime.js";
+import {
+  resolveQueryParamDescriptors,
+  resolveActiveQueryParamEntries,
+  buildQueryParamEntriesToken
+} from "../support/listQueryParamSupport.js";
+import { appendRequestQueryEntriesToPath } from "../support/requestQueryPathSupport.js";
 import { resolveRouteParamNamesInOrder } from "../support/routeTemplateHelpers.js";
 
 function useView({
@@ -23,6 +29,7 @@ function useView({
   notFoundMessage = "Record not found.",
   model,
   mapLoadedToModel,
+  requestQueryParams = null,
   recordIdParam = "recordId",
   routeParams = null,
   routeRecordId = null,
@@ -62,20 +69,46 @@ function useView({
     },
     realtime
   });
+  const queryParamsContext = computed(() => {
+    return Object.freeze({
+      surfaceId: operationScope.routeContext.currentSurfaceId.value,
+      scopeParamValue: operationScope.scopeParamValue.value,
+      ownershipFilter: operationScope.normalizedOwnershipFilter
+    });
+  });
+  const requestQueryParamDescriptors = computed(() => {
+    return resolveQueryParamDescriptors(requestQueryParams, queryParamsContext.value);
+  });
+  const activeRequestQueryParamEntries = computed(() => {
+    return resolveActiveQueryParamEntries(requestQueryParamDescriptors.value);
+  });
+  const activeRequestQueryParamsToken = computed(() => {
+    return buildQueryParamEntriesToken(activeRequestQueryParamEntries.value);
+  });
   const queryKey = computed(() => {
     const source = Array.isArray(operationScope.queryKey.value) ? operationScope.queryKey.value : [];
+    const next = [...source];
+    if (activeRequestQueryParamsToken.value) {
+      next.push("__request_query__", activeRequestQueryParamsToken.value);
+    }
     if (!includeRecordIdInQueryKey) {
-      return source;
+      return next;
     }
 
     const recordIdToken = String(viewUiRuntime.recordId.value || "").trim();
-    return [...source, recordIdToken];
+    return [...next, recordIdToken];
+  });
+  const requestPath = computed(() => {
+    return appendRequestQueryEntriesToPath(
+      operationScope.apiPath.value,
+      activeRequestQueryParamEntries.value
+    );
   });
   const canView = operationScope.permissionGate("view");
 
   const resource = useEndpointResource({
     queryKey,
-    path: operationScope.apiPath,
+    path: requestPath,
     enabled: operationScope.queryCanRun(canView),
     readMethod,
     fallbackLoadError

package/src/client/composables/support/requestQueryPathSupport.js

@@ -0,0 +1,31 @@
+import { appendQueryString } from "@jskit-ai/kernel/shared/support";
+
+function appendRequestQueryEntriesToPath(path = "", entries = []) {
+  const normalizedPath = String(path || "").trim();
+  if (!normalizedPath) {
+    return "";
+  }
+
+  const sourceEntries = Array.isArray(entries) ? entries : [];
+  const searchParams = new URLSearchParams();
+  for (const entry of sourceEntries) {
+    const key = String(entry?.key || "").trim();
+    const values = Array.isArray(entry?.values) ? entry.values : [];
+    if (!key || values.length < 1) {
+      continue;
+    }
+
+    for (const value of values) {
+      searchParams.append(key, value);
+    }
+  }
+
+  const serializedSearch = searchParams.toString();
+  if (!serializedSearch) {
+    return normalizedPath;
+  }
+
+  return appendQueryString(normalizedPath, serializedSearch);
+}
+
+export { appendRequestQueryEntriesToPath };

package/test/useViewRequestQueryParams.test.js

@@ -0,0 +1,20 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+import { appendRequestQueryEntriesToPath } from "../src/client/composables/support/requestQueryPathSupport.js";
+
+test("appendRequestQueryEntriesToPath appends request query params deterministically", () => {
+  assert.equal(
+    appendRequestQueryEntriesToPath("/api/w/dev-admin/contacts/1", [
+      { key: "include", values: ["vetId", "linkedUserId", "pets", "pets.breedId"] },
+      { key: "limit", values: ["10"] }
+    ]),
+    "/api/w/dev-admin/contacts/1?include=vetId&include=linkedUserId&include=pets&include=pets.breedId&limit=10"
+  );
+});
+
+test("appendRequestQueryEntriesToPath leaves the base path unchanged when no request params are active", () => {
+  assert.equal(
+    appendRequestQueryEntriesToPath("/api/w/dev-admin/contacts/1", []),
+    "/api/w/dev-admin/contacts/1"
+  );
+});