@fieldia/core 0.20.0 → 0.22.0

package/src/lib/record/search.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"search.mjs","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/record/search.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAuBlC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAC/C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AACzD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AAEhD;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,IAAU,EAAE,IAAc,EAAE,QAA+B,EAAE,SAAS,EAAE,4BAA4B,EAAE;IAC/I,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,GAAG;YAAE,SAAS;QACnB,MAAM,GAAG,GAAG,CAAC,EAAoB,EAAE,KAAgB,EAAE,UAAkB,EAAE,KAAc,EAAE,EAAE,CACzF,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACzI,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;aAClE,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAClC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACjC,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO;gBAAE,IAAI,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;oBAAE,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAC1J,CAAC;aAAM,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;YAClD,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAAE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IACD,oFAAoF;IACpF,MAAM,IAAI,GAAG,CAAC,CAAa,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC;IACF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9G,CAAC;AAED,gIAAgI;AAChI,MAAM,UAAU,cAAc,CAAC,MAAwB,EAAE,IAAc;IACrE,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC/F,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,+EAA+E;YAC/E,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,IAAI,EAAE,CAAqB,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACjJ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC9C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC5H,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,aAAa,CAAC,MAAwB;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAA4C,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC;AAC1G,CAAC"}
+{"version":3,"file":"search.mjs","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/record/search.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAuBlF,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAC/C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AACzD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;AAEhD,wGAAwG;AACxG,MAAM,UAAU,GAAG,wDAAwD,CAAC;AAE5E;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,IAAU,EAAE,IAAc,EAAE,QAA+B,EAAE,SAAS,EAAE,4BAA4B,EAAE,EAAE,MAAM,GAAG,IAAI;IAC9J,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,+EAA+E;IAC/E,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACnD,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,CAAC,GAAG;YAAE,SAAS;QACnB,MAAM,GAAG,GAAG,CAAC,EAAoB,EAAE,KAAgB,EAAE,UAAkB,EAAE,KAAc,EAAE,EAAE,CACzF,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACzI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAClE,+FAA+F;YAC/F,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YACzC,IAAI,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,MAAM;gBAAE,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;;gBAC3F,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAClC,CAAC;aAAM,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;aAC3E,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;YACnC,KAAK,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO;gBAAE,IAAI,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAAE,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QAC5J,CAAC;aAAM,IAAI,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;gBAAE,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IACD,oFAAoF;IACpF,MAAM,IAAI,GAAG,CAAC,CAAa,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC,CAAC;IACF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9G,CAAC;AAED,gIAAgI;AAChI,MAAM,UAAU,cAAc,CAAC,MAAwB,EAAE,IAAc;IACrE,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAC/F,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7E,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACpC,+EAA+E;YAC/E,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,IAAI,EAAE,CAAqB,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACjJ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;iBAC9C,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC5H,CAAC;aAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,aAAa,CAAC,MAAwB;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAA4C,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,MAAM,IAAI,EAAE,CAAC;AAC1G,CAAC"}

package/src/lib/record/structures.d.mts

@@ -5,10 +5,15 @@ import type { Value } from './values.mjs';
 /**
  * What a structure's widget asks of its answer beyond Required: an address
  * (`json.address`) its parts in `options.requiredParts` filled — the first
- * missing one named — and a table of lines or a repeating group as few lines
- * as `options.min` and as many as `options.max`, once it has any. Undefined
- * when it keeps them, or when there is nothing to check.
+ * missing one named — and its postcode of its country's shape where that is
+ * known; and a table of lines or a repeating group as few lines as
+ * `options.min` and as many as `options.max`, once it has any. Undefined when
+ * it keeps them, or when there is nothing to check.
  */
 /** An address's parts, in the order its boxes and its messages name them. */
 export declare const ADDRESS_PARTS: readonly ["street", "line2", "city", "region", "postcode", "country"];
+/** A postcode as it is kept: digits in any script as 0-9, no direction marks, no spaces at its ends. */
+export declare const settledPostcode: (text: string) => string;
+/** Whether a postcode is of its country's shape: null when the country's shape is not known, or there is no postcode. */
+export declare function postcodeFits(country: unknown, postcode: unknown): boolean | null;
 export declare function checkStructure(field: Field, node: FieldNode, value: Value | undefined, messages: Messages): string | undefined;

package/src/lib/record/structures.d.ts

@@ -5,10 +5,15 @@ import type { Value } from './values';
 /**
  * What a structure's widget asks of its answer beyond Required: an address
  * (`json.address`) its parts in `options.requiredParts` filled — the first
- * missing one named — and a table of lines or a repeating group as few lines
- * as `options.min` and as many as `options.max`, once it has any. Undefined
- * when it keeps them, or when there is nothing to check.
+ * missing one named — and its postcode of its country's shape where that is
+ * known; and a table of lines or a repeating group as few lines as
+ * `options.min` and as many as `options.max`, once it has any. Undefined when
+ * it keeps them, or when there is nothing to check.
  */
 /** An address's parts, in the order its boxes and its messages name them. */
 export declare const ADDRESS_PARTS: readonly ["street", "line2", "city", "region", "postcode", "country"];
