foldkit-entity 0.14.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/README.md +139 -5
  2. package/dist/collation.d.ts +33 -2
  3. package/dist/collation.d.ts.map +1 -0
  4. package/dist/conformance/index.d.ts +4 -4
  5. package/dist/conformance/index.d.ts.map +1 -1
  6. package/dist/conformance/index.js +5 -7
  7. package/dist/conformance/index.js.map +1 -1
  8. package/dist/conformance/operator.d.ts +1 -2
  9. package/dist/conformance/operator.d.ts.map +1 -1
  10. package/dist/conformance/operator.js +2 -6
  11. package/dist/conformance/operator.js.map +1 -1
  12. package/dist/conformance/relational.d.ts +17 -17
  13. package/dist/conformance/relational.d.ts.map +1 -1
  14. package/dist/conformance/relational.js +1 -3
  15. package/dist/conformance/relational.js.map +1 -1
  16. package/dist/conformance/variants.d.ts +47 -0
  17. package/dist/conformance/variants.d.ts.map +1 -0
  18. package/dist/conformance/variants.js +126 -0
  19. package/dist/conformance/variants.js.map +1 -0
  20. package/dist/context.d.ts +60 -2
  21. package/dist/context.d.ts.map +1 -0
  22. package/dist/descriptor.d.ts +33 -0
  23. package/dist/descriptor.d.ts.map +1 -0
  24. package/dist/descriptor.js +137 -0
  25. package/dist/descriptor.js.map +1 -0
  26. package/dist/entity.d.ts +231 -0
  27. package/dist/entity.d.ts.map +1 -0
  28. package/dist/entity.js +435 -0
  29. package/dist/entity.js.map +1 -0
  30. package/dist/evaluate.d.ts +204 -2
  31. package/dist/evaluate.d.ts.map +1 -0
  32. package/dist/evaluate.js +51 -7
  33. package/dist/evaluate.js.map +1 -1
  34. package/dist/expr.d.ts +915 -2
  35. package/dist/expr.d.ts.map +1 -0
  36. package/dist/expr.js +50 -10
  37. package/dist/expr.js.map +1 -1
  38. package/dist/held.d.ts +112 -2
  39. package/dist/held.d.ts.map +1 -0
  40. package/dist/held.js +13 -2
  41. package/dist/held.js.map +1 -1
  42. package/dist/ids.d.ts +8 -0
  43. package/dist/ids.d.ts.map +1 -0
  44. package/dist/ids.js +8 -0
  45. package/dist/ids.js.map +1 -0
  46. package/dist/index.d.ts +380 -6
  47. package/dist/index.d.ts.map +1 -0
  48. package/dist/index.js +108 -12
  49. package/dist/index.js.map +1 -0
  50. package/dist/invariant.d.ts +123 -2
  51. package/dist/invariant.d.ts.map +1 -0
  52. package/dist/invariant.js +236 -1
  53. package/dist/invariant.js.map +1 -0
  54. package/dist/law.d.ts +264 -2
  55. package/dist/law.d.ts.map +1 -0
  56. package/dist/law.js +1 -1
  57. package/dist/operators.d.ts +170 -2
  58. package/dist/operators.d.ts.map +1 -0
  59. package/dist/operators.js +3 -3
  60. package/dist/readFilter.d.ts +8 -2
  61. package/dist/readFilter.d.ts.map +1 -0
  62. package/dist/sets.d.ts +18 -2
  63. package/dist/sets.d.ts.map +1 -0
  64. package/dist/sets.js +1 -1
  65. package/dist/shape.d.ts +23 -2
  66. package/dist/shape.d.ts.map +1 -0
  67. package/dist/tested.d.ts +8 -2
  68. package/dist/tested.d.ts.map +1 -0
  69. package/dist/text.d.ts +27 -2
  70. package/dist/text.d.ts.map +1 -0
  71. package/dist/text.js +1 -1
  72. package/dist/variants.d.ts +72 -0
  73. package/dist/variants.d.ts.map +1 -0
  74. package/dist/variants.js +76 -0
  75. package/dist/variants.js.map +1 -0
  76. package/dist/words.d.ts +17 -2
  77. package/dist/words.d.ts.map +1 -0
  78. package/dist/write.d.ts +312 -2
  79. package/dist/write.d.ts.map +1 -0
  80. package/dist/write.js +3 -3
  81. package/package.json +3 -3
  82. package/dist/collation-BB4YTIbY.d.ts +0 -34
  83. package/dist/collation-BB4YTIbY.d.ts.map +0 -1
  84. package/dist/index-48JeXG0A.d.ts +0 -2585
  85. package/dist/index-48JeXG0A.d.ts.map +0 -1
  86. package/dist/readFilter-CWMnFRVw.d.ts +0 -9
  87. package/dist/readFilter-CWMnFRVw.d.ts.map +0 -1
  88. package/dist/shape-LAowRf9f.d.ts +0 -23
  89. package/dist/shape-LAowRf9f.d.ts.map +0 -1
  90. package/dist/src-DKhUqLoC.js +0 -731
  91. package/dist/src-DKhUqLoC.js.map +0 -1
  92. package/dist/words-a4e9o-TK.d.ts +0 -18
  93. package/dist/words-a4e9o-TK.d.ts.map +0 -1
