velocious 1.0.643 → 1.0.645

package/src/frontend-models/preloader.js

@@ -1,5 +1,7 @@
 // @ts-check
 
+import {modelPrimaryKeyCacheKey, scalarModelPrimaryKey} from "../utils/model-primary-key.js"
+
 /**
  * Preloads relationships onto already-loaded frontend model instances.
  *
@@ -36,7 +38,8 @@ export default class FrontendModelPreloader {
 
     if (modelsToLoad.length === 0) return
 
-    const primaryKey = modelClass.primaryKey()
+    const primaryKeyDefinition = modelClass.primaryKey()
+    const primaryKey = scalarModelPrimaryKey(primaryKeyDefinition, `FrontendModelPreloader.preload() for ${modelClass.name}`)
     const ids = modelsToLoad.map((model) => model.primaryKeyValue())
 
     // Rebuild a fresh query carrying only the projection-relevant state so a
@@ -58,11 +61,11 @@ export default class FrontendModelPreloader {
     const reloadedById = new Map()
 
     for (const reloadedModel of reloaded) {
-      reloadedById.set(String(reloadedModel.primaryKeyValue()), reloadedModel)
+      reloadedById.set(modelPrimaryKeyCacheKey(primaryKeyDefinition, reloadedModel.primaryKeyValue()), reloadedModel)
     }
 
     for (const model of modelsToLoad) {
-      const reloadedModel = reloadedById.get(String(model.primaryKeyValue()))
+      const reloadedModel = reloadedById.get(modelPrimaryKeyCacheKey(primaryKeyDefinition, model.primaryKeyValue()))
 
       // The record may have been deleted/filtered between the original load and
       // this preload — skip it rather than crashing on a missing reload.

package/src/frontend-models/query.js

@@ -4,6 +4,7 @@ import {resolveFrontendModelClass} from "./model-registry.js"
 import {normalizeRansackGroup, parseRansackSort} from "../utils/ransack.js"
 import {isModelScopeDescriptor} from "../utils/model-scope.js"
 import isPlainObject from "../utils/plain-object.js"
+import {modelPrimaryKeyConditions} from "../utils/model-primary-key.js"
 
 /**
  * FrontendModelSearch type.
@@ -1333,7 +1334,11 @@ export default class FrontendModelQuery {
 
     return {
       ...selectMap,
-      [rootModelName]: Array.from(new Set([rootPrimaryKey, ...existingRootAttributes, ...requiredAttributes]))
+      [rootModelName]: Array.from(new Set([
+        ...(Array.isArray(rootPrimaryKey) ? rootPrimaryKey : [rootPrimaryKey]),
+        ...existingRootAttributes,
+        ...requiredAttributes
+      ]))
     }
   }
 
@@ -1936,7 +1941,9 @@ export default class FrontendModelQuery {
     const query = this.clone()
 
     if (query._sort.length < 1) {
-      query.sort([[this.modelClass.primaryKey(), "asc"]])
+      const primaryKey = this.modelClass.primaryKey()
+
+      query.sort((Array.isArray(primaryKey) ? primaryKey : [primaryKey]).map((column) => [column, "asc"]))
     }
 
     query.limit(1)
@@ -1963,7 +1970,9 @@ export default class FrontendModelQuery {
     const query = this.clone()
 
     if (query._sort.length < 1) {
-      query.sort([[this.modelClass.primaryKey(), "desc"]])
+      const primaryKey = this.modelClass.primaryKey()
+
+      query.sort((Array.isArray(primaryKey) ? primaryKey : [primaryKey]).map((column) => [column, "desc"]))
     } else {
       query._sort = query._sort.map((sortEntry) => ({
         ...sortEntry,
@@ -2017,15 +2026,15 @@ export default class FrontendModelQuery {
 
   /**
    * Runs find.
-   * @param {number | string} id - Record id.
+   * @param {import("../utils/model-primary-key.js").ModelPrimaryKeyValue} id - Record id.
    * @returns {Promise<InstanceType<T>>} - Found model.
    */
   async find(id) {
     const pk = this.modelClass.primaryKey()
-    const model = await this.findBy({[pk]: id})
+    const model = await this.findBy(modelPrimaryKeyConditions(pk, id))
 
     if (!model) {
-      throw new Error(`${this.modelClass.getModelName()} not found with ${pk}=${id}`)
+      throw new Error(`${this.modelClass.getModelName()} not found with ${pk}=${JSON.stringify(id)}`)
     }
 
     return model

package/src/frontend-models/resource-definition.js

@@ -176,6 +176,7 @@ function normalizeFrontendModelResourceConfiguration(resourceConfiguration) {
   }
 
   restArgsError(restArgs)
+  validateFrontendModelResourcePrimaryKey(resourceConfiguration.primaryKey)
 
   const normalizedCommands = normalizeFrontendModelResourceCommands(resourceConfiguration)
   const sync = normalizeFrontendModelResourceSync(resourceConfiguration)
@@ -195,6 +196,23 @@ function normalizeFrontendModelResourceConfiguration(resourceConfiguration) {
   }
 }
 
