@jskit-ai/crud-core 0.1.180 → 0.1.182

package/package.json

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

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.180",
-    "@jskit-ai/resource-crud-core": "0.1.111"
+    "@jskit-ai/crud-core": "0.1.182",
+    "@jskit-ai/resource-crud-core": "0.1.113"
   },
   "jskit": {
     "kind": "runtime",

package/src/server/jsonApiModule/actions.js

@@ -3,6 +3,7 @@ import {
   createSchema,
   recordIdParamsValidator
 } from "@jskit-ai/kernel/shared/validators";
+import { normalizeJsonApiFieldsets } from "@jskit-ai/kernel/shared/support/jsonApiFieldsets";
 import { createEntityChangedActionEvent } from "@jskit-ai/kernel/server/actions";
 import {
   decodeJsonApiResourceResponse,
@@ -166,6 +167,102 @@ function createCrudAssistantTransport(resource, operation, relationshipEntries,
   });
 }
 
+function projectCrudAssistantRecordFields(record, selectedFields = null, {
+  preserveKeys = []
+} = {}) {
+  if (!isRecord(record) || !Array.isArray(selectedFields)) {
+    return record;
+  }
+
+  const allowedKeys = new Set(["id", ...preserveKeys, ...selectedFields]);
+  return Object.fromEntries(
+    Object.entries(record).filter(([key]) => allowedKeys.has(key))
+  );
+}
+
+function projectCrudAssistantLookupValue(value, selectedFields = null) {
+  if (Array.isArray(value)) {
+    return value.map((entry) => projectCrudAssistantRecordFields(entry, selectedFields));
+  }
+  return projectCrudAssistantRecordFields(value, selectedFields);
+}
+
+function projectCrudAssistantReadRecord(record, {
+  lookupContainerKey = "",
+  primaryFields = null,
+  relatedFieldsByLookupKey = new Map()
+} = {}) {
+  if (!isRecord(record)) {
+    return record;
+  }
+
+  const primaryProjection = projectCrudAssistantRecordFields(record, primaryFields, {
+    preserveKeys: lookupContainerKey && isRecord(record[lookupContainerKey])
+      ? [lookupContainerKey]
+      : []
+  });
+  const projectedRecord = primaryProjection === record ? { ...record } : primaryProjection;
+  if (!lookupContainerKey || !isRecord(projectedRecord[lookupContainerKey])) {
+    return projectedRecord;
+  }
+
+  projectedRecord[lookupContainerKey] = Object.fromEntries(
+    Object.entries(projectedRecord[lookupContainerKey]).map(([lookupKey, value]) => {
+      return [
+        lookupKey,
+        projectCrudAssistantLookupValue(value, relatedFieldsByLookupKey.get(lookupKey))
+      ];
+    })
+  );
+  return projectedRecord;
+}
+
+function createCrudAssistantResultProjection(input = {}, resource = {}, relationshipEntries = []) {
+  const primaryType = String(resource?.namespace || "").trim();
+  const fieldsets = normalizeJsonApiFieldsets(input?.fields, {
+    primaryType
+  });
+  if (Object.keys(fieldsets).length < 1) {
+    return null;
+  }
+
+  const relatedFieldsByLookupKey = new Map();
+  for (const entry of relationshipEntries) {
+    const selectedFields = fieldsets[entry.relationshipType];
+    if (!Array.isArray(selectedFields)) {
+      continue;
+    }
+    relatedFieldsByLookupKey.set(entry.relationshipName, selectedFields);
+    relatedFieldsByLookupKey.set(entry.attributeKey, selectedFields);
+  }
+
+  return {
+    primaryFields: fieldsets[primaryType],
+    relatedFieldsByLookupKey
+  };
+}
+
+function projectCrudAssistantReadResult(result, projection = null, {
+  lookupContainerKey = ""
+} = {}) {
+  if (!projection) {
+    return result;
+  }
+
+  const projectionOptions = {
+    ...projection,
+    lookupContainerKey
+  };
+  if (isRecord(result) && Array.isArray(result.items)) {
+    return {
+      ...result,
+      items: result.items.map((entry) => projectCrudAssistantReadRecord(entry, projectionOptions))
+    };
+  }
+
+  return projectCrudAssistantReadRecord(result, projectionOptions);
+}
+
 function transformCrudAssistantResult(operation, result, {
   input = {},
   resource,
@@ -184,39 +281,45 @@ function transformCrudAssistantResult(operation, result, {
   }
 
   const resolved = resolveAssistantResultValue(result);
+  const projection = operation === "list" || operation === "view"
+    ? createCrudAssistantResultProjection(input, resource, relationshipEntries)
+    : null;
+  const projectReadResult = (value) => projectCrudAssistantReadResult(value, projection, {
+    lookupContainerKey
+  });
   if (operation === "list") {
     if (resolved.document.kind === "collection") {
       const decoded = decodeJsonApiResourceResponse(
         resolved.value,
         createCrudAssistantTransport(resource, operation, relationshipEntries, lookupContainerKey)
       );
-      return {
+      return projectReadResult({
         items: decoded.items,
         nextCursor: normalizeOptionalCursor(decoded.nextCursor)
-      };
+      });
     }
     if (Array.isArray(resolved.value)) {
-      return {
+      return projectReadResult({
         items: resolved.value,
         nextCursor: null
-      };
+      });
     }
     if (isRecord(resolved.value) && Array.isArray(resolved.value.items)) {
-      return {
+      return projectReadResult({
         items: resolved.value.items,
         nextCursor: normalizeOptionalCursor(resolved.value.nextCursor)
-      };
+      });
     }
     return resolved.value;
   }
 
   if (resolved.document.kind === "resource") {
-    return decodeJsonApiResourceResponse(
+    return projectReadResult(decodeJsonApiResourceResponse(
       resolved.value,
       createCrudAssistantTransport(resource, operation, relationshipEntries, lookupContainerKey)
-    );
+    ));
   }
-  return resolved.value;
+  return projectReadResult(resolved.value);
 }
 
 function createCrudAssistantReadDescription({

package/test/assistantActionConformance.test.js

@@ -11,14 +11,46 @@ import { defineCrudResource } from "@jskit-ai/resource-crud-core/shared/crudReso
 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" })
+  Object.freeze({
+    id: "41",
+    serviceId: "11",
+    productId: "21",
+    contactId: "31",
+    petId: "7",
+    summary: "Wash and trim"
+  }),
+  Object.freeze({
+    id: "42",
+    serviceId: "12",
+    productId: "22",
+    contactId: "32",
+    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" })
+  "7": Object.freeze({ id: "7", contactId: "31", breedId: "91", name: "Fido", species: "dog" }),
+  "8": Object.freeze({ id: "8", contactId: "32", breedId: "92", name: "Mabel", species: "cat" })
 });
 
+function lookupField(namespace, relationshipName) {
+  return {
+    type: "id",
+    required: true,
+    belongsTo: namespace,
+    as: relationshipName,
+    relation: {
+      kind: "lookup",
+      namespace,
+      valueKey: "id",
+      labelKey: "name"
+    },
+    operations: {
+      output: { required: true }
+    }
+  };
+}
+
 function createBookingsResource() {
   return defineCrudResource({
     namespace: "bookings",
@@ -30,21 +62,10 @@ function createBookingsResource() {
       }
     },
     schema: {
-      petId: {
-        type: "id",
-        required: true,
-        belongsTo: "pets",
-        as: "pet",
-        relation: {
-          kind: "lookup",
-          namespace: "pets",
-          valueKey: "id",
-          labelKey: "name"
-        },
-        operations: {
-          output: { required: true }
-        }
-      },
+      serviceId: lookupField("services", "service"),
+      productId: lookupField("products", "product"),
+      contactId: lookupField("contacts", "contact"),
+      petId: lookupField("pets", "pet"),
       summary: {
         type: "string",
         required: true,
@@ -77,20 +98,24 @@ function createBookingDocument(query = {}) {
     .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 }
-              }
-            }
-          }
-        : {})
+      relationships: {
+        service: {
+          data: { type: "services", id: booking.serviceId }
+        },
+        product: {
+          data: { type: "products", id: booking.productId }
+        },
+        contact: {
+          data: { type: "contacts", id: booking.contactId }
+        },
+        pet: {
+          data: { type: "pets", id: booking.petId }
+        }
+      }
     };
   });
   const included = includesPet
@@ -100,7 +125,15 @@ function createBookingDocument(query = {}) {
         attributes: selectFields({
           name: PETS[booking.petId].name,
           species: PETS[booking.petId].species
-        }, selectedPets)
+        }, selectedPets),
+        relationships: {
+          contact: {
+            data: { type: "contacts", id: PETS[booking.petId].contactId }
+          },
+          breed: {
+            data: { type: "breeds", id: PETS[booking.petId].breedId }
+          }
+        }
       }))
     : [];
 
