@terascope/data-types 2.15.0 → 2.16.0

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

@@ -1,6 +1,30 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A Base64-encoded binary value stored as an Elasticsearch/OpenSearch
+ * `binary` field.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'binary', doc_values: false }`.
+ *   `doc_values` is always forced off because binary fields are not
+ *   searchable and can be very large. Honors `indexed: false` (emitted as
+ *   `index: false`).
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * Because it is neither indexed for search nor stored as doc values, a
+ * `Binary` field is opaque storage — you can retrieve it by `_source` but
+ * cannot filter, sort, or aggregate on it. This can be useful to store
+ * small files (thumbnails, audio, scripts, cryptographic keys, bit vectors)
+ * that can be filtered, sorted, and aggregated by metadata fields stored
+ * on the same record.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { thumbnail: { type: 'Binary' } }
+ * };
+ */
 export default class BinaryType extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"binary.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/binary.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,UAAW,SAAQ,QAAQ;IAC5C,WAAW,IAAI,aAAa;IAiB5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"binary.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/binary.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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,WAAW,IAAI,aAAa;IAiB5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

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

@@ -1,5 +1,29 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A Base64-encoded binary value stored as an Elasticsearch/OpenSearch
+ * `binary` field.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'binary', doc_values: false }`.
+ *   `doc_values` is always forced off because binary fields are not
+ *   searchable and can be very large. Honors `indexed: false` (emitted as
+ *   `index: false`).
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `String`.
+ *
+ * Because it is neither indexed for search nor stored as doc values, a
+ * `Binary` field is opaque storage — you can retrieve it by `_source` but
+ * cannot filter, sort, or aggregate on it. This can be useful to store
+ * small files (thumbnails, audio, scripts, cryptographic keys, bit vectors)
+ * that can be filtered, sorted, and aggregated by metadata fields stored
+ * on the same record.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { thumbnail: { type: 'Binary' } }
+ * };
+ */
 export default class BinaryType extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"binary.js","sourceRoot":"","sources":["../../../../src/types/v1/binary.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,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;QACxD,yDAAyD;QACzD,iDAAiD;QACjD,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC;QAE1B,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":"binary.js","sourceRoot":"","sources":["../../../../src/types/v1/binary.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,QAAQ;IAC5C,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;QACxD,yDAAyD;QACzD,iDAAiD;QACjD,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC;QAE1B,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/boolean.d.ts

@@ -1,6 +1,20 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A true/false value stored as an Elasticsearch/OpenSearch `boolean`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'boolean' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Boolean`.
+ * - **xLucene:** `Boolean`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { is_active: { type: 'Boolean' } }
+ * };
+ */
 export default class BooleanType extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/boolean.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":"boolean.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/boolean.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;;;;;;;;;;;;;GAaG;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/boolean.js

@@ -1,5 +1,19 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A true/false value stored as an Elasticsearch/OpenSearch `boolean`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'boolean' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Boolean`.
+ * - **xLucene:** `Boolean`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { is_active: { type: 'Boolean' } }
+ * };
+ */
 export default class BooleanType extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../../../src/types/v1/boolean.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,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC;CACJ"}
+{"version":3,"file":"boolean.js","sourceRoot":"","sources":["../../../../src/types/v1/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;GAaG;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,SAAS,CAAC,CAAC;IACtC,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/boundary.d.ts

@@ -1,6 +1,27 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType, { ToGraphQLOptions } from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A geo boundary represented as a list of lat/lon points — for example the
+ * corners of a bounding box or the vertices of a polygon. Unlike `geo_point`,
+ * the coordinates are stored as plain `float` sub-fields rather than a native
+ * geo type.
+ *
+ * - **ES/OpenSearch mapping:** an object with `properties: { lat: { type:
+ *   'float' }, lon: { type: 'float' } }`. When `indexed: false` the whole
+ *   object is disabled via `enabled: false` (note: `enabled`, not `index`,
+ *   because this is an object mapping).
+ * - **GraphQL:** a list of a generated object type — `[DTGeoBoundaryV1]` with
+ *   `lat: Float!` and `lon: Float!` (an `input` variant is emitted when
+ *   `isInput` is set).
+ * - **xLucene:** `Geo`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { bounds: { type: 'Boundary' } }
+ * };
+ */
 export default class Boundary extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL({ isInput }?: ToGraphQLOptions): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"boundary.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/boundary.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,EAAE,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,QAAQ;IAC1C,WAAW,IAAI,aAAa;IAmB5B,SAAS,CAAC,EAAE,OAAO,EAAE,GAAE,gBAAqB,GAAG,WAAW;IAY1D,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"boundary.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/boundary.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,EAAE,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,QAAQ;IAC1C,WAAW,IAAI,aAAa;IAmB5B,SAAS,CAAC,EAAE,OAAO,EAAE,GAAE,gBAAqB,GAAG,WAAW;IAY1D,SAAS,IAAI,iBAAiB;CAGjC"}

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

@@ -1,5 +1,26 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A geo boundary represented as a list of lat/lon points — for example the
+ * corners of a bounding box or the vertices of a polygon. Unlike `geo_point`,
+ * the coordinates are stored as plain `float` sub-fields rather than a native
+ * geo type.
+ *
+ * - **ES/OpenSearch mapping:** an object with `properties: { lat: { type:
+ *   'float' }, lon: { type: 'float' } }`. When `indexed: false` the whole
+ *   object is disabled via `enabled: false` (note: `enabled`, not `index`,
+ *   because this is an object mapping).
+ * - **GraphQL:** a list of a generated object type — `[DTGeoBoundaryV1]` with
+ *   `lat: Float!` and `lon: Float!` (an `input` variant is emitted when
+ *   `isInput` is set).
+ * - **xLucene:** `Geo`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { bounds: { type: 'Boundary' } }
+ * };
+ */
 export default class Boundary extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"boundary.js","sourceRoot":"","sources":["../../../../src/types/v1/boundary.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAA8B,MAAM,iBAAiB,CAAC;AAG7D,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,QAAQ;IAC1C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB;YAC1B,UAAU,EAAE;gBACR,GAAG,EAAE,EAAE,IAAI,EAAE,OAAsB,EAAE;gBACrC,GAAG,EAAE,EAAE,IAAI,EAAE,OAAsB,EAAE;aACxC;SACJ,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;QAE1D,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS,CAAC,EAAE,OAAO,KAAuB,EAAE;QACxC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG;cACb,OAAO,IAAI,IAAI;;;;SAIpB,CAAC;QACF,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,GAAG,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,GAAG,EAAE,CAAC;IAClD,CAAC;CACJ"}
+{"version":3,"file":"boundary.js","sourceRoot":"","sources":["../../../../src/types/v1/boundary.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAA8B,MAAM,iBAAiB,CAAC;AAG7D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,QAAQ;IAC1C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB;YAC1B,UAAU,EAAE;gBACR,GAAG,EAAE,EAAE,IAAI,EAAE,OAAsB,EAAE;gBACrC,GAAG,EAAE,EAAE,IAAI,EAAE,OAAsB,EAAE;aACxC;SACJ,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK;YAAE,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;QAE1D,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,SAAS,CAAC,EAAE,OAAO,KAAuB,EAAE;QACxC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG;cACb,OAAO,IAAI,IAAI;;;;SAIpB,CAAC;QACF,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,GAAG,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,GAAG,EAAE,CAAC;IAClD,CAAC;CACJ"}

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

@@ -1,6 +1,24 @@
 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 `byte`
+ * (8-bit signed integer, -128 to 127).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'byte' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Int`.
+ * - **xLucene:** `Integer`.
+ *
+ * Prefer the smallest numeric type that fits the value range to save space;
+ * use `Short`, `Integer`, or `Long` for larger values.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { retries: { type: 'Byte' } }
+ * };
+ */
 export default class Byte extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"byte.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/byte.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":"byte.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/byte.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;;;;;;;;;;;;;;;;;GAiBG;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/byte.js

@@ -1,5 +1,23 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A whole number stored as an Elasticsearch/OpenSearch `byte`
+ * (8-bit signed integer, -128 to 127).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'byte' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Int`.
+ * - **xLucene:** `Integer`.
+ *
+ * Prefer the smallest numeric type that fits the value range to save space;
+ * use `Short`, `Integer`, or `Long` for larger values.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { retries: { type: 'Byte' } }
+ * };
+ */
 export default class Byte extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"byte.js","sourceRoot":"","sources":["../../../../src/types/v1/byte.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,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":"byte.js","sourceRoot":"","sources":["../../../../src/types/v1/byte.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;GAiBG;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,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/date.d.ts

@@ -1,6 +1,25 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A date/time value stored as an Elasticsearch/OpenSearch `date`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'date' }`, optionally with a `format`.
+ *   The `config.format` is only carried through to ES when it is a custom
+ *   (non-`DateFormat`) pattern or an epoch format; `DateFormat.seconds` is
+ *   normalized to `epoch` and `DateFormat.milliseconds` to `epoch_millis`,
+ *   since ES only understands `epoch`/`epoch_millis`. When no usable format
+ *   is present the `format` key is dropped (via `withoutNil`). Honors
+ *   `indexed: false` (emitted as `index: false`).
+ * - **GraphQL:** `String` (ISO-8601 date strings).
+ * - **xLucene:** `Date`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { created: { type: 'Date' } }
+ * };
+ */
 export default class DateType extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

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

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

@@ -1,6 +1,25 @@
 import { xLuceneFieldType, DateFormat } from '@terascope/types';
 import { withoutNil } from '@terascope/core-utils';
 import BaseType from '../base-type.js';
+/**
+ * A date/time value stored as an Elasticsearch/OpenSearch `date`.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'date' }`, optionally with a `format`.
+ *   The `config.format` is only carried through to ES when it is a custom
+ *   (non-`DateFormat`) pattern or an epoch format; `DateFormat.seconds` is
+ *   normalized to `epoch` and `DateFormat.milliseconds` to `epoch_millis`,
+ *   since ES only understands `epoch`/`epoch_millis`. When no usable format
+ *   is present the `format` key is dropped (via `withoutNil`). Honors
+ *   `indexed: false` (emitted as `index: false`).
+ * - **GraphQL:** `String` (ISO-8601 date strings).
+ * - **xLucene:** `Date`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { created: { type: 'Date' } }
+ * };
+ */
 export default class DateType extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"date.js","sourceRoot":"","sources":["../../../../src/types/v1/date.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,UAAU,EACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,QAAQ;IAC1C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,MAA0B,CAAC;QAE/B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CACtB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,UAAU,CAAC;eAChC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,KAAK;eACvC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO;eACzC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,YAAY;eAC9C,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,YAAY,CACpD,EACC,CAAC;YACC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAgB,CAAC;QAC1C,CAAC;QAED,0CAA0C;QAC1C,IAAI,MAAM,KAAK,UAAU,CAAC,YAAY,EAAE,CAAC;YACrC,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC;QACrC,CAAC;QACD,IAAI,MAAM,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,CAAC;QAED,MAAM,MAAM,GAAkB,UAAU,CAAC;YACrC,IAAI,EAAE,MAAqB;YAC3B,MAAM;SACT,CAAC,CAAC;QAEH,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,IAAI,EAAE,CAAC;IACnD,CAAC;CACJ"}
+{"version":3,"file":"date.js","sourceRoot":"","sources":["../../../../src/types/v1/date.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,UAAU,EACb,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,QAAQ;IAC1C,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAI,MAA0B,CAAC;QAE/B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CACtB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,UAAU,CAAC;eAChC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,KAAK;eACvC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,OAAO;eACzC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,YAAY;eAC9C,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,YAAY,CACpD,EACC,CAAC;YACC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAgB,CAAC;QAC1C,CAAC;QAED,0CAA0C;QAC1C,IAAI,MAAM,KAAK,UAAU,CAAC,YAAY,EAAE,CAAC;YACrC,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC;QACrC,CAAC;QACD,IAAI,MAAM,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,CAAC;QAED,MAAM,MAAM,GAAkB,UAAU,CAAC;YACrC,IAAI,EAAE,MAAqB;YAC3B,MAAM;SACT,CAAC,CAAC;QAEH,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,IAAI,EAAE,CAAC;IACnD,CAAC;CACJ"}

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

@@ -1,6 +1,30 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A domain name optimized for matching by domain suffix. The base value is
+ * analyzed case-insensitively (`lowercase_keyword_analyzer`) and exposes two
+ * sub-fields: `tokens` (the `standard` analyzer) and `right`, which uses a
+ * reversed `path_hierarchy` tokenizer so a query can match on progressively
+ * broader suffixes (e.g. `www.example.com` → `com`, `example.com`,
+ * `www.example.com`).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'text', analyzer:
+ *   'lowercase_keyword_analyzer', fields: { tokens: …, right: … } }`, plus the
+ *   custom `analyzer` (`lowercase_keyword_analyzer`, `domain_analyzer`) and
+ *   `tokenizer` (`domain_tokens`, type `path_hierarchy`, `delimiter: '.'`,
+ *   `reverse: 'true'`) definitions. The `right` sub-field uses
+ *   `domain_analyzer` at index time and `lowercase_keyword_analyzer` as its
+ *   `search_analyzer`.
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `AnalyzedString`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { domain: { type: 'Domain' } }
+ * };
+ */
 export default class Domain extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/domain.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,MAAO,SAAQ,QAAQ;IAC/B,WAAW,IAAI,aAAa;IAyCrC,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAKjC"}
+{"version":3,"file":"domain.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/domain.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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IAC/B,WAAW,IAAI,aAAa;IAyCrC,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAKjC"}

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

@@ -1,5 +1,29 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A domain name optimized for matching by domain suffix. The base value is
+ * analyzed case-insensitively (`lowercase_keyword_analyzer`) and exposes two
+ * sub-fields: `tokens` (the `standard` analyzer) and `right`, which uses a
+ * reversed `path_hierarchy` tokenizer so a query can match on progressively
+ * broader suffixes (e.g. `www.example.com` → `com`, `example.com`,
+ * `www.example.com`).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'text', analyzer:
+ *   'lowercase_keyword_analyzer', fields: { tokens: …, right: … } }`, plus the
+ *   custom `analyzer` (`lowercase_keyword_analyzer`, `domain_analyzer`) and
+ *   `tokenizer` (`domain_tokens`, type `path_hierarchy`, `delimiter: '.'`,
+ *   `reverse: 'true'`) definitions. The `right` sub-field uses
+ *   `domain_analyzer` at index time and `lowercase_keyword_analyzer` as its
+ *   `search_analyzer`.
+ * - **GraphQL:** `String`.
+ * - **xLucene:** `AnalyzedString`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { domain: { type: 'Domain' } }
+ * };
+ */
 export default class Domain extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"domain.js","sourceRoot":"","sources":["../../../../src/types/v1/domain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAkC,MAAM,kBAAkB,CAAC;AACpF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IAC/B,WAAW;QAChB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,MAAqB;oBAC3B,QAAQ,EAAE,4BAA4B;oBACtC,MAAM,EAAE;wBACJ,MAAM,EAAE;4BACJ,IAAI,EAAE,MAAqB;4BAC3B,QAAQ,EAAE,UAAU;yBACvB;wBACD,KAAK,EAAE;4BACH,IAAI,EAAE,MAAqB;4BAC3B,QAAQ,EAAE,iBAAiB;4BAC3B,eAAe,EAAE,4BAA4B;yBAChD;qBACJ;iBACJ;aACJ;YACD,QAAQ,EAAE;gBACN,0BAA0B,EAAE;oBACxB,SAAS,EAAE,SAAS;oBACpB,MAAM,EAAE,WAAW;iBACtB;gBACD,eAAe,EAAE;oBACb,MAAM,EAAE,WAAW;oBACnB,IAAI,EAAE,QAAQ;oBACd,SAAS,EAAE,eAAe;iBAC7B;aACJ;YACD,SAAS,EAAE;gBACP,aAAa,EAAE;oBACX,OAAO,EAAE,MAAM;oBACf,IAAI,EAAE,gBAAgB;oBACtB,SAAS,EAAE,GAAG;iBACjB;aACJ;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO;YACH,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,cAAc;SAChD,CAAC;IACN,CAAC;CACJ"}
