@reventlessdev/reventless-spec 3.0.0-alpha.100

package/src/generator/Codegen.res.mjs

@@ -0,0 +1,565 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
+import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as Stdlib_JsError from "@rescript/runtime/lib/es6/Stdlib_JsError.js";
+import * as Pairing$Reventless from "./Pairing.res.mjs";
+import * as Discovery$Reventless from "./Discovery.res.mjs";
+
+function stripSuffix(s, suffix) {
+  if (s.endsWith(suffix)) {
+    return s.slice(0, s.length - suffix.length | 0);
+  } else {
+    return s;
+  }
+}
+
+function epModuleName(mappingStem) {
+  return stripSuffix(mappingStem, "Mapping");
+}
+
+function renderSlices(platformFactory, suffix, implSuffix, stems) {
+  return stems.map(stem => "  module " + stem + suffix + " = Platform." + platformFactory + ".Make(" + stem + ", " + stem + implSuffix + ")");
+}
+
+function renderStateChangeSlices(stems, asyncStems) {
+  return stems.map(stem => {
+    let match = asyncStems[stem];
+    let factory = match !== undefined && match ? "MakeAsync" : "Make";
+    return "  module " + stem + "Slice = Platform.StateChangeSlice." + factory + "(" + stem + ", " + stem + Pairing$Reventless.implSuffixForStateChange + ")";
+  });
+}
+
+function renderAutomationSlices(stems) {
+  return stems.map(stem => "  module " + stem + "Slice = Platform.AutomationSlice.Make(" + stem + ", " + stem + "_Automation)");
+}
+
+function renderAggregates(aggregates) {
+  return aggregates.flatMap(param => {
+    let spec = param.spec;
+    let em = Stdlib_Option.getOr(param.eventMappings, "ReventlessInfra.NoEventMappings.Make(" + spec + ")");
+    let factory = param.isAsync ? "MakeAsync" : "Make";
+    return [
+      "  module " + spec + "Aggregate = Platform.Aggregate." + factory + "(",
+      "    " + spec + ",",
+      "    " + param.behavior + ",",
+      "    " + em + ",",
+      "  )"
+    ];
+  });
+}
+
+function renderReadModels(readModels) {
+  return readModels.flatMap(param => {
+    let readModel = param.readModel;
+    let wrapperName = readModel.endsWith("ReadModel") ? readModel : readModel + "ReadModel";
+    let factory = param.stream ? "Platform.ReadModelStream.Make" : "Platform.ReadModel.Make";
+    return ["  module " + wrapperName + " = " + factory + "(" + readModel + ", " + param.projections + ")"];
+  });
+}
+
+function renderTasks(tasks) {
+  return tasks.map(stem => "  module " + stem + "Task = Platform.Task.Make(" + stem + ")");
+}
+
+function renderExtensionPoints(extensionPoints) {
+  return extensionPoints.flatMap(param => {
+    let mappings = param.mappings;
+    let group = param.group;
+    let count = mappings.length;
+    let firstMapping = mappings[0];
+    let moduleName = group !== undefined ? group : stripSuffix(firstMapping, "Mapping");
+    switch (count) {
+      case 0 :
+        return [];
+      case 1 :
+        return ["  module " + moduleName + " = Platform.ExtensionPoint.Make(" + firstMapping + ")"];
+      case 2 :
+        let m2 = mappings[1];
+        return [
+          "  module " + moduleName + " = Platform.ExtensionPoint.Make2(",
+          "    " + firstMapping + ",",
+          "    " + m2 + ",",
+          "  )"
+        ];
+      case 3 :
+        let m2$1 = mappings[1];
+        let m3 = mappings[2];
+        return [
+          "  module " + moduleName + " = Platform.ExtensionPoint.Make3(",
+          "    " + firstMapping + ",",
+          "    " + m2$1 + ",",
+          "    " + m3 + ",",
+          "  )"
+        ];
+      default:
+        let mappingLines = mappings.map(m => "      module(" + m + "),");
+        return [
+          [
+            "  module " + moduleName + " = Platform.ExtensionPoint.MakeMulti({",
+            "    module Spec = " + firstMapping + ".ExtensionPoint",
+            "    module type Mapping = ReventlessInfra.ExtensionPointMapping.T with module ExtensionPoint := Spec",
+            "    let name = Spec.name",
+            "    let moduleUrl: string = %raw(`import.meta.url`)",
+            "    let mappings: array<module(Mapping)> = ["
+          ],
+          mappingLines,
+          [
+            "    ]",
+            "  })"
+          ]
+        ].flat();
+    }
+  });
+}
+
+function renderExtensions(extensions) {
+  return extensions.map(stem => "  module " + stem + " = Platform.Extension.Make(" + stem + ".Mapping)");
+}
+
+function renderMakeParam(param, items, moduleSuffix) {
+  if (items.length === 0) {
+    return;
+  }
+  let entries = items.map(s => "module(" + s + moduleSuffix + ")");
+  return "      ~" + param + "=[" + entries.join(", ") + "],";
+}
+
+function renderStateViewSlicesMakeParam(slices, streamSlices) {
+  let entries = [
+    slices.map(s => "module(" + s + "Slice)"),
+    streamSlices.map(s => "module(" + s + "StreamSlice)")
+  ].flat();
+  if (entries.length === 0) {
+    return;
+  } else {
+    return "      ~stateViewSlices=[" + entries.join(", ") + "],";
+  }
+}
+
+function renderReadModelMakeParam(readModels) {
+  if (readModels.length === 0) {
+    return;
+  }
+  let entries = readModels.map(param => {
+    let readModel = param.readModel;
+    let wrapperName = readModel.endsWith("ReadModel") ? readModel : readModel + "ReadModel";
+    return "module(" + wrapperName + ")";
+  });
+  return "      ~readModels=[" + entries.join(", ") + "],";
+}
+
+function renderAggregateMakeParam(aggregates) {
+  if (aggregates.length === 0) {
+    return;
+  }
+  let entries = aggregates.map(param => "module(" + param.spec + "Aggregate)");
+  return "      ~aggregates=[" + entries.join(", ") + "],";
+}
+
+function renderEpMakeParam(extensionPoints) {
+  if (extensionPoints.length === 0) {
+    return;
+  }
+  let entries = extensionPoints.map(param => {
+    let group = param.group;
+    let firstMapping = param.mappings[0];
+    let moduleName = group !== undefined ? group : stripSuffix(firstMapping, "Mapping");
+    return "module(" + moduleName + ")";
+  });
+  return "      ~extensionPoints=[" + entries.join(", ") + "],";
+}
+
+function renderExtensionMakeParam(extensions) {
+  if (extensions.length === 0) {
+    return;
+  }
+  let entries = extensions.map(s => "module(" + s + ")");
+  return "      ~extensions=[" + entries.join(", ") + "],";
+}
+
+function renderRuntimeHints(h) {
+  let optInt = o => {
+    if (o !== undefined) {
+      return "Some(" + o.toString() + ")";
+    } else {
+      return "None";
+    }
+  };
+  return "{ReventlessInfra.RuntimeHints.memorySize: " + optInt(h.memorySize) + ", timeout: " + optInt(h.timeout) + "}";
+}
+
+function collectComponentNames(resolved) {
+  return [
+    resolved.aggregates.map(param => param.spec),
+    resolved.readModels.map(param => param.readModel),
+    resolved.stateChangeSlices,
+    resolved.stateViewSlices,
+    resolved.stateViewSlicesStream,
+    resolved.automationSlices,
+    resolved.outboundTranslationSlices,
+    resolved.inboundTranslationSlices,
+    resolved.tasks,
+    resolved.extensions,
+    resolved.extensionPoints.map(param => {
+      let group = param.group;
+      if (group !== undefined) {
+        return group;
+      } else {
+        return stripSuffix(param.mappings[0], "Mapping");
+      }
+    })
+  ].flat();
+}
+
+function validateComponentRuntimeKeys(resolved, componentRuntime) {
+  let known = collectComponentNames(resolved);
+  Object.keys(componentRuntime).forEach(name => {
+    if (!known.includes(name)) {
+      console.warn("Generator: plugin.json `runtime` override for `" + name + "` matches no component in this plugin. Known components: " + known.join(", "));
+      return;
+    }
+  });
+}
+
+function renderComponentRuntimeParam(componentRuntime) {
+  let entries = Object.entries(componentRuntime);
+  if (entries.length === 0) {
+    return;
+  }
+  let rendered = entries.map(param => "(\"" + param[0] + "\", " + renderRuntimeHints(param[1]) + ")").join(", ");
+  return "      ~componentRuntime=Dict.fromArray([" + rendered + "]),";
+}
+
+function renderTaskMakeParam(tasks) {
+  if (tasks.length === 0) {
+    return;
+  }
+  let entries = tasks.map(s => "module(" + s + "Task)");
+  return "      ~tasks=[" + entries.join(", ") + "],";
+}
+
+function renderPluginStructureCall(name, aggregates, readModels, stateViewSlices, stateViewSlicesStream, stateChangeSlices, automationSlices, outboundTranslationSlices, inboundTranslationSlices, extensions, extensionPoints, componentChapters) {
+  let epMappingStems = extensionPoints.flatMap(param => param.mappings);
+  let hasComponents = aggregates.length !== 0 || readModels.length !== 0 || stateViewSlices.length !== 0 || stateViewSlicesStream.length !== 0 || stateChangeSlices.length !== 0 || automationSlices.length !== 0 || outboundTranslationSlices.length !== 0 || inboundTranslationSlices.length !== 0 || extensions.length !== 0 || epMappingStems.length !== 0;
+  if (!hasComponents) {
+    return;
+  }
+  let ls = [];
+  ls.push("  let pluginStructure = Platform.Plugin.makePluginDefinition(");
+  ls.push("    ~name=\"" + name + "\",");
+  if (aggregates.length !== 0) {
+    let entries = aggregates.map(param => "module(" + param.spec + "Aggregate)");
+    ls.push("    ~aggregates=[" + entries.join(", ") + "],");
+  }
+  if (readModels.length !== 0) {
+    let entries$1 = readModels.map(param => {
+      let readModel = param.readModel;
+      let wrapperName = readModel.endsWith("ReadModel") ? readModel : readModel + "ReadModel";
+      return "module(" + wrapperName + ")";
+    });
+    ls.push("    ~readModels=[" + entries$1.join(", ") + "],");
+  }
+  let allStateViewEntries = [
+    stateViewSlices.map(s => "module(" + s + "Slice)"),
+    stateViewSlicesStream.map(s => "module(" + s + "StreamSlice)")
+  ].flat();
+  if (allStateViewEntries.length !== 0) {
+    ls.push("    ~stateViewSlices=[" + allStateViewEntries.join(", ") + "],");
+  }
+  if (stateChangeSlices.length !== 0) {
+    let entries$2 = stateChangeSlices.map(s => "module(" + s + "Slice)");
+    ls.push("    ~stateChangeSlices=[" + entries$2.join(", ") + "],");
+  }
+  if (automationSlices.length !== 0) {
+    let entries$3 = automationSlices.map(s => "module(" + s + "Slice)");
+    ls.push("    ~automationSlices=[" + entries$3.join(", ") + "],");
+  }
+  if (outboundTranslationSlices.length !== 0) {
+    let entries$4 = outboundTranslationSlices.map(s => "module(" + s + "Slice)");
+    ls.push("    ~outboundTranslationSlices=[" + entries$4.join(", ") + "],");
+  }
+  if (inboundTranslationSlices.length !== 0) {
+    let entries$5 = inboundTranslationSlices.map(s => "module(" + s + "Slice)");
+    ls.push("    ~inboundTranslationSlices=[" + entries$5.join(", ") + "],");
+  }
+  if (extensions.length !== 0) {
+    let entries$6 = extensions.map(s => "module(" + s + ")");
+    ls.push("    ~extensions=[" + entries$6.join(", ") + "],");
+  }
+  if (epMappingStems.length !== 0) {
+    let entries$7 = epMappingStems.map(s => "module(" + s + ")");
+    ls.push("    ~extensionPoints=[" + entries$7.join(", ") + "],");
+  }
+  if (componentChapters.length !== 0) {
+    let entries$8 = componentChapters.map(param => "(\"" + param[0] + "\", \"" + param[1] + "\")");
+    ls.push("    ~componentChapters=Dict.fromArray([" + entries$8.join(", ") + "]),");
+  }
+  ls.push("  )");
+  return ls;
+}
+
+function validateUniqueSpecStems(discovered) {
+  let byStem = {};
+  discovered.forEach(d => {
+    let existing = Stdlib_Option.getOr(byStem[d.stem], []);
+    existing.push(d.relPath);
+    byStem[d.stem] = existing;
+  });
+  Object.entries(byStem).forEach(param => {
+    let paths = param[1];
+    if (paths.length <= 1) {
+      return;
+    }
+    let pathList = paths.toSorted((a, b) => {
+      if (a < b) {
+        return -1.0;
+      } else if (a > b) {
+        return 1.0;
+      } else {
+        return 0.0;
+      }
+    }).join("\n  - ");
+    Stdlib_JsError.throwWithMessage("Generator: stem `" + param[0] + "` is used by multiple files. Filename stems must be unique across a plugin so the generated module names don't collide:\n  - " + pathList);
+  });
+}
+
+function validateSliceTargets(resolved) {
+  let knownReceivers = resolved.aggregates.map(param => param.spec).concat(resolved.stateChangeSlices);
+  let check = (kind, stem, target) => {
+    if (target !== undefined) {
+      if (!knownReceivers.includes(target)) {
+        return Stdlib_JsError.throwWithMessage("Generator: " + kind + " `" + stem + "` declares targetName = \"" + target + "\" but no such command receiver exists. Valid targets: " + knownReceivers.join(", "));
+      } else {
+        return;
+      }
+    } else {
+      return Stdlib_JsError.throwWithMessage("Generator: " + kind + " `" + stem + "` is missing `let targetName = \"...\"`. Valid targets: " + knownReceivers.join(", "));
+    }
+  };
+  resolved.automationSlices.forEach(stem => check("AutomationSlice", stem, Stdlib_Option.getOr(resolved.automationSliceTargets[stem], undefined)));
+  resolved.inboundTranslationSlices.forEach(stem => check("InboundTranslationSlice", stem, Stdlib_Option.getOr(resolved.inboundTranslationSliceTargets[stem], undefined)));
+  resolved.outboundTranslationSlices.forEach(stem => {
+    let t = Stdlib_Option.getOr(resolved.outboundTranslationSliceTargets[stem], undefined);
+    if (t !== undefined && !knownReceivers.includes(t)) {
+      return Stdlib_JsError.throwWithMessage("Generator: OutboundTranslationSlice `" + stem + "` declares targetName = Some(\"" + t + "\") but no such command receiver exists. Valid targets: " + knownReceivers.join(", "));
+    }
+  });
+}
+
+function renderMain(config) {
+  let name = config.name;
+  return [
+    "// AUTO-GENERATED — do not edit. Run `npm run generate` to update.",
+    "// " + name + " plugin — AWS deployment.",
+    "",
+    "ReventlessInfra.DeployBootstrap.run(PreDeploy)",
+    "",
+    "module Platform = ReventlessAws.Platform.Make()",
+    "module " + name + " = Plugin.Make(Platform)",
+    "",
+    "let default = Platform.deployPlugin(",
+    "  ~plugin=module(" + name + "),",
+    ")",
+    "",
+    "ReventlessInfra.DeployBootstrap.run(PostDeploy)",
+    ""
+  ].join("\n");
+}
+
+function pluginNameToEnvBase(name) {
+  return name.split("").map((ch, i) => {
+    let isUpper = ch !== "" && ch === ch.toUpperCase() && ch !== ch.toLowerCase();
+    if (i > 0 && isUpper) {
+      return "_" + ch;
+    } else {
+      return ch;
+    }
+  }).join("").toUpperCase();
+}
+
+function renderAwsWrapper(compositionNamespace) {
+  return [
+    "// AUTO-GENERATED — do not edit. Run `npm run generate` to update.",
+    "",
+    "module Make = (",
+    "  Platform: ReventlessInfra.Platform.T",
+    "    with type api = ReventlessAws.Types.AppSync.api",
+    "    and type role = ReventlessAws.Types.AppSync.role,",
+    ") => {",
+    "  module Composition = " + compositionNamespace + ".Plugin.Make(Platform)",
+    "  let make = () => Composition.make()",
+    "}",
+    ""
+  ].join("\n");
+}
+
+function renderComposition(config, resolved, componentChapters) {
+  let lines = [];
+  lines.push("// AUTO-GENERATED — do not edit. Run `npm run generate` to update.");
+  lines.push("");
+  lines.push("@val external uiBundleUrl: option<string> = \"process.env." + pluginNameToEnvBase(config.name) + "_UI_BUNDLE_URL\"");
+  lines.push("");
+  lines.push("module Make = (Platform: ReventlessInfra.Platform.T) => {");
+  let push = sectionLines => {
+    sectionLines.forEach(l => {
+      lines.push(l);
+    });
+    lines.push("");
+  };
+  if (resolved.stateChangeSlices.length !== 0) {
+    lines.push("  // StateChangeSlices");
+    push(renderStateChangeSlices(resolved.stateChangeSlices, resolved.asyncStateChangeSlices));
+  }
+  if (resolved.stateViewSlices.length !== 0) {
+    lines.push("  // StateViewSlices");
+    push(renderSlices("StateViewSlice", "Slice", Pairing$Reventless.implSuffixForStateView, resolved.stateViewSlices));
+  }
+  if (resolved.stateViewSlicesStream.length !== 0) {
+    lines.push("  // StateViewSliceStreams");
+    push(renderSlices("StateViewSliceStream", "StreamSlice", Pairing$Reventless.implSuffixForStateView, resolved.stateViewSlicesStream));
+  }
+  if (resolved.automationSlices.length !== 0) {
+    lines.push("  // AutomationSlices");
+    push(renderAutomationSlices(resolved.automationSlices));
+  }
+  if (resolved.outboundTranslationSlices.length !== 0) {
+    lines.push("  // OutboundTranslationSlices");
+    push(renderSlices("OutboundTranslationSlice", "Slice", Pairing$Reventless.implSuffixForTranslation, resolved.outboundTranslationSlices));
+  }
+  if (resolved.inboundTranslationSlices.length !== 0) {
+    lines.push("  // InboundTranslationSlices");
+    push(renderSlices("InboundTranslationSlice", "Slice", Pairing$Reventless.implSuffixForTranslation, resolved.inboundTranslationSlices));
+  }
+  if (resolved.aggregates.length !== 0) {
+    lines.push("  // Aggregates");
+    push(renderAggregates(resolved.aggregates));
+  }
+  if (resolved.readModels.length !== 0) {
+    lines.push("  // ReadModels");
+    push(renderReadModels(resolved.readModels));
+  }
+  if (resolved.tasks.length !== 0) {
+    lines.push("  // Tasks");
+    push(renderTasks(resolved.tasks));
+  }
+  if (resolved.extensionPoints.length !== 0) {
+    lines.push("  // ExtensionPoints");
+    push(renderExtensionPoints(resolved.extensionPoints));
+  }
+  if (resolved.extensions.length !== 0) {
+    lines.push("  // Extensions");
+    push(renderExtensions(resolved.extensions));
+  }
+  let pluginStructureLines = renderPluginStructureCall(config.name, resolved.aggregates, resolved.readModels, resolved.stateViewSlices, resolved.stateViewSlicesStream, resolved.stateChangeSlices, resolved.automationSlices, resolved.outboundTranslationSlices, resolved.inboundTranslationSlices, resolved.extensions, resolved.extensionPoints, componentChapters);
+  let hasPluginStructure = Stdlib_Option.isSome(pluginStructureLines);
+  if (pluginStructureLines !== undefined) {
+    pluginStructureLines.forEach(l => {
+      lines.push(l);
+    });
+    lines.push("");
+  }
+  lines.push("  let make = () =>");
+  lines.push("    Platform.Plugin.make(");
+  lines.push("      ~name=\"" + config.name + "\",");
+  lines.push("      ~heartbeatInterval=" + config.heartbeatInterval.toString() + ",");
+  let uiFragmentsParam;
+  if (hasPluginStructure) {
+    let ls = [];
+    ls.push("      ~uiFragments=?uiBundleUrl->Option.map(url =>");
+    ls.push("        Platform.Plugin.makeAutoUIManifest(");
+    ls.push("          ~remoteEntryUrl=url,");
+    ls.push("          ~name=\"" + config.name + "\",");
+    ls.push("          ~pluginStructure,");
+    ls.push("          ~readModelPositions=[\"platform-summary\"],");
+    ls.push("          ~aggregatePositions=[\"resource-detail\"],");
+    ls.push("        )");
+    ls.push("      ),");
+    uiFragmentsParam = ls;
+  } else {
+    uiFragmentsParam = undefined;
+  }
+  let makeParams = [
+    renderEpMakeParam(resolved.extensionPoints),
+    renderExtensionMakeParam(resolved.extensions),
+    renderAggregateMakeParam(resolved.aggregates),
+    renderReadModelMakeParam(resolved.readModels),
+    renderTaskMakeParam(resolved.tasks),
+    renderMakeParam("stateChangeSlices", resolved.stateChangeSlices, "Slice"),
+    renderStateViewSlicesMakeParam(resolved.stateViewSlices, resolved.stateViewSlicesStream),
+    renderMakeParam("automationSlices", resolved.automationSlices, "Slice"),
+    renderMakeParam("outboundTranslationSlices", resolved.outboundTranslationSlices, "Slice"),
+    renderMakeParam("inboundTranslationSlices", resolved.inboundTranslationSlices, "Slice"),
+    hasPluginStructure ? "      ~pluginStructure=pluginStructure," : undefined,
+    resolved.systemCallableComponents.length !== 0 ? "      ~systemCallableComponents=[" + resolved.systemCallableComponents.map(n => "\"" + n + "\"").join(", ") + "]," : undefined,
+    renderComponentRuntimeParam(config.componentRuntime)
+  ];
+  validateComponentRuntimeKeys(resolved, config.componentRuntime);
+  Stdlib_Array.filterMap(makeParams, x => x).forEach(line => {
+    lines.push(line);
+  });
+  if (uiFragmentsParam !== undefined) {
+    uiFragmentsParam.forEach(line => {
+      lines.push(line);
+    });
+  }
+  lines.push("    )");
+  lines.push("}");
+  lines.push("");
+  return lines.join("\n");
+}
+
+function render(config, resolved, discovered) {
+  validateUniqueSpecStems(discovered);
+  validateSliceTargets(resolved);
+  let componentStems = [
+    resolved.aggregates.map(param => param.spec),
+    resolved.readModels.map(param => param.readModel),
+    resolved.stateChangeSlices,
+    resolved.stateViewSlices,
+    resolved.stateViewSlicesStream,
+    resolved.automationSlices,
+    resolved.outboundTranslationSlices,
+    resolved.inboundTranslationSlices
+  ].flat();
+  let componentChapters = Discovery$Reventless.chaptersByStem(discovered).filter(param => componentStems.includes(param[0]));
+  let match = config.variant;
+  if (typeof match !== "object") {
+    return renderComposition(config, resolved, componentChapters);
+  } else {
+    return renderAwsWrapper(match.compositionNamespace);
+  }
+}
+
+export {
+  stripSuffix,
+  epModuleName,
+  renderSlices,
+  renderStateChangeSlices,
+  renderAutomationSlices,
+  renderAggregates,
+  renderReadModels,
+  renderTasks,
+  renderExtensionPoints,
+  renderExtensions,
+  renderMakeParam,
+  renderStateViewSlicesMakeParam,
+  renderReadModelMakeParam,
+  renderAggregateMakeParam,
+  renderEpMakeParam,
+  renderExtensionMakeParam,
+  renderRuntimeHints,
+  collectComponentNames,
+  validateComponentRuntimeKeys,
+  renderComponentRuntimeParam,
+  renderTaskMakeParam,
+  renderPluginStructureCall,
+  validateUniqueSpecStems,
+  validateSliceTargets,
+  renderMain,
+  pluginNameToEnvBase,
+  renderAwsWrapper,
+  renderComposition,
+  render,
+}
+/* Pairing-Reventless Not a pure module */