@@ -123,8 +156,12 @@ function createFixture() {
       calls.push({ query, context });
       return returnJsonApiDocument(createBookingDocument(query));
     },
-    async getDocumentById() {
-      return returnJsonApiDocument({ data: createBookingDocument().data[0] });
+    async getDocumentById(_recordId, query) {
+      const document = createBookingDocument(query);
+      return returnJsonApiDocument({
+        data: document.data[0],
+        ...(document.included ? { included: document.included } : {})
+      });
     }
   };
   const definitions = createCrudJsonApiActions({
@@ -210,14 +247,23 @@ test("generated CRUD list contracts conform through native assistant discovery a
     contract.result.inputSchema,
     contract.result.inputSchema.properties.fields
   );
-  assert.deepEqual(Object.keys(fieldsetInputSchema.properties), ["bookings", "pets"]);
+  assert.deepEqual(
+    Object.keys(fieldsetInputSchema.properties),
+    ["bookings", "services", "products", "contacts", "pets"]
+  );
   assert.equal(fieldsetInputSchema.additionalProperties, false);
-  assert.deepEqual(fieldsetInputSchema.properties.bookings.items.enum, ["id", "petId", "summary"]);
+  assert.deepEqual(
+    fieldsetInputSchema.properties.bookings.items.enum,
+    ["id", "serviceId", "productId", "contactId", "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, /\{"bookings":\["serviceId"\],"services":\["name"\]\}/u);
+  assert.match(
+    contract.result.description,
+    /fields keys must be JSON:API resource types: "bookings", "services", "products", "contacts", "pets"/u
+  );
   assert.match(contract.result.description, /use "pets" instead of "pet"/u);
   assert.match(
     contract.result.description,
@@ -241,21 +287,35 @@ test("generated CRUD list contracts conform through native assistant discovery a
     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" }
+      {
+        id: "41",
+        serviceId: 11,
+        productId: 21,
+        contactId: 31,
+        petId: 7,
+        summary: "Wash and trim"
+      },
+      {
+        id: "42",
+        serviceId: 12,
+        productId: 22,
+        contactId: 32,
+        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"] },
+      fields: { bookings: ["serviceId"] },
       limit: 5
     });
     assert.equal(response.ok, true);
     assert.deepEqual(response.result.result.items, [
-      { id: "41", petId: 7 },
-      { id: "42", petId: 8 }
+      { id: "41", serviceId: 11 },
+      { id: "42", serviceId: 12 }
     ]);
   });
 
@@ -264,6 +324,8 @@ test("generated CRUD list contracts conform through native assistant discovery a
     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[0].lookups.pet.contactId, "31");
+    assert.equal(response.result.result.items[0].lookups.pet.breedId, "91");
     assert.equal(response.result.result.items[1].lookups.pet.name, "Mabel");
   });
 
@@ -271,7 +333,7 @@ test("generated CRUD list contracts conform through native assistant discovery a
     const response = await executeList(fixture, toolSet, {
       workspaceSlug: "model-controlled-workspace",
       include: "pet",
-      fields: { bookings: ["petId"], pets: ["name"] },
+      fields: { bookings: ["id", "serviceId"], pets: ["name"] },
       limit: 5
     });
     assert.equal(response.ok, true);
@@ -279,7 +341,7 @@ test("generated CRUD list contracts conform through native assistant discovery a
     assert.deepEqual(JSON.parse(JSON.stringify(response.result.result.items)), [
       {
         id: "41",
-        petId: 7,
+        serviceId: 11,
         lookups: {
           petId: { id: "7", name: "Fido" },
           pet: { id: "7", name: "Fido" }
@@ -287,7 +349,7 @@ test("generated CRUD list contracts conform through native assistant discovery a
       },
       {
         id: "42",
-        petId: 8,
+        serviceId: 12,
         lookups: {
           petId: { id: "8", name: "Mabel" },
           pet: { id: "8", name: "Mabel" }
@@ -295,7 +357,12 @@ test("generated CRUD list contracts conform through native assistant discovery a
       }
     ]);
     assert.equal(Object.hasOwn(response.result.result.items[0], "summary"), false);
+    assert.equal(Object.hasOwn(response.result.result.items[0], "productId"), false);
+    assert.equal(Object.hasOwn(response.result.result.items[0], "contactId"), false);
+    assert.equal(Object.hasOwn(response.result.result.items[0], "petId"), false);
     assert.equal(Object.hasOwn(response.result.result.items[0].lookups.pet, "species"), false);
+    assert.equal(Object.hasOwn(response.result.result.items[0].lookups.pet, "contactId"), false);
+    assert.equal(Object.hasOwn(response.result.result.items[0].lookups.pet, "breedId"), false);
     assert.deepEqual(
       validateSchemaPayload(listDefinition.extensions.assistant.output, response.result.result, {
         phase: "output"
@@ -303,9 +370,47 @@ test("generated CRUD list contracts conform through native assistant discovery a
       response.result.result
     );
     assert.equal(fixture.calls.at(-1).query.workspaceSlug, undefined);
+    assert.deepEqual(fixture.calls.at(-1).query.fields, {
+      bookings: ["id", "serviceId"],
+      pets: ["name"]
+    });
     assert.equal(fixture.calls.at(-1).context.workspace.slug, "north-clinic");
   });
 
+  await t.test("sparse view projection removes unselected relationship linkage", async () => {
+    const viewContract = await fixture.catalog.executeToolCall({
+      toolName: "assistant_action_contract",
+      argumentsText: JSON.stringify({ actionId: "crud.bookings.view", version: 1 }),
+      context: fixture.context,
+      toolSet
+    });
+    assert.equal(viewContract.ok, true);
+
+    const response = await fixture.catalog.executeToolCall({
+      toolName: "assistant_action_execute",
+      argumentsText: JSON.stringify({
+        actionId: "crud.bookings.view",
+        version: 1,
+        input: {
+          recordId: "41",
+          include: "pet",
+          fields: { bookings: ["serviceId"], pets: ["name"] }
+        }
+      }),
+      context: fixture.context,
+      toolSet
+    });
+    assert.equal(response.ok, true);
+    assert.deepEqual(JSON.parse(JSON.stringify(response.result.result)), {
+      id: "41",
+      serviceId: 11,
+      lookups: {
+        petId: { id: "7", name: "Fido" },
+        pet: { id: "7", name: "Fido" }
+      }
+    });
+  });
+
   await t.test("limit and cursor truncation remain bounded", async () => {
     const response = await executeList(fixture, toolSet, { limit: 1 });
     assert.equal(response.ok, true);
@@ -329,7 +434,7 @@ test("generated CRUD list contracts conform through native assistant discovery a
     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
+      /fields expects an object keyed by JSON:API resource type, such as \{"bookings":\["serviceId"\],"services":\["name"\]\}/u
     );
   });
 
@@ -344,7 +449,10 @@ test("generated CRUD list contracts conform through native assistant discovery a
     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,
+      /Allowed keys: "bookings", "services", "products", "contacts", "pets"/u
+    );
     assert.match(response.error.message, /use "pets" instead of "pet"/u);
     assert.equal(fixture.calls.length, callCount);
   });