+/** A postcode as it is kept: digits in any script as 0-9, no direction marks, no spaces at its ends. */
+export declare const settledPostcode: (text: string) => string;
+/** Whether a postcode is of its country's shape: null when the country's shape is not known, or there is no postcode. */
+export declare function postcodeFits(country: unknown, postcode: unknown): boolean | null;
 export declare function checkStructure(field: Field, node: FieldNode, value: Value | undefined, messages: Messages): string | undefined;

package/src/lib/record/structures.js

@@ -1,17 +1,54 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ADDRESS_PARTS = void 0;
+exports.settledPostcode = exports.ADDRESS_PARTS = void 0;
+exports.postcodeFits = postcodeFits;
 exports.checkStructure = checkStructure;
+const input_rules_1 = require("./input-rules");
 const messages_1 = require("./messages");
 /**
  * What a structure's widget asks of its answer beyond Required: an address
  * (`json.address`) its parts in `options.requiredParts` filled — the first
- * missing one named — and a table of lines or a repeating group as few lines
- * as `options.min` and as many as `options.max`, once it has any. Undefined
- * when it keeps them, or when there is nothing to check.
+ * missing one named — and its postcode of its country's shape where that is
+ * known; and a table of lines or a repeating group as few lines as
+ * `options.min` and as many as `options.max`, once it has any. Undefined when
+ * it keeps them, or when there is nothing to check.
  */
 /** An address's parts, in the order its boxes and its messages name them. */
 exports.ADDRESS_PARTS = ['street', 'line2', 'city', 'region', 'postcode', 'country'];
+/**
+ * A postcode's shape by its country, where it is known: how many digits, and
+ * one as the country writes it. Egypt's, Saudi Arabia's, Kuwait's and
+ * Jordan's have five; Bahrain's three or four; Oman's three. Others are not
+ * checked.
+ */
+const POSTCODES = {
+    EG: { least: 5, most: 5, example: '11511' },
+    SA: { least: 5, most: 5, example: '12271' },
+    KW: { least: 5, most: 5, example: '13001' },
+    JO: { least: 5, most: 5, example: '11118' },
+    BH: { least: 3, most: 4, example: '317' },
+    OM: { least: 3, most: 3, example: '112' },
+};
+/** A postcode as it is kept: digits in any script as 0-9, no direction marks, no spaces at its ends. */
+const settledPostcode = (text) => (0, input_rules_1.foldDigits)((0, input_rules_1.stripMarks)(text)).trim();
+exports.settledPostcode = settledPostcode;
+/** Whether a postcode is of its country's shape: null when the country's shape is not known, or there is no postcode. */
+function postcodeFits(country, postcode) {
+    const shape = typeof country === 'string' ? POSTCODES[country.toUpperCase()] : undefined;
+    if (!shape || typeof postcode !== 'string' || !postcode.trim())
+        return null;
+    const digits = (0, exports.settledPostcode)(postcode);
+    return /^[0-9]+$/.test(digits) && digits.length >= shape.least && digits.length <= shape.most;
+}
+/** A country's name in a language, by its code: Egypt, مصر, Égypte, Ägypten. */
+function countryName(code, locale) {
+    try {
+        return new Intl.DisplayNames([locale], { type: 'region' }).of(code) ?? code;
+    }
+    catch {
+        return code;
+    }
+}
 function checkStructure(field, node, value, messages) {
     const options = node.options ?? {};
     const label = node.label ?? field.label;
@@ -21,12 +58,19 @@ function checkStructure(field, node, value, messages) {
         if (typeof options['max'] === 'number' && value.length > options['max'])
             return (0, messages_1.fill)(messages.maxLines, { label, max: options['max'] });
     }
-    const needed = options['requiredParts'];
-    if (node.widget !== 'address' || !Array.isArray(needed) || !value || typeof value !== 'object' || Array.isArray(value))
+    const needed = Array.isArray(options['requiredParts']) ? options['requiredParts'] : [];
+    if (node.widget !== 'address' || !value || typeof value !== 'object' || Array.isArray(value))
         return undefined;
     const asked = Array.isArray(options['parts']) ? options['parts'] : exports.ADDRESS_PARTS;
     const parts = value;
     const missing = exports.ADDRESS_PARTS.findIndex((part) => needed.includes(part) && asked.includes(part) && !String(parts[part] ?? '').trim());
-    return missing < 0 ? undefined : (0, messages_1.fill)(messages.required, { label: messages.addressParts.split('|')[missing] });
+    if (missing >= 0)
+        return (0, messages_1.fill)(messages.required, { label: messages.addressParts.split('|')[missing] });
+    if (postcodeFits(parts['country'], parts['postcode']) !== false)
+        return undefined;
+    const country = String(parts['country']).toUpperCase();
+    const shape = POSTCODES[country];
+    const n = shape.least === shape.most ? shape.least : `${shape.least}–${shape.most}`;
+    return (0, messages_1.fill)(messages.postcode, { label, country: countryName(country, messages.locale), n, example: shape.example });
 }
 //# sourceMappingURL=structures.js.map