@@ -0,0 +1 @@
1
+ {"version":3,"file":"expr.d.ts","names":["Collation","Law","Arr"],"sources":["../src/expr.ts"],"mappings":";;;;;;iBAgCiB,YAAY;WAClB;WACA,OAAO;;;;;;iBAOD,UAAU;WAChB;WACA,OAAO;WACP;WACA,QAAQ,OAAO,MAAM;;;;;;WAMrB,WAAW,OAAO,OAAOA;;;;;;;;iBASnB,UAAU;WAChB;WACA;WACA,QAAQ,OAAO,MAAM;;;;;;;iBAQf,SAAS;WACf;WACA,OAAO,UAAU;;;;;;;;iBASX;WACN;WACA;WACA;WACA,aAAa,OAAO;;WAEpB,OAAO,cAAc,OAAO;WAC5B,QAAQ,OAAO;;;;;;WAMf,WAAW,OAAO,WAAW,MAAM,cAAc,gBAAgB;;;;;;WAMjE;;;;;;;WAOA;;WAEA,MAAM,cAAcC;;;iBAId;;WAEN,MAAM,UAAU;;;;;;WAMhB,WAAW,eAAe;;;qBAIxB,aAAa;;;;;qBAMb,cAAW,UAAc,oBAAkB,WAAa;;;;;;iBAmBpD,SAAS;WACf;WACA,UAAU;WACV,MAAM,cAAc;WACpB,WAAW,OAAO,OAAO,KAAK;;WAE9B,WAAW,OAAO,OAAOD;;;YAIxB,cAAc,+BAA+B;;;;;;iBAOxC,SAAS;WACf;;WAEA,KAAKE,MAAI,sBAAsB;;WAE/B,OAAO,UAAU;;;YAIhB,KAAK,KACb,YAAY,KACZ,UAAU,KACV,UAAU,KACV,SAAS,KACT,SAAS,KACT,WAAW,KACX,QAAQ,KACR,SAAS,KACT,eAAe;;YAGP,UAAU;;;;;;;;;YAUV,YACR,cACA,gBACA,oBACA,cACA,eACA,cACA,eACA,mBACA,gBACA;;;;;;;;iBASa;WACN;;WAEA,KAAK,cAAc;WACnB,UAAU;;WAEV,OAAO,OAAO,OAAO;;;iBAIf;WACN;WACA,MAAM;WACN,OAAO;;;;;;;iBAQD;WACN;WACA,SAAS;WACT;;;;;;;iBAQM;WACN;WACA,OAAO;WACP,QAAQ;;;;;;;;iBASF;WACN;WACA,OAAO;WACP,OAAO;;;;;;;iBAQD;WACN;WACA,UAAUA,MAAI,sBAAsB;;;iBAI9B;WACN;WACA,UAAUA,MAAI,sBAAsB;;;;;;;iBAQ9B;WACN;WACA,SAAS;;;YAIR;;;;;;iBAOK;WACN;WACA,UAAU;WACV,MAAM;WACN,OAAO;WACP,WAAW,OAAO,OAAOF;;;;;;;iBAQnB;WACN;WACA,UAAU;WACV,MAAM,cAAc;WACpB,WAAW,OAAO,OAAO;;WAEzB,WAAW,OAAO,OAAOA;;;;;;;;YASxB,aAAa,UAAU;;;;;KAM9B,QAAQ,KAAK,WAAW,KAAK;;KAG7B,WAAW,KAAK,4BAA4B,OAAO,cAAc,KAAK,KAAK;;;;;;;iBAQ/D,MAAM;WACZ,WAAW;;;;;;;YAQV,QAAQ,KAClB,UAAU,kBAAkB,cAAc,OAAO,cAC7C,OACA,UAAU,qBAAqB,cAAc,6BAC3C,OACA,UAAU;WAAwB;YAEhC;WAAqB,iBAAiB;oBACpB,iBAEd,uBACE;;;;;KAQX,WACH,sBACA,qBACA,sCACiB,mBAEd,gBAAgB,kBAEf,2BAA2B,cAAc,QAAQ,OAAO,gCAAgC;;KAGzF;;iBAGY,QAAQ;WACd,YAAY;;;YAIX,QAAQ,KAClB,UAAU,kCAAkC,KACxC,OAAO,OAAO,KAAK,KACnB,UAAU,qCAAqC,qBAAqB,YAClE,KAAK,WAAW,wCAChB,UAAU,sBAER,UAAU,WAAW,KACnB;;;;;;;;;;;;;;;;;;;;;YAuBA,cACR,4BAA4B,OAAO,aAAa,OAAO,uCACvD,eACA;cAmBE,UAAW,GAAC,OAAS,MAAI,YAAY;;qBA8C9B,cAAW,mBAAqB,SAAS;;;;;;YA0D1C;;iBAiBK;;WAEN;WACA;;WAEA,OAAO;;;iBAID;;WAEN,QAAQ,cAAc;;WAEtB,MAAM,cAAc;;WAEpB,QAAQ;;WAER,YAAY,cAAc;;WAE1B,WAAW,cAAc;;;;;;WAMzB,SAAS,cAAc,oBAAoB,kBAAkB;;;;;;;iBAQvD,0BAA0B;WAChC,WAAW,cAAc;WACzB,OAAO,cAAc;;;;;;;;YASpB,iBACR,4BAGE,OAAO,aAAa,OAAO,wBAAwB,+BAErD,eACA,sBACA,eACA,sBACA,KAAK,QACL,KAAK;;UAqLC,WAAW,aAAa;GAC/B,UAAU,WAAW,MAAM,IAAI;GAC/B,UAAU,WAAW,UAAU,WAAW,aAAa,cAAc,YACpE,OAAO,GACP,QAAQ,MACL,MAAM,OACR,OAAO,MAAM,QAAQ,KAAK,QAAQ,KAAK,QAAQ;MAC9C,UAAUE,MAAI,sBAAsB,aAAa;;;KAWlD,SAAS,UAAU,OAAO,OAAO,OAAO,MAAM,QAAQ;;;;;YAM/C,WAAW,UAAU,OAAO,OACpC,4BAA4B,OAAO,aAAa,OAAO,WAAW,SAAS,iBAC3E,KAAK,SAAS,uBACG,SAAS,KAAK,qBAC/B,SAAS;;YAGD,YAAY,UAAU,OAAO,OACrC,KAAK,SAAS,uBACG,SAAS,KAAK;;KAG9B,OAAO,YAAY,OAAO,QAAQ,SAAS,0BAC5C,gBACA,SAAS,SAAS;;KAGjB,OAAO,YAAY,OAAO,QAAQ,SAAS,0BAC5C,YACA,KAAK,SAAS;;;;;iBAMD,SAAS,WAAW,cAAc,OAAO,MAAM,YAAY,OAAO;SAC1E,sBAAsB,WAAW,KAAK,WAAW,GAAG,WACtD,MAAM,IACR,OAAO,OAAO,MAAM,QAAQ;;;;;;SAMxB,sBAAsB,WAAW,KAAK,WAAW,GAAG,WACtD,UAAU,GAAG,eACf,OAAO,OAAO,MAAM,QAAQ;WACtB,YAAY;;;iBAIN;;WAEN,WAAWF;;;UAubZ;GACP,sBAAsB,eAAe,WAAW,UAAU,QAAQ,iBACjE,UAAU,eAAe,eAAe,yBACxC,KAAK,KACH,UAAU,kBAAkB,kBAAkB,SAAS,QAAQ,cAAc,MAAM;GACtF,qBAAqB,UAAU,QAAQ,QAAQ,OAAO,kBACrD,QAAQ,gBAAgB,OACxB,KAAK,IACJ,eAAe,QAAQ;;;;;;qBAOf;;YAGD,QAAQ,uBAChB,YAAY,cAAc,OAAO,eAChC,gBAAgB,MAAM,UACtB,kBAAkB,MAAM;;KAuHxB,MAAM,UAAU,0BAA0B;;KAG1C,YAAY,UAAU,kBAAkB,oBAAoB,KAC/D,uBAAuB;;YAKb,WAAW,UAAU,kBAAkB,gCACvC,WAAW,YAAY,GAAG,cAAc,YAAY,WAAW,GAAG,YAAY,GAAG,GAAG;;YAIpF,UAAU,sBAAsB,UAAU,kBAAkB,gCAC5D,WAAW,YAAY,GAAG,cAAc,SAChD,OAAO,OAAO,KAAK,YAAY,GAAG,GAAG,OAErC,MAAM;;UAIA;GACP,UAAU,wBAAwB,UAAU,MAAM,IAAI,UAAU,mBAC/D,QAAQ,GACR,KAAK,GACL,SAAS,QAAQ,WAAW,GAAG,OAAO,IACrC,YAAY,MAAM,YAAY,QAAQ;GAEvC,sBACA,eAAe,wBACT,UAAU,MAAM,SACtB,UAAU,mBAEV,UAAU,eAAe,eAAe,yBACxC,KAAK,GACL,SAAS,QAAQ,UAAU,OAAO,QAAQ,OAAO,IAChD,YAAY,MAAM,QAAQ,QAAQ;;;UAqD7B;GACP,qBAAqB,oBAAoB,UAAU,OAAO,YACzD,OAAO,YAAY,MAAM,KAAK,KAC7B,UAAU,OAAO,OAAO,KAAK,MAAM,MAAM;GAE1C,YAAY,gBACV;;UAOI;GACP,qBAAqB,oBAAoB,UAAU,OAAO,YACzD,OAAO,YAAY,MAAM,KAAK,KAC7B,SAAS,OAAO,OAAO,KAAK,MAAM,MAAM;GAC1C,qBAAqB,oBAAoB,0BACxC,UAAU,eAAe,MAAM,KAAK,kBAAkB,YACrD,SAAS,kDAAkD,MAAM;;qBAMzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiCA,iBAAM,WAAW,cAAc,OAAO,MAAM,YAAY,OAAO,KAAG,YACjE;aAEC,OAAO;aACP,QAAQ;aACR;aACA;;aAEA,OAAO,cAAcC;;aAGjB,eACJ,kBAAkB,WAAW,KAAK,YAAY,GAAG,WACjD,OAAO;aACH;aACA;;aAGA;aACA,QAAQ;aACR,YAAY;SAG1B,SAAS,IAAI;;;;;;;;;;;;;;EAgBY,qBAAA,OAAA,cAAc,UAAU;EAgBzC,WAAA,UAAU,YAAY,SAAO,MAAQ,MAAI,UAAU,YAAY,YAAY;;;;;;;;EAW7E,cAAA,OAAA,cAAc,UAAU,YAAY,WAAS;aAEzC,YAAY,cAAc;aAC1B,WAAW;QAErB;;;;;;;EASK,QAAA,GAAC,aAAa,QAAU,OAAO,MAAM,gBAAc,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;EA8BrD,MAAA;;;;;;;;;;;;;;;EAgBI,SAClB,sBACA,eAAe,WACf,UAAU,YAAY,MAAM,gBAE5B,UAAU,eAAe,eAAe,yBACxC,QAAQ,MACL,kBAAkB,MAAM;;;;;;;;;;;;;;;;;;;EAoBjB,IAAA;;;;;;;;;;;;;;;;;;;;;;;;;;EA8BV,KAAA,UAAU,eAAe,YACzB,WAAW,UAAU,aACjB,4FAEE,QAAQ,KACR,KAAK,QAAQ,MACb,SAAS,QAAQ,aACjB,eAAe,QAAQ,8BACN,QAAQ,KAAK,qBAAmB,MAEjD,GAAC,OAGA,MACN,cAAc,MAAM,QAAQ,KAAK,QAAQ;;;;;;EAQnC,SAAA,UAAU,cAAY,SAAW,MAAI,gBAAgB,MAAM,QAAQ;;EAIhE,YAAA,UAAU,cAAY,SAAW,MAAI,gBAAgB,MAAM,QAAQ;;;;;;;;;;;;;;;;;EAmBpE,WAAA,UAAU,aAAW,OACvB,GAAC,iBACS,sBAAsB,oBAAoB,6BAC1D,oBAAoB,MAAM,QAAQ;;;;;;;;;;;;;;EAyBhC,KAAA,UAAU,cAAY,OAClB,GAAC,OACD,cAAc,QAAQ,MAAM,KAAK,cAAc,QAAQ,SAC7D,cAAc,MAAM,QAAQ;;;;;;;;;;;;;;EAtlC9B,KAAA,UAAU,gBAAgB,UAAU,QAAQ,KAAK,KAAK,QAAQ,KAAG,MAC1D,GAAC,OACA,GAAC;aACY,YAAYD;QAC/B,mBAAmB,MAAM,QAAQ,KAAK,QAAQ;;;;;;;;;;;;;;;;;;;;EAqnCF,KAAA,WAAW;;;;;;;;;;;EAYf,IAAA,WAAW;;;;;;;;EAShD,MAAA,UAAU,WAAS,SAAW,MAAI,eAAe,MAAM,QAAQ;;;;;;;;;;;;;;EAsBzD,YAAA,GAAG,UAAU,WAAS,OACzB,UAAU,IAAE,QACX,OAAO,UAAU,YAAY,QAAQ,MAC5C,YAAY,MAAM,QAAQ;;EAMhB,OAAA,MAAA;;;;;;;EAQe,iBAAA,WAAA,WAAS,QAAU,SAAS,6BAA2B;;;iBA+EpE;WACN;WACA;WACA,MAAM;;;;;;;WAON;;;;;WAKA,WAAW,OAAO,OAAOA;;;iBAInB;WACN;;WAEA,YAAYA;;;YA6EX,WAAW;WACZ,IAAI;WACJ;;;;;;;iBAQM;WACN;WACA,MAAM,UAAU;WAChB,SAAS,SAAS,eAAe,qBAAqB;;;YAIrD,WAAW,YAAY;qBAetB;;EAEX,MAAM,UAAU,iBAAe,MAAQ,GAAC,UAAY,gBAAc,YAAY,MAAM,QAAQ;;EAG5F,OAAO,UAAU,iBAAe,MACxB,GAAC,UACG,gBACT,YAAY,MAAM,QAAQ;;;;;;;;;;;EAY7B,SAAS,yBAAyB,4BAA4B,KAAK,KAAK,oBAAiB,MACjF,UAAU,WAAW,MAAI,SACtB,YACR,cAAc,MAAM,QAAQ,cAAc;;;;;;YAuBnC;WACG;;WACA;WAA+B;;;;;;;qBAoPjC,oBAAc,OACf,cAAc,UAAU,YAAY,cAC7C;;;;;;;;;;;;iBAkCc,MAAM,UAAU,mBAAmB,SAAS;WAClD;WACA,QAAQ;;;;;;;WAOR,OAAO,cAAc;;WAErB,SAAS,cAAc;;;YAItB,WAAW,MAAM;;;;;;;;qBA0GhB;qBAkGA;;EAEX,OAAO,UAAU,WAAS,QAAU,MAAI,MAAM;;;;;;;;;;;EAY9C,cACS,UAAU,cAAc,eAAU,YAAiB,OACzD,UAAU,WAAS,MACZ,MAAM,KAAK,WAAW,QAAQ,YAAY,8BAC/C,MAAM;;;;;;EAaX,gBACS,UAAU,cAAc,cAAS,OAAY,OACnD,UAAU,WAAS,MACZ,MAAM,KAAK,WAAW,QAAQ,YAAY,mCAC/C,MAAM;;;;;;;;EAeX,WAAQ,MACA,UAAQ,OACP,SAAS,6BACf,cAAc;;;;;;;;EAsBjB,YAAS,MACD,UAAQ,OACP,SAAS,0BAAwB;aACpB,YAAY;QAC/B;;;;;;EAiBH,YAAS,MAAS,aAAW;;;;;;EAQ7B,eAAY,MAAS,aAAW;;;;;;;;;;;;;;;;;;;;EAyBhC,cAAW,MACH,UAAQ,WACH,cAAc,YAAU,YACxB,kBACV;;;;;;;;;;;;;;;EAgBH,OAAI,MAAS"}
package/dist/expr.js CHANGED
@@ -1,10 +1,11 @@
1
+ import { Array as Array$1, Match, Option, Pipeable, Schema, SchemaAST } from "effect";
2
+ import { own, put } from "./record.js";
3
+ import { variantsOf } from "./variants.js";
4
+ import { SchemaShape } from "./shape.js";
5
+ import { absurd } from "effect/Function";
1
6
  import { Collation } from "./collation.js";
