@reventlessdev/trait-attachments 1.0.0-alpha.15 → 1.0.0-alpha.17

package/README.md

@@ -43,12 +43,14 @@ Unlike the geocoding trait this one writes nothing back into its host: the graft
 ```sh
 pnpm exec graft-trait @reventlessdev/trait-attachments \
   --into src/Product --tests tests/Product \
-  --entity Product --entityId productId --noun Image \
-  --file productImage --created ProductAdded --view Products
+  --entity Product --entityId productId --entityIdType CatalogSpec.ProductId \
+  --noun Image --file productImage --created ProductAdded --view Products
 ```
 
    The field is named for the store it draws from, and `--noun` is what this host calls
-   one attachment — it runs through every name the graft declares.
+   one attachment — it runs through every name the graft declares. `--entityIdType` names
+   the host's identity module, so the emitted ids are typed; leave it out for a host that
+   keeps its ids as strings.
 
 2. Fill the `TODO(graft)` markers. They are the host's own policy: the events its
    refusal turns on, the error it raises, and the `else if` in `decide` that raises it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reventlessdev/trait-attachments",
-  "version": "1.0.0-alpha.15",
+  "version": "1.0.0-alpha.17",
   "description": "Attachments domain trait: rules, host contract, conformance suite and emitter for an ordered set of stored files on an entity, with a primary and captions",
   "license": "Apache-2.0",
   "files": [
@@ -13,8 +13,8 @@
   "dependencies": {
     "sury": "11.0.0-rc.2",
     "sury-ppx": "11.0.0-rc.2",
-    "@reventlessdev/reventless-gwt": "1.0.0-alpha.213",
-    "@reventlessdev/reventless-spec": "3.0.0-alpha.139"
+    "@reventlessdev/reventless-spec": "3.0.0-alpha.140",
+    "@reventlessdev/reventless-gwt": "1.0.0-alpha.215"
   },
   "devDependencies": {
     "rescript": "12.3.0"

package/src/Attachments_Scaffold.res

@@ -38,6 +38,9 @@ type config = {
   entity: string,
   /** Its id field: `"productId"`. */
   entityId: string,
+  /** The host's identity module for that id: `"ProductId"`. Absent ⇒ `string`,
+      for a host that has not declared one. */
+  entityIdType?: string,
   /**
   What this host calls one attachment, capitalised and singular: `"Image"`,
   `"Document"`, `"Attachment"`.
@@ -161,6 +164,15 @@ let namesOf = (c: config): names => {
 
 let refTypeOf = (c: config) => c.refType->Option.getOr("Reventless.UploadableImage.t")
 
+// The entity id's type, and a fixture value of it.
+let idTypeOf = (c: config) => c.entityIdType->Option.mapOr("string", t => t ++ ".t")
+
+let idValueOf = (c: config, literal: string) =>
+  switch c.entityIdType {
+  | Some(t) => `${t}.make("${literal}")`
+  | None => `"${literal}"`
+  }
+
 // What the VIEW holds, as against what an event's reference field holds. An
 // event names a file; a view holds that file together with the text that goes
 // with it, because a cell renderer is handed a field and a value and never the
@@ -304,7 +316,7 @@ let sliceSpec = (c: config): string => {
   let attrs = commandAttributes(c)
   let createdArm =
     c.createdCarriesEntityId->Option.getOr(true)
-      ? `  | ${c.created}({ ${c.entityId}: string})`
+      ? `  | ${c.created}({ ${c.entityId}: ${idTypeOf(c)}})`
       : `  | ${c.created}`
   // Present only where a choice exists. A bounded set has one member, so
   // nothing consumes or emits a primary — and the trait's rules never produce
@@ -365,16 +377,22 @@ let sliceSpec = (c: config): string => {
           ],
       `@schema`,
       `type command =`,
-      `${attrs}${n.attachCmd}({ ${c.entityId}: string, ${c.file}: ${ref}, altText?: string})`,
+      `${attrs}${n.attachCmd}({ ${c.entityId}: ${idTypeOf(
+          c,
+        )}, ${c.file}: ${ref}, altText?: string})`,
       // The bounded set's remove names nothing. This is the reported defect in its
       // purest form — the old command asked for an upload in order to delete.
       single
-        ? `${attrs}${n.removeCmd}({ ${c.entityId}: string})`
-        : `${attrs}${n.removeCmd}({ ${c.entityId}: string, ${c.file}: ${sel}})`,
-      ...single ? [] : [`${attrs}${n.setPrimaryCmd}({ ${c.entityId}: string, ${c.file}: ${sel}})`],
+        ? `${attrs}${n.removeCmd}({ ${c.entityId}: ${idTypeOf(c)}})`
+        : `${attrs}${n.removeCmd}({ ${c.entityId}: ${idTypeOf(c)}, ${c.file}: ${sel}})`,
+      ...single
+        ? []
+        : [`${attrs}${n.setPrimaryCmd}({ ${c.entityId}: ${idTypeOf(c)}, ${c.file}: ${sel}})`],
       single
-        ? `${attrs}${n.setAltTextCmd}({ ${c.entityId}: string, altText: string})`
-        : `${attrs}${n.setAltTextCmd}({ ${c.entityId}: string, ${c.file}: ${sel}, altText: string})`,
+        ? `${attrs}${n.setAltTextCmd}({ ${c.entityId}: ${idTypeOf(c)}, altText: string})`
+        : `${attrs}${n.setAltTextCmd}({ ${c.entityId}: ${idTypeOf(
+              c,
+            )}, ${c.file}: ${sel}, altText: string})`,
       ``,
       `@schema`,
       `type error =`,
@@ -384,14 +402,14 @@ let sliceSpec = (c: config): string => {
       ``,
       `@schema`,
       `type event =`,
-      `  | ${n.attached}({ ${c.entityId}: string, ${c.file}: ${ref}, altText?: string})`,
-      `  | ${n.removed}({ ${c.entityId}: string, ${c.file}: ${ref}})`,
-      ...primaryArm(`${c.entityId}: string, `),
-      `  | ${n.altTextSet}({ ${c.entityId}: string, ${c.file}: ${ref}, altText: string})`,
+      `  | ${n.attached}({ ${c.entityId}: ${idTypeOf(c)}, ${c.file}: ${ref}, altText?: string})`,
+      `  | ${n.removed}({ ${c.entityId}: ${idTypeOf(c)}, ${c.file}: ${ref}})`,
+      ...primaryArm(`${c.entityId}: ${idTypeOf(c)}, `),
+      `  | ${n.altTextSet}({ ${c.entityId}: ${idTypeOf(c)}, ${c.file}: ${ref}, altText: string})`,
       `  // The member a reader should now show, or none. A conclusion rather than a`,
       `  // decision: most of the moves that change it — a first attachment, a removal`,
       `  // promoting the next — are nobody's choice, so nothing else announces them.`,
-      `  | ${n.effectiveChanged}({ ${c.entityId}: string, ${c.file}?: ${ref}})`,
+      `  | ${n.effectiveChanged}({ ${c.entityId}: ${idTypeOf(c)}, ${c.file}?: ${ref}})`,
       ``,
       ...commandTransitionBinding(c),
       `// The graft's own record of itself. Nothing else survives into a deployed`,
@@ -544,7 +562,7 @@ let conformanceBinding = (c: config): string => {
   let refB = c.refB->Option.getOr(`/uploads/00000000-0000-4000-8000-000000000002/b`)
   let createdValue =
     c.createdCarriesEntityId->Option.getOr(true)
-      ? `${c.created}({ ${c.entityId}: "${id}"})`
+      ? `${c.created}({ ${c.entityId}: ${idValueOf(c, id)}})`
       : c.created
   lines(
     [
@@ -577,30 +595,57 @@ let conformanceBinding = (c: config): string => {
       `      ${n.effectiveChanged}({ ${c.file}: ?ref})`,
       `  }`,
       ``,
-      `  let attach = ref => ${n.slice}.${n.attachCmd}({ ${c.entityId}: "${id}", ${c.file}: ref})`,
+      `  let attach = ref => ${n.slice}.${n.attachCmd}({ ${c.entityId}: ${idValueOf(
+          c,
+          id,
+        )}, ${c.file}: ref})`,
       ...single
-        ? [`  let clear = ${n.slice}.${n.removeCmd}({ ${c.entityId}: "${id}"})`]
+        ? [`  let clear = ${n.slice}.${n.removeCmd}({ ${c.entityId}: ${idValueOf(c, id)}})`]
         : [
-            `  let remove = ref => ${n.slice}.${n.removeCmd}({ ${c.entityId}: "${id}", ${c.file}: ref})`,
+            `  let remove = ref => ${n.slice}.${n.removeCmd}({ ${c.entityId}: ${idValueOf(
+                c,
+                id,
+              )}, ${c.file}: ref})`,
             `  let setPrimary = ref =>`,
-            `    ${n.slice}.${n.setPrimaryCmd}({ ${c.entityId}: "${id}", ${c.file}: ref})`,
+            `    ${n.slice}.${n.setPrimaryCmd}({ ${c.entityId}: ${idValueOf(
+                c,
+                id,
+              )}, ${c.file}: ref})`,
           ],
       single
-        ? `  let setAltText = altText => ${n.slice}.${n.setAltTextCmd}({ ${c.entityId}: "${id}", altText})`
-        : `  let setAltText = (ref, altText) =>\n    ${n.slice}.${n.setAltTextCmd}({ ${c.entityId}: "${id}", ${c.file}: ref, altText})`,
+        ? `  let setAltText = altText => ${n.slice}.${n.setAltTextCmd}({ ${c.entityId}: ${idValueOf(
+              c,
+              id,
+            )}, altText})`
+        : `  let setAltText = (ref, altText) =>\n    ${n.slice}.${n.setAltTextCmd}({ ${c.entityId}: ${idValueOf(
+              c,
+              id,
+            )}, ${c.file}: ref, altText})`,
       ``,
-      `  let attached = ref => ${n.slice}.${n.attached}({ ${c.entityId}: "${id}", ${c.file}: ref})`,
-      `  let removed = ref => ${n.slice}.${n.removed}({ ${c.entityId}: "${id}", ${c.file}: ref})`,
+      `  let attached = ref => ${n.slice}.${n.attached}({ ${c.entityId}: ${idValueOf(
+          c,
+          id,
+        )}, ${c.file}: ref})`,
+      `  let removed = ref => ${n.slice}.${n.removed}({ ${c.entityId}: ${idValueOf(
+          c,
+          id,
+        )}, ${c.file}: ref})`,
       ...single
         ? []
         : [
             `  let primarySet = ref =>`,
-            `    ${n.slice}.${n.primarySet}({ ${c.entityId}: "${id}", ${c.file}: ref})`,
+            `    ${n.slice}.${n.primarySet}({ ${c.entityId}: ${idValueOf(c, id)}, ${c.file}: ref})`,
           ],
       `  let altTextSet = (ref, altText) =>`,
-      `    ${n.slice}.${n.altTextSet}({ ${c.entityId}: "${id}", ${c.file}: ref, altText})`,
+      `    ${n.slice}.${n.altTextSet}({ ${c.entityId}: ${idValueOf(
+          c,
+          id,
+        )}, ${c.file}: ref, altText})`,
       `  let effectiveChanged = ref =>`,
-      `    ${n.slice}.${n.effectiveChanged}({ ${c.entityId}: "${id}", ${c.file}: ?ref})`,
+      `    ${n.slice}.${n.effectiveChanged}({ ${c.entityId}: ${idValueOf(
+          c,
+          id,
+        )}, ${c.file}: ?ref})`,
       `  let notAttached = ${n.slice}.${n.notAttached}`,
       `}`,
       ``,

package/src/Attachments_Scaffold.res.mjs

@@ -8,6 +8,7 @@ import * as Attachments_Rules$TraitAttachments from "./Attachments_Rules.res.mjs
 let configSchema = Sury.$schema(s => ({
   entity: s.m(Sury.string),
   entityId: s.m(Sury.string),
+  entityIdType: s.m(Sury.$option(Sury.string)),
   noun: s.m(Sury.string),
   file: s.m(Sury.string),
   cardinality: s.m(Sury.$option(Attachments_Rules$TraitAttachments.cardinalitySchema)),
@@ -54,6 +55,19 @@ function refTypeOf(c) {
   return Stdlib_Option.getOr(c.refType, "Reventless.UploadableImage.t");
 }
 
+function idTypeOf(c) {
+  return Stdlib_Option.mapOr(c.entityIdType, "string", t => t + ".t");
+}
+
+function idValueOf(c, literal) {
+  let t = c.entityIdType;
+  if (t !== undefined) {
+    return t + `.make("` + literal + `")`;
+  } else {
+    return `"` + literal + `"`;
+  }
+}
+
 function viewTypeOf(c) {
   if (Stdlib_Option.getOr(c.refType, "Reventless.UploadableImage.t").includes("Image")) {
     return "Reventless.CaptionedImage.t";
@@ -156,7 +170,7 @@ function sliceSpec(c) {
   let sel = selectionTypeOf(c);
   let single = Stdlib_Option.getOr(c.cardinality, "Many") === "Single";
   let attrs = commandAttributes(c);
-  let createdArm = Stdlib_Option.getOr(c.createdCarriesEntityId, true) ? `  | ` + c.created + `({ ` + c.entityId + `: string})` : `  | ` + c.created;
+  let createdArm = Stdlib_Option.getOr(c.createdCarriesEntityId, true) ? `  | ` + c.created + `({ ` + c.entityId + `: ` + idTypeOf(c) + `})` : `  | ` + c.created;
   let primaryArm = prefix => {
     if (single) {
       return [];
@@ -216,12 +230,12 @@ function sliceSpec(c) {
     [
       `@schema`,
       `type command =`,
-      attrs + n.attachCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `, altText?: string})`,
-      single ? attrs + n.removeCmd + `({ ` + c.entityId + `: string})` : attrs + n.removeCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + sel + `})`
+      attrs + n.attachCmd + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `: ` + ref + `, altText?: string})`,
+      single ? attrs + n.removeCmd + `({ ` + c.entityId + `: ` + idTypeOf(c) + `})` : attrs + n.removeCmd + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `: ` + sel + `})`
     ],
-    single ? [] : [attrs + n.setPrimaryCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + sel + `})`],
+    single ? [] : [attrs + n.setPrimaryCmd + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `: ` + sel + `})`],
     [
-      single ? attrs + n.setAltTextCmd + `({ ` + c.entityId + `: string, altText: string})` : attrs + n.setAltTextCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + sel + `, altText: string})`,
+      single ? attrs + n.setAltTextCmd + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, altText: string})` : attrs + n.setAltTextCmd + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `: ` + sel + `, altText: string})`,
       ``,
       `@schema`,
       `type error =`,
@@ -231,16 +245,16 @@ function sliceSpec(c) {
       ``,
       `@schema`,
       `type event =`,
-      `  | ` + n.attached + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `, altText?: string})`,
-      `  | ` + n.removed + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `})`
+      `  | ` + n.attached + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `: ` + ref + `, altText?: string})`,
+      `  | ` + n.removed + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `: ` + ref + `})`
     ],
-    primaryArm(c.entityId + `: string, `),
+    primaryArm(c.entityId + `: ` + idTypeOf(c) + `, `),
     [
-      `  | ` + n.altTextSet + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `, altText: string})`,
+      `  | ` + n.altTextSet + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `: ` + ref + `, altText: string})`,
       `  // The member a reader should now show, or none. A conclusion rather than a`,
       `  // decision: most of the moves that change it — a first attachment, a removal`,
       `  // promoting the next — are nobody's choice, so nothing else announces them.`,
-      `  | ` + n.effectiveChanged + `({ ` + c.entityId + `: string, ` + c.file + `?: ` + ref + `})`,
+      `  | ` + n.effectiveChanged + `({ ` + c.entityId + `: ` + idTypeOf(c) + `, ` + c.file + `?: ` + ref + `})`,
       ``
     ],
     commandTransitionBinding(c),
@@ -371,7 +385,7 @@ function conformanceBinding(c) {
   let id = "e1";
   let refA = Stdlib_Option.getOr(c.refA, `/uploads/00000000-0000-4000-8000-000000000001/a`);
   let refB = Stdlib_Option.getOr(c.refB, `/uploads/00000000-0000-4000-8000-000000000002/b`);
-  let createdValue = Stdlib_Option.getOr(c.createdCarriesEntityId, true) ? c.created + `({ ` + c.entityId + `: "` + id + `"})` : c.created;
+  let createdValue = Stdlib_Option.getOr(c.createdCarriesEntityId, true) ? c.created + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `})` : c.created;
   return Belt_Array.concatMany([
     [
       `// The Attachments trait's conformance suite, bound to \`` + n.slice + `\`.`,
@@ -401,28 +415,28 @@ function conformanceBinding(c) {
       `      ` + n.effectiveChanged + `({ ` + c.file + `: ?ref})`,
       `  }`,
       ``,
-      `  let attach = ref => ` + n.slice + `.` + n.attachCmd + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`
+      `  let attach = ref => ` + n.slice + `.` + n.attachCmd + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref})`
     ],
-    single ? [`  let clear = ` + n.slice + `.` + n.removeCmd + `({ ` + c.entityId + `: "` + id + `"})`] : [
-        `  let remove = ref => ` + n.slice + `.` + n.removeCmd + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`,
+    single ? [`  let clear = ` + n.slice + `.` + n.removeCmd + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `})`] : [
+        `  let remove = ref => ` + n.slice + `.` + n.removeCmd + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref})`,
         `  let setPrimary = ref =>`,
-        `    ` + n.slice + `.` + n.setPrimaryCmd + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`
+        `    ` + n.slice + `.` + n.setPrimaryCmd + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref})`
       ],
     [
-      single ? `  let setAltText = altText => ` + n.slice + `.` + n.setAltTextCmd + `({ ` + c.entityId + `: "` + id + `", altText})` : `  let setAltText = (ref, altText) =>\n    ` + n.slice + `.` + n.setAltTextCmd + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref, altText})`,
+      single ? `  let setAltText = altText => ` + n.slice + `.` + n.setAltTextCmd + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, altText})` : `  let setAltText = (ref, altText) =>\n    ` + n.slice + `.` + n.setAltTextCmd + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref, altText})`,
       ``,
-      `  let attached = ref => ` + n.slice + `.` + n.attached + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`,
-      `  let removed = ref => ` + n.slice + `.` + n.removed + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`
+      `  let attached = ref => ` + n.slice + `.` + n.attached + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref})`,
+      `  let removed = ref => ` + n.slice + `.` + n.removed + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref})`
     ],
     single ? [] : [
         `  let primarySet = ref =>`,
-        `    ` + n.slice + `.` + n.primarySet + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`
+        `    ` + n.slice + `.` + n.primarySet + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref})`
       ],
     [
       `  let altTextSet = (ref, altText) =>`,
-      `    ` + n.slice + `.` + n.altTextSet + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref, altText})`,
+      `    ` + n.slice + `.` + n.altTextSet + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ref, altText})`,
       `  let effectiveChanged = ref =>`,
-      `    ` + n.slice + `.` + n.effectiveChanged + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ?ref})`,
+      `    ` + n.slice + `.` + n.effectiveChanged + `({ ` + c.entityId + `: ` + idValueOf(c, id) + `, ` + c.file + `: ?ref})`,
       `  let notAttached = ` + n.slice + `.` + n.notAttached,
       `}`,
       ``,
@@ -568,6 +582,8 @@ export {
   isSingle,
   namesOf,
   refTypeOf,
+  idTypeOf,
+  idValueOf,
   viewTypeOf,
   setFieldOf,
   selectionBinding,