package/src/lib/record/structures.js.map

@@ -1 +1 @@
-{"version":3,"file":"structures.js","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/record/structures.ts"],"names":[],"mappings":";;;AAgBA,wCAaC;AA3BD,yCAAiD;AAGjD;;;;;;GAMG;AAEH,6EAA6E;AAChE,QAAA,aAAa,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAEnG,SAAgB,cAAc,CAAC,KAAY,EAAE,IAAe,EAAE,KAAwB,EAAE,QAAkB;IACxG,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC;IACxC,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACtE,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAA,eAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxI,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAA,eAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1I,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzI,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,qBAAa,CAAC;IACjF,MAAM,KAAK,GAAG,KAAgC,CAAC;IAC/C,MAAM,OAAO,GAAG,qBAAa,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtI,OAAO,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,eAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AACjH,CAAC"}
+{"version":3,"file":"structures.js","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/record/structures.ts"],"names":[],"mappings":";;;AAqCA,oCAKC;AAWD,wCAkBC;AArED,+CAAuD;AACvD,yCAAiD;AAGjD;;;;;;;GAOG;AAEH,6EAA6E;AAChE,QAAA,aAAa,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,SAAS,GAAqE;IAClF,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;IACzC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;CAC1C,CAAC;AAEF,wGAAwG;AACjG,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAA,wBAAU,EAAC,IAAA,wBAAU,EAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAAxE,QAAA,eAAe,mBAAyD;AAErF,yHAAyH;AACzH,SAAgB,YAAY,CAAC,OAAgB,EAAE,QAAiB;IAC9D,MAAM,KAAK,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzF,IAAI,CAAC,KAAK,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;QAAE,OAAO,IAAI,CAAC;IAC5E,MAAM,MAAM,GAAG,IAAA,uBAAe,EAAC,QAAQ,CAAC,CAAC;IACzC,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC;AAChG,CAAC;AAED,gFAAgF;AAChF,SAAS,WAAW,CAAC,IAAY,EAAE,MAAc;IAC/C,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IAC9E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,KAAY,EAAE,IAAe,EAAE,KAAwB,EAAE,QAAkB;IACxG,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC;IACxC,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACtE,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAA,eAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxI,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAA,eAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1I,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACvF,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC/G,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,qBAAa,CAAC;IACjF,MAAM,KAAK,GAAG,KAAgC,CAAC;IAC/C,MAAM,OAAO,GAAG,qBAAa,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtI,IAAI,OAAO,IAAI,CAAC;QAAE,OAAO,IAAA,eAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvG,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,KAAK;QAAE,OAAO,SAAS,CAAC;IAClF,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACvD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;IACpF,OAAO,IAAA,eAAI,EAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;AACvH,CAAC"}

package/src/lib/record/structures.mjs

@@ -1,13 +1,48 @@
+import { foldDigits, stripMarks } from './input-rules.mjs';
 import { fill } from './messages.mjs';
 /**
  * What a structure's widget asks of its answer beyond Required: an address
  * (`json.address`) its parts in `options.requiredParts` filled — the first
- * missing one named — and a table of lines or a repeating group as few lines
- * as `options.min` and as many as `options.max`, once it has any. Undefined
- * when it keeps them, or when there is nothing to check.
+ * missing one named — and its postcode of its country's shape where that is
+ * known; and a table of lines or a repeating group as few lines as
+ * `options.min` and as many as `options.max`, once it has any. Undefined when
+ * it keeps them, or when there is nothing to check.
  */
 /** An address's parts, in the order its boxes and its messages name them. */
 export const ADDRESS_PARTS = ['street', 'line2', 'city', 'region', 'postcode', 'country'];
