@idfkit/schemas 0.1.0 → 0.2.0-rc.1

package/README.md

@@ -16,10 +16,12 @@ npm install @idfkit/schemas
 The raw epJSON schemas are ~10 MB each, 17 of them, 11.9 MB gzipped in total. In
 a Python wheel nobody notices. On a page load it decides your architecture.
 
-87% of object-type definitions are byte-identical across releases: `Zone` has not
-changed since EnergyPlus 8.9. So this package stores each unique definition once,
-keyed by a content hash, and gives every version a manifest mapping type name to
-hash.
+The 17 manifests name 14,092 object-type definitions between them, and only
+2,568 of those are distinct. 82% of what the releases carry is a byte-identical
+repeat of a definition another release already has: `Construction`, for
+instance, has changed once in 17 releases. So this package stores each unique
+definition once, keyed by a content hash, and gives every version a manifest
+mapping type name to hash.
 
 |                                          | All 17 versions, gzipped |
 | ---------------------------------------- | ------------------------ |
@@ -28,7 +30,7 @@ hash.
 | Content-addressed (this package)         | ~1,000 KB                |
 
 Splitting per version would have been the obvious move and is the wrong one: it
-duplicates the shared 87% across packages and makes cross-version work require
+duplicates the shared 82% across packages and makes cross-version work require
 several installs. The longer argument is in [Content-addressed
 schemas](https://js.idfkit.com/explanation/content-addressed-schemas/).
 

package/dist/types.d.ts

@@ -4,8 +4,9 @@
  * This is deliberately NOT the raw epJSON schema. Keys are single letters and
  * documentation metadata (`note`, `ip-units`, `field_info`) is dropped, because
  * this bundle is on the critical path of every parse and, in a browser, every
- * page load. Human-facing metadata lives in `@idfkit/schemas/docs`, which only
- * tooling that renders documentation needs to pull in.
+ * page load. This package republishes that metadata nowhere; tooling that
+ * renders documentation reads the raw epJSON schemas directly, or uses
+ * idfkit-docs (https://docs.idfkit.com).
  */
 /** Field storage class, mirroring how the IDF writer must format the value. */
 export type FieldKind = 
@@ -20,22 +21,59 @@ export type FieldKind =
 export interface SlimField {
     /** Storage class. */
     t: FieldKind;
-    /** Field accepts `Autosize` / `Autocalculate` in addition to a number. */
+    /**
+     * Field is an `anyOf` of a numeric branch and a string branch, in that order.
+     *
+     * Set for every one of the 13060 such fields across the 17 bundled versions.
+     * The numeric branch's type, enum and bounds are hoisted onto this record;
+     * the string branch survives as `se`.
+     */
     auto?: 1;
+    /**
+     * String literals the `anyOf` string branch accepts, verbatim from the schema.
+     *
+     * Only meaningful together with `auto`. Absent while `auto` is set means the
+     * string branch carries no enum at all and ANY string is legal there, which is
+     * the shape of 646 fields including `Schedule:Compact`'s extensible `field`.
+     * That is why the empty string is kept here rather than filtered out the way
+     * `e` filters it: `se: ['']` (the whole string branch of the 68 fields whose
+     * number branch carries a numeric enum) and no `se` at all mean the opposite
+     * of one another.
+     *
+     * The sentinel is not a constant: 10565 fields take `Autosize` and 1781 take
+     * `Autocalculate`, so a validator that accepts either everywhere accepts a
+     * value EnergyPlus rejects.
+     */
+    se?: string[];
     /** Names of reference lists this field points *into* (i.e. it is a foreign key). */
     ol?: string[];
     /** Names of reference lists this field contributes *to* (i.e. it is a key). */
     ref?: string[];
-    /** Permitted values for a choice field. */
-    e?: string[];
+    /**
+     * Permitted values for a choice field.
+     *
+     * Numbers, not strings, on the 68 fields across the versions that express a
+     * choice numerically (`e: [1, 3]` on `Site:GroundDomain:Slab.phase`). Compare
+     * strings case-insensitively and numbers by value.
+     */
+    e?: (string | number)[];
     /** Schema default, applied on write when the field is absent. */
     d?: string | number;
     min?: number;
     max?: number;
-    /** Exclusive minimum. */
-    xmin?: number;
-    /** Exclusive maximum. */
-    xmax?: number;
+    /**
+     * Exclusive minimum, in whichever JSON Schema dialect the version shipped.
+     *
+     * A number is the bound itself (draft-06+, 9.6.0 onwards). The boolean `true`
+     * qualifies the sibling `min`, making it exclusive (draft-04, 8.9.0 through
+     * 9.5.0). Measured across the bundled schemas: `xmin` is boolean 9013 times
+     * in the older seven versions and numeric 13840 times in the newer ten;
+     * `xmax` behaves identically, and no version mixes the two. Branch on the
+     * value's type, never on the version.
+     */
+    xmin?: number | boolean;
+    /** Exclusive maximum. Number or boolean, exactly as `xmin`. */
+    xmax?: number | boolean;
     /** SI units, used by the unit-conversion helpers. */
     u?: string;
     /** Value is case-sensitive and must not be normalized. */

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,+EAA+E;AAC/E,MAAM,MAAM,SAAS;AACnB,+BAA+B;AAC7B,GAAG;AACL,oDAAoD;GAClD,GAAG;AACL,gDAAgD;GAC9C,GAAG;AACL,gCAAgC;GAC9B,KAAK,CAAC;AAEV,MAAM,WAAW,SAAS;IACxB,qBAAqB;IACrB,CAAC,EAAE,SAAS,CAAC;IACb,0EAA0E;IAC1E,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,oFAAoF;IACpF,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,+EAA+E;IAC/E,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,2CAA2C;IAC3C,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;IACb,iEAAiE;IACjE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,0DAA0D;IAC1D,EAAE,CAAC,EAAE,CAAC,CAAC;CACR;AAED,MAAM,WAAW,cAAc;IAC7B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,kEAAkE;IAClE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,QAAQ;IACvB,yEAAyE;IACzE,CAAC,EAAE,MAAM,EAAE,CAAC;IACZ,qDAAqD;IACrD,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC7B,4BAA4B;IAC5B,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;IACb,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,iCAAiC;IACjC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,8EAA8E;IAC9E,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,8EAA8E;IAC9E,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,0DAA0D;IAC1D,CAAC,CAAC,EAAE,cAAc,CAAC;IACnB,oDAAoD;IACpD,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,2EAA2E;AAC3E,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAC/E,MAAM,MAAM,SAAS;AACnB,+BAA+B;AAC7B,GAAG;AACL,oDAAoD;GAClD,GAAG;AACL,gDAAgD;GAC9C,GAAG;AACL,gCAAgC;GAC9B,KAAK,CAAC;AAEV,MAAM,WAAW,SAAS;IACxB,qBAAqB;IACrB,CAAC,EAAE,SAAS,CAAC;IACb;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,CAAC,CAAC;IACT;;;;;;;;;;;;;;OAcG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,oFAAoF;IACpF,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,+EAA+E;IAC/E,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf;;;;;;OAMG;IACH,CAAC,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACxB,iEAAiE;IACjE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB,qDAAqD;IACrD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,0DAA0D;IAC1D,EAAE,CAAC,EAAE,CAAC,CAAC;CACR;AAED,MAAM,WAAW,cAAc;IAC7B,qDAAqD;IACrD,GAAG,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,kEAAkE;IAClE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,QAAQ;IACvB,yEAAyE;IACzE,CAAC,EAAE,MAAM,EAAE,CAAC;IACZ,qDAAqD;IACrD,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC7B,4BAA4B;IAC5B,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;IACb,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,iCAAiC;IACjC,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,8EAA8E;IAC9E,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,8EAA8E;IAC9E,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,0DAA0D;IAC1D,CAAC,CAAC,EAAE,cAAc,CAAC;IACnB,oDAAoD;IACpD,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAED,2EAA2E;AAC3E,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,gEAAgE;IAChE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC"}

package/dist/types.js

@@ -4,8 +4,9 @@
  * This is deliberately NOT the raw epJSON schema. Keys are single letters and
  * documentation metadata (`note`, `ip-units`, `field_info`) is dropped, because
  * this bundle is on the critical path of every parse and, in a browser, every
- * page load. Human-facing metadata lives in `@idfkit/schemas/docs`, which only
- * tooling that renders documentation needs to pull in.
+ * page load. This package republishes that metadata nowhere; tooling that
+ * renders documentation reads the raw epJSON schemas directly, or uses
+ * idfkit-docs (https://docs.idfkit.com).
  */
 export {};
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idfkit/schemas",
-  "version": "0.1.0",
+  "version": "0.2.0-rc.1",
   "description": "Content-addressed EnergyPlus epJSON schemas for all supported versions",
   "type": "module",
   "license": "MIT",