+{"version":3,"file":"domain.js","sourceRoot":"","sources":["../../../../src/types/v1/domain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAkC,MAAM,kBAAkB,CAAC;AACpF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IAC/B,WAAW;QAChB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACV,IAAI,EAAE,MAAqB;oBAC3B,QAAQ,EAAE,4BAA4B;oBACtC,MAAM,EAAE;wBACJ,MAAM,EAAE;4BACJ,IAAI,EAAE,MAAqB;4BAC3B,QAAQ,EAAE,UAAU;yBACvB;wBACD,KAAK,EAAE;4BACH,IAAI,EAAE,MAAqB;4BAC3B,QAAQ,EAAE,iBAAiB;4BAC3B,eAAe,EAAE,4BAA4B;yBAChD;qBACJ;iBACJ;aACJ;YACD,QAAQ,EAAE;gBACN,0BAA0B,EAAE;oBACxB,SAAS,EAAE,SAAS;oBACpB,MAAM,EAAE,WAAW;iBACtB;gBACD,eAAe,EAAE;oBACb,MAAM,EAAE,WAAW;oBACnB,IAAI,EAAE,QAAQ;oBACd,SAAS,EAAE,eAAe;iBAC7B;aACJ;YACD,SAAS,EAAE;gBACP,aAAa,EAAE;oBACX,OAAO,EAAE,MAAM;oBACf,IAAI,EAAE,gBAAgB;oBACtB,SAAS,EAAE,GAAG;iBACjB;aACJ;SACJ,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,SAAS;QACL,OAAO;YACH,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,cAAc;SAChD,CAAC;IACN,CAAC;CACJ"}

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

@@ -1,6 +1,21 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A floating-point number stored as an Elasticsearch/OpenSearch `double`
+ * (64-bit, double-precision IEEE 754).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'double' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`.
+ * - **xLucene:** `Float`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { latitude_precise: { type: 'Double' } }
+ * };
+ */
 export default class Double extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"double.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/double.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,MAAO,SAAQ,QAAQ;IACxC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"double.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/double.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;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,WAAW,IAAI,aAAa;IAc5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

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

@@ -1,5 +1,20 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A floating-point number stored as an Elasticsearch/OpenSearch `double`
+ * (64-bit, double-precision IEEE 754).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'double' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`.
+ * - **xLucene:** `Float`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { latitude_precise: { type: 'Double' } }
+ * };
+ */
 export default class Double extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"double.js","sourceRoot":"","sources":["../../../../src/types/v1/double.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,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,KAAK,EAAE,CAAC;IACpD,CAAC;CACJ"}