+/**
+ * A postcode's shape by its country, where it is known: how many digits, and
+ * one as the country writes it. Egypt's, Saudi Arabia's, Kuwait's and
+ * Jordan's have five; Bahrain's three or four; Oman's three. Others are not
+ * checked.
+ */
+const POSTCODES = {
+    EG: { least: 5, most: 5, example: '11511' },
+    SA: { least: 5, most: 5, example: '12271' },
+    KW: { least: 5, most: 5, example: '13001' },
+    JO: { least: 5, most: 5, example: '11118' },
+    BH: { least: 3, most: 4, example: '317' },
+    OM: { least: 3, most: 3, example: '112' },
+};
+/** A postcode as it is kept: digits in any script as 0-9, no direction marks, no spaces at its ends. */
+export const settledPostcode = (text) => foldDigits(stripMarks(text)).trim();
+/** Whether a postcode is of its country's shape: null when the country's shape is not known, or there is no postcode. */
+export function postcodeFits(country, postcode) {
+    const shape = typeof country === 'string' ? POSTCODES[country.toUpperCase()] : undefined;
+    if (!shape || typeof postcode !== 'string' || !postcode.trim())
+        return null;
+    const digits = settledPostcode(postcode);
+    return /^[0-9]+$/.test(digits) && digits.length >= shape.least && digits.length <= shape.most;
+}
+/** A country's name in a language, by its code: Egypt, مصر, Égypte, Ägypten. */
+function countryName(code, locale) {
+    try {
+        return new Intl.DisplayNames([locale], { type: 'region' }).of(code) ?? code;
+    }
+    catch {
+        return code;
+    }
+}
 export function checkStructure(field, node, value, messages) {
     const options = node.options ?? {};
     const label = node.label ?? field.label;
@@ -17,12 +52,19 @@ export function checkStructure(field, node, value, messages) {
         if (typeof options['max'] === 'number' && value.length > options['max'])
             return fill(messages.maxLines, { label, max: options['max'] });
     }
-    const needed = options['requiredParts'];
-    if (node.widget !== 'address' || !Array.isArray(needed) || !value || typeof value !== 'object' || Array.isArray(value))
+    const needed = Array.isArray(options['requiredParts']) ? options['requiredParts'] : [];
+    if (node.widget !== 'address' || !value || typeof value !== 'object' || Array.isArray(value))
         return undefined;
     const asked = Array.isArray(options['parts']) ? options['parts'] : ADDRESS_PARTS;
     const parts = value;
     const missing = ADDRESS_PARTS.findIndex((part) => needed.includes(part) && asked.includes(part) && !String(parts[part] ?? '').trim());
-    return missing < 0 ? undefined : fill(messages.required, { label: messages.addressParts.split('|')[missing] });
+    if (missing >= 0)
+        return fill(messages.required, { label: messages.addressParts.split('|')[missing] });
+    if (postcodeFits(parts['country'], parts['postcode']) !== false)
+        return undefined;
+    const country = String(parts['country']).toUpperCase();
+    const shape = POSTCODES[country];
+    const n = shape.least === shape.most ? shape.least : `${shape.least}–${shape.most}`;
+    return fill(messages.postcode, { label, country: countryName(country, messages.locale), n, example: shape.example });
 }
 //# sourceMappingURL=structures.mjs.map

package/src/lib/record/structures.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"structures.mjs","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/record/structures.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAiB,MAAM,YAAY,CAAC;AAGjD;;;;;;GAMG;AAEH,6EAA6E;AAC7E,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAEnG,MAAM,UAAU,cAAc,CAAC,KAAY,EAAE,IAAe,EAAE,KAAwB,EAAE,QAAkB;IACxG,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC;IACxC,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACtE,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxI,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1I,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzI,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IACjF,MAAM,KAAK,GAAG,KAAgC,CAAC;IAC/C,MAAM,OAAO,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtI,OAAO,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AACjH,CAAC"}
+{"version":3,"file":"structures.mjs","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/record/structures.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,IAAI,EAAiB,MAAM,YAAY,CAAC;AAGjD;;;;;;;GAOG;AAEH,6EAA6E;AAC7E,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,SAAS,GAAqE;IAClF,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE;IAC3C,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;IACzC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE;CAC1C,CAAC;AAEF,wGAAwG;AACxG,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAErF,yHAAyH;AACzH,MAAM,UAAU,YAAY,CAAC,OAAgB,EAAE,QAAiB;IAC9D,MAAM,KAAK,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACzF,IAAI,CAAC,KAAK,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;QAAE,OAAO,IAAI,CAAC;IAC5E,MAAM,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;IACzC,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC;AAChG,CAAC;AAED,gFAAgF;AAChF,SAAS,WAAW,CAAC,IAAY,EAAE,MAAc;IAC/C,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IAC9E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAY,EAAE,IAAe,EAAE,KAAwB,EAAE,QAAkB;IACxG,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC;IACxC,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACtE,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACxI,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC1I,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACvF,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC/G,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IACjF,MAAM,KAAK,GAAG,KAAgC,CAAC;IAC/C,MAAM,OAAO,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtI,IAAI,OAAO,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvG,IAAI,YAAY,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,KAAK,KAAK;QAAE,OAAO,SAAS,CAAC;IAClF,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACvD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IACjC,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;IACpF,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;AACvH,CAAC"}

package/src/lib/record/upload-to.d.mts