package/src/generator/Config.res

@@ -0,0 +1,106 @@
+// Plugin configuration reader.
+// Reads plugin.json from srcDir (optional) and derives defaults from package.json.
+
+type variant = Composition | Aws({compositionNamespace: string})
+
+// Per-component runtime resource hints, parsed from the optional `runtime`
+// block in plugin.json and keyed by component name. Both fields are optional;
+// an omitted field falls through to the per-kind builder default. See
+// docs/plans/configurable-component-runtime-resources.md.
+type runtimeHints = {
+  memorySize: option<int>,
+  timeout: option<int>,
+}
+
+type config = {
+  name: string,
+  heartbeatInterval: int,
+  exclude: array<string>,
+  // Keyed by component name (e.g. "Customers", "PlaceOrder"). Empty when the
+  // plugin.json has no `runtime` block.
+  componentRuntime: dict<runtimeHints>,
+  variant: variant,
+}
+
+// Convert npm package name to PascalCase plugin name.
+// "@scope/my-catalog" → "MyCatalog", "online-shop" → "OnlineShop"
+// Single-sourced with reventless-gwt's LocalHost via `PluginName` so the two
+// can't drift (a drift silently breaks graph plugin keys).
+let packageNameToPluginName = PluginName.fromPackageName
+
+let readJson = (path: string): option<JSON.t> =>
+  try Some(NodeFs.readFileSync(path)->JSON.parseOrThrow) catch {
+  | _ => None
+  }
+
+let getStrField = (json: JSON.t, key: string): option<string> =>
+  json
+  ->JSON.Decode.object
+  ->Option.flatMap(d => d->Dict.get(key))
+  ->Option.flatMap(JSON.Decode.string)
+
+let getIntField = (json: JSON.t, key: string): option<int> =>
+  json
+  ->JSON.Decode.object
+  ->Option.flatMap(d => d->Dict.get(key))
+  ->Option.flatMap(JSON.Decode.float)
+  ->Option.map(Float.toInt)
+
+let getStrArrayField = (json: JSON.t, key: string): option<array<string>> =>
+  json
+  ->JSON.Decode.object
+  ->Option.flatMap(d => d->Dict.get(key))
+  ->Option.flatMap(JSON.Decode.array)
+  ->Option.map(arr => arr->Array.filterMap(JSON.Decode.string))
+
+// Parse the optional `runtime` object: each key is a component name, each value
+// an object with optional `memorySize` / `timeout` ints. A missing block yields
+// an empty dict; a non-object entry is skipped.
+let getComponentRuntime = (json: JSON.t): dict<runtimeHints> => {
+  let result: dict<runtimeHints> = Dict.make()
+  json
+  ->JSON.Decode.object
+  ->Option.flatMap(d => d->Dict.get("runtime"))
+  ->Option.flatMap(JSON.Decode.object)
+  ->Option.forEach(runtimeObj =>
+    runtimeObj
+    ->Dict.toArray
+    ->Array.forEach(((componentName, entry)) =>
+      result->Dict.set(
+        componentName,
+        {
+          memorySize: getIntField(entry, "memorySize"),
+          timeout: getIntField(entry, "timeout"),
+        },
+      )
+    )
+  )
+  result
+}
+
+let read = (~srcDir: string): config => {
+  // Read package.json `name` from the parent of srcDir
+  let packageJsonPath = NodePath.join([NodePath.dirname(srcDir), "package.json"])
+  let packageJsonName = readJson(packageJsonPath)->Option.flatMap(j => getStrField(j, "name"))
+
+  // Read plugin.json from srcDir (optional)
+  let pluginJsonPath = NodePath.join([srcDir, "plugin.json"])
+  let pluginJson = if NodeFs.existsSync(pluginJsonPath) {
+    readJson(pluginJsonPath)
+  } else {
+    None
+  }
+
+  {
+    name: PluginName.resolve(
+      ~pluginJsonName=pluginJson->Option.flatMap(j => getStrField(j, "name")),
+      ~packageJsonName,
+    ),
+    heartbeatInterval: pluginJson
+    ->Option.flatMap(j => getIntField(j, "heartbeatInterval"))
+    ->Option.getOr(5),
+    exclude: pluginJson->Option.flatMap(j => getStrArrayField(j, "exclude"))->Option.getOr([]),
+    componentRuntime: pluginJson->Option.map(getComponentRuntime)->Option.getOr(Dict.make()),
+    variant: Composition,
+  }
+}