@mailwoman/annotations 4.16.2 → 5.1.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.
- package/out/index.d.ts +7 -9
- package/out/index.d.ts.map +1 -1
- package/out/index.js +5 -6
- package/out/index.js.map +1 -1
- package/package.json +6 -6
package/out/index.d.ts
CHANGED
|
@@ -53,9 +53,8 @@ export interface Nuts {
|
|
|
53
53
|
level3?: string;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
* The native enrichment set. Every field is optional; an annotator fills the slice it owns.
|
|
57
|
-
*
|
|
58
|
-
* from.
|
|
56
|
+
* The native enrichment set. Every field is optional; an annotator fills the slice it owns. camelCase throughout,
|
|
57
|
+
* structured sub-objects — the internal representation the serializers map from.
|
|
59
58
|
*/
|
|
60
59
|
export interface AnnotationSet {
|
|
61
60
|
dms?: DMS;
|
|
@@ -97,10 +96,9 @@ export interface AnnotatorInput {
|
|
|
97
96
|
/** A unit of enrichment: takes a coordinate/place, returns the slice of the set it can fill. */
|
|
98
97
|
export type Annotator = (input: AnnotatorInput) => Partial<AnnotationSet> | Promise<Partial<AnnotationSet>>;
|
|
99
98
|
/**
|
|
100
|
-
* Compose a set of annotators into a single runner. Calling the returned function runs all
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
* enrichment never sinks the rest.
|
|
99
|
+
* Compose a set of annotators into a single runner. Calling the returned function runs all annotators (concurrently)
|
|
100
|
+
* over one input and merges their results into one {@link AnnotationSet}. Later annotators win on key collisions. An
|
|
101
|
+
* annotator that throws is skipped, so one failing enrichment never sinks the rest.
|
|
104
102
|
*/
|
|
105
103
|
export declare function composeAnnotators(annotators: Annotator[]): (input: AnnotatorInput) => Promise<AnnotationSet>;
|
|
106
104
|
/** OpenCage's `annotations` block, keyed and cased as OpenCage documents it. */
|
|
@@ -154,8 +152,8 @@ export interface OpenCageAnnotations {
|
|
|
154
152
|
};
|
|
155
153
|
}
|
|
156
154
|
/**
|
|
157
|
-
* Serialize the native set to OpenCage's `annotations` key names + casing, for the compat APIs.
|
|
158
|
-
*
|
|
155
|
+
* Serialize the native set to OpenCage's `annotations` key names + casing, for the compat APIs. Only the populated
|
|
156
|
+
* fields are emitted.
|
|
159
157
|
*/
|
|
160
158
|
export declare function toOpenCage(set: AnnotationSet): OpenCageAnnotations;
|
|
161
159
|
/** Return the native set (the stable public native shape). */
|
package/out/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,yCAAyC;AACzC,MAAM,WAAW,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACX;AAED,2CAA2C;AAC3C,MAAM,WAAW,QAAQ;IACxB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACT;AAED,yBAAyB;AACzB,MAAM,WAAW,YAAY;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAED,sCAAsC;AACtC,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,mEAAmE;AACnE,MAAM,WAAW,QAAQ;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED,+CAA+C;AAC/C,MAAM,WAAW,OAAO;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,wCAAwC;AACxC,MAAM,WAAW,IAAI;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAED
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,yCAAyC;AACzC,MAAM,WAAW,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACX;AAED,2CAA2C;AAC3C,MAAM,WAAW,QAAQ;IACxB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACT;AAED,yBAAyB;AACzB,MAAM,WAAW,YAAY;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAED,sCAAsC;AACtC,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,mEAAmE;AACnE,MAAM,WAAW,QAAQ;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;CACb;AAED,+CAA+C;AAC/C,MAAM,WAAW,OAAO;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,wCAAwC;AACxC,MAAM,WAAW,IAAI;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,QAAQ,CAAA;IACd,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sBAAsB;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,sGAAsG;AACtG,MAAM,WAAW,cAAc;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,oFAAoF;IACpF,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,mGAAmG;IACnG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kGAAkG;IAClG,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,oGAAoG;IACpG,IAAI,CAAC,EAAE,IAAI,CAAA;CACX;AAED,gGAAgG;AAChG,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAA;AAE3G;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,aAAa,CAAC,CAc5G;AAED,gFAAgF;AAChF,MAAM,WAAW,mBAAmB;IACnC,GAAG,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAA;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACnC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;IACrE,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACxE,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,KAAK,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,KAAK,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,KAAK,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;IACjH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAC1B;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,aAAa,GAAG,mBAAmB,CA4DlE;AAED,8DAA8D;AAC9D,wBAAgB,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,CAE1D"}
|
package/out/index.js
CHANGED
|
@@ -13,10 +13,9 @@
|
|
|
13
13
|
* own shape. One schema, two serializers (the hybrid decision).
|
|
14
14
|
*/
|
|
15
15
|
/**
|
|
16
|
-
* Compose a set of annotators into a single runner. Calling the returned function runs all
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* enrichment never sinks the rest.
|
|
16
|
+
* Compose a set of annotators into a single runner. Calling the returned function runs all annotators (concurrently)
|
|
17
|
+
* over one input and merges their results into one {@link AnnotationSet}. Later annotators win on key collisions. An
|
|
18
|
+
* annotator that throws is skipped, so one failing enrichment never sinks the rest.
|
|
20
19
|
*/
|
|
21
20
|
export function composeAnnotators(annotators) {
|
|
22
21
|
return async (input) => {
|
|
@@ -32,8 +31,8 @@ export function composeAnnotators(annotators) {
|
|
|
32
31
|
};
|
|
33
32
|
}
|
|
34
33
|
/**
|
|
35
|
-
* Serialize the native set to OpenCage's `annotations` key names + casing, for the compat APIs.
|
|
36
|
-
*
|
|
34
|
+
* Serialize the native set to OpenCage's `annotations` key names + casing, for the compat APIs. Only the populated
|
|
35
|
+
* fields are emitted.
|
|
37
36
|
*/
|
|
38
37
|
export function toOpenCage(set) {
|
|
39
38
|
const out = {};
|
package/out/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AA+FH;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAuB;IACxD,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE;QACtB,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAmC,EAAE;YAClE,IAAI,CAAC;gBACJ,OAAO,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO,EAAE,CAAA;YACV,CAAC;QACF,CAAC,CAAC,CACF,CAAA;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,KAAK,CAAkB,CAAA;IACpD,CAAC,CAAA;AACF,CAAC;AAqBD;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,GAAkB;IAC5C,MAAM,GAAG,GAAwB,EAAE,CAAA;IAEnC,IAAI,GAAG,CAAC,GAAG;QAAE,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;IAE7D,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI;QAAE,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;IAEzC,IAAI,GAAG,CAAC,UAAU,IAAI,IAAI;QAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAA;IAE3D,IAAI,GAAG,CAAC,QAAQ;QAAE,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;IAEzE,IAAI,GAAG,CAAC,OAAO,IAAI,IAAI;QAAE,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAA;IAElD,IAAI,GAAG,CAAC,YAAY,IAAI,IAAI;QAAE,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,YAAY,CAAA;IAE1D,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;QACb,GAAG,CAAC,GAAG,GAAG,EAAE,CAAA;QAEZ,IAAI,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,IAAI;YAAE,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;QAEnE,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI;YAAE,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;IACjE,CAAC;IAED,IAAI,GAAG,CAAC,WAAW,IAAI,IAAI;QAAE,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAA;IAE9D,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QAClB,GAAG,CAAC,QAAQ,GAAG,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;QAEjD,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,IAAI;YAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAA;QAEpE,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI;YAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAA;IAC3E,CAAC;IAED,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI;QAAE,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;IAEzC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QAClB,GAAG,CAAC,QAAQ,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;QAE1C,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,IAAI;YAAE,GAAG,CAAC,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAA;QAEpF,IAAI,GAAG,CAAC,QAAQ,CAAC,YAAY,IAAI,IAAI;YAAE,GAAG,CAAC,QAAQ,CAAC,aAAa,GAAG,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAA;IAC9F,CAAC;IAED,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QACd,GAAG,CAAC,IAAI,GAAG,EAAE,CAAA;QAEb,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAA;QAEvE,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAA;QAEvE,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI;YAAE,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAA;IACxE,CAAC;IAED,IAAI,GAAG,CAAC,QAAQ,IAAI,IAAI;QAAE,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAA;IAEtD,IAAI,GAAG,CAAC,QAAQ,IAAI,IAAI;QAAE,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAA;IAErD,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI;QAAE,GAAG,CAAC,IAAI,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,EAAE,CAAA;IAErD,OAAO,GAAG,CAAA;AACX,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,QAAQ,CAAC,GAAkB;IAC1C,OAAO,GAAG,CAAA;AACX,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mailwoman/annotations",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.1.0",
|
|
4
4
|
"description": "The annotations composer — a native typed AnnotationSet, the Annotator interface, and OpenCage/native serializers. Each recipe package (timezone, un-locode, coordinate formats, country reference) implements Annotator; this composes them into the block the drop-in APIs return.",
|
|
5
5
|
"license": "AGPL-3.0-only",
|
|
6
6
|
"repository": {
|
|
@@ -8,11 +8,6 @@
|
|
|
8
8
|
"url": "https://github.com/sister-software/mailwoman.git",
|
|
9
9
|
"directory": "annotations"
|
|
10
10
|
},
|
|
11
|
-
"type": "module",
|
|
12
|
-
"exports": {
|
|
13
|
-
"./package.json": "./package.json",
|
|
14
|
-
".": "./out/index.js"
|
|
15
|
-
},
|
|
16
11
|
"files": [
|
|
17
12
|
"out/**/*.js",
|
|
18
13
|
"out/**/*.js.map",
|
|
@@ -20,6 +15,11 @@
|
|
|
20
15
|
"out/**/*.d.ts.map",
|
|
21
16
|
"README.md"
|
|
22
17
|
],
|
|
18
|
+
"type": "module",
|
|
19
|
+
"exports": {
|
|
20
|
+
"./package.json": "./package.json",
|
|
21
|
+
".": "./out/index.js"
|
|
22
|
+
},
|
|
23
23
|
"publishConfig": {
|
|
24
24
|
"access": "public"
|
|
25
25
|
}
|