@@ -0,0 +1,50 @@
+import { type UploadedFile, type UploadFile, type UploadRequest } from './data-source.mjs';
+/**
+ * A data source's `upload` for a plain endpoint, written once: a POST of a
+ * form with the file in it, or a PUT of the file itself to an address the
+ * app's server signs for it (Azure Blob's SAS, S3's presigned URL). Through
+ * XMLHttpRequest in a browser, so its progress is told; through fetch where
+ * there is none. Core names no DOM types: the few it uses are read from the
+ * host, as far as this file needs them.
+ *
+ *   upload: uploadTo({ url: '/api/files', headers: { 'X-CSRF-Token': token } })
+ */
+/** Where one file goes, with headers of its own beside the options': a signed address's. */
+export interface UploadTarget {
+    url: string;
+    headers?: Record<string, string>;
+}
+/** The server's answer, for `link` to read the stored file's address from. */
+export interface UploadAnswer {
+    status: number;
+    /** The address the file was sent to. */
+    url: string;
+    /** The answer's body, as text. */
+    text: string;
+    /** The body read as JSON, or undefined when it is not JSON. */
+    json: unknown;
+    header(name: string): string | null;
+}
+type Maybe<T> = T | Promise<T>;
+export interface UploadToOptions {
+    /** Where each file goes: an address, or a function of the file and the request giving one — an address your server signs, say. */
+    url: string | ((file: UploadFile, request: UploadRequest) => Maybe<string | UploadTarget>);
+    /** POST, the usual, sends a form with the file under `field`; PUT sends the file itself as the body, as a signed address takes it. */
+    method?: 'POST' | 'PUT';
+    /** The form's field the file goes under, with POST: `file` unless said. */
+    field?: string;
+    /** Headers for every file: a token, say. Content-Type is the file's own with PUT, and the form's with POST. */
+    headers?: Record<string, string> | ((file: UploadFile, request: UploadRequest) => Maybe<Record<string, string>>);
+    /** Send the browser's cookies to another origin too. */
+    withCredentials?: boolean;
+    /**
+     * The stored file's address and id, from the answer. Without it: the JSON's
+     * `url` (or `location`) and its `fileId` (or `id`), else the Location
+     * header, else — for a PUT — the address it was put to, without its query
+     * (a signature is not a link to keep).
+     */
+    link?: (answer: UploadAnswer, file: UploadFile) => Maybe<Partial<UploadedFile>>;
+}
+/** An upload to a plain endpoint, for a data source: `{ ...source, upload: uploadTo({ url: '/api/files' }) }`. */
+export declare function uploadTo(options: UploadToOptions): (file: UploadFile, request: UploadRequest) => Promise<UploadedFile>;
+export {};

package/src/lib/record/upload-to.d.ts

@@ -0,0 +1,50 @@
+import { type UploadedFile, type UploadFile, type UploadRequest } from './data-source';
+/**
+ * A data source's `upload` for a plain endpoint, written once: a POST of a
+ * form with the file in it, or a PUT of the file itself to an address the
+ * app's server signs for it (Azure Blob's SAS, S3's presigned URL). Through
+ * XMLHttpRequest in a browser, so its progress is told; through fetch where
+ * there is none. Core names no DOM types: the few it uses are read from the
+ * host, as far as this file needs them.
+ *
+ *   upload: uploadTo({ url: '/api/files', headers: { 'X-CSRF-Token': token } })
+ */
+/** Where one file goes, with headers of its own beside the options': a signed address's. */
+export interface UploadTarget {
+    url: string;
+    headers?: Record<string, string>;
+}
+/** The server's answer, for `link` to read the stored file's address from. */
+export interface UploadAnswer {
+    status: number;
+    /** The address the file was sent to. */
+    url: string;
+    /** The answer's body, as text. */
+    text: string;
+    /** The body read as JSON, or undefined when it is not JSON. */
+    json: unknown;
+    header(name: string): string | null;
+}
+type Maybe<T> = T | Promise<T>;
+export interface UploadToOptions {
+    /** Where each file goes: an address, or a function of the file and the request giving one — an address your server signs, say. */
+    url: string | ((file: UploadFile, request: UploadRequest) => Maybe<string | UploadTarget>);
+    /** POST, the usual, sends a form with the file under `field`; PUT sends the file itself as the body, as a signed address takes it. */
+    method?: 'POST' | 'PUT';
+    /** The form's field the file goes under, with POST: `file` unless said. */
+    field?: string;
+    /** Headers for every file: a token, say. Content-Type is the file's own with PUT, and the form's with POST. */
+    headers?: Record<string, string> | ((file: UploadFile, request: UploadRequest) => Maybe<Record<string, string>>);
+    /** Send the browser's cookies to another origin too. */
+    withCredentials?: boolean;
+    /**
+     * The stored file's address and id, from the answer. Without it: the JSON's
+     * `url` (or `location`) and its `fileId` (or `id`), else the Location
+     * header, else — for a PUT — the address it was put to, without its query
+     * (a signature is not a link to keep).
+     */
+    link?: (answer: UploadAnswer, file: UploadFile) => Maybe<Partial<UploadedFile>>;
+}
+/** An upload to a plain endpoint, for a data source: `{ ...source, upload: uploadTo({ url: '/api/files' }) }`. */
+export declare function uploadTo(options: UploadToOptions): (file: UploadFile, request: UploadRequest) => Promise<UploadedFile>;
+export {};

