@jskit-ai/users-web 0.1.70 → 0.1.71

package/src/client/composables/runtime/useCommandCore.js

@@ -9,7 +9,7 @@ function useCommandCore({
   canRun,
   fieldBag,
   feedback,
-  parseInput,
+  input,
   buildRawPayload,
   buildCommandPayload,
   buildCommandOptions,
@@ -43,13 +43,8 @@ function useCommandCore({
       : {};
 
     const validationResult = validateOperationInput({
-      parseInput,
+      input,
       rawPayload,
-      context: {
-        queryClient,
-        resource,
-        context
-      },
       fieldBag,
       feedback,
       validationMessage: String(messages.validation || "Validation failed.")
@@ -58,7 +53,7 @@ function useCommandCore({
       return null;
     }
 
-    const { parseResult, parsedInput } = validationResult;
+    const { parsedInput } = validationResult;
     const payload = typeof buildCommandPayload === "function"
       ? buildCommandPayload(parsedInput, {
           rawPayload,
@@ -83,7 +78,6 @@ function useCommandCore({
       if (typeof onRunSuccess === "function") {
         await onRunSuccess(response, {
           parsed: parsedInput,
-          parseResult,
           rawPayload,
           payload,
           options,
@@ -103,7 +97,6 @@ function useCommandCore({
       if (typeof onRunError === "function") {
         await onRunError(error, {
           parsed: parsedInput,
-          parseResult,
           rawPayload,
           payload,
           options,

package/src/client/composables/runtime/useEndpointResource.js

@@ -1,4 +1,4 @@
-import { computed } from "vue";
+import { computed, unref } from "vue";
 import { useMutation, useQuery } from "@tanstack/vue-query";
 import { usersWebHttpClient } from "../../lib/httpClient.js";
 import { asPlainObject } from "../support/scopeHelpers.js";
@@ -6,6 +6,58 @@ import { resolveEnabledRef, resolveTextRef } from "../support/refValueHelpers.js
 import { toQueryErrorMessage } from "../support/errorMessageHelpers.js";
 import { hasResolvedQueryData } from "../support/resourceLoadStateHelpers.js";
 
+function buildEndpointReadRequestOptions({
+  method = "GET",
+  query = null,
+  transport = null
+} = {}) {
+  const requestOptions = {
+    method: String(method || "GET").toUpperCase()
+  };
+
+  const normalizedQuery = resolveRequestQuery(query);
+  if (normalizedQuery) {
+    requestOptions.query = normalizedQuery;
+  }
+
+  if (transport && typeof transport === "object") {
+    requestOptions.transport = transport;
+  }
+
+  return requestOptions;
+}
+
+function resolveRequestQuery(value = null) {
+  const source = unref(value);
+  if (!source || typeof source !== "object" || Array.isArray(source)) {
+    return null;
+  }
+
+  return source;
+}
+
+function buildEndpointWriteRequestOptions({
+  method = "PATCH",
+  body = undefined,
+  options = null,
+  transport = null
+} = {}) {
+  const requestOptions = {
+    method: String(method || "PATCH").toUpperCase(),
+    ...(asPlainObject(options))
+  };
+
+  if (body !== undefined) {
+    requestOptions.body = body;
+  }
+
+  if (transport && typeof transport === "object") {
+    requestOptions.transport = transport;
+  }
+
+  return requestOptions;
+}
+
 function useEndpointResource({
   queryKey,
   path = "",
@@ -13,6 +65,8 @@ function useEndpointResource({
   client = usersWebHttpClient,
   readMethod = "GET",
   writeMethod = "PATCH",
+  readQuery = null,
+  transport = null,
   queryOptions = null,
   mutationOptions = null,
   fallbackLoadError = "Unable to load resource.",
@@ -34,7 +88,11 @@ function useEndpointResource({
       }
 
       return client.request(requestPath, {
-        method: String(readMethod || "GET").toUpperCase()
+        ...buildEndpointReadRequestOptions({
+          method: readMethod,
+          query: readQuery,
+          transport
+        })
       });
     },
     enabled: queryEnabled,
@@ -50,18 +108,17 @@ function useEndpointResource({
       }
 
       const method = String(options.method || writeMethod || "PATCH").toUpperCase();
-      const hasBody = Object.prototype.hasOwnProperty.call(options, "body");
+      const hasBody = Object.hasOwn(options, "body");
       const body = hasBody ? options.body : options.payload;
-      const requestOptions = {
-        method,
-        ...(asPlainObject(options.options))
-      };
-
-      if (body !== undefined) {
-        requestOptions.body = body;
-      }
-
-      return client.request(requestPath, requestOptions);
+      return client.request(
+        requestPath,
+        buildEndpointWriteRequestOptions({
+          method,
+          body,
+          options: options.options,
+          transport
+        })
+      );
     },
     ...(asPlainObject(mutationOptions))
   });
@@ -106,4 +163,8 @@ function useEndpointResource({
   });
 }
 
-export { useEndpointResource };
+export {
+  buildEndpointReadRequestOptions,
+  buildEndpointWriteRequestOptions,
+  useEndpointResource
+};

package/src/client/composables/runtime/useListCore.js

@@ -1,22 +1,42 @@
-import { computed } from "vue";
-import { appendQueryString } from "@jskit-ai/kernel/shared/support";
+import { computed, unref } from "vue";
 import { usersWebHttpClient } from "../../lib/httpClient.js";
 import { asPlainObject } from "../support/scopeHelpers.js";
 import { resolveEnabledRef, resolveTextRef } from "../support/refValueHelpers.js";
 import { usePagedCollection } from "../usePagedCollection.js";
 
-function appendPageParam(path, pageParam) {
-  const normalizedPath = String(path || "").trim();
-  if (!normalizedPath) {
-    return "";
+function buildListRequestOptions({
+  requestOptions = null,
+  transport = null,
+  pageParam = null
+} = {}) {
+  const resolvedOptions = {
+    method: "GET",
+    ...(resolveRequestOptionsObject(requestOptions))
+  };
+
+  const sourceQuery =
+    resolvedOptions.query && typeof resolvedOptions.query === "object" && !Array.isArray(resolvedOptions.query)
+      ? { ...resolvedOptions.query }
+      : {};
+  if (pageParam !== null && pageParam !== undefined && pageParam !== "") {
+    sourceQuery.cursor = String(pageParam);
   }
-  if (pageParam === null || pageParam === undefined || pageParam === "") {
-    return normalizedPath;
+  if (Object.keys(sourceQuery).length > 0) {
+    resolvedOptions.query = sourceQuery;
+  } else {
+    delete resolvedOptions.query;
   }
 
-  const query = new URLSearchParams();
-  query.set("cursor", String(pageParam));
-  return appendQueryString(normalizedPath, query.toString());
+  if (transport && typeof transport === "object") {
+    resolvedOptions.transport = transport;
+  }
+
+  return resolvedOptions;
+}
+
+function resolveRequestOptionsObject(value = null) {
+  const source = unref(value);
+  return asPlainObject(source);
 }
 
 function useListCore({
@@ -24,6 +44,7 @@ function useListCore({
   path = "",
   enabled = true,
   client = usersWebHttpClient,
+  transport = null,
   initialPageParam = null,
   getNextPageParam,
   selectItems,
@@ -43,15 +64,19 @@ function useListCore({
     initialPageParam,
     enabled: queryEnabled,
     queryFn: async ({ pageParam }) => {
-      const requestPath = appendPageParam(normalizedPath.value, pageParam);
+      const requestPath = normalizedPath.value;
       if (!requestPath) {
         throw new Error("List path is required.");
       }
 
-      return client.request(requestPath, {
-        method: "GET",
-        ...(asPlainObject(requestOptions))
-      });
+      return client.request(
+        requestPath,
+        buildListRequestOptions({
+          requestOptions,
+          transport,
+          pageParam
+        })
+      );
     },
     getNextPageParam,
     selectItems,
@@ -62,4 +87,7 @@ function useListCore({
   return collection;
 }
 
-export { useListCore };
+export {
+  buildListRequestOptions,
+  useListCore
+};

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

@@ -0,0 +1,100 @@
+import { computed, unref } from "vue";
+import {
+  resolveQueryParamDescriptors,
+  resolveActiveQueryParamEntries,
+  buildQueryParamEntriesToken
+} from "./listQueryParamSupport.js";
+
+function resolveRequestQueryContext(context = null) {
+  const source = unref(context);
+  return source && typeof source === "object" && !Array.isArray(source) ? source : {};
+}
+
+function resolveRequestQueryBaseKey(sourceQueryKey = null) {
+  const source = unref(sourceQueryKey);
+  if (Array.isArray(source)) {
+    return [...source];
+  }
+  if (source == null) {
+    return [];
+  }
+  return [source];
+}
+
+function appendRequestQueryValue(target = {}, key = "", values = []) {
+  const normalizedKey = String(key || "").trim();
+  const normalizedValues = (Array.isArray(values) ? values : [])
+    .map((value) => String(value ?? "").trim())
+    .filter(Boolean);
+  if (!normalizedKey || normalizedValues.length < 1) {
+    return;
+  }
+
+  const currentValue = target[normalizedKey];
+  if (currentValue === undefined) {
+    target[normalizedKey] = normalizedValues.length === 1 ? normalizedValues[0] : [...normalizedValues];
+    return;
+  }
+
+  const currentValues = Array.isArray(currentValue) ? [...currentValue] : [currentValue];
+  target[normalizedKey] = [...currentValues, ...normalizedValues];
+}
+
+function buildRequestQueryObject(entries = []) {
+  const sourceEntries = Array.isArray(entries) ? entries : [];
+  const query = {};
+
+  for (const entry of sourceEntries) {
+    appendRequestQueryValue(query, entry?.key, entry?.values);
+  }
+
+  return Object.freeze(query);
+}
+
+function createRequestQueryRuntime({
+  requestQueryParams = null,
+  context = null,
+  sourceQueryKey = null
+} = {}) {
+  const requestQueryParamDescriptors = computed(() => {
+    return resolveQueryParamDescriptors(requestQueryParams, resolveRequestQueryContext(context));
+  });
+  const activeRequestQueryParamEntries = computed(() => {
+    return resolveActiveQueryParamEntries(requestQueryParamDescriptors.value);
+  });
+  const activeRequestQueryParamsToken = computed(() => {
+    return buildQueryParamEntriesToken(activeRequestQueryParamEntries.value);
+  });
+  const queryKey = computed(() => {
+    if (!activeRequestQueryParamsToken.value) {
+      return unref(sourceQueryKey);
+    }
+
+    const next = resolveRequestQueryBaseKey(sourceQueryKey);
+    next.push("__request_query__", activeRequestQueryParamsToken.value);
+    return next;
+  });
+  const requestQuery = computed(() => {
+    if (activeRequestQueryParamEntries.value.length < 1) {
+      return null;
+    }
+
+    return buildRequestQueryObject(activeRequestQueryParamEntries.value);
+  });
+
+  return Object.freeze({
+    requestQueryParamDescriptors,
+    activeRequestQueryParamEntries,
+    activeRequestQueryParamsToken,
+    queryKey,
+    requestQuery
+  });
+}
+
+export {
+  appendRequestQueryValue,
+  buildRequestQueryObject,
+  createRequestQueryRuntime,
+  resolveRequestQueryBaseKey,
+  resolveRequestQueryContext
+};

package/src/client/composables/useAccountSettingsRuntime.js

@@ -7,7 +7,6 @@ import {
   resolveSurfaceNavigationTargetFromPlacementContext
 } from "@jskit-ai/shell-web/client/placement";
 import { useShellWebErrorRuntime } from "@jskit-ai/shell-web/client/error";
-import { validateOperationSection } from "@jskit-ai/http-runtime/shared/validators/operationValidation";
 import { ROUTE_VISIBILITY_PUBLIC } from "@jskit-ai/kernel/shared/support/visibility";
 import { userProfileResource } from "@jskit-ai/users-core/shared/resources/userProfileResource";
 import { userSettingsResource } from "@jskit-ai/users-core/shared/resources/userSettingsResource";
@@ -52,6 +51,24 @@ function useAccountSettingsRuntime() {
   const accountNotificationsWriteQueryKey = ["users-web", "settings", "account-notifications-write"];
   const sessionQueryKey = Object.freeze(["users-web", "session", "csrf"]);
   const OWNERSHIP_PUBLIC = ROUTE_VISIBILITY_PUBLIC;
+  const USER_SETTINGS_TRANSPORT = Object.freeze({
+    kind: "jsonapi-resource",
+    responseType: "user-settings",
+    responseKind: "record"
+  });
+  const USER_PROFILE_UPDATE_TRANSPORT = Object.freeze({
+    ...USER_SETTINGS_TRANSPORT,
+    requestType: "user-profiles"
+  });
+  const USER_PREFERENCES_UPDATE_TRANSPORT = Object.freeze({
+    ...USER_SETTINGS_TRANSPORT,
+    requestType: "user-preferences"
+  });
+  const USER_NOTIFICATION_SETTINGS_UPDATE_TRANSPORT = Object.freeze({
+    ...USER_SETTINGS_TRANSPORT,
+    requestType: "user-notification-settings"
+  });
+  const USER_PROFILE_AVATAR_DELETE_TRANSPORT = USER_SETTINGS_TRANSPORT;
 
   const accountSettingsPath = computed(() =>
     resolveSurfacePathFromPlacementContext(placementContext.value, "account", "/")
@@ -184,6 +201,7 @@ function useAccountSettingsRuntime() {
     ownershipFilter: OWNERSHIP_PUBLIC,
     apiSuffix: "/settings",
     queryKeyFactory: () => accountSettingsQueryKey,
+    transport: USER_SETTINGS_TRANSPORT,
     realtime: {
       event: "account.settings.changed"
     },
@@ -198,16 +216,12 @@ function useAccountSettingsRuntime() {
     queryKeyFactory: () => accountProfileWriteQueryKey,
     readEnabled: false,
     writeMethod: "PATCH",
+    transport: USER_PROFILE_UPDATE_TRANSPORT,
     fallbackSaveError: "Unable to update profile.",
     fieldErrorKeys: ["displayName"],
     model: profileForm,
     mapLoadedToModel: mapAccountSettingsPayload,
-    parseInput: (rawPayload) =>
-      validateOperationSection({
-        operation: userProfileResource.operations.patch,
-        section: "bodyValidator",
-        value: rawPayload
-      }),
+    input: userProfileResource.operations.patch.body,
     buildRawPayload: (model) => ({
       displayName: String(model.displayName || "").trim()
     }),
@@ -221,6 +235,7 @@ function useAccountSettingsRuntime() {
     ownershipFilter: OWNERSHIP_PUBLIC,
     apiSuffix: "/settings/profile/avatar",
     writeMethod: "DELETE",
+    transport: USER_PROFILE_AVATAR_DELETE_TRANSPORT,
     fallbackRunError: "Unable to remove avatar.",
     model: profileForm,
     onRunSuccess: (payload, { queryClient: commandQueryClient }) => {
@@ -240,16 +255,12 @@ function useAccountSettingsRuntime() {
     queryKeyFactory: () => accountPreferencesWriteQueryKey,
     readEnabled: false,
     writeMethod: "PATCH",
+    transport: USER_PREFERENCES_UPDATE_TRANSPORT,
     fallbackSaveError: "Unable to update preferences.",
     fieldErrorKeys: ["theme", "locale", "timeZone", "dateFormat", "numberFormat", "currencyCode", "avatarSize"],
     model: preferencesForm,
     mapLoadedToModel: mapAccountSettingsPayload,
-    parseInput: (rawPayload) =>
-      validateOperationSection({
-        operation: userSettingsResource.operations.preferencesUpdate,
-        section: "bodyValidator",
-        value: rawPayload
-      }),
+    input: userSettingsResource.operations.preferencesUpdate.body,
     buildRawPayload: (model) => ({
       theme: model.theme,
       locale: model.locale,
@@ -272,15 +283,11 @@ function useAccountSettingsRuntime() {
     queryKeyFactory: () => accountNotificationsWriteQueryKey,
     readEnabled: false,
     writeMethod: "PATCH",
+    transport: USER_NOTIFICATION_SETTINGS_UPDATE_TRANSPORT,
     fallbackSaveError: "Unable to update notifications.",
     model: notificationsForm,
     mapLoadedToModel: mapAccountSettingsPayload,
-    parseInput: (rawPayload) =>
-      validateOperationSection({
-        operation: userSettingsResource.operations.notificationsUpdate,
-        section: "bodyValidator",
-        value: rawPayload
-      }),
+    input: userSettingsResource.operations.notificationsUpdate.body,
     buildRawPayload: (model) => ({
       productUpdates: Boolean(model.productUpdates),
       accountActivity: Boolean(model.accountActivity),

package/src/client/composables/useCommand.js

@@ -17,12 +17,13 @@ function useCommand({
   apiSuffix = "",
   runPermissions = [],
   writeMethod = "POST",
+  transport = null,
   placementSource = "users-web.command",
   fallbackRunError = "Unable to complete action.",
   fieldErrorKeys = [],
   clearOnRouteChange = true,
   model,
-  parseInput,
+  input,
   buildRawPayload,
   buildCommandPayload,
   buildCommandOptions,
@@ -52,6 +53,7 @@ function useCommand({
     path: operationScope.apiPath,
     enabled: false,
     writeMethod,
+    transport,
     fallbackSaveError: fallbackRunError
   });
 
@@ -67,7 +69,7 @@ function useCommand({
     canRun,
     fieldBag,
     feedback,
-    parseInput,
+    input,
     buildRawPayload,
     buildCommandPayload,
     buildCommandOptions,