@reventlessdev/trait-attachments 1.0.0-alpha.1

package/src/Attachments_Scaffold.res.mjs

@@ -0,0 +1,354 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Sury from "sury";
+import * as Belt_Array from "@rescript/runtime/lib/es6/Belt_Array.js";
+import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+
+let configSchema = Sury.$schema(s => ({
+  entity: s.m(Sury.string),
+  entityId: s.m(Sury.string),
+  noun: s.m(Sury.string),
+  file: s.m(Sury.string),
+  created: s.m(Sury.string),
+  createdCarriesEntityId: s.m(Sury.$option(Sury.bool)),
+  view: s.m(Sury.string),
+  refType: s.m(Sury.$option(Sury.string)),
+  authorize: s.m(Sury.$option(Sury.string)),
+  transition: s.m(Sury.$option(Sury.array(Sury.string))),
+  refA: s.m(Sury.$option(Sury.string)),
+  refB: s.m(Sury.$option(Sury.string))
+}));
+
+function namesOf(c) {
+  let subject = c.entity + c.noun;
+  return {
+    slice: subject + "s",
+    attachCmd: "Attach" + subject,
+    removeCmd: "Remove" + subject,
+    setPrimaryCmd: "SetPrimary" + subject,
+    setAltTextCmd: "Set" + subject + "AltText",
+    attached: subject + "Attached",
+    removed: subject + "Removed",
+    primarySet: c.entity + "Primary" + c.noun + "Set",
+    altTextSet: subject + "AltTextSet",
+    notFound: c.entity + "NotFound",
+    notAttached: subject + "NotAttached"
+  };
+}
+
+function refTypeOf(c) {
+  return Stdlib_Option.getOr(c.refType, "Reventless.UploadableImage.t");
+}
+
+function commandAttributes(c) {
+  let a = c.authorize;
+  if (a !== undefined) {
+    return `  | @authorize(` + a + `)\n  `;
+  } else {
+    return "  | ";
+  }
+}
+
+function commandTransitionBinding(c) {
+  let n = namesOf(c);
+  let arms = [
+    n.attachCmd,
+    n.removeCmd,
+    n.setPrimaryCmd,
+    n.setAltTextCmd
+  ].map(cmd => `  | ` + cmd + `(_)`).join("\n");
+  let states = c.transition;
+  if (states !== undefined) {
+    return [
+      `type lifecycleState = ` + c.view + `.<lifecycle>  // TODO(graft): the enum's name`,
+      `let commandTransition = (command: command): Reventless.Transition.t<lifecycleState> => {`,
+      `  open Reventless.Transition`,
+      `  switch command {`,
+      arms + ` =>`,
+      `    Guards([` + states.join(", ") + `])`,
+      `  }`,
+      `}`,
+      ``
+    ];
+  } else {
+    return [
+      `// TODO(graft): the states this host allows its attachment set to change in,`,
+      `// as constructors of the linked view's lifecycle enum. Delete this binding`,
+      `// outright if the answer is "any state" — the framework's default says so.`,
+      `//`,
+      `//   type lifecycleState = ` + c.view + `.<lifecycle>`,
+      `//   let commandTransition = (command: command): Reventless.Transition.t<lifecycleState> => {`,
+      `//     open Reventless.Transition`,
+      `//     switch command {`,
+      arms.replaceAll("  | ", "//     | ") + ` =>`,
+      `//       Guards([` + c.view + `.<State>])`,
+      `//     }`,
+      `//   }`,
+      ``
+    ];
+  }
+}
+
+function lines(ls) {
+  return ls.join("\n");
+}
+
+function sliceSpec(c) {
+  let n = namesOf(c);
+  let ref = Stdlib_Option.getOr(c.refType, "Reventless.UploadableImage.t");
+  let attrs = commandAttributes(c);
+  let createdArm = Stdlib_Option.getOr(c.createdCarriesEntityId, true) ? `  | ` + c.created + `({ ` + c.entityId + `: string})` : `  | ` + c.created;
+  return Belt_Array.concatMany([
+    [
+      `// ` + n.slice + ` StateChangeSlice: ` + c.entity + `'s attachment set — attach, remove,`,
+      `// choose the primary, caption. A graft of the Attachments trait; the set's rules`,
+      `// are the trait's and are asserted by its conformance suite, bound in the tests.`,
+      `//`,
+      `// Emitted by the trait. Everything below is this host's own vocabulary, so it is`,
+      `// ordinary source from here on — edit it freely.`,
+      ``,
+      `@@reventless.spec`,
+      ``,
+      `@schema`,
+      `type consumedEvent =`,
+      createdArm,
+      `  | ` + n.attached + `({ ` + c.file + `: string})`,
+      `  | ` + n.removed + `({ ` + c.file + `: string})`,
+      `  | ` + n.primarySet + `({ ` + c.file + `: string})`,
+      `  | ` + n.altTextSet + `({ ` + c.file + `: string, altText: string})`,
+      `  // TODO(graft): add the events this host's own refusal turns on — whatever`,
+      `  // moves it into a state where attachments may not be changed.`,
+      ``,
+      `@schema`,
+      `type command =`,
+      attrs + n.attachCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `, altText?: string})`,
+      attrs + n.removeCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `})`,
+      attrs + n.setPrimaryCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `})`,
+      attrs + n.setAltTextCmd + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `, altText: string})`,
+      ``,
+      `@schema`,
+      `type error =`,
+      `  | ` + n.notFound,
+      `  | ` + n.notAttached,
+      `  // TODO(graft): add this host's own refusal.`,
+      ``,
+      `@schema`,
+      `type event =`,
+      `  | ` + n.attached + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `, altText?: string})`,
+      `  | ` + n.removed + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `})`,
+      `  | ` + n.primarySet + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `})`,
+      `  | ` + n.altTextSet + `({ ` + c.entityId + `: string, ` + c.file + `: ` + ref + `, altText: string})`,
+      ``
+    ],
+    commandTransitionBinding(c),
+    [
+      `// The graft's own record of itself. Nothing else survives into a deployed`,
+      `// plugin — the dependency and the rules alias are source-side — so without`,
+      `// this a running estate cannot say where this slice came from.`,
+      `let traits = [TraitAttachments.Attachments.declaration]`,
+      ``
+    ]
+  ]).join("\n");
+}
+
+function sliceBehavior(c) {
+  let n = namesOf(c);
+  return [
+    `@@reventless.behavior`,
+    ``,
+    `// The set's rules are the trait's. What is left here is this host's own refusal`,
+    `// and the mapping between its constructors and the trait's ops and facts.`,
+    `module Attachments = TraitAttachments.Attachments_Rules`,
+    ``,
+    `type state = {exists: bool, attachments: Attachments.t}`,
+    ``,
+    `let initialState = {exists: false, attachments: Attachments.empty}`,
+    ``,
+    `let evolve = (state, event) => {`,
+    `  let fold = fact => {...state, attachments: state.attachments->Attachments.evolve(fact)}`,
+    `  switch event {`,
+    `  | ` + c.created + `(_) => {...state, exists: true}`,
+    `  | ` + n.attached + `({` + c.file + `}) => fold(Attached({ref: ` + c.file + `, altText: None}))`,
+    `  | ` + n.removed + `({` + c.file + `}) => fold(Removed({ref: ` + c.file + `}))`,
+    `  | ` + n.primarySet + `({` + c.file + `}) => fold(PrimarySet({ref: ` + c.file + `}))`,
+    `  | ` + n.altTextSet + `({` + c.file + `, altText}) => fold(AltTextSet({ref: ` + c.file + `, altText}))`,
+    `  // TODO(graft): fold this host's own events into its own state.`,
+    `  }`,
+    `}`,
+    ``,
+    `let toOp = command =>`,
+    `  switch command {`,
+    `  | ` + n.attachCmd + `({` + c.entityId + `, ` + c.file + `, altText: ?altText}) => (`,
+    `      ` + c.entityId + `,`,
+    `      Attachments.Attach({ref: ` + c.file + `, altText}),`,
+    `    )`,
+    `  | ` + n.removeCmd + `({` + c.entityId + `, ` + c.file + `}) => (`,
+    `      ` + c.entityId + `,`,
+    `      Attachments.Remove({ref: ` + c.file + `}),`,
+    `    )`,
+    `  | ` + n.setPrimaryCmd + `({` + c.entityId + `, ` + c.file + `}) => (`,
+    `      ` + c.entityId + `,`,
+    `      Attachments.SetPrimary({ref: ` + c.file + `}),`,
+    `    )`,
+    `  | ` + n.setAltTextCmd + `({` + c.entityId + `, ` + c.file + `, altText}) => (`,
+    `      ` + c.entityId + `,`,
+    `      Attachments.SetAltText({ref: ` + c.file + `, altText}),`,
+    `    )`,
+    `  }`,
+    ``,
+    `let toEvent = (` + c.entityId + `, fact) =>`,
+    `  switch fact {`,
+    `  | Attachments.Attached({ref, altText}) =>`,
+    `    ` + n.attached + `({` + c.entityId + `, ` + c.file + `: ref, altText: ?altText})`,
+    `  | Attachments.Removed({ref}) => ` + n.removed + `({` + c.entityId + `, ` + c.file + `: ref})`,
+    `  | Attachments.PrimarySet({ref}) => ` + n.primarySet + `({` + c.entityId + `, ` + c.file + `: ref})`,
+    `  | Attachments.AltTextSet({ref, altText}) =>`,
+    `    ` + n.altTextSet + `({` + c.entityId + `, ` + c.file + `: ref, altText})`,
+    `  }`,
+    ``,
+    `let decide = (state, command) =>`,
+    `  if !state.exists {`,
+    `    Error(` + n.notFound + `)`,
+    `  } else {`,
+    `    // TODO(graft): this host's own refusal goes here, ahead of the set's rules —`,
+    `    // an \`else if\` returning the error added above. A graft with no extra refusal`,
+    `    // is a complete graft, so leaving this is legitimate.`,
+    `    let (` + c.entityId + `, op) = toOp(command)`,
+    `    switch state.attachments->Attachments.decide(op) {`,
+    `    | Error(#NotAttached) => Error(` + n.notAttached + `)`,
+    `    | Ok(None) => Ok([])`,
+    `    | Ok(Some(fact)) => Ok([toEvent(` + c.entityId + `, fact)])`,
+    `    }`,
+    `  }`,
+    ``
+  ].join("\n");
+}
+
+function conformanceBinding(c) {
+  let n = namesOf(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;
+  return [
+    `// The Attachments trait's conformance suite, bound to \`` + n.slice + `\`.`,
+    `// Emitted whole: every name here is one the graft already declared.`,
+    ``,
+    `module Binding = {`,
+    `  type ref = string`,
+    `  let refA = "` + refA + `"`,
+    `  let refB = "` + refB + `"`,
+    ``,
+    `  module Spec = ` + n.slice,
+    `  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})`,
+    `  let primarySetC = (ref): ` + n.slice + `.consumedEvent => ` + n.primarySet + `({ ` + c.file + `: ref})`,
+    `  let altTextSetC = (ref, altText): ` + n.slice + `.consumedEvent =>`,
+    `    ` + n.altTextSet + `({ ` + c.file + `: ref, altText})`,
+    ``,
+    `  let attach = ref => ` + n.slice + `.` + n.attachCmd + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`,
+    `  let remove = ref => ` + n.slice + `.` + n.removeCmd + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`,
+    `  let setPrimary = ref =>`,
+    `    ` + n.slice + `.` + n.setPrimaryCmd + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`,
+    `  let setAltText = (ref, altText) =>`,
+    `    ` + n.slice + `.` + n.setAltTextCmd + `({ ` + c.entityId + `: "` + 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 primarySet = ref =>`,
+    `    ` + n.slice + `.` + n.primarySet + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref})`,
+    `  let altTextSet = (ref, altText) =>`,
+    `    ` + n.slice + `.` + n.altTextSet + `({ ` + c.entityId + `: "` + id + `", ` + c.file + `: ref, altText})`,
+    `  let notAttached = ` + n.slice + `.` + n.notAttached,
+    `}`,
+    ``,
+    `module Conformance = TraitAttachments.Attachments_Conformance.Make(Binding)`,
+    ``,
+    `Conformance.register()`,
+    ``
+  ].join("\n");
+}
+
+function projectionPatch(c) {
+  let n = namesOf(c);
+  return {
+    into: `StateViewSliceStream/` + c.view + `_Projection.res`,
+    at: `the projection's \`switch\`, and two fields on \`` + c.view + `\`'s state`,
+    contents: [
+      `// On the view's state, two fields — the set, and its primary as one string.`,
+      `// The second is not redundancy: a card, a gallery tile and a reference cell`,
+      `// each read one image-semantic string per row, so without it every tile is blank.`,
+      `//`,
+      `//   ` + c.file + `s: array<{` + c.file + `: string, altText?: string}>,`,
+      `//   ` + c.file + `?: string,`,
+      ``,
+      `| ` + n.attached + `({` + c.entityId + `, ` + c.file + `, altText: ?altText}) =>`,
+      `  Update(` + c.entityId + `, state => {`,
+      `    let ` + c.file + `s = Array.concat(state.` + c.file + `s, [{` + c.file + `: ` + c.file + `, altText: ?altText}])`,
+      `    {...state, ` + c.file + `s, ` + c.file + `: ?withPrimary(` + c.file + `s, state.primaryChosen)}`,
+      `  })`,
+      `| ` + n.removed + `({` + c.entityId + `, ` + c.file + `}) =>`,
+      `  Update(` + c.entityId + `, state => {`,
+      `    let ` + c.file + `s = state.` + c.file + `s->Array.filter(m => m.` + c.file + ` != ` + c.file + `)`,
+      `    {...state, ` + c.file + `s, ` + c.file + `: ?withPrimary(` + c.file + `s, state.primaryChosen)}`,
+      `  })`,
+      `| ` + n.primarySet + `({` + c.entityId + `, ` + c.file + `}) =>`,
+      `  Update(` + c.entityId + `, state => {...state, ` + c.file + `: Some(` + c.file + `)})`,
+      `| ` + n.altTextSet + `({` + c.entityId + `, ` + c.file + `, altText}) =>`,
+      `  Update(` + c.entityId + `, state => {`,
+      `    ...state,`,
+      `    ` + c.file + `s: state.` + c.file + `s->Array.map(m =>`,
+      `      m.` + c.file + ` == ` + c.file + ` ? {...m, altText} : m`,
+      `    ),`,
+      `  })`,
+      ``,
+      `// The primary a reader should show: the one chosen, else the first attached —`,
+      `// the same rule the trait applies, over the view's own rows.`,
+      `let withPrimary = (members, chosen) =>`,
+      `  TraitAttachments.Attachments_Rules.primaryOf(`,
+      `    ~chosen,`,
+      `    ~attached=members->Array.map(m => m.` + c.file + `),`,
+      `  )`
+    ].join("\n")
+  };
+}
+
+function emit(config, into, tests) {
+  let n = namesOf(config);
+  return {
+    files: [
+      {
+        path: into + `/StateChangeSlice/` + n.slice + `.res`,
+        contents: sliceSpec(config)
+      },
+      {
+        path: into + `/StateChangeSlice/` + n.slice + `_Behavior.res`,
+        contents: sliceBehavior(config)
+      },
+      {
+        path: tests + `/` + n.slice + `Conformance_GWT.res`,
+        contents: conformanceBinding(config)
+      }
+    ],
+    patches: [projectionPatch(config)]
+  };
+}
+
+export {
+  configSchema,
+  namesOf,
+  refTypeOf,
+  commandAttributes,
+  commandTransitionBinding,
+  lines,
+  sliceSpec,
+  sliceBehavior,
+  conformanceBinding,
+  projectionPatch,
+  emit,
+}
+/* configSchema Not a pure module */