@reventlessdev/trait-attachments 1.0.0-alpha.4 → 1.0.0-alpha.41

package/src/Attachments_Scaffold.res.mjs

@@ -8,11 +8,12 @@ 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)),
   created: s.m(Sury.string),
-  createdCarriesEntityId: s.m(Sury.$option(Sury.bool)),
+  createdCarriesEntityId: s.m(Sury.$option(Sury.boolean)),
   view: s.m(Sury.string),
   lifecycleType: s.m(Sury.$option(Sury.string)),
   refType: s.m(Sury.$option(Sury.string)),
@@ -43,6 +44,7 @@ function namesOf(c) {
     attached: subject + "Attached",
     removed: subject + "Removed",
     primarySet: c.entity + "Primary" + c.noun + "Set",
+    effectiveChanged: c.entity + "Effective" + c.noun + "Changed",
     altTextSet: subject + "AltTextSet",
     notFound: c.entity + "NotFound",
     notAttached: subject + "NotAttached"
@@ -53,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";
@@ -155,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 [];
@@ -189,6 +204,7 @@ function sliceSpec(c) {
     primaryArm(""),
     [
       `  | ` + n.altTextSet + `({ ` + c.file + `: ` + ref + `, altText: string})`,
+      `  | ` + n.effectiveChanged + `({ ` + c.file + `?: ` + ref + `})`,
       `  // TODO(graft): add the events this host's own refusal turns on — whatever`,
       `  // moves it into a state where attachments may not be changed.`,
       ``
@@ -214,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 =`,
@@ -229,12 +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 + `: ` + idTypeOf(c) + `, ` + c.file + `?: ` + ref + `})`,
       ``
     ],
     commandTransitionBinding(c),
@@ -273,6 +293,7 @@ function sliceBehavior(c) {
     single ? [] : [`  | ` + n.primarySet + `({` + c.file + `}) => fold(PrimarySet({ref: ` + c.file + `}))`],
     [
       `  | ` + n.altTextSet + `({` + c.file + `, altText}) => fold(AltTextSet({ref: ` + c.file + `, altText}))`,
+      `  | ` + n.effectiveChanged + `({` + c.file + `: ?ref}) => fold(EffectiveChanged({ref: ref}))`,
       `  // TODO(graft): fold this host's own events into its own state.`,
       `  }`,
       `}`,
@@ -332,6 +353,12 @@ function sliceBehavior(c) {
       ) + n.altTextSet + `({` + c.entityId + `, ` + c.file + `: ref, altText})` + (
         single ? ")" : ""
       ),
+      `  | Attachments.EffectiveChanged({ref}) =>`,
+      `    ` + (
+        single ? "Some(" : ""
+      ) + n.effectiveChanged + `({` + c.entityId + `, ` + c.file + `: ?ref})` + (
+        single ? ")" : ""
+      ),
       `  }`,
       ``,
       `let decide = (state, command) =>`,
@@ -358,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 + `\`.`,
@@ -373,35 +400,43 @@ function conformanceBinding(c) {
       `  module Behavior = ` + n.slice + `_Behavior`,
       ``,
       `  // Annotated: the slice consumes and emits same-named constructors.`,
-      `  let created: array<` + n.slice + `.consumedEvent> = [` + createdValue + `]`,
-      `  let attachedC = (ref): ` + n.slice + `.consumedEvent => ` + n.attached + `({ ` + c.file + `: ref})`,
-      `  let removedC = (ref): ` + n.slice + `.consumedEvent => ` + n.removed + `({ ` + c.file + `: ref})`
+      `  // The same facts as the slice consumes them: no ` + c.entityId + `, because the`,
+      `  // partition already says which entity they belong to.`,
+      `  module Consumed = {`,
+      `    let created: array<` + n.slice + `.consumedEvent> = [` + createdValue + `]`,
+      `    let attached = (ref): ` + n.slice + `.consumedEvent => ` + n.attached + `({ ` + c.file + `: ref})`,
+      `    let removed = (ref): ` + n.slice + `.consumedEvent => ` + n.removed + `({ ` + c.file + `: ref})`
     ],
-    single ? [] : [`  let primarySetC = (ref): ` + n.slice + `.consumedEvent => ` + n.primarySet + `({ ` + c.file + `: ref})`],
+    single ? [] : [`    let primarySet = (ref): ` + n.slice + `.consumedEvent => ` + n.primarySet + `({ ` + c.file + `: ref})`],
     [
-      `  let altTextSetC = (ref, altText): ` + n.slice + `.consumedEvent =>`,
-      `    ` + n.altTextSet + `({ ` + c.file + `: ref, altText})`,
+      `    let altTextSet = (ref, altText): ` + n.slice + `.consumedEvent =>`,
+      `      ` + n.altTextSet + `({ ` + c.file + `: ref, altText})`,
+      `    let effectiveChanged = (ref): ` + n.slice + `.consumedEvent =>`,
+      `      ` + 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 + `: ` + idValueOf(c, id) + `, ` + c.file + `: ?ref})`,
       `  let notAttached = ` + n.slice + `.` + n.notAttached,
       `}`,
       ``,
@@ -416,7 +451,7 @@ function conformanceBinding(c) {
 function singleProjectionPatch(c) {
   let n = namesOf(c);
   return {
-    into: `StateViewSliceStream/` + c.view + `_Projection.res`,
+    into: `StateViewStream/` + c.view + `_Projection.res`,
     at: `the projection's \`switch\`, and one field on \`` + c.view + `\`'s state`,
     contents: [
       `// On the view's state, one field — the reference and its text, in one value.`,
@@ -456,7 +491,7 @@ function manyProjectionPatch(c) {
   let n = namesOf(c);
   let set = c.file + "s";
   return {
-    into: `StateViewSliceStream/` + c.view + `_Projection.res`,
+    into: `StateViewStream/` + c.view + `_Projection.res`,
     at: `the projection's \`switch\`, and one field on \`` + c.view + `\`'s state`,
     contents: [
       `// On the view's state, one field — the set, primary first.`,
@@ -525,11 +560,11 @@ function emit(config, into, tests) {
   return {
     files: [
       {
-        path: into + `/StateChangeSlice/` + n.slice + `.res`,
+        path: into + `/StateChange/` + n.slice + `.res`,
         contents: sliceSpec(config)
       },
       {
-        path: into + `/StateChangeSlice/` + n.slice + `_Behavior.res`,
+        path: into + `/StateChange/` + n.slice + `_Behavior.res`,
         contents: sliceBehavior(config)
       },
       {
@@ -547,6 +582,8 @@ export {
   isSingle,
   namesOf,
   refTypeOf,
+  idTypeOf,
+  idValueOf,
   viewTypeOf,
   setFieldOf,
   selectionBinding,