@terascope/data-types 2.14.0 → 2.15.1

package/dist/src/data-type.d.ts

@@ -7,6 +7,24 @@ import * as i from './interfaces.js';
  * - Elasticsearch Mappings
  * - GraphQL Schemas
  * - xLucene
+ *
+ * It is constructed from a `DataTypeConfig` (a `version` plus a map of field
+ * names to their {@link BaseType} configs); nested `Object` and `Tuple` fields
+ * declared with dot-notation are grouped into {@link GroupType} /
+ * {@link TupleType} instances during construction.
+ *
+ * @example
+ * const dataType = new DataType({
+ *     version: 1,
+ *     fields: {
+ *         name: { type: 'Keyword' },
+ *         location: { type: 'GeoPoint' },
+ *     },
+ * }, 'Person');
+ *
+ * dataType.toESMapping();  // Elasticsearch/OpenSearch mapping
+ * dataType.toGraphQL();    // GraphQL schema string
+ * dataType.toXlucene();    // xLucene type config
  */
 export declare class DataType {
     readonly name: string;
@@ -16,15 +34,51 @@ export declare class DataType {
     /** An object of base fields with their child fields */
     readonly groupedFields: i.GroupedFields;
     private readonly _types;
-    /** Merge multiple data types into one GraphQL schema, useful for removing duplicates */
+    /**
+     * Merge multiple data types into a single GraphQL schema, de-duplicating
+     * shared custom types and scalars. Throws on a missing or duplicate type
+     * name (or duplicate input name when `createInputTypes` is set). Options
+     * control input-type generation, snake_case naming, scalar removal, and
+     * per-type reference/virtual fields.
+     */
     static mergeGraphQLDataTypes(types: DataType[], options?: i.MergeGraphQLOptions): string;
+    /**
+     * @param config the data type config; `version` defaults to the latest and
+     * `fields` to `{}`, and the config is validated (throwing on an unknown
+     * version or invalid field config).
+     * @param typeName optional name for the type (required by some conversions,
+     * e.g. GraphQL).
+     * @param description optional description carried into the GraphQL output.
+     */
     constructor(config: Partial<DataTypeConfig>, typeName?: string, description?: string);
     /**
      * Convert the DataType to an elasticsearch mapping.
      */
     toESMapping({ overrides, distribution, majorVersion, minorVersion, version, _meta }?: Partial<i.ESMappingOptions>): ESMapping;
+    /**
+     * Convert the DataType to a formatted GraphQL schema string. Combines the
+     * generated custom types, the base type, an optional input type, and any
+     * `args.customTypes`, then validates and prints the result. Pass
+     * `removeScalars` to strip `scalar` declarations from the output.
+     *
+     * Note: fields that reference an undeclared scalar (e.g. `Any`/`Tuple` →
+     * `JSON`) require that scalar to be supplied for the schema to validate.
+     */
     toGraphQL(args?: i.GraphQLOptions, removeScalars?: boolean): string;
+    /**
+     * Build the GraphQL type parts without assembling/validating a full schema:
+     * the `baseType` definition, an optional `inputType`, and the `customTypes`
+     * (scalars and generated nested types) the fields reference. Use this when
+     * composing several data types into one schema (see
+     * {@link DataType.mergeGraphQLDataTypes}); use `toGraphQL` for a single,
+     * ready-to-use schema string. Throws if no type name is available.
+     */
     toGraphQLTypes(args?: i.GraphQLOptions): i.GraphQLTypesResult;
+    /**
+     * Convert the DataType to an xLucene type config — a flat map of field name
+     * (including nested dot-notation paths) to its xLucene field type, merged
+     * across every field.
+     */
     toXlucene(): xLuceneTypeConfig;
 }
 //# sourceMappingURL=data-type.d.ts.map

package/dist/src/data-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-type.d.ts","sourceRoot":"","sources":["../../src/data-type.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,cAAc,EAA6B,SAAS,EACpC,sBAAsB,EAAE,iBAAiB,EAC5D,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,CAAC,MAAM,iBAAiB,CAAC;AAKrC;;;;;;;GAOG;AACH,qBAAa,QAAQ;IACjB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC;IAExC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IAEpC,wFAAwF;IACxF,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,GAAE,CAAC,CAAC,mBAAwB,GAAG,MAAM;gBAyDhF,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;IAgBpF;;OAEG;IACH,WAAW,CAAC,EACR,SAAS,EAAE,YAAmD,EAC9D,YAAgB,EAAE,YAAiB,EAAE,OAAkB,EAAE,KAAK,EACjE,GAAE,OAAO,CAAC,CAAC,CAAC,gBAAgB,CAAM,GAAG,SAAS;IA6C/C,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,cAAc,EAAE,aAAa,UAAQ,GAAG,MAAM;IAQjE,cAAc,CAAC,IAAI,GAAE,CAAC,CAAC,cAAmB,GAAG,CAAC,CAAC,kBAAkB;IA0EjE,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"data-type.d.ts","sourceRoot":"","sources":["../../src/data-type.ts"],"names":[],"mappings":"AAIA,OAAO,EACH,cAAc,EAA6B,SAAS,EACpC,sBAAsB,EAAE,iBAAiB,EAC5D,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,CAAC,MAAM,iBAAiB,CAAC;AAKrC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,QAAQ;IACjB,QAAQ,CAAC,IAAI,EAAG,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC;IAExC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IAEpC;;;;;;OAMG;IACH,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,OAAO,GAAE,CAAC,CAAC,mBAAwB,GAAG,MAAM;IAyD5F;;;;;;;OAOG;gBACS,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;IAgBpF;;OAEG;IACH,WAAW,CAAC,EACR,SAAS,EAAE,YAAmD,EAC9D,YAAgB,EAAE,YAAiB,EAAE,OAAkB,EAAE,KAAK,EACjE,GAAE,OAAO,CAAC,CAAC,CAAC,gBAAgB,CAAM,GAAG,SAAS;IA6C/C;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,cAAc,EAAE,aAAa,UAAQ,GAAG,MAAM;IAQjE;;;;;;;OAOG;IACH,cAAc,CAAC,IAAI,GAAE,CAAC,CAAC,cAAmB,GAAG,CAAC,CAAC,kBAAkB;IA0EjE;;;;OAIG;IACH,SAAS,IAAI,iBAAiB;CAGjC"}

package/dist/src/data-type.js