package/src/lib/record/upload-to.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadTo = uploadTo;
+const data_source_1 = require("./data-source");
+/** The statuses that say the store will not keep this file, whatever is tried: its size, its kind, what it holds. */
+const REFUSALS = new Set([400, 409, 413, 415, 422]);
+const stopped = () => Object.assign(new Error('The upload was stopped'), { name: 'AbortError' });
+/** An upload to a plain endpoint, for a data source: `{ ...source, upload: uploadTo({ url: '/api/files' }) }`. */
+function uploadTo(options) {
+    const method = options.method ?? 'POST';
+    return async (file, request) => {
+        if (request.signal?.aborted)
+            throw stopped();
+        const host = globalThis;
+        const given = typeof options.url === 'function' ? await options.url(file, request) : options.url;
+        const target = typeof given === 'string' ? { url: given } : given;
+        const own = typeof options.headers === 'function' ? await options.headers(file, request) : (options.headers ?? {});
+        const headers = { ...own, ...target.headers };
+        // A file the browser picked is a Blob already; one held as bytes is made one.
+        const blob = file instanceof host.Blob ? file : new host.Blob([await file.arrayBuffer()], { type: file.type });
+        let body = blob;
+        if (method === 'PUT') {
+            if (!Object.keys(headers).some((name) => name.toLowerCase() === 'content-type'))
+                headers['Content-Type'] = file.type || 'application/octet-stream';
+        }
+        else {
+            const form = new host.FormData();
+            form.append(options.field ?? 'file', blob, file.name);
+            body = form;
+        }
+        const answer = await (host.XMLHttpRequest ? viaXhr : viaFetch)(host, { method, url: target.url, headers, body, file, request, withCredentials: options.withCredentials === true });
+        if (answer.status < 200 || answer.status >= 300) {
+            const said = wordsOf(answer);
+            if (REFUSALS.has(answer.status))
+                throw (0, data_source_1.saveRefused)({ kind: 'rule', message: said || `The store did not take ${file.name} (${answer.status})` });
+            throw new Error(said ? `${said} (${answer.status})` : `The store answered ${answer.status}`);
+        }
+        const linked = options.link ? await options.link(answer, file) : linkOf(answer, method, host);
+        if (!linked.url)
+            throw new Error(`The store's answer named no address for ${file.name}: give uploadTo a link() that reads it`);
+        return { url: linked.url, name: linked.name ?? file.name, size: linked.size ?? file.size, type: linked.type ?? file.type, ...(linked.fileId !== undefined ? { fileId: linked.fileId } : {}) };
+    };
+}
+function viaXhr(host, sending) {
+    const { request } = sending;
+    return new Promise((resolve, reject) => {
+        const xhr = new host.XMLHttpRequest();
+        const stop = () => xhr.abort();
+        const done = () => request.signal?.removeEventListener('abort', stop);
+        xhr.open(sending.method, sending.url);
+        for (const [name, value] of Object.entries(sending.headers))
+            xhr.setRequestHeader(name, value);
+        if (sending.withCredentials)
+            xhr.withCredentials = true;
+        xhr.upload.onprogress = (event) => request.onProgress?.(event.loaded, event.lengthComputable ? event.total : sending.file.size);
+        xhr.onload = () => (done(), resolve(answered(sending.url, xhr.status, xhr.responseText, (name) => xhr.getResponseHeader(name))));
+        // What fetch throws when the network fails: read as the network's problem.
+        xhr.onerror = () => (done(), reject(new TypeError('Failed to fetch: the network failed during the upload')));
+        xhr.onabort = () => (done(), reject(stopped()));
+        request.signal?.addEventListener('abort', stop);
+        xhr.send(sending.body);
+    });
+}
+async function viaFetch(host, sending) {
+    if (!host.fetch)
+        throw new Error('uploadTo needs XMLHttpRequest or fetch');
+    const response = await host.fetch(sending.url, {
+        method: sending.method,
+        headers: sending.headers,
+        body: sending.body,
+        ...(sending.request.signal ? { signal: sending.request.signal } : {}),
+        ...(sending.withCredentials ? { credentials: 'include' } : {}),
+    });
+    const text = await response.text();
+    // No progress on the way: the whole of it, once it is there.
+    sending.request.onProgress?.(sending.file.size, sending.file.size);
+    return answered(sending.url, response.status, text, (name) => response.headers.get(name));
+}
+function answered(url, status, text, header) {
+    let json;
+    try {
+        json = text ? JSON.parse(text) : undefined;
+    }
+    catch {
+        json = undefined;
+    }
+    return { status, url, text, json, header };
+}
+/** What a refusing server says, for the person: its JSON's message, or a short text. */
+function wordsOf(answer) {
+    const json = answer.json;
+    const said = json?.message ?? (typeof json?.error === 'object' ? json.error?.message : json?.error);
+    if (typeof said === 'string' && said.trim())
+        return said.trim();
+    const text = answer.text.trim();
+    return text && text.length <= 200 && !/^\s*</.test(text) && answer.json === undefined ? text : '';
+}
+/** The stored file's address as the answer gives it: JSON, Location, or where a PUT put it. */
+function linkOf(answer, method, host) {
+    const json = (answer.json && typeof answer.json === 'object' ? answer.json : {});
+    const id = json['fileId'] ?? json['id'];
+    const fileId = typeof id === 'string' || typeof id === 'number' ? id : undefined;
+    const said = json['url'] ?? json['location'];
+    const location = answer.header('location');
+    const url = typeof said === 'string' ? said : location ? against(location, answer.url, host) : method === 'PUT' ? answer.url.split('?')[0] : undefined;
+    return { ...(url ? { url } : {}), ...(fileId !== undefined ? { fileId } : {}) };
+}
+/** A Location read against the address the file was sent to. */
+function against(location, sentTo, host) {
+    try {
+        return new host.URL(location, new host.URL(sentTo, host.location?.href).href).href;
+    }
+    catch {
+        return location;
+    }
+}
+//# sourceMappingURL=upload-to.js.map

