@mapomodule/form 2.0.0-beta.8 → 2.0.0-beta.9

package/dist/__tests__/camomillaRoundTrip.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=camomillaRoundTrip.test.d.ts.map

package/dist/__tests__/camomillaRoundTrip.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"camomillaRoundTrip.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/camomillaRoundTrip.test.ts"],"names":[],"mappings":""}

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@mapomodule/form",
   "configKey": "mapoForm",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.0-beta.9",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/runtime/composables/useFormFromSchema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useFormFromSchema.d.ts","sourceRoot":"","sources":["../../../src/runtime/composables/useFormFromSchema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAAE,kBAAkB,EAAa,MAAM,mBAAmB,CAAC;AAsMvE,4EAA4E;AAC5E,MAAM,WAAW,wBAAwB;IACvC,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACzD;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,UAAU,EAClB,OAAO,GAAE,wBAA6B,GACrC,kBAAkB,EAAE,CA+BtB"}
+{"version":3,"file":"useFormFromSchema.d.ts","sourceRoot":"","sources":["../../../src/runtime/composables/useFormFromSchema.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAAE,kBAAkB,EAAa,MAAM,mBAAmB,CAAC;AAwMvE,4EAA4E;AAC5E,MAAM,WAAW,wBAAwB;IACvC,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;CACzD;AAED;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,UAAU,EAClB,OAAO,GAAE,wBAA6B,GACrC,kBAAkB,EAAE,CA+BtB"}

package/dist/runtime/composables/useFormFromSchema.js

@@ -4,6 +4,7 @@ function mapType(schema, key) {
   const t = Array.isArray(schema.type) ? schema.type.find((v) => v !== "null") : schema.type;
   const fmt = schema.format;
   if (t === "string") {
+    if (fmt === "textarea") return "textarea";
     if (fmt === "date") return "date";
     if (fmt === "date-time") return "datetime";
     if (fmt === "time") return "time";
@@ -104,6 +105,7 @@ function propertyToDescriptor(key, rawSchema, defs, requiredKeys, rules) {
     type,
     label: schema.title ?? void 0,
     required: requiredKeys.has(key),
+    ...schema.readOnly ? { readonly: true } : {},
     ...visible ? { visible } : {},
     ...Object.keys(attrs).length ? { attrs } : {}
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapomodule/form",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.0-beta.9",
   "description": "Mapo declarative typed form engine and field components",
   "type": "module",
   "license": "MIT",
@@ -49,7 +49,7 @@
     "@internationalized/date": "^3.7.0",
     "@mapomodule/i18n": "2.0.0-beta.2",
     "@mapomodule/store": "2.0.0-beta.5",
-    "@mapomodule/utils": "2.0.0-beta.3",
+    "@mapomodule/utils": "2.0.0-beta.4",
     "@tiptap/extension-image": "^2.11.5",
     "@tiptap/extension-link": "^2.11.5",
     "@tiptap/extension-underline": "^2.11.5",

package/src/__tests__/article.schema.json

@@ -0,0 +1,193 @@
+{
+  "type": "object",
+  "properties": {
+    "indexable": {
+      "type": "boolean",
+      "translatable": true,
+      "title": "Indexable"
+    },
+    "ordering": {
+      "type": "integer",
+      "maximum": 9223372036854775807,
+      "format": "int64",
+      "minimum": 0,
+      "title": "Ordering"
+    },
+    "is_public": { "type": "boolean", "readOnly": true, "title": "Is public" },
+    "meta": { "type": "object", "title": "Meta" },
+    "routerlink": { "type": "string", "readOnly": true, "title": "Routerlink" },
+    "og_url": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 200,
+      "translatable": true,
+      "title": "Og url"
+    },
+    "tags": {
+      "type": "relation",
+      "model": "camomilla.Tag",
+      "multiple": true,
+      "endpoint": "/api/camomilla/tags/",
+      "title": "Tags"
+    },
+    "published_at": {
+      "type": "string",
+      "format": "date-time",
+      "nullable": true,
+      "translatable": true,
+      "title": "Published at"
+    },
+    "keywords": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 200,
+      "translatable": true,
+      "title": "Keywords"
+    },
+    "breadcrumbs_title": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 128,
+      "translatable": true,
+      "title": "Breadcrumbs title"
+    },
+    "content": {
+      "type": "string",
+      "translatable": true,
+      "title": "Content",
+      "format": "textarea"
+    },
+    "identifier": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 200,
+      "title": "Identifier"
+    },
+    "template": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 500,
+      "title": "Template"
+    },
+    "description": {
+      "type": "string",
+      "nullable": true,
+      "translatable": true,
+      "title": "Description",
+      "format": "textarea"
+    },
+    "id": { "type": "integer", "readOnly": true, "title": "ID" },
+    "og_title": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 200,
+      "translatable": true,
+      "title": "Og title"
+    },
+    "canonical": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 200,
+      "translatable": true,
+      "title": "Canonical"
+    },
+    "author": {
+      "type": "relation",
+      "model": "auth.User",
+      "multiple": false,
+      "endpoint": "/api/camomilla/users/",
+      "nullable": true,
+      "title": "Author"
+    },
+    "og_image": {
+      "type": "relation",
+      "model": "camomilla.Media",
+      "multiple": false,
+      "endpoint": "/api/camomilla/media/",
+      "nullable": true,
+      "title": "Og image"
+    },
+    "parent_page": {
+      "type": "relation",
+      "model": "camomilla.Article",
+      "multiple": false,
+      "endpoint": "/api/camomilla/articles/",
+      "nullable": true,
+      "title": "Parent page"
+    },
+    "highlight_image": {
+      "type": "relation",
+      "model": "camomilla.Media",
+      "multiple": false,
+      "endpoint": "/api/camomilla/media/",
+      "nullable": true,
+      "title": "Highlight image"
+    },
+    "template_file": {
+      "type": "string",
+      "readOnly": true,
+      "title": "Template file"
+    },
+    "date_updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "readOnly": true,
+      "title": "Date updated at"
+    },
+    "breadcrumbs": {
+      "type": "string",
+      "readOnly": true,
+      "title": "Breadcrumbs"
+    },
+    "og_description": {
+      "type": "string",
+      "nullable": true,
+      "translatable": true,
+      "title": "Og description",
+      "format": "textarea"
+    },
+    "template_data": {
+      "type": "object",
+      "translatable": true,
+      "title": "Template data"
+    },
+    "date_created": {
+      "type": "string",
+      "format": "date-time",
+      "readOnly": true,
+      "title": "Date created"
+    },
+    "autopermalink": {
+      "type": "boolean",
+      "translatable": true,
+      "title": "Autopermalink"
+    },
+    "title": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 200,
+      "translatable": true,
+      "title": "Title"
+    },
+    "permalink": {
+      "type": "string",
+      "translatable": true,
+      "title": "Permalink"
+    },
+    "og_type": {
+      "type": "string",
+      "nullable": true,
+      "maxLength": 200,
+      "translatable": true,
+      "title": "Og type"
+    },
+    "status": { "type": "string", "readOnly": true, "title": "Status" },
+    "deleted_at": {
+      "type": "string",
+      "format": "date-time",
+      "readOnly": true,
+      "nullable": true,
+      "title": "Deleted at"
+    }
+  }
+}

