@jskit-ai/resource-crud-core 0.1.196 → 0.1.197

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## Unreleased
+
+- New catalog `locales/en.json` (exported as `./locales/en.json`) with the list filter words under `jskit.crud.listFilter.*`.
+- `CRUD_LIST_FILTER_PRESENCE_OPTIONS` labels are message keys (`jskit.crud.listFilter.present`, `jskit.crud.listFilter.missing`); render them with `text()`. `formatCrudListFilterDefaultChipLabel` takes a `t` option for the app's translator and keeps its English without one.
+
+### New message keys (8)
+
+<details><summary>Key list</summary>
+
+- `jskit.crud.listFilter.present`
+- `jskit.crud.listFilter.missing`
+- `jskit.crud.listFilter.chip.value`
+- `jskit.crud.listFilter.chip.range`
+- `jskit.crud.listFilter.chip.from`
+- `jskit.crud.listFilter.chip.to`
+- `jskit.crud.listFilter.chip.min`
+- `jskit.crud.listFilter.chip.max`
+
+</details>

package/locales/en.json

@@ -0,0 +1,18 @@
+{
+  "jskit": {
+    "crud": {
+      "listFilter": {
+        "present": "Present",
+        "missing": "Missing",
+        "chip": {
+          "value": "{label}: {value}",
+          "range": "{label}: {from} to {to}",
+          "from": "{label}: from {from}",
+          "to": "{label}: to {to}",
+          "min": "{label}: min {min}",
+          "max": "{label}: max {max}"
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/resource-crud-core",
-  "version": "0.1.196",
+  "version": "0.1.197",
   "type": "module",
   "scripts": {
     "test": "node --test --test-concurrency=1"
@@ -10,10 +10,11 @@
     "./shared/crudListFilters": "./src/shared/crudListFilters.js",
     "./shared/crudLookup": "./src/shared/crudLookup.js",
     "./shared/crudNamespaceSupport": "./src/shared/crudNamespaceSupport.js",
-    "./shared/crudResource": "./src/shared/crudResource.js"
+    "./shared/crudResource": "./src/shared/crudResource.js",
+    "./locales/en.json": "./locales/en.json"
   },
   "dependencies": {
-    "@jskit-ai/resource-core": "0.1.196"
+    "@jskit-ai/resource-core": "0.1.197"
   },
   "description": "Shared CRUD resource, field, lookup, filter, and namespace contracts.",
   "jskit": {
@@ -34,6 +35,6 @@
     }
   },
   "peerDependencies": {
-    "@jskit-ai/kernel": "0.2.5"
+    "@jskit-ai/kernel": "0.2.6"
   }
 }

package/src/shared/crudListFilterValues.js

@@ -1,11 +1,13 @@
 // The values a CRUD list filter holds: its types and their empty, UI, query and chip forms.
 import { deepFreeze } from "@jskit-ai/kernel/shared/support/deepFreeze";
+import { catalogMessage, formatMessage } from "@jskit-ai/kernel/shared/i18n";
 import {
   normalizeBoolean,
   normalizeCanonicalRecordIdText,
   normalizeUniqueTextList,
   normalizeText
 } from "@jskit-ai/kernel/shared/support/normalize";
+import en from "../../locales/en.json" with { type: "json" };
 
 const CRUD_LIST_FILTER_TYPE_FLAG = "flag";
 const CRUD_LIST_FILTER_TYPE_ENUM = "enum";
@@ -35,14 +37,16 @@ const CRUD_LIST_FILTER_PRESENCE_VALUES = new Set([
   CRUD_LIST_FILTER_PRESENCE_PRESENT,
   CRUD_LIST_FILTER_PRESENCE_MISSING
 ]);
+// Option labels are message keys; JSKIT's filter controls and chips render them
+// with text(), which shows any other label as written.
 const CRUD_LIST_FILTER_PRESENCE_OPTIONS = Object.freeze([
   Object.freeze({
     value: CRUD_LIST_FILTER_PRESENCE_PRESENT,
-    label: "Present"
+    label: "jskit.crud.listFilter.present"
   }),
   Object.freeze({
     value: CRUD_LIST_FILTER_PRESENCE_MISSING,
-    label: "Missing"
+    label: "jskit.crud.listFilter.missing"
   })
 ]);
 const CRUD_LIST_FILTER_INVALID_VALUES_REJECT = "reject";
@@ -556,12 +560,26 @@ function atomicValueText(value) {
   return String(value || "");
 }
 
-function formatCrudListFilterDefaultChipLabel(filter = {}, rawValue, { resolveAtomicValue: resolveAtomicLabel = atomicValueText } = {}) {
+/**
+ * A chip message in English, from this package's catalog; a client passes its own
+ * translator instead.
+ * @param {string} key
+ * @param {Record<string, unknown>} params
+ */
+function englishChipText(key, params) {
+  return formatMessage(catalogMessage(en, key), params);
+}
+
+function formatCrudListFilterDefaultChipLabel(filter = {}, rawValue, {
+  resolveAtomicValue: resolveAtomicLabel = atomicValueText,
+  t = englishChipText
+} = {}) {
   const normalizedValue = normalizeCrudListFilterUiValue(filter, rawValue);
   const type = normalizeCrudListFilterType(filter.type);
+  const label = filter.label;
 
   if (type === CRUD_LIST_FILTER_TYPE_FLAG) {
-    return filter.label;
+    return label;
   }
 
   if (
@@ -569,41 +587,41 @@ function formatCrudListFilterDefaultChipLabel(filter = {}, rawValue, { resolveAt
     type === CRUD_LIST_FILTER_TYPE_PRESENCE ||
     type === CRUD_LIST_FILTER_TYPE_RECORD_ID
   ) {
-    return `${filter.label}: ${resolveAtomicLabel(normalizedValue, filter)}`;
+    return t("jskit.crud.listFilter.chip.value", { label, value: resolveAtomicLabel(normalizedValue, filter) });
   }
 
   if (type === CRUD_LIST_FILTER_TYPE_ENUM_MANY || type === CRUD_LIST_FILTER_TYPE_RECORD_ID_MANY) {
     const atomicValue = Array.isArray(normalizedValue)
       ? normalizedValue[0] || ""
       : normalizeText(normalizedValue);
-    return `${filter.label}: ${resolveAtomicLabel(atomicValue, filter)}`;
+    return t("jskit.crud.listFilter.chip.value", { label, value: resolveAtomicLabel(atomicValue, filter) });
   }
 
   if (type === CRUD_LIST_FILTER_TYPE_DATE) {
-    return `${filter.label}: ${normalizedValue}`;
+    return t("jskit.crud.listFilter.chip.value", { label, value: normalizedValue });
   }
 
   if (type === CRUD_LIST_FILTER_TYPE_DATE_RANGE) {
     if (normalizedValue?.from && normalizedValue?.to) {
-      return `${filter.label}: ${normalizedValue.from} to ${normalizedValue.to}`;
+      return t("jskit.crud.listFilter.chip.range", { label, from: normalizedValue.from, to: normalizedValue.to });
     }
     if (normalizedValue?.from) {
-      return `${filter.label}: from ${normalizedValue.from}`;
+      return t("jskit.crud.listFilter.chip.from", { label, from: normalizedValue.from });
     }
-    return `${filter.label}: to ${normalizedValue?.to || ""}`;
+    return t("jskit.crud.listFilter.chip.to", { label, to: normalizedValue?.to || "" });
   }
 
   if (type === CRUD_LIST_FILTER_TYPE_NUMBER_RANGE) {
     if (normalizedValue?.min && normalizedValue?.max) {
-      return `${filter.label}: ${normalizedValue.min} to ${normalizedValue.max}`;
+      return t("jskit.crud.listFilter.chip.range", { label, from: normalizedValue.min, to: normalizedValue.max });
     }
     if (normalizedValue?.min) {
-      return `${filter.label}: min ${normalizedValue.min}`;
+      return t("jskit.crud.listFilter.chip.min", { label, min: normalizedValue.min });
     }
-    return `${filter.label}: max ${normalizedValue?.max || ""}`;
+    return t("jskit.crud.listFilter.chip.max", { label, max: normalizedValue?.max || "" });
   }
 
-  return filter.label;
+  return label;
 }
 
 function normalizeCrudListFilterType(value = "") {

package/test/crudListFilters.test.js

@@ -19,8 +19,11 @@ import {
   formatCrudListFilterQueryValue,
   parseCrudListFilterQueryValue,
   resolveCrudListFilterQueryKeys,
-  resolveCrudListFilterOptionLabel
+  resolveCrudListFilterOptionLabel,
+  CRUD_LIST_FILTER_PRESENCE_OPTIONS
 } from "../src/shared/crudListFilters.js";
+import { catalogMessage, formatMessage } from "@jskit-ai/kernel/shared/i18n";
+import en from "../locales/en.json" with { type: "json" };
 
 test("defineCrudListFilters normalizes common filter shapes", () => {
   const filters = defineCrudListFilters({
@@ -350,3 +353,36 @@ test("crud list filter helpers share canonical UI and query normalization", () =
     "Status: Active"
   );
 });
+
+test("default chip labels keep their English and render through a caller's translator", () => {
+  const filters = defineCrudListFilters({
+    price: { type: "numberRange", label: "Price" },
+    arrival: { type: "dateRange", label: "Arrival" },
+    storage: { type: "presence", label: "Storage" }
+  });
+
+  assert.equal(formatCrudListFilterDefaultChipLabel(filters.price, { min: "1", max: "5" }), "Price: 1 to 5");
+  assert.equal(formatCrudListFilterDefaultChipLabel(filters.price, { min: "1", max: "" }), "Price: min 1");
+  assert.equal(formatCrudListFilterDefaultChipLabel(filters.price, { min: "", max: "5" }), "Price: max 5");
+  assert.equal(
+    formatCrudListFilterDefaultChipLabel(filters.arrival, { from: "2026-04-01", to: "2026-04-30" }),
+    "Arrival: 2026-04-01 to 2026-04-30"
+  );
+  assert.equal(formatCrudListFilterDefaultChipLabel(filters.arrival, { from: "2026-04-01", to: "" }), "Arrival: from 2026-04-01");
+  assert.equal(formatCrudListFilterDefaultChipLabel(filters.arrival, { from: "", to: "2026-04-30" }), "Arrival: to 2026-04-30");
+
+  // The presence options' labels are message keys whose English is unchanged.
+  assert.deepEqual(
+    CRUD_LIST_FILTER_PRESENCE_OPTIONS.map((option) => formatMessage(catalogMessage(en, option.label))),
+    ["Present", "Missing"]
+  );
+  assert.equal(
+    formatCrudListFilterDefaultChipLabel(filters.storage, "missing", {
+      resolveAtomicValue: (value) => formatMessage(catalogMessage(en, resolveCrudListFilterOptionLabel(filters.storage, value)))
+    }),
+    "Storage: Missing"
+  );
+
+  const t = (key, params) => `${key.split(".").at(-1)}(${Object.values(params).join(",")})`;
+  assert.equal(formatCrudListFilterDefaultChipLabel(filters.price, { min: "1", max: "5" }, { t }), "range(Price,1,5)");
+});

package/test/i18nCatalog.test.js

@@ -0,0 +1,16 @@
+import assert from "node:assert/strict";
+import path from "node:path";
+import test from "node:test";
+import { fileURLToPath } from "node:url";
+import { evaluateI18nCatalogContract } from "../../../tooling/test-support/i18nCatalogContract.mjs";
+
+const TEST_DIRECTORY = path.dirname(fileURLToPath(import.meta.url));
+const REPO_ROOT = path.resolve(TEST_DIRECTORY, "..", "..", "..");
+
+test("resource-crud-core English catalog matches its source", () => {
+  const { problems } = evaluateI18nCatalogContract({
+    repoRoot: REPO_ROOT,
+    packageDir: path.join(REPO_ROOT, "packages", "resource-crud-core")
+  });
+  assert.deepEqual(problems, []);
+});