@mapled/next 0.6.0 → 0.7.0

package/README.md

@@ -63,6 +63,16 @@ await mapled.getRecords("artcles");                       // type error — no s
 
 Without a schema the client behaves as before: any key, `Record<string, unknown>` data, or the type you name per call (`getRecords<Article>("articles")`). `createAppClient<MapledSchema>` types live data the same way — `db.create("orders", data)` wants an `Order`. `mapled doctor` tells you when the generated file is behind the schema.
 
+### Renamed fields
+
+When a field's key is renamed in Mapled, nothing breaks: the old key stays as an alias — delivered next to the new one, accepted in `filter`, `sort`, `fields`, `expand` and in live-data writes — until someone removes it in Field settings. Answers that still serve a previous key name it (`aliases: { products: { price: "amount" } }` on a list result), and outside production the client says so once per key:
+
+```
+[mapled] “price” in “products” was renamed to “amount”. The old key keeps working until its alias is removed in Mapled — use “amount” instead.
+```
+
+Move the code to the new key, run `mapled types generate` (the old key is typed `@deprecated` until then), and remove the alias. In production the client stays silent.
+
 ### Pin a release
 
 A page that makes several reads can pin them all to one release, so a publish landing mid-render can't mix two versions:

package/dist/index.d.ts

@@ -51,6 +51,10 @@ export type ListResult<T = Record<string, unknown>> = {
     records: MapledRecord<T>[];
     total: number;
     release: number;
+    /** Renamed fields whose previous keys this answer still serves, by
+        collection: `{ products: { price: "amount" } }`. Absent when nothing
+        was renamed. Outside production the SDK warns about each once. */
+    aliases?: Record<string, Record<string, string>>;
 };
 export type ImageOptions = {
     /** Snapped up to the nearest preset (64 … 2560); never upscaled past the source. */

package/dist/index.js

@@ -1,6 +1,34 @@
 /** Mapled delivery client for Next.js sites.
     Reads published content only — pair it with the revalidation webhook
     handler from "@mapled/next/server" for instant updates on publish. */
+/** Renamed fields (previous keys): Mapled keeps serving a renamed field
+    under its old key — and accepting it in filters, sorts and writes —
+    until the alias is removed in Field settings, and names such keys in
+    its answers. Outside production each is reported once per process, so
+    the site moves to the new key before the alias goes. */
+const KEY_RE = /^[a-z0-9][a-z0-9-]{0,63}$/;
+const reported = new Set();
+function reportAliases(body) {
+    if (typeof process !== "undefined" && process.env?.NODE_ENV === "production")
+        return;
+    const aliases = body?.aliases;
+    if (!aliases || typeof aliases !== "object")
+        return;
+    for (const [collection, keys] of Object.entries(aliases)) {
+        if (!keys || typeof keys !== "object" || !KEY_RE.test(collection))
+            continue;
+        for (const [previous, current] of Object.entries(keys)) {
+            // keys are the project's content: only what looks like a key is printed
+            if (typeof current !== "string" || !KEY_RE.test(previous) || !KEY_RE.test(current))
+                continue;
+            const id = `${collection}.${previous}`;
+            if (reported.has(id))
+                continue;
+            reported.add(id);
+            console.warn(`[mapled] “${previous}” in “${collection}” was renamed to “${current}”. The old key keeps working until its alias is removed in Mapled — use “${current}” instead.`);
+        }
+    }
+}
 /** URL of an image or file value (an asset id) — the original, or a
     resized variant made on first request and cached from then on. */
 export function assetUrl(id, opts = {}) {
@@ -95,7 +123,9 @@ export function createClient(config) {
         const res = await fetch(`${base}${path}${qs ? `?${qs}` : ""}`, init);
         if (!res.ok)
             throw await failure(res);
-        return { status: res.status, body: (await res.json()) };
+        const body = (await res.json());
+        reportAliases(body);
+        return { status: res.status, body };
     }
     /** expand / fields on every read. */
     const readParams = (search, opts) => {
@@ -198,7 +228,9 @@ export function createAppClient(config) {
             }
             throw new MapledError(res.status, message);
         }
-        return (await res.json());
+        const body = (await res.json());
+        reportAliases(body);
+        return body;
     }
     const collectionPath = (c) => `/v1/app/collections/${encodeURIComponent(c)}/records`;
     const client = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapled/next",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Read published Mapled content in a Next.js site \u2014 delivery client, ISR tags, and a revalidation webhook handler.",
   "license": "MIT",
   "homepage": "https://mapled.io",