2
7
  import { now, viewer } from "./context.js";
3
- import { SchemaShape } from "./shape.js";
4
8
  import { Law } from "./law.js";
5
- import { own } from "./record.js";
6
- import { Array as Array$1, Match, Option, Pipeable, Schema, SchemaAST } from "effect";
7
- import { absurd } from "effect/Function";
8
9
  // src/expr.ts
9
10
  /**
10
11
  * `Expr` — a query's scalar computations as typed values.
@@ -602,7 +603,30 @@ const existsOf = (relation, where) => {
602
603
  where: filter
603
604
  });
604
605
  };
606
+ const isOf = (subject, tag, build) => {
607
+ const relation = tagOf(subject) === "Relation" ? subject : void 0;
608
+ if (relation !== void 0 && relation.cardinality !== "one") throw new Error(`[foldkit-entity] Expr.is: ${relation.owner.name}.${relation.key} is a many relation, which reaches no one row`);
609
+ const entity = relation === void 0 ? subject : relation.target();
610
+ const variants = Option.getOrThrowWith(typeof entity === "object" && entity !== null && "identity" in entity ? variantsOf(entity.identity) : Option.none(), () => /* @__PURE__ */ new Error("[foldkit-entity] Expr.is: the first argument is an Entity declared with Entity.defineVariants, or a one relation to one"));
611
+ if (!variants.tags.includes(tag)) throw new Error(`[foldkit-entity] Expr.is: ${entity.name} has no case "${tag}"; its cases are ${variants.tags.join(", ")}`);
612
+ const stored = entity.fields;
613
+ const read = (field) => relation === void 0 ? field : pathOf(relation, field);
614
+ const is = Expr.eq(read(stored._tag), tag);
615
+ if (build === void 0) return is;
616
+ const caseFields = {};
617
+ for (const [key, schema] of Object.entries(variants.cases[tag])) put(caseFields, key, read(Object.freeze({
618
+ ...stored[key],
619
+ schema
620
+ })));
621
+ const asked = build(Object.freeze(caseFields));
622
+ if (!isPredicate(asked)) throw new Error(`[foldkit-entity] Expr.is: what is asked of a ${tag} is a predicate`);
623
+ return Expr.and(is, asked);
624
+ };
605
625
  const fieldOf = ((field) => fieldExpr(field));