package/src/lib/record/upload-to.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-to.js","sourceRoot":"","sources":["../../../../../../libs/core/src/lib/record/upload-to.ts"],"names":[],"mappings":";;AAqFA,4BA6BC;AAlHD,+CAAoG;AAqDpG,qHAAqH;AACrH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AA4BpD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;AAEjG,kHAAkH;AAClH,SAAgB,QAAQ,CAAC,OAAwB;IAC/C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC;IACxC,OAAO,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;QAC7B,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO;YAAE,MAAM,OAAO,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,UAA6B,CAAC;QAC3C,MAAM,KAAK,GAAG,OAAO,OAAO,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC;QACjG,MAAM,MAAM,GAAiB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAChF,MAAM,GAAG,GAAG,OAAO,OAAO,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QACnH,MAAM,OAAO,GAA2B,EAAE,GAAG,GAAG,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QACtE,8EAA8E;QAC9E,MAAM,IAAI,GAAG,IAAI,YAAY,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/G,IAAI,IAAI,GAAY,IAAI,CAAC;QACzB,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC;gBAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,0BAA0B,CAAC;QACrJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACtD,IAAI,GAAG,IAAI,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC,CAAC;QACnL,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAC7B,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC;gBAAE,MAAM,IAAA,yBAAW,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,IAAI,0BAA0B,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;YAChJ,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,sBAAsB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC/F,CAAC;QACD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9F,IAAI,CAAC,MAAM,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,IAAI,CAAC,IAAI,wCAAwC,CAAC,CAAC;QAC/H,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAChM,CAAC,CAAC;AACJ,CAAC;AAYD,SAAS,MAAM,CAAC,IAAU,EAAE,OAAgB;IAC1C,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,IAAK,IAAI,CAAC,cAAsD,EAAE,CAAC;QAC/E,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACtE,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QACtC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC/F,IAAI,OAAO,CAAC,eAAe;YAAE,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC;QACxD,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChI,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACjI,2EAA2E;QAC3E,GAAG,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,IAAI,SAAS,CAAC,uDAAuD,CAAC,CAAC,CAAC,CAAC;QAC7G,GAAG,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAChD,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAChD,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,IAAU,EAAE,OAAgB;IAClD,IAAI,CAAC,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAC7C,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC/D,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACnC,6DAA6D;IAC7D,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnE,OAAO,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW,EAAE,MAAc,EAAE,IAAY,EAAE,MAAuC;IAClG,IAAI,IAAa,CAAC;IAClB,IAAI,CAAC;QACH,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,GAAG,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC7C,CAAC;AAED,wFAAwF;AACxF,SAAS,OAAO,CAAC,MAAoB;IACnC,MAAM,IAAI,GAAG,MAAM,CAAC,IAA0D,CAAC;IAC/E,MAAM,IAAI,GAAG,IAAI,EAAE,OAAO,IAAI,CAAC,OAAO,IAAI,EAAE,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAE,IAAI,CAAC,KAAsC,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IAChE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAChC,OAAO,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;AACpG,CAAC;AAED,+FAA+F;AAC/F,SAAS,MAAM,CAAC,MAAoB,EAAE,MAAc,EAAE,IAAU;IAC9D,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAA4B,CAAC;IAC5G,MAAM,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,OAAO,EAAE,KAAK,QAAQ,IAAI,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACjF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAC3C,MAAM,GAAG,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvJ,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AAClF,CAAC;AAED,gEAAgE;AAChE,SAAS,OAAO,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAU;IAC3D,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;IACrF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;AACH,CAAC"}

package/src/lib/record/upload-to.mjs

