@terascope/data-types 2.15.0 → 2.16.0

package/dist/src/types/v1/keyword.d.ts

@@ -1,6 +1,26 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * An exact-match string stored as an Elasticsearch/OpenSearch `keyword`. The
+ * value is indexed verbatim (not analyzed), so it is suited to filtering,
+ * sorting, and aggregations rather than full-text search.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'keyword' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `String`, except when the field is named `_key`, which maps
+ *   to the `ID` scalar so it can serve as a record's identity.
+ * - **xLucene:** `String`.
+ *
+ * Use `Text` when you need analyzed full-text search, or one of the
+ * `Keyword*` analyzer variants for case-insensitive / tokenized matching.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { status: { type: 'Keyword' } }
+ * };
+ */
 export default class Keyword extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/keyword.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keyword.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/keyword.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAOxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"keyword.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/keyword.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAOxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/keyword.js

@@ -1,5 +1,25 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * An exact-match string stored as an Elasticsearch/OpenSearch `keyword`. The
+ * value is indexed verbatim (not analyzed), so it is suited to filtering,
+ * sorting, and aggregations rather than full-text search.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'keyword' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `String`, except when the field is named `_key`, which maps
+ *   to the `ID` scalar so it can serve as a record's identity.
+ * - **xLucene:** `String`.
+ *
+ * Use `Text` when you need analyzed full-text search, or one of the
+ * `Keyword*` analyzer variants for case-insensitive / tokenized matching.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { status: { type: 'Keyword' } }
+ * };
+ */
 export default class Keyword extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/keyword.js.map