+/**
+ * Validates a resource primary-key definition before it can be used to build CRUD conditions.
+ * @param {import("../utils/model-primary-key.js").ModelPrimaryKeyDefinition | undefined} primaryKey - Resource primary key.
+ * @returns {void}
+ */
+function validateFrontendModelResourcePrimaryKey(primaryKey) {
+  if (!Array.isArray(primaryKey)) return
+
+  if (primaryKey.length === 0) {
+    throw new Error("Resource primaryKey arrays must contain at least one attribute.")
+  }
+
+  if (new Set(primaryKey).size !== primaryKey.length) {
+    throw new Error("Resource primaryKey arrays must contain unique attributes.")
+  }
+}
+
 /**
  * Runs normalize frontend model resource abilities.
  * @param {string[] | undefined} abilities - Resource abilities config (camelCase action list).
@@ -286,8 +304,9 @@ export function frontendModelApiManifest(backendProjects) {
     for (const configuredModelName of Object.keys(projectResources).sort()) {
       const resourceDefinition = projectResources[configuredModelName]
       const resourceConfiguration = frontendModelResourceConfigurationFromDefinition(resourceDefinition)
+      const resourceClass = frontendModelResourceClassFromDefinition(resourceDefinition)
 
-      if (!resourceConfiguration) continue
+      if (!resourceConfiguration || !resourceClass) continue
 
       const modelName = resourceConfiguration.modelName || configuredModelName
       const resourcePath = `/${inflection.dasherize(inflection.pluralize(inflection.underscore(configuredModelName)))}`
@@ -296,7 +315,7 @@ export function frontendModelApiManifest(backendProjects) {
       const entry = {
         modelName,
         path: resourcePath,
-        primaryKey: resourceConfiguration.primaryKey || "id",
+        primaryKey: resourceClass.resolvedPrimaryKey(resourceConfiguration),
         attributes: manifestAttributes(resourceConfiguration.attributes),
         abilities: resourceConfiguration.abilities,
         builtInCommands: {

package/src/frontend-models/use-destroyed-event.js

@@ -19,7 +19,7 @@ import useModelClassEvent from "./use-model-class-event.js"
  * @typedef {import("./use-model-class-event.js").FrontendModelDestroyEventPayload} FrontendModelClassDestroyEventPayload */
 /**
  * Defines this typedef.
- * @typedef {{id: string}} FrontendModelInstanceDestroyEventPayload */
+ * @typedef {{id: string | import("../utils/model-primary-key.js").CompositeModelPrimaryKeyValue}} FrontendModelInstanceDestroyEventPayload */
 /**
  * FrontendModelDestroyEventPayload type.
  * @typedef {FrontendModelClassDestroyEventPayload | FrontendModelInstanceDestroyEventPayload} FrontendModelDestroyEventPayload */

package/src/frontend-models/use-model-class-event.js

@@ -17,10 +17,10 @@ import {frontendModelRemoteRequestContextKey} from "./remote-request-context.js"
  * @typedef {"create" | "update" | "destroy"} FrontendModelClassEventName */
 /**
  * Defines this typedef.
- * @typedef {{id: string, model: FrontendModelInstance}} FrontendModelCreateUpdateEventPayload */
+ * @typedef {{id: string | import("../utils/model-primary-key.js").CompositeModelPrimaryKeyValue, model: FrontendModelInstance}} FrontendModelCreateUpdateEventPayload */
 /**
  * Defines this typedef.
- * @typedef {{id: string}} FrontendModelDestroyEventPayload */
+ * @typedef {{id: string | import("../utils/model-primary-key.js").CompositeModelPrimaryKeyValue}} FrontendModelDestroyEventPayload */
 /**
  * FrontendModelClassEventPayload type.
  * @typedef {FrontendModelCreateUpdateEventPayload | FrontendModelDestroyEventPayload} FrontendModelClassEventPayload */

package/src/frontend-models/use-updated-event.js

@@ -19,7 +19,7 @@ import useModelClassEvent from "./use-model-class-event.js"
  * @typedef {import("./use-model-class-event.js").FrontendModelCreateUpdateEventPayload} FrontendModelClassUpdateEventPayload */
 /**
  * Defines this typedef.
- * @typedef {{id: string, model: FrontendModelInstance}} FrontendModelInstanceUpdateEventPayload */
+ * @typedef {{id: string | import("../utils/model-primary-key.js").CompositeModelPrimaryKeyValue, model: FrontendModelInstance}} FrontendModelInstanceUpdateEventPayload */
 /**
  * FrontendModelUpdateEventPayload type.
  * @typedef {FrontendModelClassUpdateEventPayload | FrontendModelInstanceUpdateEventPayload} FrontendModelUpdateEventPayload */