@jskit-ai/crud-core 0.1.178 → 0.1.180

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/crud-core",
-  "version": "0.1.178",
+  "version": "0.1.180",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -23,11 +23,9 @@
     "./server/routeContracts": "./src/server/routeContracts.js"
   },
   "dependencies": {
-    "@jskit-ai/database-runtime": "0.1.167",
-    "@jskit-ai/http-runtime": "0.1.165",
-    "@jskit-ai/json-rest-api-core": "0.1.111",
-    "@jskit-ai/kernel": "0.1.167",
-    "@jskit-ai/resource-crud-core": "0.1.109",
+    "@jskit-ai/database-runtime": "0.1.169",
+    "@jskit-ai/json-rest-api-core": "0.1.113",
+    "@jskit-ai/resource-crud-core": "0.1.111",
     "json-rest-schema": "^1.0.17"
   },
   "description": "Shared server-side CRUD service, repository, route, and query helpers.",
@@ -45,5 +43,9 @@
         "providers": []
       }
     }
+  },
+  "peerDependencies": {
+    "@jskit-ai/http-runtime": "0.1.167",
+    "@jskit-ai/kernel": "0.1.169"
   }
 }

package/patterns/json-api-resource-package/example/packages/books/package.json

@@ -8,8 +8,8 @@
     "./shared": "./src/shared/index.js"
   },
   "dependencies": {
-    "@jskit-ai/crud-core": "0.1.178",
-    "@jskit-ai/resource-crud-core": "0.1.109"
+    "@jskit-ai/crud-core": "0.1.180",
+    "@jskit-ai/resource-crud-core": "0.1.111"
   },
   "jskit": {
     "kind": "runtime",

package/src/server/jsonApiModule/actions.js

@@ -1,15 +1,22 @@
 import {
   composeSchemaDefinitions,
+  createSchema,
   recordIdParamsValidator
 } from "@jskit-ai/kernel/shared/validators";
 import { createEntityChangedActionEvent } from "@jskit-ai/kernel/server/actions";
 import {
+  decodeJsonApiResourceResponse,
   normalizeJsonApiDocument,
-  simplifyJsonApiDocument,
   unwrapJsonApiResult
 } from "@jskit-ai/http-runtime/shared";
 import { resolveCrudRecordChangedEvent } from "@jskit-ai/resource-crud-core/shared/crudNamespaceSupport";
 import {
+  resolveJsonApiFieldsetContract,
+  resolveJsonApiRelationshipEntries,
+  resolveSchemaFieldDefinitions
+} from "../jsonApiResourceContract.js";
+import {
+  createJsonApiFieldsetsQueryValidator,
   createStandardCrudListQueryValidators,
   createStandardCrudViewQueryValidators
 } from "../listQueryValidators.js";
@@ -37,12 +44,6 @@ function normalizeOptionalCursor(value) {
   return normalized || null;
 }
 
-function resolveDocumentNextCursor(document = {}) {
-  return normalizeOptionalCursor(
-    document?.meta?.page?.nextCursor ?? document?.meta?.pagination?.cursor?.next
-  );
-}
-
 function resolveAssistantResultValue(result) {
   const taggedResult = unwrapJsonApiResult(result);
   const value = taggedResult ? taggedResult.value : result;
@@ -53,7 +54,124 @@ function resolveAssistantResultValue(result) {
   };
 }
 
-function transformCrudAssistantResult(operation, result, { input = {} } = {}) {
+function createProjectionRecordSchema(recordSchema, {
+  lookupContainerKey = "",
+  relationshipEntries = []
+} = {}) {
+  const definitions = recordSchema?.getFieldDefinitions?.();
+  if (!isRecord(definitions)) {
+    return recordSchema;
+  }
+
+  const fields = Object.fromEntries(
+    Object.entries(definitions).map(([fieldKey, fieldDefinition]) => [
+      fieldKey,
+      {
+        ...fieldDefinition,
+        required: fieldKey === "id" && fieldDefinition?.required === true
+      }
+    ])
+  );
+  if (lookupContainerKey && isRecord(fields[lookupContainerKey])) {
+    const createRelatedRecordSchema = (entry) => createSchema({
+      id: {
+        type: "string",
+        required: true
+      },
+      ...(entry.labelKey && entry.labelKey !== "id"
+        ? {
+            [entry.labelKey]: {
+              type: "string",
+              required: false,
+              nullable: true
+            }
+          }
+        : {})
+    });
+    const lookupFields = Object.fromEntries(
+      relationshipEntries.map((entry) => [
+        entry.relationshipName,
+        entry.many === true
+          ? {
+              type: "array",
+              required: false,
+              items: {
+                type: "object",
+                schema: createRelatedRecordSchema(entry),
+                additionalProperties: true
+              }
+            }
+          : {
+              type: "object",
+              required: false,
+              schema: createRelatedRecordSchema(entry),
+              additionalProperties: true
+            }
+      ])
+    );
+    fields[lookupContainerKey] = {
+      ...fields[lookupContainerKey],
+      type: "object",
+      required: false,
+      ...(Object.keys(lookupFields).length > 0 ? { schema: createSchema(lookupFields) } : {}),
+      additionalProperties: true
+    };
+  }
+
+  return createSchema(fields);
+}
+
+function createProjectionOutputDefinition(output, operation, relationshipEntries, lookupContainerKey) {
+  if (!output || (operation !== "list" && operation !== "view")) {
+    return output;
+  }
+
+  if (operation === "view") {
+    return Object.freeze({
+      schema: createProjectionRecordSchema(output.schema, { lookupContainerKey, relationshipEntries }),
+      mode: "replace"
+    });
+  }
+
+  const listFields = resolveSchemaFieldDefinitions(output);
+  const items = listFields.items;
+  if (!isRecord(items) || items.type !== "array" || typeof items.items?.getFieldDefinitions !== "function") {
+    return output;
+  }
+
+  return Object.freeze({
+    schema: createSchema({
+      ...listFields,
+      items: {
+        ...items,
+        items: createProjectionRecordSchema(items.items, { lookupContainerKey, relationshipEntries })
+      }
+    }),
+    mode: "replace"
+  });
+}
+
+function createCrudAssistantTransport(resource, operation, relationshipEntries, lookupContainerKey) {
+  const lookupFieldMap = Object.fromEntries(
+    relationshipEntries
+      .filter((entry) => entry.many !== true)
+      .map((entry) => [entry.relationshipName, entry.attributeKey])
+  );
+  return Object.freeze({
+    kind: "jsonapi-resource",
+    responseType: resource.namespace,
+    responseKind: operation === "list" ? "collection" : "record",
+    ...(lookupContainerKey ? { lookupContainerKey } : {}),
+    ...(Object.keys(lookupFieldMap).length > 0 ? { lookupFieldMap } : {})
+  });
+}
+
+function transformCrudAssistantResult(operation, result, {
+  input = {},
+  resource,
+  relationshipEntries = [],
+  lookupContainerKey = ""
+} = {}) {
   if (operation === "delete") {
     const resolved = resolveAssistantResultValue(result);
     if (isRecord(resolved.value) && resolved.value.deleted === true && resolved.value.id != null) {
@@ -68,9 +186,13 @@ function transformCrudAssistantResult(operation, result, { input = {} } = {}) {
   const resolved = resolveAssistantResultValue(result);
   if (operation === "list") {
     if (resolved.document.kind === "collection") {
+      const decoded = decodeJsonApiResourceResponse(
+        resolved.value,
+        createCrudAssistantTransport(resource, operation, relationshipEntries, lookupContainerKey)
+      );
       return {
-        items: simplifyJsonApiDocument(resolved.value),
-        nextCursor: resolveDocumentNextCursor(resolved.document)
+        items: decoded.items,
+        nextCursor: normalizeOptionalCursor(decoded.nextCursor)
       };
     }
     if (Array.isArray(resolved.value)) {
@@ -89,29 +211,93 @@ function transformCrudAssistantResult(operation, result, { input = {} } = {}) {
   }
 
   if (resolved.document.kind === "resource") {
-    return simplifyJsonApiDocument(resolved.value);
+    return decodeJsonApiResourceResponse(
+      resolved.value,
+      createCrudAssistantTransport(resource, operation, relationshipEntries, lookupContainerKey)
+    );
   }
   return resolved.value;
 }
 
+function createCrudAssistantReadDescription({
+  fieldsetContract,
+  lookupContainerKey = "",
+  namespace = "",
+  operation = "list"
+} = {}) {
+  const relationshipEntries = fieldsetContract.relationshipEntries;
+  const firstRelationship = relationshipEntries[0] || null;
+  const includeExample = relationshipEntries.length > 0
+    ? relationshipEntries.slice(0, 2).map((entry) => entry.relationshipName).join(",")
+    : "pet,service";
+  const fieldsExample = firstRelationship
+    ? ` fields can be {\"${namespace}\":[\"${firstRelationship.attributeKey}\"],` +
+      `\"${firstRelationship.relationshipType}\":[\"${firstRelationship.labelKey || "id"}\"]}.`
+    : ` fields can be {\"${namespace}\":[\"id\"]}.`;
+  const aliasGuidance = fieldsetContract.aliasMappings
+    .map((entry) => `use \"${entry.resourceType}\" instead of \"${entry.alias}\"`)
+    .join("; ");
+  const fieldsetKeyGuidance = fieldsetContract.resourceTypes.length > 0
+    ? ` fields keys must be JSON:API resource types: ${fieldsetContract.resourceTypes.map((entry) => `\"${entry}\"`).join(", ")}.` +
+      (aliasGuidance ? ` Relationship aliases are invalid fieldset keys; ${aliasGuidance}.` : "")
+    : "";
+  const primaryFieldGuidance = fieldsetContract.primaryFields.length > 0
+    ? ` Valid \"${namespace}\" fields: ${fieldsetContract.primaryFields.map((entry) => `\"${entry}\"`).join(", ")}.`
+    : "";
+  const relationshipGuidance = relationshipEntries.length > 0
+    ? ` Include relationships: ${relationshipEntries.map((entry) => {
+        const lookupPath = lookupContainerKey
+          ? ` -> ${operation === "list" ? "items[]." : ""}${lookupContainerKey}.${entry.relationshipName}`
+          : "";
+        return `\"${entry.relationshipName}\" -> resource type \"${entry.relationshipType}\"${lookupPath}`;
+      }).join("; ")}.`
+    : "";
+
+  const subject = operation === "list" ? `List ${namespace} records.` : `View a ${namespace} record.`;
+  return `${subject} include must be a comma-separated string such as \"${includeExample}\";` +
+    `${fieldsExample}${fieldsetKeyGuidance}${primaryFieldGuidance}${relationshipGuidance}`;
+}
+
 function createCrudAssistantExtension(resource, namespace, operation) {
   const resourceOperation = CRUD_ASSISTANT_RESOURCE_OPERATION[operation];
-  const output = resource?.operations?.[resourceOperation]?.output || null;
-  const actionLabel = operation === "list"
-    ? `List ${namespace} records.`
-    : operation === "view"
-      ? `View a ${namespace} record.`
-      : operation === "create"
-        ? `Create a ${namespace} record.`
-        : operation === "update"
-          ? `Update a ${namespace} record.`
-          : `Delete a ${namespace} record.`;
+  const nativeOutput = resource?.operations?.[resourceOperation]?.output || null;
+  const recordOutput = operation === "list"
+    ? Object.freeze({
+        schema: resolveSchemaFieldDefinitions(nativeOutput).items?.items,
+        mode: "replace"
+      })
+    : nativeOutput;
+  const relationshipEntries = resolveJsonApiRelationshipEntries(recordOutput);
+  const lookupContainerKey = String(resource?.contract?.lookup?.containerKey || "").trim();
+  const output = createProjectionOutputDefinition(
+    nativeOutput,
+    operation,
+    relationshipEntries,
+    lookupContainerKey
+  );
+  const actionLabel = operation === "list" || operation === "view"
+    ? createCrudAssistantReadDescription({
+        fieldsetContract: resolveJsonApiFieldsetContract(resource),
+        lookupContainerKey,
+        namespace,
+        operation
+      })
+    : operation === "create"
+      ? `Create a ${namespace} record.`
+      : operation === "update"
+        ? `Update a ${namespace} record.`
+        : `Delete a ${namespace} record.`;
 
   return Object.freeze({
     description: actionLabel,
     output,
     transformResult(result, context) {
-      return transformCrudAssistantResult(operation, result, context);
+      return transformCrudAssistantResult(operation, result, {
+        ...context,
+        resource,
+        relationshipEntries,
+        lookupContainerKey
+      });
     }
   });
 }
@@ -125,9 +311,15 @@ function createActionInput(
 ) {
   const definitions = scopeInputValidator ? [scopeInputValidator] : [];
   if (operation === "list") {
-    definitions.push(...createStandardCrudListQueryValidators({ resource, listFilterQueryValidator }));
+    definitions.push(...createStandardCrudListQueryValidators({
+      resource,
+      listFilterQueryValidator,
+      fieldsetsQueryValidator: createJsonApiFieldsetsQueryValidator({ resource })
+    }));
   } else if (operation === "view") {
-    definitions.push(recordIdParamsValidator, ...createStandardCrudViewQueryValidators());
+    definitions.push(recordIdParamsValidator, ...createStandardCrudViewQueryValidators({
+      fieldsetsQueryValidator: createJsonApiFieldsetsQueryValidator({ resource })
+    }));
   } else if (operation === "create") {
     definitions.push(operationInputs.create || resource.operations.create.body);
   } else if (operation === "update") {

package/src/server/jsonApiResourceContract.js

@@ -0,0 +1,119 @@
+import { normalizeText } from "@jskit-ai/kernel/shared/support/normalize";
+import { resolveCrudResourceScopeName } from "@jskit-ai/resource-crud-core/shared/crudLookup";
+
+function isRecord(value) {
+  return Boolean(value) && typeof value === "object" && !Array.isArray(value);
+}
+
+function resolveSchemaFieldDefinitions(definition = null) {
+  const schema = definition?.schema;
+  if (!schema || typeof schema.getFieldDefinitions !== "function") {
+    return {};
+  }
+
+  const definitions = schema.getFieldDefinitions();
+  return isRecord(definitions) ? definitions : {};
+}
+
+function resolveJsonApiRelationshipEntries(definition = null) {
+  const entries = [];
+
+  for (const [fieldKey, fieldDefinition] of Object.entries(resolveSchemaFieldDefinitions(definition))) {
+    const normalizedFieldDefinition = isRecord(fieldDefinition) ? fieldDefinition : {};
+    const relationshipType = String(normalizedFieldDefinition.belongsTo || "").trim();
+    if (relationshipType) {
+      const relationshipName = String(normalizedFieldDefinition.as || fieldKey || "").trim();
+      if (!relationshipName) {
+        continue;
+      }
+
+      entries.push(Object.freeze({
+        attributeKey: fieldKey,
+        relationshipName,
+        relationshipType,
+        labelKey: String(normalizedFieldDefinition?.relation?.labelKey || "").trim(),
+        required: normalizedFieldDefinition.required === true,
+        nullable: normalizedFieldDefinition.nullable === true
+      }));
+      continue;
+    }
+
+    const relation = isRecord(normalizedFieldDefinition.relation)
+      ? normalizedFieldDefinition.relation
+      : {};
+    if (String(relation.kind || "").trim().toLowerCase() !== "collection") {
+      continue;
+    }
+
+    const collectionRelationshipType = resolveCrudResourceScopeName(
+      relation.target || relation.targetResource || relation.namespace || relation.apiPath
+    );
+    if (!collectionRelationshipType) {
+      continue;
+    }
+
+    const collectionRelationshipName = String(
+      relation.as || normalizedFieldDefinition.as || fieldKey || ""
+    ).trim();
+    if (!collectionRelationshipName) {
+      continue;
+    }
+
+    entries.push(Object.freeze({
+      attributeKey: fieldKey,
+      relationshipName: collectionRelationshipName,
+      relationshipType: collectionRelationshipType,
+      labelKey: String(relation.labelKey || "").trim(),
+      many: true,
+      required: normalizedFieldDefinition.required === true,
+      nullable: normalizedFieldDefinition.nullable === true
+    }));
+  }
+
+  return Object.freeze(entries);
+}
+
+function resolveJsonApiFieldsetContract(resource = {}) {
+  const primaryType = normalizeText(resource?.namespace);
+  const relationshipEntries = resolveJsonApiRelationshipEntries(resource?.operations?.view?.output);
+  const lookupContainerKey = normalizeText(resource?.contract?.lookup?.containerKey);
+  const primaryFields = Object.freeze(
+    Object.keys(resolveSchemaFieldDefinitions(resource?.operations?.view?.output))
+      .map((entry) => normalizeText(entry))
+      .filter((entry) => entry && entry !== lookupContainerKey)
+  );
+  const aliasMappings = Object.freeze(
+    relationshipEntries
+      .filter((entry) => entry.relationshipName !== entry.relationshipType)
+      .map((entry) => Object.freeze({
+        alias: entry.relationshipName,
+        resourceType: entry.relationshipType
+      }))
+  );
+  const resourceTypes = [];
+  const seenTypes = new Set();
+  for (const resourceType of [
+    primaryType,
+    ...relationshipEntries.map((entry) => normalizeText(entry.relationshipType))
+  ]) {
+    if (!resourceType || seenTypes.has(resourceType)) {
+      continue;
+    }
+    seenTypes.add(resourceType);
+    resourceTypes.push(resourceType);
+  }
+
+  return Object.freeze({
+    aliasMappings,
+    primaryType,
+    primaryFields,
+    relationshipEntries,
+    resourceTypes: Object.freeze(resourceTypes)
+  });
+}
+
+export {
+  resolveJsonApiFieldsetContract,
+  resolveJsonApiRelationshipEntries,
+  resolveSchemaFieldDefinitions
+};

package/src/server/listQueryValidators.js

@@ -4,6 +4,7 @@ import {
 } from "@jskit-ai/kernel/shared/validators";
 import { normalizeText } from "@jskit-ai/kernel/shared/support/normalize";
 import { resolveCrudParentFilterKeys as resolveSharedCrudParentFilterKeys } from "@jskit-ai/resource-crud-core/shared/crudLookup";
+import { resolveJsonApiFieldsetContract } from "./jsonApiResourceContract.js";
 
 const listSearchQueryValidator = Object.freeze({
   schema: createSchema({
@@ -19,29 +20,96 @@ const lookupIncludeQueryValidator = Object.freeze({
   schema: createSchema({
     include: {
       type: "string",
-      required: false
+      required: false,
+      messages: {
+        default: "include expects a comma-separated string such as \"pet,service\"."
+      }
     }
   }),
   mode: "patch"
 });
 
+function createJsonApiFieldsetValueDefinition({ allowedFields = [] } = {}) {
+  const normalizedAllowedFields = [...new Set(
+    (Array.isArray(allowedFields) ? allowedFields : [])
+      .map((entry) => normalizeText(entry))
+      .filter(Boolean)
+  )];
+
+  return Object.freeze({
+    type: "array",
+    required: false,
+    items: {
+      type: "string",
+      minLength: 1,
+      ...(normalizedAllowedFields.length > 0
+        ? { enum: Object.freeze(normalizedAllowedFields) }
+        : {})
+    }
+  });
+}
+
+const jsonApiFieldsetValueDefinition = createJsonApiFieldsetValueDefinition();
+
 const jsonApiFieldsetsQueryValidator = Object.freeze({
   schema: createSchema({
     fields: {
       type: "object",
       required: false,
-      values: {
-        type: "array",
-        items: {
-          type: "string",
-          minLength: 1
-        }
-      }
+      messages: {
+        default: "fields expects an object such as {\"bookings\":[\"petId\"],\"pets\":[\"name\"]}."
+      },
+      values: jsonApiFieldsetValueDefinition
     }
   }),
   mode: "patch"
 });
 
+function createJsonApiFieldsetsQueryValidator({ resource = {} } = {}) {
+  const contract = resolveJsonApiFieldsetContract(resource);
+  if (!contract.primaryType || contract.resourceTypes.length < 1) {
+    return jsonApiFieldsetsQueryValidator;
+  }
+
+  const firstRelationship = contract.relationshipEntries[0] || null;
+  const example = firstRelationship
+    ? `{"${contract.primaryType}":["${firstRelationship.attributeKey}"],` +
+      `"${firstRelationship.relationshipType}":["${firstRelationship.labelKey || "id"}"]}`
+    : `{"${contract.primaryType}":["id"]}`;
+  const allowedTypes = contract.resourceTypes.map((entry) => `"${entry}"`).join(", ");
+  const aliasGuidance = contract.aliasMappings
+    .map((entry) => `use "${entry.resourceType}" instead of "${entry.alias}"`)
+    .join("; ");
+  const additionalPropertiesMessage =
+    `fields keys must be JSON:API resource types. Allowed keys: ${allowedTypes}.` +
+    (aliasGuidance ? ` Relationship aliases are invalid keys; ${aliasGuidance}.` : "");
+  const fieldsetSchema = createSchema(
+    Object.fromEntries(
+      contract.resourceTypes.map((resourceType) => [
+        resourceType,
+        createJsonApiFieldsetValueDefinition({
+          allowedFields: resourceType === contract.primaryType ? contract.primaryFields : []
+        })
+      ])
+    )
+  );
+
+  return Object.freeze({
+    schema: createSchema({
+      fields: {
+        type: "object",
+        required: false,
+        schema: fieldsetSchema,
+        messages: {
+          default: `fields expects an object keyed by JSON:API resource type, such as ${example}.`,
+          additionalProperties: additionalPropertiesMessage
+        }
+      }
+    }),
+    mode: "patch"
+  });
+}
+
 function resolveCrudListUsesOrderedCursor(list = {}) {
   const entries = Array.isArray(list?.orderBy)
     ? list.orderBy
@@ -109,7 +177,8 @@ function createStandardCrudListQueryValidators({
   resource = {},
   listFilterQueryValidator = null,
   searchQueryValidator = listSearchQueryValidator,
-  includeQueryValidator = lookupIncludeQueryValidator
+  includeQueryValidator = lookupIncludeQueryValidator,
+  fieldsetsQueryValidator = jsonApiFieldsetsQueryValidator
 } = {}) {
   const resolvedListFilterQueryValidator =
     listFilterQueryValidator
@@ -126,21 +195,23 @@ function createStandardCrudListQueryValidators({
       ? [resolvedListFilterQueryValidator]
       : []),
     includeQueryValidator,
-    jsonApiFieldsetsQueryValidator
+    fieldsetsQueryValidator
   ];
 }
 
 function createStandardCrudViewQueryValidators({
-  includeQueryValidator = lookupIncludeQueryValidator
+  includeQueryValidator = lookupIncludeQueryValidator,
+  fieldsetsQueryValidator = jsonApiFieldsetsQueryValidator
 } = {}) {
   return [
     includeQueryValidator,
-    jsonApiFieldsetsQueryValidator
+    fieldsetsQueryValidator
   ];
 }
 
 export {
   createCrudCursorPaginationQueryValidator,
+  createJsonApiFieldsetsQueryValidator,
   listSearchQueryValidator,
   lookupIncludeQueryValidator,
   jsonApiFieldsetsQueryValidator,

package/src/server/routeContracts.js

@@ -6,84 +6,18 @@ import {
   composeSchemaDefinitions,
   recordIdParamsValidator
 } from "@jskit-ai/kernel/shared/validators";
-import { resolveCrudResourceScopeName } from "@jskit-ai/resource-crud-core/shared/crudLookup";
 import {
   createStandardCrudListQueryValidators,
   createStandardCrudViewQueryValidators,
   listSearchQueryValidator as defaultListSearchQueryValidator,
   lookupIncludeQueryValidator as defaultLookupIncludeQueryValidator
 } from "./listQueryValidators.js";
+import { resolveJsonApiRelationshipEntries } from "./jsonApiResourceContract.js";
 
 function isRecord(value) {
   return Boolean(value) && typeof value === "object" && !Array.isArray(value);
 }
 
-function resolveSchemaFieldDefinitions(definition = null) {
-  const schema = definition?.schema;
-  if (!schema || typeof schema.getFieldDefinitions !== "function") {
-    return {};
-  }
-
-  const definitions = schema.getFieldDefinitions();
-  return isRecord(definitions) ? definitions : {};
-}
-
-function resolveJsonApiRelationshipEntries(definition = null) {
-  const entries = [];
-
-  for (const [fieldKey, fieldDefinition] of Object.entries(resolveSchemaFieldDefinitions(definition))) {
-    const normalizedFieldDefinition = isRecord(fieldDefinition) ? fieldDefinition : {};
-    const relationshipType = String(normalizedFieldDefinition.belongsTo || "").trim();
-    if (relationshipType) {
-      const relationshipName = String(normalizedFieldDefinition.as || fieldKey || "").trim();
-      if (!relationshipName) {
-        continue;
-      }
-
-      entries.push(Object.freeze({
-        attributeKey: fieldKey,
-        relationshipName,
-        relationshipType,
-        required: normalizedFieldDefinition.required === true,
-        nullable: normalizedFieldDefinition.nullable === true
-      }));
-      continue;
-    }
-
-    const relation = isRecord(normalizedFieldDefinition.relation)
-      ? normalizedFieldDefinition.relation
-      : {};
-    if (String(relation.kind || "").trim().toLowerCase() !== "collection") {
-      continue;
-    }
-
-    const collectionRelationshipType = resolveCrudResourceScopeName(
-      relation.target || relation.targetResource || relation.namespace || relation.apiPath
-    );
-    if (!collectionRelationshipType) {
-      continue;
-    }
-
-    const collectionRelationshipName = String(
-      relation.as || normalizedFieldDefinition.as || fieldKey || ""
-    ).trim();
-    if (!collectionRelationshipName) {
-      continue;
-    }
-
-    entries.push(Object.freeze({
-      attributeKey: fieldKey,
-      relationshipName: collectionRelationshipName,
-      relationshipType: collectionRelationshipType,
-      many: true,
-      required: normalizedFieldDefinition.required === true,
-      nullable: normalizedFieldDefinition.nullable === true
-    }));
-  }
-
-  return Object.freeze(entries);
-}
-
 function readOwnValue(source = {}, key = "") {
   if (isRecord(source) && Object.hasOwn(source, key)) {
     return {
@@ -574,4 +508,4 @@ function createCrudJsonApiRouteContracts({
   });
 }
 
-export { createCrudJsonApiRouteContracts };
+export { createCrudJsonApiRouteContracts, resolveJsonApiRelationshipEntries };

package/test/assistantActionConformance.test.js

@@ -0,0 +1,372 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+import { createServiceToolCatalog } from "@jskit-ai/assistant-core/server";
+import { createActionCatalogue } from "@jskit-ai/kernel/server/actions";
+import {
+  createSchema,
+  validateSchemaPayload
+} from "@jskit-ai/kernel/shared/validators";
+import { returnJsonApiDocument } from "@jskit-ai/http-runtime/shared";
+import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudResource";
+import { createCrudJsonApiActions } from "../src/server/jsonApiModule/actions.js";
+
+const BOOKINGS = Object.freeze([
+  Object.freeze({ id: "41", petId: "7", summary: "Wash and trim" }),
+  Object.freeze({ id: "42", petId: "8", summary: "Nail trim" })
+]);
+const PETS = Object.freeze({
+  "7": Object.freeze({ id: "7", name: "Fido", species: "dog" }),
+  "8": Object.freeze({ id: "8", name: "Mabel", species: "cat" })
+});
+
+function createBookingsResource() {
+  return defineCrudResource({
+    namespace: "bookings",
+    tableName: "bookings",
+    crudOperations: ["list", "view"],
+    contract: {
+      lookup: {
+        containerKey: "lookups"
+      }
+    },
+    schema: {
+      petId: {
+        type: "id",
+        required: true,
+        belongsTo: "pets",
+        as: "pet",
+        relation: {
+          kind: "lookup",
+          namespace: "pets",
+          valueKey: "id",
+          labelKey: "name"
+        },
+        operations: {
+          output: { required: true }
+        }
+      },
+      summary: {
+        type: "string",
+        required: true,
+        operations: {
+          output: { required: true }
+        }
+      }
+    }
+  });
+}
+
+function selectFields(source, selectedFields = null) {
+  if (!Array.isArray(selectedFields)) {
+    return { ...source };
+  }
+  return Object.fromEntries(
+    selectedFields
+      .filter((field) => Object.hasOwn(source, field))
+      .map((field) => [field, source[field]])
+  );
+}
+
+function createBookingDocument(query = {}) {
+  const limit = Math.min(Number(query.limit) || BOOKINGS.length, BOOKINGS.length);
+  const selectedBookings = query.fields?.bookings || null;
+  const selectedPets = query.fields?.pets || null;
+  const includesPet = String(query.include || "")
+    .split(",")
+    .map((entry) => entry.trim())
+    .includes("pet");
+  const rows = BOOKINGS.slice(0, limit);
+  const data = rows.map((booking) => {
+    const includePetLinkage = !selectedBookings || selectedBookings.includes("petId");
+    return {
+      type: "bookings",
+      id: booking.id,
+      attributes: selectFields({ summary: booking.summary }, selectedBookings),
+      ...(includePetLinkage
+        ? {
+            relationships: {
+              pet: {
+                data: { type: "pets", id: booking.petId }
+              }
+            }
+          }
+        : {})
+    };
+  });
+  const included = includesPet
+    ? rows.map((booking) => ({
+        type: "pets",
+        id: booking.petId,
+        attributes: selectFields({
+          name: PETS[booking.petId].name,
+          species: PETS[booking.petId].species
+        }, selectedPets)
+      }))
+    : [];
+
+  return {
+    data,
+    ...(included.length > 0 ? { included } : {}),
+    meta: {
+      page: {
+        nextCursor: limit < BOOKINGS.length ? `after-${rows.at(-1)?.id}` : null
+      }
+    }
+  };
+}
+
+function createFixture() {
+  const resource = createBookingsResource();
+  const calls = [];
+  const service = {
+    async queryDocuments(query, { context }) {
+      calls.push({ query, context });
+      return returnJsonApiDocument(createBookingDocument(query));
+    },
+    async getDocumentById() {
+      return returnJsonApiDocument({ data: createBookingDocument().data[0] });
+    }
+  };
+  const definitions = createCrudJsonApiActions({
+    namespace: "bookings",
+    resource,
+    service,
+    surface: "admin",
+    operations: ["list", "view"],
+    scopeInputValidator: Object.freeze({
+      schema: createSchema({
+        workspaceSlug: { type: "string", required: true }
+      }),
+      mode: "patch"
+    }),
+    scopeInputKeys: ["workspaceSlug"],
+    permissionForOperation: () => ({
+      require: "all",
+      permissions: ["bookings.list"]
+    })
+  });
+  const actions = createActionCatalogue();
+  actions.register({
+    contributorId: "test.generated-bookings",
+    domain: "bookings",
+    actions: definitions
+  });
+  const catalog = createServiceToolCatalog(actions, { maxDirectTools: 0 });
+  const context = Object.freeze({
+    actor: Object.freeze({ id: "user-7" }),
+    permissions: Object.freeze(["bookings.list"]),
+    surface: "admin",
+    workspace: Object.freeze({ slug: "north-clinic" })
+  });
+  return { actions, calls, catalog, context, definitions, resource };
+}
+
+async function loadListContract(fixture, context = fixture.context) {
+  const toolSet = fixture.catalog.resolveToolSet(context);
+  const search = await fixture.catalog.executeToolCall({
+    toolName: "assistant_action_search",
+    argumentsText: JSON.stringify({ query: "bookings list" }),
+    context,
+    toolSet
+  });
+  const contract = await fixture.catalog.executeToolCall({
+    toolName: "assistant_action_contract",
+    argumentsText: JSON.stringify({ actionId: "crud.bookings.list", version: 1 }),
+    context,
+    toolSet
+  });
+  return { contract, search, toolSet };
+}
+
+async function executeList(fixture, toolSet, input, context = fixture.context) {
+  return fixture.catalog.executeToolCall({
+    toolName: "assistant_action_execute",
+    argumentsText: JSON.stringify({
+      actionId: "crud.bookings.list",
+      version: 1,
+      input
+    }),
+    context,
+    toolSet
+  });
+}
+
+function resolveLocalSchemaReference(schema, node) {
+  const reference = node?.allOf?.[0]?.$ref;
+  assert.match(reference || "", /^#\/definitions\//u);
+  return schema.definitions[reference.slice("#/definitions/".length)];
+}
+
+test("generated CRUD list contracts conform through native assistant discovery and execution", async (t) => {
+  const fixture = createFixture();
+  const { contract, search, toolSet } = await loadListContract(fixture);
+  const listDefinition = fixture.definitions.find((entry) => entry.id === "crud.bookings.list");
+
+  assert.equal(search.ok, true);
+  assert.deepEqual(search.result.items.map((entry) => entry.actionId), ["crud.bookings.list"]);
+  assert.equal(contract.ok, true);
+  assert.equal(contract.result.inputSchema.properties.include.type, "string");
+  const fieldsetInputSchema = resolveLocalSchemaReference(
+    contract.result.inputSchema,
+    contract.result.inputSchema.properties.fields
+  );
+  assert.deepEqual(Object.keys(fieldsetInputSchema.properties), ["bookings", "pets"]);
+  assert.equal(fieldsetInputSchema.additionalProperties, false);
+  assert.deepEqual(fieldsetInputSchema.properties.bookings.items.enum, ["id", "petId", "summary"]);
+  assert.equal(Object.hasOwn(fieldsetInputSchema.properties.pets.items, "enum"), false);
+  assert.equal(Object.hasOwn(contract.result.inputSchema.properties, "workspaceSlug"), false);
+  assert.match(contract.result.description, /include must be a comma-separated string/u);
+  assert.match(contract.result.description, /\{"bookings":\["petId"\],"pets":\["name"\]\}/u);
+  assert.match(contract.result.description, /fields keys must be JSON:API resource types: "bookings", "pets"/u);
+  assert.match(contract.result.description, /use "pets" instead of "pet"/u);
+  assert.match(
+    contract.result.description,
+    /"pet" -> resource type "pets" -> items\[\]\.lookups\.pet/u
+  );
+  const primaryOutputSchema = resolveLocalSchemaReference(
+    contract.result.outputSchema,
+    contract.result.outputSchema.properties.items.items
+  );
+  const lookupOutputSchema = resolveLocalSchemaReference(
+    contract.result.outputSchema,
+    primaryOutputSchema.properties.lookups
+  );
+  const petOutputSchema = resolveLocalSchemaReference(
+    contract.result.outputSchema,
+    lookupOutputSchema.properties.pet
+  );
+  assert.ok(petOutputSchema.properties.name.anyOf.some((entry) => entry.type === "string"));
+
+  await t.test("full list without fields or include", async () => {
+    const response = await executeList(fixture, toolSet, { limit: 5 });
+    assert.equal(response.ok, true);
+    assert.deepEqual(response.result.result.items, [
+      { id: "41", petId: 7, summary: "Wash and trim" },
+      { id: "42", petId: 8, summary: "Nail trim" }
+    ]);
+    assert.equal(response.result.result.nextCursor, null);
+  });
+
+  await t.test("sparse primary fields only", async () => {
+    const response = await executeList(fixture, toolSet, {
+      fields: { bookings: ["petId"] },
+      limit: 5
+    });
+    assert.equal(response.ok, true);
+    assert.deepEqual(response.result.result.items, [
+      { id: "41", petId: 7 },
+      { id: "42", petId: 8 }
+    ]);
+  });
+
+  await t.test("included relationship without sparse fields", async () => {
+    const response = await executeList(fixture, toolSet, { include: "pet", limit: 5 });
+    assert.equal(response.ok, true);
+    assert.equal(response.result.result.items[0].lookups.pet.name, "Fido");
+    assert.equal(response.result.result.items[0].lookups.pet.species, "dog");
+    assert.equal(response.result.result.items[1].lookups.pet.name, "Mabel");
+  });
+
+  await t.test("included relationship plus sparse primary and related fields", async () => {
+    const response = await executeList(fixture, toolSet, {
+      workspaceSlug: "model-controlled-workspace",
+      include: "pet",
+      fields: { bookings: ["petId"], pets: ["name"] },
+      limit: 5
+    });
+    assert.equal(response.ok, true);
+    assert.notEqual(response.error?.code, "assistant_tool_output_invalid");
+    assert.deepEqual(JSON.parse(JSON.stringify(response.result.result.items)), [
+      {
+        id: "41",
+        petId: 7,
+        lookups: {
+          petId: { id: "7", name: "Fido" },
+          pet: { id: "7", name: "Fido" }
+        }
+      },
+      {
+        id: "42",
+        petId: 8,
+        lookups: {
+          petId: { id: "8", name: "Mabel" },
+          pet: { id: "8", name: "Mabel" }
+        }
+      }
+    ]);
+    assert.equal(Object.hasOwn(response.result.result.items[0], "summary"), false);
+    assert.equal(Object.hasOwn(response.result.result.items[0].lookups.pet, "species"), false);
+    assert.deepEqual(
+      validateSchemaPayload(listDefinition.extensions.assistant.output, response.result.result, {
+        phase: "output"
+      }),
+      response.result.result
+    );
+    assert.equal(fixture.calls.at(-1).query.workspaceSlug, undefined);
+    assert.equal(fixture.calls.at(-1).context.workspace.slug, "north-clinic");
+  });
+
+  await t.test("limit and cursor truncation remain bounded", async () => {
+    const response = await executeList(fixture, toolSet, { limit: 1 });
+    assert.equal(response.ok, true);
+    assert.equal(response.result.result.items.length, 1);
+    assert.equal(response.result.result.nextCursor, "after-41");
+    assert.equal(fixture.calls.at(-1).query.limit, 1);
+  });
+
+  await t.test("invalid array-shaped include gives an actionable validation result", async () => {
+    const response = await executeList(fixture, toolSet, { include: ["pet"] });
+    assert.equal(response.ok, false);
+    assert.equal(response.error.code, "ACTION_VALIDATION_FAILED");
+    assert.equal(response.error.status, 400);
+    assert.match(response.error.message, /include expects a comma-separated string such as "pet,service"/u);
+  });
+
+  await t.test("invalid array-shaped fields gives an actionable validation result", async () => {
+    const response = await executeList(fixture, toolSet, { fields: ["pet.name"] });
+    assert.equal(response.ok, false);
+    assert.equal(response.error.code, "ACTION_VALIDATION_FAILED");
+    assert.equal(response.error.status, 400);
+    assert.match(
+      response.error.message,
+      /fields expects an object keyed by JSON:API resource type, such as \{"bookings":\["petId"\],"pets":\["name"\]\}/u
+    );
+  });
+
+  await t.test("relationship aliases are rejected as sparse-fieldset resource keys", async () => {
+    const callCount = fixture.calls.length;
+    const response = await executeList(fixture, toolSet, {
+      include: "pet",
+      fields: { pet: ["name"] },
+      limit: 3
+    });
+    assert.equal(response.ok, false);
+    assert.equal(response.error.code, "ACTION_VALIDATION_FAILED");
+    assert.equal(response.error.status, 400);
+    assert.match(response.error.message, /fields\.pet: fields keys must be JSON:API resource types/u);
+    assert.match(response.error.message, /Allowed keys: "bookings", "pets"/u);
+    assert.match(response.error.message, /use "pets" instead of "pet"/u);
+    assert.equal(fixture.calls.length, callCount);
+  });
+
+  await t.test("permission denial removes the generated action from native discovery", async () => {
+    const deniedContext = {
+      ...fixture.context,
+      permissions: []
+    };
+    const deniedToolSet = fixture.catalog.resolveToolSet(deniedContext);
+    assert.deepEqual(deniedToolSet.tools, []);
+    assert.deepEqual(await fixture.catalog.executeToolCall({
+      toolName: "crud_bookings_list",
+      argumentsText: "{}",
+      context: deniedContext,
+      toolSet: deniedToolSet
+    }), {
+      ok: false,
+      error: {
+        code: "assistant_tool_unknown",
+        message: "Unknown tool."
+      }
+    });
+  });
+});

package/test/defineCrudJsonApiFeature.test.js

@@ -227,11 +227,18 @@ test("generated CRUD actions expose truthful assistant contracts without changin
   const byOperation = new Map(actions.map((entry) => [entry.id.split(".").at(-1), entry]));
 
   assert.ok(actions.every((entry) => entry.output === null));
-  assert.equal(byOperation.get("list").extensions.assistant.output, resource.operations.list.output);
-  assert.equal(byOperation.get("view").extensions.assistant.output, resource.operations.view.output);
+  assert.notEqual(byOperation.get("list").extensions.assistant.output, resource.operations.list.output);
+  assert.notEqual(byOperation.get("view").extensions.assistant.output, resource.operations.view.output);
   assert.equal(byOperation.get("create").extensions.assistant.output, resource.operations.create.output);
   assert.equal(byOperation.get("update").extensions.assistant.output, resource.operations.patch.output);
   assert.equal(byOperation.get("delete").extensions.assistant.output, resource.operations.delete.output);
+  const sparseListContract = byOperation.get("list").extensions.assistant.output.schema.toJsonSchema({ mode: "replace" });
+  const sparseListItemContract = Object.values(sparseListContract.definitions)[0];
+  assert.deepEqual(sparseListItemContract.required, ["id"]);
+  assert.deepEqual(
+    byOperation.get("view").extensions.assistant.output.schema.toJsonSchema({ mode: "replace" }).required,
+    ["id"]
+  );
 
   const transform = async (operation, input = {}) => {
     const definition = byOperation.get(operation);

package/test/listQueryValidators.test.js

@@ -10,6 +10,7 @@ import {
   listSearchQueryValidator,
   lookupIncludeQueryValidator,
   createCrudCursorPaginationQueryValidator,
+  createJsonApiFieldsetsQueryValidator,
   createCrudParentFilterQueryValidator,
   createStandardCrudListQueryValidators,
   createStandardCrudViewQueryValidators,
@@ -26,11 +27,13 @@ function composeSchemaDefinition(...definitions) {
 }
 
 function createCrudResource({
+  namespace = "",
   viewFields = {},
   createFields = {},
   patchFields = {}
 } = {}) {
   return {
+    ...(namespace ? { namespace } : {}),
     operations: {
       view: {
         output: {
@@ -90,6 +93,62 @@ test("lookupIncludeQueryValidator keeps include optional when merged with pagina
   assert.deepEqual(compiled.schema.querystring.required || [], []);
 });
 
+test("resource-aware sparse fieldsets enumerate JSON:API types and reject relationship aliases", () => {
+  const resource = createCrudResource({
+    namespace: "bookings",
+    viewFields: {
+      petId: {
+        type: "integer",
+        belongsTo: "pets",
+        as: "pet",
+        relation: {
+          labelKey: "name"
+        }
+      },
+      serviceId: {
+        type: "integer",
+        belongsTo: "services",
+        as: "service",
+        relation: {
+          labelKey: "name"
+        }
+      }
+    }
+  });
+  const validator = createJsonApiFieldsetsQueryValidator({ resource });
+  const transportSchema = validator.schema.toJsonSchema({ mode: "patch" });
+  const fieldsetReference = transportSchema.properties.fields.allOf[0].$ref;
+  const fieldsetSchema = transportSchema.definitions[fieldsetReference.slice("#/definitions/".length)];
+
+  assert.deepEqual(Object.keys(fieldsetSchema.properties), ["bookings", "pets", "services"]);
+  assert.equal(fieldsetSchema.additionalProperties, false);
+  assert.deepEqual(fieldsetSchema.properties.bookings.items.enum, ["petId", "serviceId"]);
+  assert.equal(Object.hasOwn(fieldsetSchema.properties.pets.items, "enum"), false);
+  assert.deepEqual(validateSchemaPayload(validator, {
+    fields: {
+      bookings: ["petId"],
+      pets: ["name"]
+    }
+  }, { phase: "input" }), {
+    fields: {
+      bookings: ["petId"],
+      pets: ["name"]
+    }
+  });
+  assert.throws(
+    () => validateSchemaPayload(validator, {
+      fields: {
+        pet: ["name"]
+      }
+    }, { phase: "input" }),
+    (error) => {
+      assert.match(error.fieldErrors?.["fields.pet"] || "", /Allowed keys: "bookings", "pets", "services"/u);
+      assert.match(error.fieldErrors?.["fields.pet"] || "", /use "pets" instead of "pet"/u);
+      return true;
+    }
+  );
+});
+
 test("createCrudCursorPaginationQueryValidator keeps numeric cursor validation for unordered lists", () => {
   const validator = createCrudCursorPaginationQueryValidator({});
 

package/test/routeContracts.test.js

@@ -180,7 +180,8 @@ test("createCrudJsonApiRouteContracts builds default CRUD JSON:API contracts", a
     limit: "25",
     fields: {
       contacts: ["id", "name"],
-      userProfiles: ["id", "name"]
+      userProfiles: ["id", "name"],
+      organizations: ["name"]
     }
   }, { phase: "input" });
 
@@ -192,7 +193,8 @@ test("createCrudJsonApiRouteContracts builds default CRUD JSON:API contracts", a
     limit: 25,
     fields: {
       contacts: ["id", "name"],
-      userProfiles: ["id", "name"]
+      userProfiles: ["id", "name"],
+      organizations: ["name"]
     }
   });