@@ -1 +1 @@
-{"version":3,"file":"keyword.js","sourceRoot":"","sources":["../../../../src/types/v1/keyword.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,SAAwB,EAAE,CAAC;QAEjE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}
+{"version":3,"file":"keyword.js","sourceRoot":"","sources":["../../../../src/types/v1/keyword.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,SAAwB,EAAE,CAAC;QAEjE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}

package/dist/src/types/v1/long.d.ts

@@ -1,6 +1,25 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A whole number stored as an Elasticsearch/OpenSearch `long`
+ * (64-bit signed integer).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'long' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`, **not** `Int`. The GraphQL `Int` scalar is only
+ *   32-bit, so it cannot represent the full `long` range; `Float` is used to
+ *   avoid overflow. Note that IEEE-754 doubles lose integer precision above
+ *   2^53, so very large `long` values may not round-trip exactly through
+ *   GraphQL.
+ * - **xLucene:** `Integer`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { bytes_transferred: { type: 'Long' } }
+ * };
+ */
 export default class Long extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/long.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"long.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/long.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"long.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/long.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/long.js

@@ -1,5 +1,24 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A whole number stored as an Elasticsearch/OpenSearch `long`
+ * (64-bit signed integer).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'long' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`, **not** `Int`. The GraphQL `Int` scalar is only
+ *   32-bit, so it cannot represent the full `long` range; `Float` is used to
+ *   avoid overflow. Note that IEEE-754 doubles lose integer precision above
+ *   2^53, so very large `long` values may not round-trip exactly through
+ *   GraphQL.
+ * - **xLucene:** `Integer`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { bytes_transferred: { type: 'Long' } }
+ * };
+ */
 export default class Long extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/long.js.map

@@ -1 +1 @@
-{"version":3,"file":"long.js","sourceRoot":"","sources":["../../../../src/types/v1/long.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,MAAqB,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC;CACJ"}
+{"version":3,"file":"long.js","sourceRoot":"","sources":["../../../../src/types/v1/long.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,MAAqB,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC;CACJ"}

package/dist/src/types/v1/ngram-tokens.d.ts

@@ -1,6 +1,27 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A keyword that supports substring matching via n-grams. The base value is
+ * an exact `keyword`, and a `tokens` sub-field is analyzed with a custom
+ * `ngram_analyzer` that emits fixed 3-character n-grams over digits only.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'keyword', fields: { tokens: { type:
+ *   'text', analyzer: 'ngram_analyzer' } } }`, plus the custom `analyzer`
+ *   (`ngram_analyzer`) and `tokenizer` (`ngram_tokenizer`, type `ngram`,
+ *   `min_gram: 3`, `max_gram: 3`, `token_chars: ['digit']`) definitions.
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * The tokenizer only grams digit characters, so this is aimed at numeric
+ * strings (e.g. phone numbers, account numbers) rather than arbitrary text.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { phone: { type: 'NgramTokens' } }
+ * };
+ */
 export default class NgramTokens extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/ngram-tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ngram-tokens.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/ngram-tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW,IAAI,aAAa;IA8B5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"ngram-tokens.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/ngram-tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW,IAAI,aAAa;IA8B5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/ngram-tokens.js

@@ -1,5 +1,26 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A keyword that supports substring matching via n-grams. The base value is
+ * an exact `keyword`, and a `tokens` sub-field is analyzed with a custom
+ * `ngram_analyzer` that emits fixed 3-character n-grams over digits only.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'keyword', fields: { tokens: { type:
+ *   'text', analyzer: 'ngram_analyzer' } } }`, plus the custom `analyzer`
+ *   (`ngram_analyzer`) and `tokenizer` (`ngram_tokenizer`, type `ngram`,
+ *   `min_gram: 3`, `max_gram: 3`, `token_chars: ['digit']`) definitions.
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * The tokenizer only grams digit characters, so this is aimed at numeric
+ * strings (e.g. phone numbers, account numbers) rather than arbitrary text.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { phone: { type: 'NgramTokens' } }
+ * };
+ */
 export default class NgramTokens extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/ngram-tokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"ngram-tokens.js","sourceRoot":"","sources":["../../../../src/types/v1/ngram-tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAkC,MAAM,kBAAkB,CAAC;AACpF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,SAAwB;oBAC9B,MAAM,EAAE;wBACJ,MAAM,EAAE;4BACJ,IAAI,EAAE,MAAqB;4BAC3B,QAAQ,EAAE,gBAAgB;yBAC7B;qBACJ;iBACJ;aACJ;YACD,QAAQ,EAAE;gBACN,cAAc,EAAE;oBACZ,SAAS,EAAE,iBAAiB;iBAC/B;aACJ;YACD,SAAS,EAAE;gBACP,eAAe,EAAE;oBACb,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,CAAC;oBACX,QAAQ,EAAE,CAAC;oBACX,WAAW,EAAE,CAAC,OAAO,CAAC;iBACzB;aACJ;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}
+{"version":3,"file":"ngram-tokens.js","sourceRoot":"","sources":["../../../../src/types/v1/ngram-tokens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAkC,MAAM,kBAAkB,CAAC;AACpF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,SAAwB;oBAC9B,MAAM,EAAE;wBACJ,MAAM,EAAE;4BACJ,IAAI,EAAE,MAAqB;4BAC3B,QAAQ,EAAE,gBAAgB;yBAC7B;qBACJ;iBACJ;aACJ;YACD,QAAQ,EAAE;gBACN,cAAc,EAAE;oBACZ,SAAS,EAAE,iBAAiB;iBAC/B;aACJ;YACD,SAAS,EAAE;gBACP,eAAe,EAAE;oBACb,IAAI,EAAE,OAAO;oBACb,QAAQ,EAAE,CAAC;oBACX,QAAQ,EAAE,CAAC;oBACX,WAAW,EAAE,CAAC,OAAO,CAAC;iBACzB;aACJ;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}

package/dist/src/types/v1/number.d.ts

@@ -1,6 +1,26 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A general-purpose numeric field for when the exact numeric width is not
+ * important. Stored as an Elasticsearch/OpenSearch `double`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'double' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`. Because the value is a `double`, integers above
+ *   2^53 may lose precision when round-tripped through GraphQL.
+ * - **xLucene:** `Number` (a distribution-agnostic numeric type, unlike the
+ *   more specific `Integer`/`Float` used by the fixed-width numeric types).
+ *
+ * Prefer a specific numeric type (`Integer`, `Long`, `Float`, `Double`) when
+ * you know the width and want a tighter ES mapping.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { score: { type: 'Number' } }
+ * };
+ */
 export default class NumberClass extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/number.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/number.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/number.js

@@ -1,5 +1,25 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A general-purpose numeric field for when the exact numeric width is not
+ * important. Stored as an Elasticsearch/OpenSearch `double`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'double' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`. Because the value is a `double`, integers above
+ *   2^53 may lose precision when round-tripped through GraphQL.
+ * - **xLucene:** `Number` (a distribution-agnostic numeric type, unlike the
+ *   more specific `Integer`/`Float` used by the fixed-width numeric types).
+ *
+ * Prefer a specific numeric type (`Integer`, `Long`, `Float`, `Double`) when
+ * you know the width and want a tighter ES mapping.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { score: { type: 'Number' } }
+ * };
+ */
 export default class NumberClass extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/number.js.map

@@ -1 +1 @@
-{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../../src/types/v1/number.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,QAAuB,EAAE,CAAC;QAEhE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../../../src/types/v1/number.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,QAAuB,EAAE,CAAC;QAEhE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}

package/dist/src/types/v1/object.d.ts

@@ -1,6 +1,24 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A nested JSON object.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'object' }`, or `{ type: 'nested' }`
+ *   when `array: true`. The `nested` type preserves the independence of each
+ *   array element for querying (an `object` array flattens its values). When
+ *   `indexed: false` the object is disabled via `enabled: false` (not
+ *   `index: false`).
+ * - **GraphQL:** a `JSONObject` custom scalar (the `scalar JSONObject`
+ *   definition is emitted alongside the field).
+ * - **xLucene:** `Object`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { metadata: { type: 'Object' } }
+ * };
+ */
 export default class ObjectType extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACtF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW,IAAI,aAAa;IAa5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmC,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACtF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW,IAAI,aAAa;IAa5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/object.js

@@ -1,5 +1,23 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A nested JSON object.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'object' }`, or `{ type: 'nested' }`
+ *   when `array: true`. The `nested` type preserves the independence of each
+ *   array element for querying (an `object` array flattens its values). When
+ *   `indexed: false` the object is disabled via `enabled: false` (not
+ *   `index: false`).
+ * - **GraphQL:** a `JSONObject` custom scalar (the `scalar JSONObject`
+ *   definition is emitted alongside the field).
+ * - **xLucene:** `Object`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { metadata: { type: 'Object' } }
+ * };
+ */
 export default class ObjectType extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/object.js.map

@@ -1 +1 @@
-{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../../src/types/v1/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAoC,MAAM,kBAAkB,CAAC;AACtF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QACrD,MAAM,UAAU,GAAkB,EAAE,IAAI,EAAE,CAAC;QAE3C,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAChC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;QAC/B,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC;IACrD,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC;IAC9D,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}
+{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../../src/types/v1/object.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAoC,MAAM,kBAAkB,CAAC;AACtF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;QACrD,MAAM,UAAU,GAAkB,EAAE,IAAI,EAAE,CAAC;QAE3C,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAChC,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;QAC/B,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,EAAE,CAAC;IACrD,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC;IAC9D,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}

package/dist/src/types/v1/short.d.ts

@@ -1,6 +1,23 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A whole number stored as an Elasticsearch/OpenSearch `short`
+ * (16-bit signed integer, -32,768 to 32,767).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'short' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Int`.
+ * - **xLucene:** `Integer`.
+ *
+ * Use `Integer` or `Long` for values outside the 16-bit range.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { port_offset: { type: 'Short' } }
+ * };
+ */
 export default class Short extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/short.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"short.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/short.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,QAAQ;IACvC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"short.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/short.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,QAAQ;IACvC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/short.js

@@ -1,5 +1,22 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A whole number stored as an Elasticsearch/OpenSearch `short`
+ * (16-bit signed integer, -32,768 to 32,767).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'short' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Int`.
+ * - **xLucene:** `Integer`.
+ *
+ * Use `Integer` or `Long` for values outside the 16-bit range.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { port_offset: { type: 'Short' } }
+ * };
+ */
 export default class Short extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/short.js.map

@@ -1 +1 @@
-{"version":3,"file":"short.js","sourceRoot":"","sources":["../../../../src/types/v1/short.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,QAAQ;IACvC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,OAAsB,EAAE,CAAC;QAE/D,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC;CACJ"}
+{"version":3,"file":"short.js","sourceRoot":"","sources":["../../../../src/types/v1/short.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,QAAQ;IACvC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,OAAsB,EAAE,CAAC;QAE/D,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC;CACJ"}

package/dist/src/types/v1/string.d.ts

@@ -1,6 +1,25 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A general-purpose string. Behaves like {@link Keyword} — the value is
+ * stored as an Elasticsearch/OpenSearch `keyword` (exact match, not
+ * analyzed) — but always maps to the GraphQL `String` scalar, with no special
+ * handling for `_key`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'keyword' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * Reach for `Text` when you need analyzed full-text search.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { name: { type: 'String' } }
+ * };
+ */
 export default class StringClass extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/string.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/string.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/string.js

@@ -1,5 +1,24 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A general-purpose string. Behaves like {@link Keyword} — the value is
+ * stored as an Elasticsearch/OpenSearch `keyword` (exact match, not
+ * analyzed) — but always maps to the GraphQL `String` scalar, with no special
+ * handling for `_key`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'keyword' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * Reach for `Text` when you need analyzed full-text search.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { name: { type: 'String' } }
+ * };
+ */
 export default class StringClass extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/string.js.map

@@ -1 +1 @@
-{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../src/types/v1/string.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,SAAwB,EAAE,CAAC;QAEjE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}
+{"version":3,"file":"string.js","sourceRoot":"","sources":["../../../../src/types/v1/string.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,QAAQ;IAC7C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,SAAwB,EAAE,CAAC;QAEjE,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}

package/dist/src/types/v1/text.d.ts

@@ -1,6 +1,23 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A full-text string stored as an Elasticsearch/OpenSearch `text` field. The
+ * value is passed through the standard analyzer (tokenized, lowercased), so
+ * it supports full-text search but is **not** suited to exact-match filtering,
+ * sorting, or aggregations — use `Keyword` for those.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'text' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { description: { type: 'Text' } }
+ * };
+ */
 export default class Text extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/text.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/text.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/text.js

@@ -1,5 +1,22 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A full-text string stored as an Elasticsearch/OpenSearch `text` field. The
+ * value is passed through the standard analyzer (tokenized, lowercased), so
+ * it supports full-text search but is **not** suited to exact-match filtering,
+ * sorting, or aggregations — use `Keyword` for those.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'text' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { description: { type: 'Text' } }
+ * };
+ */
 export default class Text extends BaseType {
     toESMapping() {
         this._validateESMapping();

package/dist/src/types/v1/text.js.map

@@ -1 +1 @@
-{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../../src/types/v1/text.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,MAAqB,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../../../src/types/v1/text.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,QAAQ;IACtC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,MAAqB,EAAE,CAAC;QAE9D,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QAExD,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,CAAC;IACrD,CAAC;CACJ"}

package/dist/src/types/v1/vector.d.ts

@@ -1,6 +1,44 @@
 import { xLuceneTypeConfig, ClientMetadata } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A dense numeric vector for k-NN / similarity search, stored as an
+ * OpenSearch `knn_vector`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'knn_vector', dimension, method: {
+ *   name, engine } }` plus a `settings` block enabling `index.knn: true`. The
+ *   `space_type` is placed at the top level for OpenSearch major version >= 3
+ *   and inside `method` for earlier versions.
+ * - **GraphQL:** `Float`.
+ * - **xLucene:** `Float`.
+ *
+ * Relevant `DataTypeFieldConfig` options:
+ * - `array` — **required**; a vector must be declared as an array.
+ * - `dimension` — **required**; must be an integer (the vector length).
+ * - `space_type` — distance metric; one of `l1`, `l2` (default), `linf`,
+ *   `cosinesimil`, `innerproduct`, `hamming`, `hammingbit`.
+ * - `name` — algorithm; `hnsw` (default) or `ivf`.
+ * - `engine` — `faiss` (default) or `lucene`.
+ *
+ * Validation (throws from `toESMapping`):
+ * - OpenSearch < 2.10 is unsupported.
+ * - `array` must be `true`, `dimension` must be an integer, and `space_type`,
+ *   `name`, and `engine` must each be valid.
+ * - `engine: 'lucene'` cannot be paired with `name: 'ivf'`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: {
+ *         embedding: {
+ *             type: 'Vector',
+ *             array: true,
+ *             dimension: 768,
+ *             space_type: 'cosinesimil'
+ *         }
+ *     }
+ * };
+ */
 export default class VectorType extends BaseType {
     toESMapping(config: ClientMetadata): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/vector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/vector.ts"],"names":[],"mappings":"AAAA,OAAO,EACe,iBAAiB,EAAE,cAAc,EAEtD,MAAM,kBAAkB,CAAC;AAE1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,aAAa;IA0ElD,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/vector.ts"],"names":[],"mappings":"AAAA,OAAO,EACe,iBAAiB,EAAE,cAAc,EAEtD,MAAM,kBAAkB,CAAC;AAE1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,aAAa;IA0ElD,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/vector.js

@@ -1,6 +1,44 @@
 import { xLuceneFieldType, ElasticsearchDistribution } from '@terascope/types';
 import { isInteger, isString } from '@terascope/core-utils';
 import BaseType from '../base-type.js';
+/**
+ * A dense numeric vector for k-NN / similarity search, stored as an
+ * OpenSearch `knn_vector`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'knn_vector', dimension, method: {
+ *   name, engine } }` plus a `settings` block enabling `index.knn: true`. The
+ *   `space_type` is placed at the top level for OpenSearch major version >= 3
+ *   and inside `method` for earlier versions.
+ * - **GraphQL:** `Float`.
+ * - **xLucene:** `Float`.
+ *
+ * Relevant `DataTypeFieldConfig` options:
+ * - `array` — **required**; a vector must be declared as an array.
+ * - `dimension` — **required**; must be an integer (the vector length).
+ * - `space_type` — distance metric; one of `l1`, `l2` (default), `linf`,
+ *   `cosinesimil`, `innerproduct`, `hamming`, `hammingbit`.
+ * - `name` — algorithm; `hnsw` (default) or `ivf`.
+ * - `engine` — `faiss` (default) or `lucene`.
+ *
+ * Validation (throws from `toESMapping`):
+ * - OpenSearch < 2.10 is unsupported.
+ * - `array` must be `true`, `dimension` must be an integer, and `space_type`,
+ *   `name`, and `engine` must each be valid.
+ * - `engine: 'lucene'` cannot be paired with `name: 'ivf'`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: {
+ *         embedding: {
+ *             type: 'Vector',
+ *             array: true,
+ *             dimension: 768,
+ *             space_type: 'cosinesimil'
+ *         }
+ *     }
+ * };
+ */
 export default class VectorType extends BaseType {
     toESMapping(config) {
         this._validateESMapping();

package/dist/src/types/v1/vector.js.map

@@ -1 +1 @@
-{"version":3,"file":"vector.js","sourceRoot":"","sources":["../../../../src/types/v1/vector.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,yBAAyB,EAC5B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW,CAAC,MAAsB;QAC9B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;QAC5D,MAAM,EAAE,SAAS,EAAE,UAAU,GAAG,IAAI,EAAE,IAAI,GAAG,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAEtF,IAAI,YAAY,KAAK,yBAAyB,CAAC,UAAU,EAAE,CAAC;YACxD,IAAI,YAAY,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,IAAI,YAAY,GAAG,EAAE,CAAC,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;YAC1F,CAAC;QACL,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,mDAAmD,CAAC,CAAC;QACtF,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,wCAAwC,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,yDAAyD,CAAC,CAAC;QAC5F,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,sCAAsC,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,MAAM,KAAK,QAAQ,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,2EAA2E,CAAC,CAAC;QAC9G,CAAC;QAED,IAAI,OAEH,CAAC;QAEF,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,GAAG;gBACN,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,YAAY;oBAClB,UAAU;oBACV,SAAS;oBACT,MAAM,EAAE;wBACJ,IAAI;wBACJ,MAAM;qBACT;iBACJ;aACJ,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,OAAO,GAAG;gBACN,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,YAAY;oBAClB,SAAS;oBACT,MAAM,EAAE;wBACJ,UAAU;wBACV,IAAI;wBACJ,MAAM;qBACT;iBACJ;aACJ,CAAC;QACN,CAAC;QAED,OAAO;YACH,OAAO;YACP,QAAQ,EAAE;gBACN,WAAW,EAAE,IAAI;aACpB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;CACJ;AAED,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;AAElG,SAAS,gBAAgB,CAAC,IAAc;IACpC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/D,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAE1C,SAAS,aAAa,CAAC,MAAe;IAClC,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IACpE,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEzC,SAAS,eAAe,CAAC,IAAa;IAClC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnE,OAAO,KAAK,CAAC;AACjB,CAAC"}
+{"version":3,"file":"vector.js","sourceRoot":"","sources":["../../../../src/types/v1/vector.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,yBAAyB,EAC5B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW,CAAC,MAAsB;QAC9B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;QAC5D,MAAM,EAAE,SAAS,EAAE,UAAU,GAAG,IAAI,EAAE,IAAI,GAAG,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAEtF,IAAI,YAAY,KAAK,yBAAyB,CAAC,UAAU,EAAE,CAAC;YACxD,IAAI,YAAY,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,IAAI,YAAY,GAAG,EAAE,CAAC,EAAE,CAAC;gBAClE,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;YAC1F,CAAC;QACL,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,mDAAmD,CAAC,CAAC;QACtF,CAAC;QAED,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,wCAAwC,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,yDAAyD,CAAC,CAAC;QAC5F,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,sCAAsC,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,MAAM,KAAK,QAAQ,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,2EAA2E,CAAC,CAAC;QAC9G,CAAC;QAED,IAAI,OAEH,CAAC;QAEF,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,GAAG;gBACN,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,YAAY;oBAClB,UAAU;oBACV,SAAS;oBACT,MAAM,EAAE;wBACJ,IAAI;wBACJ,MAAM;qBACT;iBACJ;aACJ,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,OAAO,GAAG;gBACN,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,YAAY;oBAClB,SAAS;oBACT,MAAM,EAAE;wBACJ,UAAU;wBACV,IAAI;wBACJ,MAAM;qBACT;iBACJ;aACJ,CAAC;QACN,CAAC;QAED,OAAO;YACH,OAAO;YACP,QAAQ,EAAE;gBACN,WAAW,EAAE,IAAI;aACpB;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;CACJ;AAED,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;AAElG,SAAS,gBAAgB,CAAC,IAAc;IACpC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/D,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,aAAa,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAE1C,SAAS,aAAa,CAAC,MAAe;IAClC,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IACpE,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAEzC,SAAS,eAAe,CAAC,IAAa;IAClC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACnE,OAAO,KAAK,CAAC;AACjB,CAAC"}