@@ -10,6 +10,24 @@ import { getTypes, LATEST_VERSION, getGroupedFields } from './types/index.js';
  * - Elasticsearch Mappings
  * - GraphQL Schemas
  * - xLucene
+ *
+ * It is constructed from a `DataTypeConfig` (a `version` plus a map of field
+ * names to their {@link BaseType} configs); nested `Object` and `Tuple` fields
+ * declared with dot-notation are grouped into {@link GroupType} /
+ * {@link TupleType} instances during construction.
+ *
+ * @example
+ * const dataType = new DataType({
+ *     version: 1,
+ *     fields: {
+ *         name: { type: 'Keyword' },
+ *         location: { type: 'GeoPoint' },
+ *     },
+ * }, 'Person');
+ *
+ * dataType.toESMapping();  // Elasticsearch/OpenSearch mapping
+ * dataType.toGraphQL();    // GraphQL schema string
+ * dataType.toXlucene();    // xLucene type config
  */
 export class DataType {
     name;
@@ -19,7 +37,13 @@ export class DataType {
     /** An object of base fields with their child fields */
     groupedFields;
     _types;
-    /** Merge multiple data types into one GraphQL schema, useful for removing duplicates */
+    /**
+     * Merge multiple data types into a single GraphQL schema, de-duplicating
+     * shared custom types and scalars. Throws on a missing or duplicate type
+     * name (or duplicate input name when `createInputTypes` is set). Options
+     * control input-type generation, snake_case naming, scalar removal, and
+     * per-type reference/virtual fields.
+     */
     static mergeGraphQLDataTypes(types, options = {}) {
         const { references: typeReferences = {}, removeScalars = false, useSnakeCase = false } = options;
         const customTypes = [...(options.customTypes ?? [])];
@@ -58,6 +82,14 @@ export class DataType {
         const strSchema = utils.joinStrings(customTypes, customTypes, typeDefs);
         return formatSchema(strSchema, removeScalars);
     }
+    /**
+     * @param config the data type config; `version` defaults to the latest and
+     * `fields` to `{}`, and the config is validated (throwing on an unknown
+     * version or invalid field config).
+     * @param typeName optional name for the type (required by some conversions,
+     * e.g. GraphQL).
+     * @param description optional description carried into the GraphQL output.
+     */
     constructor(config, typeName, description) {
         if (typeName)
             this.name = typeName;
@@ -114,11 +146,28 @@ export class DataType {
         }
         return defaultsDeep({}, overrides, esMapping);
     }
+    /**
+     * Convert the DataType to a formatted GraphQL schema string. Combines the
+     * generated custom types, the base type, an optional input type, and any
+     * `args.customTypes`, then validates and prints the result. Pass
+     * `removeScalars` to strip `scalar` declarations from the output.
+     *
+     * Note: fields that reference an undeclared scalar (e.g. `Any`/`Tuple` →
+     * `JSON`) require that scalar to be supplied for the schema to validate.
+     */
     toGraphQL(args, removeScalars = false) {
         const { baseType, inputType, customTypes } = this.toGraphQLTypes(args);
         const schema = utils.joinStrings(customTypes, baseType, inputType, args?.customTypes);
         return formatSchema(schema, removeScalars);
     }
+    /**
+     * Build the GraphQL type parts without assembling/validating a full schema:
+     * the `baseType` definition, an optional `inputType`, and the `customTypes`
+     * (scalars and generated nested types) the fields reference. Use this when
+     * composing several data types into one schema (see
+     * {@link DataType.mergeGraphQLDataTypes}); use `toGraphQL` for a single,
+     * ready-to-use schema string. Throws if no type name is available.
+     */
     toGraphQLTypes(args = {}) {
         const { typeName = this.name, references = [], useSnakeCase = false, description = this.description, createInputType = false } = args;
         if (!typeName) {
@@ -167,6 +216,11 @@ export class DataType {
             customTypes,
         };
     }
+    /**
+     * Convert the DataType to an xLucene type config — a flat map of field name
+     * (including nested dot-notation paths) to its xLucene field type, merged
+     * across every field.
+     */
     toXlucene() {
         return this._types.reduce((accum, type) => ({ ...accum, ...type.toXlucene() }), {});
     }

package/dist/src/data-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-type.js","sourceRoot":"","sources":["../../src/data-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EAAE,GAAG,EAAE,UAAU,EACzB,YAAY,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACa,yBAAyB,EAE5C,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGzE,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE9E;;;;;;;GAOG;AACH,MAAM,OAAO,QAAQ;IACR,IAAI,CAAU;IACd,WAAW,CAAU;IACrB,MAAM,CAAyB;IAC/B,OAAO,CAAS;IACzB,uDAAuD;IAC9C,aAAa,CAAkB;IAEvB,MAAM,CAAa;IAEpC,wFAAwF;IACxF,MAAM,CAAC,qBAAqB,CAAC,KAAiB,EAAE,UAAiC,EAAE;QAC/E,MAAM,EACF,UAAU,EAAE,cAAc,GAAG,EAAE,EAC/B,aAAa,GAAG,KAAK,EACrB,YAAY,GAAG,KAAK,EACvB,GAAG,OAAO,CAAC;QAEZ,MAAM,WAAW,GAAa,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;YACzE,CAAC;YAED,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;YAC3E,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEtB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,OAAO,CAAC;gBAE5E,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CAAC,yCAAyC,SAAS,SAAS,CAAC,CAAC;gBACjF,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;YAED,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACrD,MAAM,UAAU,GAAa,KAAK,CAAC,mBAAmB,CAClD,MAAM,EACN,YAAY,CACf,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;gBAC/B,UAAU;gBACV,YAAY;gBACZ,eAAe,EAAE,OAAO,CAAC,gBAAgB;gBACzC,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;aACvD,CAAC,CAAC;YAEH,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACxC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAE/B,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QAExE,OAAO,YAAY,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAClD,CAAC;IAED,YAAY,MAA+B,EAAE,QAAiB,EAAE,WAAoB;QAChF,IAAI,QAAQ;YAAE,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC;QACnC,IAAI,WAAW;YAAE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAEhD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,sBAAsB,CAAC;YACrD,OAAO,EAAE,cAAc;YACvB,MAAM,EAAE,EAAE;YACV,GAAG,MAAM;SACZ,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC;QAExB,IAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,EACR,SAAS,EAAE,YAAY,GAAG,yBAAyB,CAAC,UAAU,EAC9D,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,EAAE,EAAE,OAAO,GAAG,QAAQ,EAAE,KAAK,KACjC,EAAE;QAC/B,MAAM,QAAQ,GAAmB;YAC7B,OAAO,EAAE,KAAK;YACd,UAAU,EAAE,EAAE;YACd,GAAG,KAAK,IAAI,EAAE,KAAK,EAAE;SACxB,CAAC;QAEF,MAAM,SAAS,GAAc;YACzB,QAAQ,EAAE,EAAE;YACZ,QAAQ;SACX,CAAC;QAEF,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC7B,MAAM,EACF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EACzC,GAAG,IAAI,CAAC,WAAW,CAAC;gBACjB,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO;aACpD,CAAC,CAAC;YAEH,IAAI,OAAO,EAAE,CAAC;gBACV,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;oBAChD,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;gBACpC,CAAC;YACL,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACX,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnD,GAAG,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;gBACtE,CAAC;YACL,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACZ,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBACpD,GAAG,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;gBACvE,CAAC;YACL,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACX,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnD,GAAG,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;gBAC9C,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAClD,CAAC;IAED,SAAS,CAAC,IAAuB,EAAE,aAAa,GAAG,KAAK;QACpD,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAC5B,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,CACtD,CAAC;QACF,OAAO,YAAY,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED,cAAc,CAAC,OAAyB,EAAE;QACtC,MAAM,EACF,QAAQ,GAAG,IAAI,CAAC,IAAI,EACpB,UAAU,GAAG,EAAE,EACf,YAAY,GAAG,KAAK,EACpB,WAAW,GAAG,IAAI,CAAC,WAAW,EAC9B,eAAe,GAAG,KAAK,EAC1B,GAAG,IAAI,CAAC;QAET,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAC;QAC7G,CAAC;QAED,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,QAAQ,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,OAAO,CAAC;QAE1E,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,MAAM,eAAe,GAAa,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC9B,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC;gBAC/B,QAAQ;gBACR,YAAY;aACf,CAAC,CAAC;YACH,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACjC,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YAExC,IAAI,eAAe,EAAE,CAAC;gBAClB,IAAI,IAAI,CAAC,qBAAqB;uBACvB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;oBACvC,MAAM,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC;wBACpC,QAAQ;wBACR,OAAO,EAAE,IAAI;wBACb,YAAY;wBACZ,cAAc,EAAE,IAAI,CAAC,qBAAqB;qBAC7C,CAAC,CAAC;oBACH,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBACvC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;gBACjD,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACpB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CACjC,oBAAoB,CAAC,+BAA+B,CAAC,EACrD,UAAU,CACb,CAAC,CAAC;QACP,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAC9B,oBAAoB,CAAC,WAAW,CAAC,EACjC,QAAQ,QAAQ;kBACV,KAAK,CAAC,WAAW,CAAC,cAAc,CAAC;cACrC,CACL,CAAC;QAEF,IAAI,SAA6B,CAAC;QAElC,IAAI,eAAe,EAAE,CAAC;YAClB,SAAS,GAAG,KAAK,CAAC,WAAW,CACzB,oBAAoB,CAAC,WAAW,EAAE,aAAa,QAAQ,EAAE,CAAC,EAC1D,SAAS,SAAS;sBACZ,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC;kBACtC,CACL,CAAC;QACN,CAAC;QAED,OAAO;YACH,QAAQ;YACR,SAAS;YACT,WAAW;SACd,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACxF,CAAC;CACJ"}
+{"version":3,"file":"data-type.js","sourceRoot":"","sources":["../../src/data-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EAAE,GAAG,EAAE,UAAU,EACzB,YAAY,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACa,yBAAyB,EAE5C,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGzE,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,QAAQ;IACR,IAAI,CAAU;IACd,WAAW,CAAU;IACrB,MAAM,CAAyB;IAC/B,OAAO,CAAS;IACzB,uDAAuD;IAC9C,aAAa,CAAkB;IAEvB,MAAM,CAAa;IAEpC;;;;;;OAMG;IACH,MAAM,CAAC,qBAAqB,CAAC,KAAiB,EAAE,UAAiC,EAAE;QAC/E,MAAM,EACF,UAAU,EAAE,cAAc,GAAG,EAAE,EAC/B,aAAa,GAAG,KAAK,EACrB,YAAY,GAAG,KAAK,EACvB,GAAG,OAAO,CAAC;QAEZ,MAAM,WAAW,GAAa,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;YACzE,CAAC;YAED,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CAAC,yCAAyC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;YAC3E,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEtB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,OAAO,CAAC;gBAE5E,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CAAC,yCAAyC,SAAS,SAAS,CAAC,CAAC;gBACjF,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC1B,CAAC;YAED,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,IAAI,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACrD,MAAM,UAAU,GAAa,KAAK,CAAC,mBAAmB,CAClD,MAAM,EACN,YAAY,CACf,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;gBAC/B,UAAU;gBACV,YAAY;gBACZ,eAAe,EAAE,OAAO,CAAC,gBAAgB;gBACzC,qBAAqB,EAAE,OAAO,CAAC,qBAAqB;aACvD,CAAC,CAAC;YAEH,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACxC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAE/B,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACnB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACpC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;QAExE,OAAO,YAAY,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,MAA+B,EAAE,QAAiB,EAAE,WAAoB;QAChF,IAAI,QAAQ;YAAE,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC;QACnC,IAAI,WAAW;YAAE,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAEhD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,sBAAsB,CAAC;YACrD,OAAO,EAAE,cAAc;YACvB,MAAM,EAAE,EAAE;YACV,GAAG,MAAM;SACZ,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAQ,CAAC;QAExB,IAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,EACR,SAAS,EAAE,YAAY,GAAG,yBAAyB,CAAC,UAAU,EAC9D,YAAY,GAAG,CAAC,EAAE,YAAY,GAAG,EAAE,EAAE,OAAO,GAAG,QAAQ,EAAE,KAAK,KACjC,EAAE;QAC/B,MAAM,QAAQ,GAAmB;YAC7B,OAAO,EAAE,KAAK;YACd,UAAU,EAAE,EAAE;YACd,GAAG,KAAK,IAAI,EAAE,KAAK,EAAE;SACxB,CAAC;QAEF,MAAM,SAAS,GAAc;YACzB,QAAQ,EAAE,EAAE;YACZ,QAAQ;SACX,CAAC;QAEF,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC7B,MAAM,EACF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EACzC,GAAG,IAAI,CAAC,WAAW,CAAC;gBACjB,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO;aACpD,CAAC,CAAC;YAEH,IAAI,OAAO,EAAE,CAAC;gBACV,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;oBAClD,MAAM,OAAO,GAAG,CAAC,UAAU,EAAE,YAAY,EAAE,GAAG,CAAC,CAAC;oBAChD,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;gBACpC,CAAC;YACL,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACX,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnD,GAAG,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;gBACtE,CAAC;YACL,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACZ,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;oBACpD,GAAG,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;gBACvE,CAAC;YACL,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACX,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnD,GAAG,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;gBAC9C,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,IAAuB,EAAE,aAAa,GAAG,KAAK;QACpD,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAC5B,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,CACtD,CAAC;QACF,OAAO,YAAY,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CAAC,OAAyB,EAAE;QACtC,MAAM,EACF,QAAQ,GAAG,IAAI,CAAC,IAAI,EACpB,UAAU,GAAG,EAAE,EACf,YAAY,GAAG,KAAK,EACpB,WAAW,GAAG,IAAI,CAAC,WAAW,EAC9B,eAAe,GAAG,KAAK,EAC1B,GAAG,IAAI,CAAC;QAET,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,uFAAuF,CAAC,CAAC;QAC7G,CAAC;QAED,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,QAAQ,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,OAAO,CAAC;QAE1E,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,MAAM,cAAc,GAAa,EAAE,CAAC;QACpC,MAAM,eAAe,GAAa,EAAE,CAAC;QAErC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC9B,MAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC;gBAC/B,QAAQ;gBACR,YAAY;aACf,CAAC,CAAC;YACH,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACjC,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YAExC,IAAI,eAAe,EAAE,CAAC;gBAClB,IAAI,IAAI,CAAC,qBAAqB;uBACvB,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;oBACvC,MAAM,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC;wBACpC,QAAQ;wBACR,OAAO,EAAE,IAAI;wBACb,YAAY;wBACZ,cAAc,EAAE,IAAI,CAAC,qBAAqB;qBAC7C,CAAC,CAAC;oBACH,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;oBACvC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;gBACjD,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACpB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CACjC,oBAAoB,CAAC,+BAA+B,CAAC,EACrD,UAAU,CACb,CAAC,CAAC;QACP,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAC9B,oBAAoB,CAAC,WAAW,CAAC,EACjC,QAAQ,QAAQ;kBACV,KAAK,CAAC,WAAW,CAAC,cAAc,CAAC;cACrC,CACL,CAAC;QAEF,IAAI,SAA6B,CAAC;QAElC,IAAI,eAAe,EAAE,CAAC;YAClB,SAAS,GAAG,KAAK,CAAC,WAAW,CACzB,oBAAoB,CAAC,WAAW,EAAE,aAAa,QAAQ,EAAE,CAAC,EAC1D,SAAS,SAAS;sBACZ,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC;kBACtC,CACL,CAAC;QACN,CAAC;QAED,OAAO;YACH,QAAQ;YACR,SAAS;YACT,WAAW;SACd,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,SAAS;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACxF,CAAC;CACJ"}

package/dist/src/types/base-type.d.ts

@@ -3,23 +3,52 @@ import { GraphQLType, TypeESMapping } from '../interfaces.js';
 export interface IBaseType {
     new (field: string, config: DataTypeFieldConfig): BaseType;
 }
+/** Options controlling how a field is rendered into GraphQL. */
 export type ToGraphQLOptions = {
     typeName?: string;
     isInput?: boolean;
     includePrivate?: boolean;
     useSnakeCase?: boolean;
 };
+/**
+ * The abstract base class every field type extends. It captures a single
+ * field's identity (`field` name, its `DataTypeFieldConfig`, and the data-type
+ * `version`) and defines the contract for converting that field into each
+ * supported output format.
+ *
+ * Concrete subclasses implement the three conversion methods; `BaseType`
+ * itself provides the shared validation and GraphQL-formatting helpers they
+ * build on. Subclasses live in `types/v1/` (the versioned field types) plus the
+ * grouping types {@link GroupType} and {@link TupleType} in `types/`.
+ */
 export default abstract class BaseType {
     readonly field: string;
     readonly config: DataTypeFieldConfig;
     readonly version: number;
     constructor(field: string, config: DataTypeFieldConfig, version?: number);
+    /**
+     * Guard used by subclasses before emitting an ES mapping: throws if the
+     * field is configured `indexed: false` but its type is in
+     * `indexedRequiredFieldTypes` (types that cannot be left unindexed).
+     */
     protected _validateESMapping(): void;
     abstract toESMapping(config: ClientMetadata): TypeESMapping;
     abstract toGraphQL(options?: ToGraphQLOptions): GraphQLType;
     abstract toXlucene(): xLuceneTypeConfig;
+    /**
+     * Build the `{ type, customTypes }` GraphQL result for a field of the given
+     * GraphQL `type`. Honors the field's `description` and `array` config
+     * (wrapping the type as a `[list]`), and carries along any `customType`
+     * SDL definitions (e.g. `scalar`/nested-type declarations) the field needs.
+     */
     protected _formatGql(type: string, customType?: string | (string[])): GraphQLType;
+    /**
+     * Build the generated name for a custom GraphQL type, e.g.
+     * `DT<TypeName>V<version>` (with an `Input` suffix for input types). Used by
+     * the grouping types to name the nested types they emit.
+     */
     _formatGQLTypeName(typeName: string, isInput?: boolean, inputSuffix?: string): string;
 }
+/** Prefix a GraphQL type/field line with its formatted description, when present. */
 export declare function formatGQLType(type: string, desc?: string): string;
 //# sourceMappingURL=base-type.d.ts.map

package/dist/src/types/base-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-type.d.ts","sourceRoot":"","sources":["../../../src/types/base-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,cAAc,EAAE,mBAAmB,EAAE,iBAAiB,EAEzD,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG9D,MAAM,WAAW,SAAS;IACtB,KAAI,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,QAAQ,CAAC;CAC7D;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,QAAQ;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEb,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,SAAI;IAMnE,SAAS,CAAC,kBAAkB;IAO5B,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,aAAa;IAC3D,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,WAAW;IAC3D,QAAQ,CAAC,SAAS,IAAI,iBAAiB;IAEvC,SAAS,CAAC,UAAU,CAChB,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,GAAC,CAAC,MAAM,EAAE,CAAC,GAC/B,WAAW;IAcd,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,WAAW,SAAU,GAAG,MAAM;CAQzF;AAOD,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAGjE"}
+{"version":3,"file":"base-type.d.ts","sourceRoot":"","sources":["../../../src/types/base-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,cAAc,EAAE,mBAAmB,EAAE,iBAAiB,EAEzD,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG9D,MAAM,WAAW,SAAS;IACtB,KAAI,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,QAAQ,CAAC;CAC7D;AAED,gEAAgE;AAChE,MAAM,MAAM,gBAAgB,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,QAAQ;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;gBAEb,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,SAAI;IAMnE;;;;OAIG;IACH,SAAS,CAAC,kBAAkB;IAO5B,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,aAAa;IAC3D,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,WAAW;IAC3D,QAAQ,CAAC,SAAS,IAAI,iBAAiB;IAEvC;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAChB,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,GAAC,CAAC,MAAM,EAAE,CAAC,GAC/B,WAAW;IAcd;;;;OAIG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,WAAW,SAAU,GAAG,MAAM;CAQzF;AAQD,qFAAqF;AACrF,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAGjE"}

package/dist/src/types/base-type.js

@@ -1,6 +1,17 @@
 import { indexedRequiredFieldTypes } from '@terascope/types';
 import { castArray } from '@terascope/core-utils';
 import { formatGQLDescription } from '../graphql-helper.js';
+/**
+ * The abstract base class every field type extends. It captures a single
+ * field's identity (`field` name, its `DataTypeFieldConfig`, and the data-type
+ * `version`) and defines the contract for converting that field into each
+ * supported output format.
+ *
+ * Concrete subclasses implement the three conversion methods; `BaseType`
+ * itself provides the shared validation and GraphQL-formatting helpers they
+ * build on. Subclasses live in `types/v1/` (the versioned field types) plus the
+ * grouping types {@link GroupType} and {@link TupleType} in `types/`.
+ */
 export default class BaseType {
     field;
     config;
@@ -10,6 +21,11 @@ export default class BaseType {
         this.field = field;
         this.config = config;
     }
+    /**
+     * Guard used by subclasses before emitting an ES mapping: throws if the
+     * field is configured `indexed: false` but its type is in
+     * `indexedRequiredFieldTypes` (types that cannot be left unindexed).
+     */
     _validateESMapping() {
         if (this.config.indexed === false) {
             if (this.config.type in indexedRequiredFieldTypes) {
@@ -17,6 +33,12 @@ export default class BaseType {
             }
         }
     }
+    /**
+     * Build the `{ type, customTypes }` GraphQL result for a field of the given
+     * GraphQL `type`. Honors the field's `description` and `array` config
+     * (wrapping the type as a `[list]`), and carries along any `customType`
+     * SDL definitions (e.g. `scalar`/nested-type declarations) the field needs.
+     */
     _formatGql(type, customType) {
         const desc = this.config.description;
         if (this.config.array) {
@@ -30,6 +52,11 @@ export default class BaseType {
             customTypes: makeCustomTypes(customType)
         };
     }
+    /**
+     * Build the generated name for a custom GraphQL type, e.g.
+     * `DT<TypeName>V<version>` (with an `Input` suffix for input types). Used by
+     * the grouping types to name the nested types they emit.
+     */
     _formatGQLTypeName(typeName, isInput, inputSuffix = 'Input') {
         return [
             'DT',
@@ -39,11 +66,13 @@ export default class BaseType {
         ].join('');
     }
 }
+/** Normalize the optional custom-type argument into an array. */
 function makeCustomTypes(customType) {
     if (!customType?.length)
         return [];
     return castArray(customType);
 }
+/** Prefix a GraphQL type/field line with its formatted description, when present. */
 export function formatGQLType(type, desc) {
     if (!desc)
         return type;

package/dist/src/types/base-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-type.js","sourceRoot":"","sources":["../../../src/types/base-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,yBAAyB,EAC5B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAa5D,MAAM,CAAC,OAAO,OAAgB,QAAQ;IACzB,KAAK,CAAS;IACd,MAAM,CAAsB;IAC5B,OAAO,CAAS;IAEzB,YAAY,KAAa,EAAE,MAA2B,EAAE,OAAO,GAAG,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAES,kBAAkB;QACxB,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,yBAAyB,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,4BAA4B,CAAC,CAAC;YACrE,CAAC;QACL,CAAC;IACL,CAAC;IAKS,UAAU,CAChB,IAAY,EACZ,UAA8B;QAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACrC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACpB,OAAO;gBACH,IAAI,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,KAAK,MAAM,IAAI,GAAG,EAAE,IAAI,CAAC;gBACrD,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC;aAC3C,CAAC;QACN,CAAC;QACD,OAAO;YACH,IAAI,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC;YACnD,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC;SAC3C,CAAC;IACN,CAAC;IAED,kBAAkB,CAAC,QAAgB,EAAE,OAAiB,EAAE,WAAW,GAAG,OAAO;QACzE,OAAO;YACH,IAAI;YACJ,QAAQ;YACR,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;YAC1B,IAAI,IAAI,CAAC,OAAO,EAAE;SACrB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;CACJ;AAED,SAAS,eAAe,CAAC,UAA8B;IACnD,IAAI,CAAC,UAAU,EAAE,MAAM;QAAE,OAAO,EAAE,CAAC;IACnC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,IAAa;IACrD,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvB,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;AACpD,CAAC"}
+{"version":3,"file":"base-type.js","sourceRoot":"","sources":["../../../src/types/base-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,yBAAyB,EAC5B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAElD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAc5D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,OAAgB,QAAQ;IACzB,KAAK,CAAS;IACd,MAAM,CAAsB;IAC5B,OAAO,CAAS;IAEzB,YAAY,KAAa,EAAE,MAA2B,EAAE,OAAO,GAAG,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACO,kBAAkB;QACxB,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAChC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,yBAAyB,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,4BAA4B,CAAC,CAAC;YACrE,CAAC;QACL,CAAC;IACL,CAAC;IAKD;;;;;OAKG;IACO,UAAU,CAChB,IAAY,EACZ,UAA8B;QAE9B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACrC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACpB,OAAO;gBACH,IAAI,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,KAAK,MAAM,IAAI,GAAG,EAAE,IAAI,CAAC;gBACrD,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC;aAC3C,CAAC;QACN,CAAC;QACD,OAAO;YACH,IAAI,EAAE,aAAa,CAAC,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC;YACnD,WAAW,EAAE,eAAe,CAAC,UAAU,CAAC;SAC3C,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,QAAgB,EAAE,OAAiB,EAAE,WAAW,GAAG,OAAO;QACzE,OAAO;YACH,IAAI;YACJ,QAAQ;YACR,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;YAC1B,IAAI,IAAI,CAAC,OAAO,EAAE;SACrB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,CAAC;CACJ;AAED,iEAAiE;AACjE,SAAS,eAAe,CAAC,UAA8B;IACnD,IAAI,CAAC,UAAU,EAAE,MAAM;QAAE,OAAO,EAAE,CAAC;IACnC,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;AACjC,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,IAAa;IACrD,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACvB,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;AACpD,CAAC"}

package/dist/src/types/group-type.d.ts

@@ -4,10 +4,35 @@ import { GraphQLType, TypeESMapping } from '../interfaces.js';
 export type NestedTypes = {
     [field: string]: BaseType;
 };
+/**
+ * Represents an `Object` field together with its nested children as a single
+ * grouped unit. This is not a `FieldType` you declare directly — it is
+ * assembled during field grouping (`getGroupType`) from an `Object` parent and
+ * its dot-notation children (e.g. `user` + `user.id` + `user.name`), so the
+ * parent and its descendants convert together into one nested structure.
+ *
+ * - **ES/OpenSearch mapping:** the parent's `object`/`nested` mapping with each
+ *   child folded into its `properties` (recursively, since a child may itself
+ *   be a group), merging any analyzers/tokenizers the children contribute.
+ * - **GraphQL:** a generated nested type (`DT<Parent><Field>V<version>`) whose
+ *   fields are the children, referenced from the parent type.
+ * - **xLucene:** the merged xLucene configs of the parent and all children,
+ *   keyed by their full dot-notation paths.
+ *
+ * @see {@link TupleType} for the ordered-set analogue.
+ */
 export default class GroupType extends BaseType {
     readonly types: NestedTypes;
     constructor(field: string, version: number, types: NestedTypes);
+    /**
+     * Emit the parent's mapping with each child nested under its `properties`,
+     * accumulating any analyzers/tokenizers contributed by the children.
+     */
     toESMapping(config: ClientMetadata): TypeESMapping;
+    /**
+     * Emit a generated nested GraphQL type built from the children and return
+     * the parent field referencing it (as `[list]` when the parent is an array).
+     */
     toGraphQL(options?: ToGraphQLOptions): GraphQLType;
     toXlucene(): xLuceneTypeConfig;
     private _removeBase;

package/dist/src/types/group-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"group-type.d.ts","sourceRoot":"","sources":["../../../src/types/group-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,iBAAiB,EACjB,cAAc,EACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,QAAQ,EAAE,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE9D,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAC;AAExD,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;gBAEhB,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IAK9D,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,aAAa;IAiClD,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,WAAW;IA0CtD,SAAS,IAAI,iBAAiB;IAK9B,OAAO,CAAC,WAAW;CAGtB"}
+{"version":3,"file":"group-type.d.ts","sourceRoot":"","sources":["../../../src/types/group-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,iBAAiB,EACjB,cAAc,EACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,QAAQ,EAAE,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE9D,MAAM,MAAM,WAAW,GAAG;IAAE,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAAA;CAAE,CAAC;AAExD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;gBAEhB,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IAK9D;;;OAGG;IACH,WAAW,CAAC,MAAM,EAAE,cAAc,GAAG,aAAa;IAiClD;;;OAGG;IACH,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,WAAW;IA0CtD,SAAS,IAAI,iBAAiB;IAK9B,OAAO,CAAC,WAAW;CAGtB"}

package/dist/src/types/group-type.js

@@ -1,11 +1,32 @@
 import { firstToUpper } from '@terascope/core-utils';
 import BaseType from './base-type.js';
+/**
+ * Represents an `Object` field together with its nested children as a single
+ * grouped unit. This is not a `FieldType` you declare directly — it is
+ * assembled during field grouping (`getGroupType`) from an `Object` parent and
+ * its dot-notation children (e.g. `user` + `user.id` + `user.name`), so the
+ * parent and its descendants convert together into one nested structure.
+ *
+ * - **ES/OpenSearch mapping:** the parent's `object`/`nested` mapping with each
+ *   child folded into its `properties` (recursively, since a child may itself
+ *   be a group), merging any analyzers/tokenizers the children contribute.
+ * - **GraphQL:** a generated nested type (`DT<Parent><Field>V<version>`) whose
+ *   fields are the children, referenced from the parent type.
+ * - **xLucene:** the merged xLucene configs of the parent and all children,
+ *   keyed by their full dot-notation paths.
+ *
+ * @see {@link TupleType} for the ordered-set analogue.
+ */
 export default class GroupType extends BaseType {
     types;
     constructor(field, version, types) {
         super(field, types[field].config, version);
         this.types = types;
     }
+    /**
+     * Emit the parent's mapping with each child nested under its `properties`,
+     * accumulating any analyzers/tokenizers contributed by the children.
+     */
     toESMapping(config) {
         const { mapping, analyzer = {}, tokenizer = {}, } = this.types[this.field].toESMapping(config);
         const baseMapping = mapping[this.field];
@@ -29,6 +50,10 @@ export default class GroupType extends BaseType {
             tokenizer,
         };
     }
+    /**
+     * Emit a generated nested GraphQL type built from the children and return
+     * the parent field referencing it (as `[list]` when the parent is an array).
+     */
     toGraphQL(options = {}) {
         const { typeName = 'Object', isInput, includePrivate } = options;
         const customTypeName = this._formatGQLTypeName(options.useSnakeCase

package/dist/src/types/group-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"group-type.js","sourceRoot":"","sources":["../../../src/types/group-type.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,QAA8B,MAAM,gBAAgB,CAAC;AAK5D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAClC,KAAK,CAAc;IAE5B,YAAY,KAAa,EAAE,OAAe,EAAE,KAAkB;QAC1D,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,WAAW,CAAC,MAAsB;QAC9B,MAAM,EACF,OAAO,EACP,QAAQ,GAAG,EAAE,EACb,SAAS,GAAG,EAAE,GACjB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAA0B,CAAC;QACjE,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAC1B,WAAW,CAAC,UAAU,GAAG,EAAE,CAAC;QAChC,CAAC;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;gBACvB,SAAS;YACb,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAoB,CAAC;YACnE,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC;YAEnD,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;YAChD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC;QAED,OAAO;YACH,OAAO;YACP,QAAQ;YACR,SAAS;SACZ,CAAC;IACN,CAAC;IAED,SAAS,CAAC,UAA4B,EAAE;QACpC,MAAM,EAAE,QAAQ,GAAG,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAEjE,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAC1C,OAAO,CAAC,YAAY;YAChB,CAAC,CAAC,IAAI,QAAQ,IAAI,IAAI,CAAC,KAAK,GAAG;YAC/B,CAAC,CAAC,GAAG,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAC9C,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAC9C,CAAC;QAEF,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,MAAM,WAAW,GAAa,EAAE,CAAC;QAEjC,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;gBACvB,SAAS;YACb,CAAC;YAED,IAAI,OAAO,IAAI,cAAc,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvE,SAAS;YACb,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAEvC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAE/C,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;QAErC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAC3C,WAAW,CAAC,IAAI,CAAC;cACX,OAAO,IAAI,cAAc;kBACrB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;;SAEzB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,SAAS;QACL,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC;IACzC,CAAC;IAEO,WAAW,CAAC,GAAW;QAC3B,OAAO,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;CACJ"}
+{"version":3,"file":"group-type.js","sourceRoot":"","sources":["../../../src/types/group-type.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,QAA8B,MAAM,gBAAgB,CAAC;AAK5D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAClC,KAAK,CAAc;IAE5B,YAAY,KAAa,EAAE,OAAe,EAAE,KAAkB;QAC1D,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,MAAsB;QAC9B,MAAM,EACF,OAAO,EACP,QAAQ,GAAG,EAAE,EACb,SAAS,GAAG,EAAE,GACjB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAA0B,CAAC;QACjE,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAC1B,WAAW,CAAC,UAAU,GAAG,EAAE,CAAC;QAChC,CAAC;QAED,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;gBACvB,SAAS;YACb,CAAC;YAED,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;YAE7C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAoB,CAAC;YACnE,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC;YAEnD,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;YAChD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC;QAED,OAAO;YACH,OAAO;YACP,QAAQ;YACR,SAAS;SACZ,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,UAA4B,EAAE;QACpC,MAAM,EAAE,QAAQ,GAAG,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC;QAEjE,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAC1C,OAAO,CAAC,YAAY;YAChB,CAAC,CAAC,IAAI,QAAQ,IAAI,IAAI,CAAC,KAAK,GAAG;YAC/B,CAAC,CAAC,GAAG,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAC9C,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAC9C,CAAC;QAEF,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,MAAM,WAAW,GAAa,EAAE,CAAC;QAEjC,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;gBACvB,SAAS;YACb,CAAC;YAED,IAAI,OAAO,IAAI,cAAc,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvE,SAAS;YACb,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAEvC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAE/C,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,EAAE,CAAC;QAErC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAC3C,WAAW,CAAC,IAAI,CAAC;cACX,OAAO,IAAI,cAAc;kBACrB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;;SAEzB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;IACxD,CAAC;IAED,SAAS;QACL,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1E,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC;IACzC,CAAC;IAEO,WAAW,CAAC,GAAW;QAC3B,OAAO,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;CACJ"}

package/dist/src/types/tuple-type.d.ts

@@ -1,6 +1,40 @@
 import { DataTypeFieldConfig, xLuceneTypeConfig } from '@terascope/types';
 import BaseType from './base-type.js';
 import { GraphQLType, TypeESMapping } from '../interfaces.js';
+/**
+ * An ordered, fixed set of values where each position (element) has its own
+ * type — the data-types analogue of a tuple. Declare the parent field as
+ * `Tuple` and give each element a dot-notation, zero-based index name
+ * (`field.0`, `field.1`, …), the same way {@link GroupType} object children
+ * are declared. At least one element field is required (the builder throws
+ * `Tuple field types require at least one field` otherwise).
+ *
+ * Unlike the v1 field types, this is not version-specific: it lives in
+ * `src/types/` (not `src/types/v1/`) and is selected during field grouping
+ * (`getTupleType`) rather than through the version registry. The `Tuple` entry
+ * in `types/mapping.ts` points at {@link AnyType} but is never reached.
+ *
+ * - **ES/OpenSearch mapping:** `{ enabled: false }` on the parent field — the
+ *   tuple is kept in `_source` but not indexed, and the element sub-fields are
+ *   **not** emitted as individual mappings, so a tuple cannot be searched,
+ *   sorted, or aggregated on.
+ * - **GraphQL:** `JSON`. As with {@link AnyType}, no `scalar JSON` definition
+ *   is emitted, so the surrounding schema must provide a `JSON` scalar — via
+ *   a GraphQL patch or a scalar library — for the field to resolve.
+ * - **xLucene:** the merged xLucene configs of the element types, keyed by
+ *   their dot paths (e.g. `{ 'field.0': 'float', 'field.1': 'float' }`). The
+ *   parent tuple field itself contributes no xLucene entry.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: {
+ *         location: { type: 'Tuple' },
+ *         'location.0': { type: 'Float' },
+ *         'location.1': { type: 'Float' },
+ *     }
+ * };
+ */
 export default class TupleType extends BaseType {
     readonly types: readonly BaseType[];
     constructor(field: string, version: number, baseConfig: DataTypeFieldConfig, types: BaseType[]);

package/dist/src/types/tuple-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tuple-type.d.ts","sourceRoot":"","sources":["../../../src/types/tuple-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE9D,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;gBAGhC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,mBAAmB,EAC/B,KAAK,EAAE,QAAQ,EAAE;IAMrB,WAAW,IAAI,aAAa;IAM5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAIjC"}
+{"version":3,"file":"tuple-type.d.ts","sourceRoot":"","sources":["../../../src/types/tuple-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAC3C,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;gBAGhC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,mBAAmB,EAC/B,KAAK,EAAE,QAAQ,EAAE;IAMrB,WAAW,IAAI,aAAa;IAM5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAIjC"}

package/dist/src/types/tuple-type.js

@@ -1,4 +1,38 @@
 import BaseType from './base-type.js';
+/**
+ * An ordered, fixed set of values where each position (element) has its own
+ * type — the data-types analogue of a tuple. Declare the parent field as
+ * `Tuple` and give each element a dot-notation, zero-based index name
+ * (`field.0`, `field.1`, …), the same way {@link GroupType} object children
+ * are declared. At least one element field is required (the builder throws
+ * `Tuple field types require at least one field` otherwise).
+ *
+ * Unlike the v1 field types, this is not version-specific: it lives in
+ * `src/types/` (not `src/types/v1/`) and is selected during field grouping
+ * (`getTupleType`) rather than through the version registry. The `Tuple` entry
+ * in `types/mapping.ts` points at {@link AnyType} but is never reached.
+ *
+ * - **ES/OpenSearch mapping:** `{ enabled: false }` on the parent field — the
+ *   tuple is kept in `_source` but not indexed, and the element sub-fields are
+ *   **not** emitted as individual mappings, so a tuple cannot be searched,
+ *   sorted, or aggregated on.
+ * - **GraphQL:** `JSON`. As with {@link AnyType}, no `scalar JSON` definition
+ *   is emitted, so the surrounding schema must provide a `JSON` scalar — via
+ *   a GraphQL patch or a scalar library — for the field to resolve.
+ * - **xLucene:** the merged xLucene configs of the element types, keyed by
+ *   their dot paths (e.g. `{ 'field.0': 'float', 'field.1': 'float' }`). The
+ *   parent tuple field itself contributes no xLucene entry.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: {
+ *         location: { type: 'Tuple' },
+ *         'location.0': { type: 'Float' },
+ *         'location.1': { type: 'Float' },
+ *     }
+ * };
+ */
 export default class TupleType extends BaseType {
     types;
     constructor(field, version, baseConfig, types) {

package/dist/src/types/tuple-type.js.map

@@ -1 +1 @@
-{"version":3,"file":"tuple-type.js","sourceRoot":"","sources":["../../../src/types/tuple-type.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAClC,KAAK,CAAsB;IAEpC,YACI,KAAa,EACb,OAAe,EACf,UAA+B,EAC/B,KAAiB;QAEjB,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,WAAW;QACP,OAAO;YACH,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;SAChD,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,SAAS;QACL,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC3D,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC;IACzC,CAAC;CACJ"}
+{"version":3,"file":"tuple-type.js","sourceRoot":"","sources":["../../../src/types/tuple-type.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,SAAQ,QAAQ;IAClC,KAAK,CAAsB;IAEpC,YACI,KAAa,EACb,OAAe,EACf,UAA+B,EAC/B,KAAiB;QAEjB,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,WAAW;QACP,OAAO;YACH,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;SAChD,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,SAAS;QACL,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC3D,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC;IACzC,CAAC;CACJ"}

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

@@ -1,6 +1,32 @@
 import { xLuceneTypeConfig } from '@terascope/types';
 import BaseType from '../base-type.js';
 import { GraphQLType, TypeESMapping } from '../../interfaces.js';
+/**
+ * A field of unrestricted shape. The value is stored but excluded from
+ * indexing, so it can hold arbitrary JSON without imposing a mapping.
+ *
+ * The type registry (`types/mapping.ts`) also maps `Tuple` to this class, but
+ * that entry is a never-reached fallback — `Tuple` fields are intercepted
+ * during field grouping and handled by their own {@link TupleType} class, so
+ * `Any` does not actually back `Tuple` at runtime.
+ *
+ * - **ES/OpenSearch mapping:** `{ enabled: false }` — ES stores the value in
+ *   `_source` but does not index it, so it cannot be searched, sorted, or
+ *   aggregated on.
+ * - **GraphQL:** `JSON`. Unlike `Object`/`GeoJSON` (which emit their own
+ *   `scalar JSONObject`/`scalar GeoJSON` definitions), this type does not emit
+ *   a `scalar JSON` definition, so the surrounding schema must provide a `JSON`
+ *   scalar — via a GraphQL patch or a scalar library — for the field to
+ *   resolve.
+ * - **xLucene:** none — `toXlucene()` returns `{}`, so the field contributes
+ *   no xLucene type.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { payload: { type: 'Any' } }
+ * };
+ */
 export default class AnyType extends BaseType {
     toESMapping(): TypeESMapping;
     toGraphQL(): GraphQLType;

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

@@ -1 +1 @@
-{"version":3,"file":"any.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/any.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAmB,MAAM,kBAAkB,CAAC;AACtE,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;IAU5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}
+{"version":3,"file":"any.d.ts","sourceRoot":"","sources":["../../../../src/types/v1/any.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAmB,MAAM,kBAAkB,CAAC;AACtE,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW,IAAI,aAAa;IAU5B,SAAS,IAAI,WAAW;IAIxB,SAAS,IAAI,iBAAiB;CAGjC"}

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

@@ -1,4 +1,30 @@
 import BaseType from '../base-type.js';
+/**
+ * A field of unrestricted shape. The value is stored but excluded from
+ * indexing, so it can hold arbitrary JSON without imposing a mapping.
+ *
+ * The type registry (`types/mapping.ts`) also maps `Tuple` to this class, but
+ * that entry is a never-reached fallback — `Tuple` fields are intercepted
+ * during field grouping and handled by their own {@link TupleType} class, so
+ * `Any` does not actually back `Tuple` at runtime.
+ *
+ * - **ES/OpenSearch mapping:** `{ enabled: false }` — ES stores the value in
+ *   `_source` but does not index it, so it cannot be searched, sorted, or
+ *   aggregated on.
+ * - **GraphQL:** `JSON`. Unlike `Object`/`GeoJSON` (which emit their own
+ *   `scalar JSONObject`/`scalar GeoJSON` definitions), this type does not emit
+ *   a `scalar JSON` definition, so the surrounding schema must provide a `JSON`
+ *   scalar — via a GraphQL patch or a scalar library — for the field to
+ *   resolve.
+ * - **xLucene:** none — `toXlucene()` returns `{}`, so the field contributes
+ *   no xLucene type.
+ *
+ * @example
+ * const config: DataTypeConfig = {
+ *     version: 1,
+ *     fields: { payload: { type: 'Any' } }
+ * };
+ */
 export default class AnyType extends BaseType {
     toESMapping() {
         this._validateESMapping();

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

@@ -1 +1 @@
-{"version":3,"file":"any.js","sourceRoot":"","sources":["../../../../src/types/v1/any.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAoB,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAEnD,OAAO;YACH,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE;SACpC,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC;IACd,CAAC;CACJ"}
+{"version":3,"file":"any.js","sourceRoot":"","sources":["../../../../src/types/v1/any.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAGvC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,SAAQ,QAAQ;IACzC,WAAW;QACP,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAE1B,MAAM,MAAM,GAAoB,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAEnD,OAAO;YACH,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE;SACpC,CAAC;IACN,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,SAAS;QACL,OAAO,EAAE,CAAC;IACd,CAAC;CACJ"}