package/src/__tests__/camomillaRoundTrip.test.ts

@@ -0,0 +1,73 @@
+import { describe, expect, it } from "vitest";
+
+import type { AnyFieldDescriptor } from "../runtime/types/index.js";
+import { useFormFromSchema } from "../runtime/composables/useFormFromSchema";
+import articleSchema from "./article.schema.json";
+
+// Captured from camomilla: FormAutoSchema().map_serializer(ArticleSerializer()).
+// This is the contract between the two repos — if camomilla changes the shape,
+// this fails here rather than as an empty form in someone's browser.
+describe("camomilla OPTIONS schema -> mapo descriptors", () => {
+  const fields = useFormFromSchema(articleSchema as never);
+  const byKey = Object.fromEntries(fields.map((f) => [f.key, f]));
+  // `attrs` is not on every member of the AnyFieldDescriptor union.
+  const attrsOf = (f: AnyFieldDescriptor | undefined) =>
+    (f as { attrs?: Record<string, unknown> } | undefined)?.attrs;
+
+  it("produces a descriptor per field, not an empty array", () => {
+    expect(fields.length).toBeGreaterThan(20);
+  });
+
+  it("maps m2m relations with a usable endpoint", () => {
+    expect(byKey.tags.type).toBe("m2m");
+    expect(attrsOf(byKey.tags)?.endpoint).toBe("/api/camomilla/tags/");
+    expect(attrsOf(byKey.tags)?.multiple).toBe(true);
+  });
+
+  it("maps fk relations with a usable endpoint", () => {
+    expect(byKey.author.type).toBe("fks");
+    expect(attrsOf(byKey.author)?.endpoint).toBe("/api/camomilla/users/");
+  });
+
+  it("does not leave any relation with an empty endpoint", () => {
+    // An empty endpoint is the silent failure: MapoFksField rewrites "" to "/",
+    // fetches the API root, and swallows the error as an empty picker.
+    const relations = fields.filter(
+      (f) => f.type === "fks" || f.type === "m2m",
+    );
+    expect(relations.length).toBeGreaterThan(0);
+    for (const rel of relations) expect(attrsOf(rel)?.endpoint).toBeTruthy();
+  });
+
+  it("marks server-computed fields readonly rather than dropping them", () => {
+    // Without this they rendered as ordinary inputs and the backend discarded
+    // whatever was typed, with nothing to notice.
+    expect(byKey.id.readonly).toBe(true);
+    expect(byKey.status.readonly).toBe(true);
+    expect(byKey.date_created.readonly).toBe(true);
+    // An editable field must NOT be flagged.
+    expect(byKey.title.readonly).toBeUndefined();
+  });
+
+  it("respects the multiline hint for unbounded text", () => {
+    // A Django TextField has no maxLength, so the >255 heuristic never fires.
+    expect(byKey.content.type).toBe("textarea");
+    expect(byKey.description.type).toBe("textarea");
+  });
+
+  it("carries labels", () => {
+    expect(byKey.title.label).toBe("Title");
+  });
+
+  it("types scalars correctly", () => {
+    expect(byKey.title.type).toBe("text");
+    expect(byKey.published_at.type).toBe("datetime");
+  });
+
+  it("has no translations envelope and no localized twins", () => {
+    expect(byKey.translations).toBeUndefined();
+    expect(fields.filter((f) => /_(it|en)$/.test(String(f.key)))).toHaveLength(
+      0,
+    );
+  });
+});

package/src/runtime/composables/useFormFromSchema.ts

@@ -11,9 +11,10 @@ function mapType(schema: JSONSchema, key: string): FieldType {
   const t = Array.isArray(schema.type)
     ? schema.type.find((v) => v !== "null")
     : schema.type;
-  const fmt = schema.format as string | undefined;
+  const fmt = schema.format;
 
   if (t === "string") {
+    if (fmt === "textarea") return "textarea";
     if (fmt === "date") return "date";
     if (fmt === "date-time") return "datetime";
     if (fmt === "time") return "time";
@@ -179,6 +180,7 @@ function propertyToDescriptor(
     type,
     label: schema.title ?? undefined,
     required: requiredKeys.has(key),
+    ...(schema.readOnly ? { readonly: true } : {}),
     ...(visible ? { visible } : {}),
     ...(Object.keys(attrs).length ? { attrs } : {}),
   };