@jskit-ai/crud-core 0.1.144 → 0.1.145

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/crud-core",
-  version: "0.1.144",
+  version: "0.1.145",
   kind: "runtime",
   description: "Shared CRUD helpers used by CRUD modules.",
   dependsOn: [
@@ -28,7 +28,7 @@ export default Object.freeze({
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/crud-core": "0.1.144"
+        "@jskit-ai/crud-core": "0.1.145"
       },
       dev: {}
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/crud-core",
-  "version": "0.1.144",
+  "version": "0.1.145",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -27,15 +27,15 @@
     "./server/routeContracts": "./src/server/routeContracts.js"
   },
   "dependencies": {
-    "@jskit-ai/database-runtime": "0.1.134",
-    "@jskit-ai/http-runtime": "0.1.133",
-    "@jskit-ai/kernel": "0.1.135",
+    "@jskit-ai/database-runtime": "0.1.135",
+    "@jskit-ai/http-runtime": "0.1.134",
+    "@jskit-ai/kernel": "0.1.136",
     "json-rest-schema": "1.x.x",
-    "@jskit-ai/realtime": "0.1.132",
-    "@jskit-ai/resource-crud-core": "0.1.78",
-    "@jskit-ai/shell-web": "0.1.136",
-    "@jskit-ai/users-core": "0.1.146",
-    "@jskit-ai/users-web": "0.1.152"
+    "@jskit-ai/realtime": "0.1.133",
+    "@jskit-ai/resource-crud-core": "0.1.79",
+    "@jskit-ai/shell-web": "0.1.137",
+    "@jskit-ai/users-core": "0.1.148",
+    "@jskit-ai/users-web": "0.1.153"
   },
   "peerDependencies": {
     "@tanstack/vue-query": "^5.90.5",

package/src/server/listQueryValidators.js

@@ -25,6 +25,23 @@ const lookupIncludeQueryValidator = Object.freeze({
   mode: "patch"
 });
 
+const jsonApiFieldsetsQueryValidator = Object.freeze({
+  schema: createSchema({
+    fields: {
+      type: "object",
+      required: false,
+      values: {
+        type: "array",
+        items: {
+          type: "string",
+          minLength: 1
+        }
+      }
+    }
+  }),
+  mode: "patch"
+});
+
 function resolveCrudListUsesOrderedCursor(list = {}) {
   const entries = Array.isArray(list?.orderBy)
     ? list.orderBy
@@ -92,6 +109,7 @@ export {
   createCrudCursorPaginationQueryValidator,
   listSearchQueryValidator,
   lookupIncludeQueryValidator,
+  jsonApiFieldsetsQueryValidator,
   resolveCrudParentFilterKeys,
   createCrudParentFilterQueryValidator
 };

package/src/server/routeContracts.js

@@ -11,6 +11,7 @@ import {
   createCrudCursorPaginationQueryValidator,
   listSearchQueryValidator as defaultListSearchQueryValidator,
   lookupIncludeQueryValidator as defaultLookupIncludeQueryValidator,
+  jsonApiFieldsetsQueryValidator,
   createCrudParentFilterQueryValidator
 } from "./listQueryValidators.js";
 
@@ -454,7 +455,12 @@ function createCrudJsonApiRouteContracts({
     listSearchQueryValidator,
     listParentFilterQueryValidator,
     ...(resolvedListFilterQueryValidator ? [resolvedListFilterQueryValidator] : []),
-    lookupIncludeQueryValidator
+    lookupIncludeQueryValidator,
+    jsonApiFieldsetsQueryValidator
+  ]);
+  const viewRouteQueryValidator = composeSchemaDefinitions([
+    lookupIncludeQueryValidator,
+    jsonApiFieldsetsQueryValidator
   ]);
   const recordRouteParamsValidator = routeParamsValidator
     ? composeSchemaDefinitions([
@@ -511,19 +517,23 @@ function createCrudJsonApiRouteContracts({
       query: listRouteQueryValidator,
       output: viewOutput,
       outputKind: "collection",
+      includeValidation400: true,
       outputAttributeExcludeKeys,
       outputRelationshipEntries: viewOutputRelationships,
+      allowSparseFields: true,
       getRecordAttributes: viewRecordAttributes,
       getRecordRelationships: viewRecordRelationships,
       getIncluded: viewIncluded
     }),
     viewRouteContract: createJsonApiResourceRouteContract({
       type: routeType,
-      query: lookupIncludeQueryValidator,
+      query: viewRouteQueryValidator,
       output: viewOutput,
       outputKind: "record",
+      includeValidation400: true,
       outputAttributeExcludeKeys,
       outputRelationshipEntries: viewOutputRelationships,
+      allowSparseFields: true,
       getRecordAttributes: viewRecordAttributes,
       getRecordRelationships: viewRecordRelationships,
       getIncluded: viewIncluded

package/test/routeContracts.test.js

@@ -177,7 +177,11 @@ test("createCrudJsonApiRouteContracts builds default CRUD JSON:API contracts", a
     include: "  ownerId  ",
     contactId: "  42  ",
     cursor: "  offset:2  ",
-    limit: "25"
+    limit: "25",
+    fields: {
+      contacts: ["id", "name"],
+      userProfiles: ["id", "name"]
+    }
   }, { phase: "input" });
 
   assert.deepEqual(normalizedListQuery, {
@@ -185,9 +189,39 @@ test("createCrudJsonApiRouteContracts builds default CRUD JSON:API contracts", a
     include: "ownerId",
     contactId: "42",
     cursor: "offset:2",
-    limit: 25
+    limit: 25,
+    fields: {
+      contacts: ["id", "name"],
+      userProfiles: ["id", "name"]
+    }
   });
 
+  assert.deepEqual(
+    await validateSchemaPayload(contracts.viewRouteContract.query, {
+      include: "owner",
+      fields: {
+        contacts: ["id", "name"],
+        userProfiles: ["id", "name"]
+      }
+    }, { phase: "input" }),
+    {
+      include: "owner",
+      fields: {
+        contacts: ["id", "name"],
+        userProfiles: ["id", "name"]
+      }
+    }
+  );
+
+  const sparseResourceSchema =
+    contracts.listRouteContract.responses[200].transportSchema.definitions.contactsSuccessResource;
+  const sparseAttributesSchemaName = sparseResourceSchema.properties.attributes.allOf[0].$ref
+    .replace("#/definitions/", "");
+  const sparseAttributesSchema =
+    contracts.listRouteContract.responses[200].transportSchema.definitions[sparseAttributesSchemaName];
+  assert.deepEqual(sparseResourceSchema.required, ["type", "id"]);
+  assert.equal(Object.hasOwn(sparseAttributesSchema, "required"), false);
+
   const decodedCreateBody = contracts.createRouteContract.transport.request.body({
     data: {
       type: "contacts",