@reventlessdev/reventless-spec 3.0.0-alpha.117 → 3.0.0-alpha.119

package/src/semantic/Currency.res.mjs

@@ -1,173 +1,173 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
-import * as S from "sury/src/S.res.mjs";
+import * as Sury from "sury";
 
-let schema = S.union([
-  S.literal("AED"),
-  S.literal("AFN"),
-  S.literal("ALL"),
-  S.literal("AMD"),
-  S.literal("AOA"),
-  S.literal("ARS"),
-  S.literal("AUD"),
-  S.literal("AWG"),
-  S.literal("AZN"),
-  S.literal("BAM"),
-  S.literal("BBD"),
-  S.literal("BDT"),
-  S.literal("BHD"),
-  S.literal("BIF"),
-  S.literal("BMD"),
-  S.literal("BND"),
-  S.literal("BOB"),
-  S.literal("BOV"),
-  S.literal("BRL"),
-  S.literal("BSD"),
-  S.literal("BTN"),
-  S.literal("BWP"),
-  S.literal("BYN"),
-  S.literal("BZD"),
-  S.literal("CAD"),
-  S.literal("CDF"),
-  S.literal("CHE"),
-  S.literal("CHF"),
-  S.literal("CHW"),
-  S.literal("CLF"),
-  S.literal("CLP"),
-  S.literal("CNY"),
-  S.literal("COP"),
-  S.literal("COU"),
-  S.literal("CRC"),
-  S.literal("CUP"),
-  S.literal("CVE"),
-  S.literal("CZK"),
-  S.literal("DJF"),
-  S.literal("DKK"),
-  S.literal("DOP"),
-  S.literal("DZD"),
-  S.literal("EGP"),
-  S.literal("ERN"),
-  S.literal("ETB"),
-  S.literal("EUR"),
-  S.literal("FJD"),
-  S.literal("FKP"),
-  S.literal("GBP"),
-  S.literal("GEL"),
-  S.literal("GHS"),
-  S.literal("GIP"),
-  S.literal("GMD"),
-  S.literal("GNF"),
-  S.literal("GTQ"),
-  S.literal("GYD"),
-  S.literal("HKD"),
-  S.literal("HNL"),
-  S.literal("HTG"),
-  S.literal("HUF"),
-  S.literal("IDR"),
-  S.literal("ILS"),
-  S.literal("INR"),
-  S.literal("IQD"),
-  S.literal("IRR"),
-  S.literal("ISK"),
-  S.literal("JMD"),
-  S.literal("JOD"),
-  S.literal("JPY"),
-  S.literal("KES"),
-  S.literal("KGS"),
-  S.literal("KHR"),
-  S.literal("KMF"),
-  S.literal("KPW"),
-  S.literal("KRW"),
-  S.literal("KWD"),
-  S.literal("KYD"),
-  S.literal("KZT"),
-  S.literal("LAK"),
-  S.literal("LBP"),
-  S.literal("LKR"),
-  S.literal("LRD"),
-  S.literal("LSL"),
-  S.literal("LYD"),
-  S.literal("MAD"),
-  S.literal("MDL"),
-  S.literal("MGA"),
-  S.literal("MKD"),
-  S.literal("MMK"),
-  S.literal("MNT"),
-  S.literal("MOP"),
-  S.literal("MRU"),
-  S.literal("MUR"),
-  S.literal("MVR"),
-  S.literal("MWK"),
-  S.literal("MXN"),
-  S.literal("MXV"),
-  S.literal("MYR"),
-  S.literal("MZN"),
-  S.literal("NAD"),
-  S.literal("NGN"),
-  S.literal("NIO"),
-  S.literal("NOK"),
-  S.literal("NPR"),
-  S.literal("NZD"),
-  S.literal("OMR"),
-  S.literal("PAB"),
-  S.literal("PEN"),
-  S.literal("PGK"),
-  S.literal("PHP"),
-  S.literal("PKR"),
-  S.literal("PLN"),
-  S.literal("PYG"),
-  S.literal("QAR"),
-  S.literal("RON"),
-  S.literal("RSD"),
-  S.literal("RUB"),
-  S.literal("RWF"),
-  S.literal("SAR"),
-  S.literal("SBD"),
-  S.literal("SCR"),
-  S.literal("SDG"),
-  S.literal("SEK"),
-  S.literal("SGD"),
-  S.literal("SHP"),
-  S.literal("SLE"),
-  S.literal("SOS"),
-  S.literal("SRD"),
-  S.literal("SSP"),
-  S.literal("STN"),
-  S.literal("SVC"),
-  S.literal("SYP"),
-  S.literal("SZL"),
-  S.literal("THB"),
-  S.literal("TJS"),
-  S.literal("TMT"),
-  S.literal("TND"),
-  S.literal("TOP"),
-  S.literal("TRY"),
-  S.literal("TTD"),
-  S.literal("TWD"),
-  S.literal("TZS"),
-  S.literal("UAH"),
-  S.literal("UGX"),
-  S.literal("USD"),
-  S.literal("USN"),
-  S.literal("UYI"),
-  S.literal("UYU"),
-  S.literal("UYW"),
-  S.literal("UZS"),
-  S.literal("VED"),
-  S.literal("VES"),
-  S.literal("VND"),
-  S.literal("VUV"),
-  S.literal("WST"),
-  S.literal("XAD"),
-  S.literal("XAF"),
-  S.literal("XCD"),
-  S.literal("XCG"),
-  S.literal("XOF"),
-  S.literal("XPF"),
-  S.literal("YER"),
-  S.literal("ZAR"),
-  S.literal("ZMW"),
-  S.literal("ZWG")
+let schema = Sury.union([
+  Sury.literal("AED"),
+  Sury.literal("AFN"),
+  Sury.literal("ALL"),
+  Sury.literal("AMD"),
+  Sury.literal("AOA"),
+  Sury.literal("ARS"),
+  Sury.literal("AUD"),
+  Sury.literal("AWG"),
+  Sury.literal("AZN"),
+  Sury.literal("BAM"),
+  Sury.literal("BBD"),
+  Sury.literal("BDT"),
+  Sury.literal("BHD"),
+  Sury.literal("BIF"),
+  Sury.literal("BMD"),
+  Sury.literal("BND"),
+  Sury.literal("BOB"),
+  Sury.literal("BOV"),
+  Sury.literal("BRL"),
+  Sury.literal("BSD"),
+  Sury.literal("BTN"),
+  Sury.literal("BWP"),
+  Sury.literal("BYN"),
+  Sury.literal("BZD"),
+  Sury.literal("CAD"),
+  Sury.literal("CDF"),
+  Sury.literal("CHE"),
+  Sury.literal("CHF"),
+  Sury.literal("CHW"),
+  Sury.literal("CLF"),
+  Sury.literal("CLP"),
+  Sury.literal("CNY"),
+  Sury.literal("COP"),
+  Sury.literal("COU"),
+  Sury.literal("CRC"),
+  Sury.literal("CUP"),
+  Sury.literal("CVE"),
+  Sury.literal("CZK"),
+  Sury.literal("DJF"),
+  Sury.literal("DKK"),
+  Sury.literal("DOP"),
+  Sury.literal("DZD"),
+  Sury.literal("EGP"),
+  Sury.literal("ERN"),
+  Sury.literal("ETB"),
+  Sury.literal("EUR"),
+  Sury.literal("FJD"),
+  Sury.literal("FKP"),
+  Sury.literal("GBP"),
+  Sury.literal("GEL"),
+  Sury.literal("GHS"),
+  Sury.literal("GIP"),
+  Sury.literal("GMD"),
+  Sury.literal("GNF"),
+  Sury.literal("GTQ"),
+  Sury.literal("GYD"),
+  Sury.literal("HKD"),
+  Sury.literal("HNL"),
+  Sury.literal("HTG"),
+  Sury.literal("HUF"),
+  Sury.literal("IDR"),
+  Sury.literal("ILS"),
+  Sury.literal("INR"),
+  Sury.literal("IQD"),
+  Sury.literal("IRR"),
+  Sury.literal("ISK"),
+  Sury.literal("JMD"),
+  Sury.literal("JOD"),
+  Sury.literal("JPY"),
+  Sury.literal("KES"),
+  Sury.literal("KGS"),
+  Sury.literal("KHR"),
+  Sury.literal("KMF"),
+  Sury.literal("KPW"),
+  Sury.literal("KRW"),
+  Sury.literal("KWD"),
+  Sury.literal("KYD"),
+  Sury.literal("KZT"),
+  Sury.literal("LAK"),
+  Sury.literal("LBP"),
+  Sury.literal("LKR"),
+  Sury.literal("LRD"),
+  Sury.literal("LSL"),
+  Sury.literal("LYD"),
+  Sury.literal("MAD"),
+  Sury.literal("MDL"),
+  Sury.literal("MGA"),
+  Sury.literal("MKD"),
+  Sury.literal("MMK"),
+  Sury.literal("MNT"),
+  Sury.literal("MOP"),
+  Sury.literal("MRU"),
+  Sury.literal("MUR"),
+  Sury.literal("MVR"),
+  Sury.literal("MWK"),
+  Sury.literal("MXN"),
+  Sury.literal("MXV"),
+  Sury.literal("MYR"),
+  Sury.literal("MZN"),
+  Sury.literal("NAD"),
+  Sury.literal("NGN"),
+  Sury.literal("NIO"),
+  Sury.literal("NOK"),
+  Sury.literal("NPR"),
+  Sury.literal("NZD"),
+  Sury.literal("OMR"),
+  Sury.literal("PAB"),
+  Sury.literal("PEN"),
+  Sury.literal("PGK"),
+  Sury.literal("PHP"),
+  Sury.literal("PKR"),
+  Sury.literal("PLN"),
+  Sury.literal("PYG"),
+  Sury.literal("QAR"),
+  Sury.literal("RON"),
+  Sury.literal("RSD"),
+  Sury.literal("RUB"),
+  Sury.literal("RWF"),
+  Sury.literal("SAR"),
+  Sury.literal("SBD"),
+  Sury.literal("SCR"),
+  Sury.literal("SDG"),
+  Sury.literal("SEK"),
+  Sury.literal("SGD"),
+  Sury.literal("SHP"),
+  Sury.literal("SLE"),
+  Sury.literal("SOS"),
+  Sury.literal("SRD"),
+  Sury.literal("SSP"),
+  Sury.literal("STN"),
+  Sury.literal("SVC"),
+  Sury.literal("SYP"),
+  Sury.literal("SZL"),
+  Sury.literal("THB"),
+  Sury.literal("TJS"),
+  Sury.literal("TMT"),
+  Sury.literal("TND"),
+  Sury.literal("TOP"),
+  Sury.literal("TRY"),
+  Sury.literal("TTD"),
+  Sury.literal("TWD"),
+  Sury.literal("TZS"),
+  Sury.literal("UAH"),
+  Sury.literal("UGX"),
+  Sury.literal("USD"),
+  Sury.literal("USN"),
+  Sury.literal("UYI"),
+  Sury.literal("UYU"),
+  Sury.literal("UYW"),
+  Sury.literal("UZS"),
+  Sury.literal("VED"),
+  Sury.literal("VES"),
+  Sury.literal("VND"),
+  Sury.literal("VUV"),
+  Sury.literal("WST"),
+  Sury.literal("XAD"),
+  Sury.literal("XAF"),
+  Sury.literal("XCD"),
+  Sury.literal("XCG"),
+  Sury.literal("XOF"),
+  Sury.literal("XPF"),
+  Sury.literal("YER"),
+  Sury.literal("ZAR"),
+  Sury.literal("ZMW"),
+  Sury.literal("ZWG")
 ]);
 
 let all = [

package/src/semantic/DateRange.res.mjs

@@ -1,10 +1,10 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
-import * as S from "sury/src/S.res.mjs";
+import * as Sury from "sury";
 import * as DateTime$Reventless from "../types/DateTime.res.mjs";
 import * as Semantic$Reventless from "./Semantic.res.mjs";
 
-let schema = S.schema(s => ({
+let schema = Sury.$schema(s => ({
   start: s.m(DateTime$Reventless.string),
   end: s.m(DateTime$Reventless.string)
 }));

package/src/semantic/Duration.res.mjs

@@ -1,6 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
-import * as S from "sury/src/S.res.mjs";
+import * as Sury from "sury";
 import * as Semantic$Reventless from "./Semantic.res.mjs";
 
 function fromInt(raw) {
@@ -17,7 +17,7 @@ function fromInt(raw) {
   }
 }
 
-let schema = Semantic$Reventless.refined(S.int, Semantic$Reventless.Id.duration, fromInt);
+let schema = Semantic$Reventless.refined(Sury.int, Semantic$Reventless.Id.duration, fromInt);
 
 export {
   fromInt,

package/src/semantic/Email.res

@@ -38,11 +38,11 @@ external toString: t => string = "%identity"
 
 // Sury's check, held once. `fromString` runs it rather than restating it, and
 // `schema` is built from `fromString`, so there is exactly one grammar here.
-let grammar: S.t<string> = S.string->S.email
+let grammar: S.t<string> = S.email
 
 /** Validate a raw string as an email address, saying why when it is not one. */
 let fromString = (raw: string): result<t, string> =>
-  switch raw->S.parseOrThrow(grammar) {
+  switch raw->S.parseOrThrow(~to=grammar) {
   | value => Ok(value)
   | exception _ => Error(`expected an email address, got ${Semantic.showString(raw)}`)
   }

package/src/semantic/Email.res.mjs

@@ -1,9 +1,10 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
 import * as S from "sury/src/S.res.mjs";
+import * as Sury from "sury";
 import * as Semantic$Reventless from "./Semantic.res.mjs";
 
-let grammar = S.email(S.string, undefined);
+let grammar = Sury.email;
 
 function fromString(raw) {
   let value;
@@ -21,7 +22,7 @@ function fromString(raw) {
   };
 }
 
-let schema = Semantic$Reventless.refined(S.string, Semantic$Reventless.Id.email, fromString);
+let schema = Semantic$Reventless.refined(Sury.string, Semantic$Reventless.Id.email, fromString);
 
 export {
   grammar,

package/src/semantic/FileRef.res

@@ -0,0 +1,28 @@
+/**
+A reference to a file the platform does **not** own.
+
+The non-image arm of the unowned pair, and {!UploadableFile}'s counterpart: same
+content fact, no store declared, nothing provisioned. See {!ImageRef} for why
+the pair exists and what the grammar refuses.
+
+@example
+```rescript
+@schema type event =
+  | SupplierCatalogPublished({
+      supplierId: @s.matches(DcbTag.string) string,
+      priceList: @s.matches(Reventless.FileRef.schema) string,
+    })
+```
+*/
+
+/** Transparent `string`; see `Email.t`. */
+type t = string
+
+external unsafe: string => t = "%identity"
+external toString: t => string = "%identity"
+
+let fromString = (raw: string): result<t, string> => Media_Ref.check(~what="file", raw)
+
+/** The sury schema for a file-reference field.
+    Use with `@s.matches(Reventless.FileRef.schema)`. */
+let schema: S.t<t> = S.string->Semantic.refined(~id=Semantic.Id.fileRef, ~check=fromString)

package/src/semantic/FileRef.res.mjs

@@ -0,0 +1,17 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Sury from "sury";
+import * as Semantic$Reventless from "./Semantic.res.mjs";
+import * as Media_Ref$Reventless from "./Media_Ref.res.mjs";
+
+function fromString(raw) {
+  return Media_Ref$Reventless.check("file", raw);
+}
+
+let schema = Semantic$Reventless.refined(Sury.string, Semantic$Reventless.Id.fileRef, fromString);
+
+export {
+  fromString,
+  schema,
+}
+/* schema Not a pure module */

package/src/semantic/GeoPoint.res

@@ -99,20 +99,24 @@ let validateLng = (raw: float): result<float, string> =>
     11-alpha miscompiles a refinement wrapping a *record* schema. Refining the
     field is both the honest placement and the one that works. */
 let latSchema: S.t<float> =
-  S.float->S.refine(s => raw =>
-    switch validateLat(raw) {
-    | Ok(_) => ()
-    | Error(why) => s.fail(why)
-    }
+  S.float->S.refine(
+    raw =>
+      switch validateLat(raw) {
+      | Ok(_) => true
+      | Error(_) => false
+      },
+    ~error="expected a latitude in -90…90",
   )
 
 /** The longitude's own schema, for the same reason. */
 let lngSchema: S.t<float> =
-  S.float->S.refine(s => raw =>
-    switch validateLng(raw) {
-    | Ok(_) => ()
-    | Error(why) => s.fail(why)
-    }
+  S.float->S.refine(
+    raw =>
+      switch validateLng(raw) {
+      | Ok(_) => true
+      | Error(_) => false
+      },
+    ~error="expected a longitude in -180…180",
   )
 
 @schema

package/src/semantic/GeoPoint.res.mjs

@@ -1,6 +1,7 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
 import * as S from "sury/src/S.res.mjs";
+import * as Sury from "sury";
 import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
 import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
 import * as Semantic$Reventless from "./Semantic.res.mjs";
@@ -47,25 +48,17 @@ function validateLng(raw) {
   }
 }
 
-let latSchema = S.refine(S.float, s => (raw => {
-  let why = validateLat(raw);
-  if (why.TAG === "Ok") {
-    return;
-  } else {
-    return s.fail(why._0, undefined);
-  }
-}));
+let latSchema = S.refine(Sury.float, raw => {
+  let match = validateLat(raw);
+  return match.TAG === "Ok";
+}, "expected a latitude in -90…90", undefined);
 
-let lngSchema = S.refine(S.float, s => (raw => {
-  let why = validateLng(raw);
-  if (why.TAG === "Ok") {
-    return;
-  } else {
-    return s.fail(why._0, undefined);
-  }
-}));
+let lngSchema = S.refine(Sury.float, raw => {
+  let match = validateLng(raw);
+  return match.TAG === "Ok";
+}, "expected a longitude in -180…180", undefined);
 
-let schema = S.schema(s => ({
+let schema = Sury.$schema(s => ({
   lat: s.m(latSchema),
   lng: s.m(lngSchema)
 }));

package/src/semantic/ImageRef.res

@@ -0,0 +1,51 @@
+/**
+A reference to an image the platform does **not** own.
+
+The counterpart of {!UploadableImage}, and the difference is provisioning: this
+field states the same *content* fact — the value is a picture, and renders as
+one — and states nothing about where it lives. No store is declared, none is
+provisioned, no upload endpoint is bound, and the value arrives from wherever
+its producer got it: a supplier's CDN, another system's asset host.
+
+Use `UploadableImage.t` for a picture the deployment stores and serves. Use this
+one where the platform is a reader of somebody else's image and could not
+provision a store for it if it wanted to.
+
+## The grammar
+
+An `http`/`https` URL, or an origin-relative path. Both are things a browser can
+put in an `src`; nothing else is.
+
+`data:` URIs are refused, and that is the rule worth stating: an event log is
+append-only, so a megabyte inlined into an image field is permanent and
+unfixable. That is the same hole {!StorageRef} exists to close, arriving through
+a field that declares no store.
+
+@example
+```rescript
+@schema type event =
+  | SupplierProductListed({
+      supplierId: @s.matches(DcbTag.string) string,
+      thumbnail: @s.matches(Reventless.ImageRef.schema) string,
+    })
+```
+*/
+
+/** Transparent `string`; see `Email.t`. */
+type t = string
+
+external unsafe: string => t = "%identity"
+external toString: t => string = "%identity"
+
+/**
+Validate a raw string as a reference to an unowned image, saying why when it is
+not one.
+
+Shared by {!FileRef} through `Media_Ref.check`: the two differ in what they
+depict, not in how a reference is written, so one grammar serves both.
+*/
+let fromString = (raw: string): result<t, string> => Media_Ref.check(~what="image", raw)
+
+/** The sury schema for an image-reference field.
+    Use with `@s.matches(Reventless.ImageRef.schema)`. */
+let schema: S.t<t> = S.string->Semantic.refined(~id=Semantic.Id.imageRef, ~check=fromString)

package/src/semantic/ImageRef.res.mjs

@@ -0,0 +1,17 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Sury from "sury";
+import * as Semantic$Reventless from "./Semantic.res.mjs";
+import * as Media_Ref$Reventless from "./Media_Ref.res.mjs";
+
+function fromString(raw) {
+  return Media_Ref$Reventless.check("image", raw);
+}
+
+let schema = Semantic$Reventless.refined(Sury.string, Semantic$Reventless.Id.imageRef, fromString);
+
+export {
+  fromString,
+  schema,
+}
+/* schema Not a pure module */

package/src/semantic/Media_Ref.res

@@ -0,0 +1,33 @@
+// The grammar `ImageRef` and `FileRef` share. They differ in what the value
+// depicts, not in how a reference to it is written, so the rule lives once here
+// rather than twice with a chance to disagree.
+
+/** Is this an absolute web address? Schemes fold case per RFC 3986. */
+let hasWebScheme = (raw: string): bool => {
+  let lower = String.toLowerCase(raw)
+  String.startsWith(lower, "http://") || String.startsWith(lower, "https://")
+}
+
+/**
+Validate a reference to a resource the platform does not own: an `http`/`https`
+URL, or an origin-relative path. `~what` names the kind in the rejection so the
+message reads as the field's own.
+
+An origin-relative path is admitted because a value may legitimately have been
+minted by this platform earlier and simply not be declared as stored here —
+refusing it would make the unowned types unable to hold their own history.
+*/
+let check = (~what: string, raw: string): result<string, string> =>
+  if raw === "" {
+    Error(`expected a ${what} reference, got an empty string`)
+  } else if hasWebScheme(raw) {
+    Ok(raw)
+  } else if String.startsWith(raw, "/") && !String.startsWith(raw, "//") {
+    Ok(raw)
+  } else {
+    Error(
+      `expected an http:// or https:// address, or an origin-relative path, got ${Semantic.showString(
+          raw,
+        )}. A data: URI is not a ${what} reference — it inlines the bytes into the event log, permanently.`,
+    )
+  }