@@ -0,0 +1,114 @@
+import { saveRefused } from './data-source.mjs';
+/** The statuses that say the store will not keep this file, whatever is tried: its size, its kind, what it holds. */
+const REFUSALS = new Set([400, 409, 413, 415, 422]);
+const stopped = () => Object.assign(new Error('The upload was stopped'), { name: 'AbortError' });
+/** An upload to a plain endpoint, for a data source: `{ ...source, upload: uploadTo({ url: '/api/files' }) }`. */
+export function uploadTo(options) {
+    const method = options.method ?? 'POST';
+    return async (file, request) => {
+        if (request.signal?.aborted)
+            throw stopped();
+        const host = globalThis;
+        const given = typeof options.url === 'function' ? await options.url(file, request) : options.url;
+        const target = typeof given === 'string' ? { url: given } : given;
+        const own = typeof options.headers === 'function' ? await options.headers(file, request) : (options.headers ?? {});
+        const headers = { ...own, ...target.headers };
+        // A file the browser picked is a Blob already; one held as bytes is made one.
+        const blob = file instanceof host.Blob ? file : new host.Blob([await file.arrayBuffer()], { type: file.type });
+        let body = blob;
+        if (method === 'PUT') {
+            if (!Object.keys(headers).some((name) => name.toLowerCase() === 'content-type'))
+                headers['Content-Type'] = file.type || 'application/octet-stream';
+        }
+        else {
+            const form = new host.FormData();
+            form.append(options.field ?? 'file', blob, file.name);
+            body = form;
+        }
+        const answer = await (host.XMLHttpRequest ? viaXhr : viaFetch)(host, { method, url: target.url, headers, body, file, request, withCredentials: options.withCredentials === true });
+        if (answer.status < 200 || answer.status >= 300) {
+            const said = wordsOf(answer);
+            if (REFUSALS.has(answer.status))
+                throw saveRefused({ kind: 'rule', message: said || `The store did not take ${file.name} (${answer.status})` });
+            throw new Error(said ? `${said} (${answer.status})` : `The store answered ${answer.status}`);
+        }
+        const linked = options.link ? await options.link(answer, file) : linkOf(answer, method, host);
+        if (!linked.url)
+            throw new Error(`The store's answer named no address for ${file.name}: give uploadTo a link() that reads it`);
+        return { url: linked.url, name: linked.name ?? file.name, size: linked.size ?? file.size, type: linked.type ?? file.type, ...(linked.fileId !== undefined ? { fileId: linked.fileId } : {}) };
+    };
+}
+function viaXhr(host, sending) {
+    const { request } = sending;
+    return new Promise((resolve, reject) => {
+        const xhr = new host.XMLHttpRequest();
+        const stop = () => xhr.abort();
+        const done = () => request.signal?.removeEventListener('abort', stop);
+        xhr.open(sending.method, sending.url);
+        for (const [name, value] of Object.entries(sending.headers))
+            xhr.setRequestHeader(name, value);
+        if (sending.withCredentials)
+            xhr.withCredentials = true;
+        xhr.upload.onprogress = (event) => request.onProgress?.(event.loaded, event.lengthComputable ? event.total : sending.file.size);
+        xhr.onload = () => (done(), resolve(answered(sending.url, xhr.status, xhr.responseText, (name) => xhr.getResponseHeader(name))));
+        // What fetch throws when the network fails: read as the network's problem.
+        xhr.onerror = () => (done(), reject(new TypeError('Failed to fetch: the network failed during the upload')));
+        xhr.onabort = () => (done(), reject(stopped()));
+        request.signal?.addEventListener('abort', stop);
+        xhr.send(sending.body);
+    });
+}
+async function viaFetch(host, sending) {
+    if (!host.fetch)
+        throw new Error('uploadTo needs XMLHttpRequest or fetch');
+    const response = await host.fetch(sending.url, {
+        method: sending.method,
+        headers: sending.headers,
+        body: sending.body,
+        ...(sending.request.signal ? { signal: sending.request.signal } : {}),
+        ...(sending.withCredentials ? { credentials: 'include' } : {}),
+    });
+    const text = await response.text();
+    // No progress on the way: the whole of it, once it is there.
+    sending.request.onProgress?.(sending.file.size, sending.file.size);
+    return answered(sending.url, response.status, text, (name) => response.headers.get(name));
+}
+function answered(url, status, text, header) {
+    let json;
+    try {
+        json = text ? JSON.parse(text) : undefined;
+    }
+    catch {
+        json = undefined;
+    }
+    return { status, url, text, json, header };
+}
+/** What a refusing server says, for the person: its JSON's message, or a short text. */
+function wordsOf(answer) {
+    const json = answer.json;
+    const said = json?.message ?? (typeof json?.error === 'object' ? json.error?.message : json?.error);
+    if (typeof said === 'string' && said.trim())
+        return said.trim();
+    const text = answer.text.trim();
+    return text && text.length <= 200 && !/^\s*</.test(text) && answer.json === undefined ? text : '';
+}
+/** The stored file's address as the answer gives it: JSON, Location, or where a PUT put it. */
+function linkOf(answer, method, host) {
+    const json = (answer.json && typeof answer.json === 'object' ? answer.json : {});
+    const id = json['fileId'] ?? json['id'];
+    const fileId = typeof id === 'string' || typeof id === 'number' ? id : undefined;
+    const said = json['url'] ?? json['location'];
+    const location = answer.header('location');
+    const url = typeof said === 'string' ? said : location ? against(location, answer.url, host) : method === 'PUT' ? answer.url.split('?')[0] : undefined;
+    return { ...(url ? { url } : {}), ...(fileId !== undefined ? { fileId } : {}) };
+}
+/** A Location read against the address the file was sent to. */
+function against(location, sentTo, host) {
+    try {
+        return new host.URL(location, new host.URL(sentTo, host.location?.href).href).href;
+    }
+    catch {
+        return location;
+    }
+}
+//# sourceMappingURL=upload-to.mjs.map