velocious 1.0.659 → 1.0.660

package/package.json

@@ -3,7 +3,7 @@
     "velocious": "build/bin/velocious.js"
   },
   "name": "velocious",
-  "version": "1.0.659",
+  "version": "1.0.660",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "files": [

package/src/frontend-model-controller.js

@@ -10,7 +10,7 @@ import {frontendModelResourceClassFromDefinition, frontendModelResourceConfigura
 import {createOfflineGrantFromBootstrap, verifyOfflineGrant} from "./sync/offline-grant.js"
 import {serverChangeFeedStoreForConfiguration} from "./sync/server-change-feed.js"
 import {mutationIdempotencyKey, verifySignedMutation} from "./sync/device-identity.js"
-import {FrontendModelQueryError, normalizeGroup as normalizeQueryGroup, normalizeJoins as normalizeQueryJoins, normalizePluck as normalizeQueryPluck, normalizePreload as normalizeQueryPreload, normalizeSearchOperator as normalizeQuerySearchOperator, normalizeSort as normalizeQuerySort} from "./frontend-models/query.js"
+import {assertFrontendModelIndexPayload, FrontendModelQueryError, normalizeGroup as normalizeQueryGroup, normalizeJoins as normalizeQueryJoins, normalizePluck as normalizeQueryPluck, normalizePreload as normalizeQueryPreload, normalizeSearchOperator as normalizeQuerySearchOperator, normalizeSort as normalizeQuerySort} from "./frontend-models/query.js"
 import {assignSafeProperty, deserializeFrontendModelTransportValue, isBackendModelInstance, serializeFrontendModelTransportValue} from "./frontend-models/transport-serialization.js"
 import {requestDetails} from "./error-reporting/request-details.js"
 import RoutesResolver from "./routes/resolver.js"
@@ -4455,14 +4455,27 @@ export default class FrontendModelController extends Controller {
       }
 
       try {
+        let indexPayload = {}
+
+        if (commandType === "index") {
+          try {
+            indexPayload = assertFrontendModelIndexPayload(payload)
+          } catch (error) {
+            throwFrontendModelQueryErrorForParserError(error)
+          }
+        }
+
         const requestContext = captureFrontendModelRemoteRequestContext(requestEntry?.requestContext)
         let responsePayload
 
         if (isBuiltInCommand) {
+          const commandPayload = commandType === "index"
+            ? indexPayload
+            : (payload && typeof payload === "object" ? payload : {})
           const commandParams = mergeFrontendModelRemoteRequestContext(
             requestContext,
             {
-              ...(payload && typeof payload === "object" ? payload : {}),
+              ...commandPayload,
               model
             }
           )

package/src/frontend-models/query.js

@@ -118,6 +118,28 @@ export class FrontendModelQueryError extends Error {
   }
 }
 
+const FRONTEND_MODEL_INDEX_PAYLOAD_KEYS = new Set([
+  "abilities",
+  "count",
+  "distinct",
+  "group",
+  "joins",
+  "limit",
+  "offset",
+  "page",
+  "perPage",
+  "pluck",
+  "preload",
+  "queryData",
+  "ransack",
+  "searches",
+  "select",
+  "selectsExtra",
+  "sort",
+  "where",
+  "withCount"
+])
+
 /**
  * Builds a query descriptor error.
  * @param {string} message - Error message.
@@ -127,6 +149,27 @@ function frontendModelQueryError(message) {
   return new FrontendModelQueryError(message)
 }
 
+/**
+ * Asserts the raw payload accepted by a shared frontend-model index command.
+ * @param {ReturnType<typeof JSON.parse>} payload - Raw index payload.
+ * @returns {Record<string, ReturnType<typeof JSON.parse>>} - Valid index payload.
+ */
+export function assertFrontendModelIndexPayload(payload) {
+  if (payload == null) return {}
+
+  if (!isPlainObject(payload)) {
+    throw frontendModelQueryError("Expected frontend-model index payload to be a plain object")
+  }
+
+  for (const payloadKey of Object.keys(payload)) {
+    if (!FRONTEND_MODEL_INDEX_PAYLOAD_KEYS.has(payloadKey)) {
+      throw frontendModelQueryError(`Unknown frontend-model index payload key "${payloadKey}"`)
+    }
+  }
+
+  return payload
+}
+
 /**
  * Runs the normalizePreload helper.
  * @param {import("../database/query/index.js").NestedPreloadRecord | string | Array<string | import("../database/query/index.js").NestedPreloadRecord> | boolean | undefined | null} preload - Preload shorthand.