+{"version":3,"file":"double.js","sourceRoot":"","sources":["../../../../src/types/v1/double.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,QAAQ;IACxC,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,KAAK,EAAE,CAAC;IACpD,CAAC;CACJ"}

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

@@ -1,6 +1,23 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A floating-point number stored as an Elasticsearch/OpenSearch `float`
+ * (32-bit, single-precision IEEE 754).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'float' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`.
+ * - **xLucene:** `Float`.
+ *
+ * Use `Double` when single-precision is not accurate enough.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { temperature: { type: 'Float' } }
+ * };
+ */
 export default class Float extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"float.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/float.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":"float.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/float.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/float.js

@@ -1,5 +1,22 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A floating-point number stored as an Elasticsearch/OpenSearch `float`
+ * (32-bit, single-precision IEEE 754).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'float' }`. Honors `indexed: false`
+ *   (emitted as `index: false`).
+ * - **GraphQL:** `Float`.
+ * - **xLucene:** `Float`.
+ *
+ * Use `Double` when single-precision is not accurate enough.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { temperature: { type: 'Float' } }
+ * };
+ */
 export default class Float extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"float.js","sourceRoot":"","sources":["../../../../src/types/v1/float.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,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;CACJ"}
+{"version":3,"file":"float.js","sourceRoot":"","sources":["../../../../src/types/v1/float.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,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;CACJ"}

package/dist/src/types/v1/geo-json.d.ts

@@ -1,6 +1,24 @@
 import { xLuceneTypeConfig, ClientMetadata } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A GeoJSON geometry (point, polygon, or multi-polygon) stored as an
+ * Elasticsearch/OpenSearch `geo_shape`, enabling shape-relation queries
+ * (intersects, within, contains, disjoint).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'geo_shape' }`. Unlike most types this
+ *   cannot be excluded from indexing — `GeoJSON` is in `indexedRequiredFieldTypes`,
+ *   so `indexed: false` will throw.
+ * - **GraphQL:** a `GeoJSON` custom scalar (the `scalar GeoJSON` definition is
+ *   emitted alongside the field).
+ * - **xLucene:** `GeoJSON`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { region: { type: 'GeoJSON' } }
+ * };
+ */
 export default class GeoJSON extends BaseType {
     toESMapping(_clientMetaData: ClientMetadata): TypeESMapping;
     toGraphQL(): GraphQLType;

package/dist/src/types/v1/geo-json.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"geo-json.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/geo-json.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAChD,cAAc,EACjB,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,CAAC,eAAe,EAAE,cAAc,GAAG,aAAa;IAa3D,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"geo-json.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/geo-json.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAChD,cAAc,EACjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW,CAAC,eAAe,EAAE,cAAc,GAAG,aAAa;IAa3D,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/types/v1/geo-json.js

@@ -1,5 +1,23 @@
 import { xLuceneFieldType } from '@terascope/types';
 import BaseType from '../base-type.js';
+/**
+ * A GeoJSON geometry (point, polygon, or multi-polygon) stored as an
+ * Elasticsearch/OpenSearch `geo_shape`, enabling shape-relation queries
+ * (intersects, within, contains, disjoint).
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'geo_shape' }`. Unlike most types this
+ *   cannot be excluded from indexing — `GeoJSON` is in `indexedRequiredFieldTypes`,
+ *   so `indexed: false` will throw.
+ * - **GraphQL:** a `GeoJSON` custom scalar (the `scalar GeoJSON` definition is
+ *   emitted alongside the field).
+ * - **xLucene:** `GeoJSON`.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { region: { type: 'GeoJSON' } }
+ * };
+ */
 export default class GeoJSON extends BaseType {
     toESMapping(_clientMetaData) {
         this._validateESMapping();

package/dist/src/types/v1/geo-json.js.map

@@ -1 +1 @@
-{"version":3,"file":"geo-json.js","sourceRoot":"","sources":["../../../../src/types/v1/geo-json.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,CAAC,eAA+B;QACvC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,WAA0B,EAAE,CAAC;QAEnE,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,qEAAqE;IACrE,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;IACxD,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC;CACJ"}
+{"version":3,"file":"geo-json.js","sourceRoot":"","sources":["../../../../src/types/v1/geo-json.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAEnB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW,CAAC,eAA+B;QACvC,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAkB,EAAE,IAAI,EAAE,WAA0B,EAAE,CAAC;QAEnE,OAAO;YACH,OAAO,EAAE;gBACL,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM;aACvB;SACJ,CAAC;IACN,CAAC;IAED,qEAAqE;IACrE,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;IACxD,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/geo-point.d.ts

@@ -1,6 +1,25 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType, { ToGraphQLOptions } from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A latitude/longitude point stored as an Elasticsearch/OpenSearch
+ * `geo_point`. Supports geo-distance, bounding-box, and polygon queries.
+ *
+ * - **ES/OpenSearch mapping:** `{ type: 'geo_point' }`. Honors
+ *   `indexed: false` (emitted as `index: false`).
+ * - **GraphQL:** a generated object type `DTGeoPointV1` with `lat: String!`
+ *   and `lon: String!` (an `input` variant named `DTGeoPointInputV1` is
+ *   emitted when `isInput` is set).
+ * - **xLucene:** `GeoPoint`.
+ *
+ * This is the preferred point type; `Geo` is the deprecated equivalent.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { location: { type: 'GeoPoint' } }
+ * };
+ */
 export default class GeoPointType extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL({ isInput }?: ToGraphQLOptions): GraphQLType;

package/dist/src/types/v1/geo-point.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"geo-point.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/geo-point.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,EAAE,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,QAAQ;IAC9C,WAAW,IAAI,aAAa;IAc5B,SAAS,CAAC,EAAE,OAAO,EAAE,GAAE,gBAAqB,GAAG,WAAW;IAY1D,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"geo-point.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/geo-point.ts"],"names":[],"mappings":"AAAA,OAAO,EAC4B,iBAAiB,EAEnD,MAAM,kBAAkB,CAAC;AAC1B,OAAO,QAAQ,EAAE,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,QAAQ;IAC9C,WAAW,IAAI,aAAa;IAc5B,SAAS,CAAC,EAAE,OAAO,EAAE,GAAE,gBAAqB,GAAG,WAAW;IAY1D,SAAS,IAAI,iBAAiB;CAGjC"}