626
+ const nextOf = ((member) => node({
627
+ _tag: "Next",
628
+ field: toOperand(member)
629
+ }));
606
630
  const Expr = {
607
631
  /**
608
632
  * An operator, defined by what a call of it means: `definedAs` builds that
@@ -682,13 +706,10 @@ const Expr = {
682
706
  schema
683
707
  }),
684
708
  /**
685
- * A field as the row a write would leave holds it: what `Entity.invariant`'s
686
- * builder hands out as `after`.
709
+ * A field, or a `one` relation as the id it points at, as the row a write
710
+ * would leave holds it: what `Entity.invariant`'s builder hands out as `after`.
687
711
  */
688
- next: (field) => node({
689
- _tag: "Next",
690
- field: fieldExpr(field)
691
- }),
712
+ next: nextOf,
692
713
  /**
693
714
  * One field of one Entity, as a scalar. An expression is one already: an
694
715
  * invariant's `before.x` and `after.x` compare as they are, so wrapping one
@@ -726,6 +747,25 @@ const Expr = {
726
747
  */
727
748
  exists: existsOf,
728
749
  /**
750
+ * The row is of case `tag` of an Entity declared with
751
+ * `Entity.defineVariants`, and holds what `build` asks of that case's
752
+ * fields, each typed as the case holds it:
753
+ *
754
+ * ```ts
755
+ * Expr.is(Domain, 'Unconfirmed')
756
+ * Expr.is(Domain, 'Available', ({ price }) => Expr.lt(price, 20))
757
+ * // Through a one relation, the row it reaches.
758
+ * Expr.is(Order.relations.domain, 'Available', ({ price }) => Expr.lt(price, 20))
759
+ * ```
760
+ *
761
+ * It is `_tag = tag` and the predicate, so a row of another case is false,
762
+ * never unknown, and `Expr.not` of it holds there. Through a relation, a null
763
+ * link reaches no row and the test is unknown, as a path's field reads null.
764
+ * Use the fields inside `build`: outside it a case's field is the stored
765
+ * column, null on rows of other cases.
766
+ */
767
+ is: isOf,
768
+ /**
729
769
  * Whoever asks, as a row of `entity`: `Expr.eq(Like.fields.userId,
730
770
  * Expr.viewer(User))`. Shaped as a `one` relation to `entity`. Its value is
731
771
  * the row's id, and null for a visitor or a viewer of another Entity, so a