elasticlink 1.0.0-beta.1 → 1.0.0

package/dist/settings.presets.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"settings.presets.d.ts","sourceRoot":"","sources":["../src/settings.presets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EACV,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,sCAAsC,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,wBAAwB,GAAI,YAAY,OAAO,CAAC,oBAAoB,CAAC,KAAG,oBAInF,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAC1B,KAAK,GACL,MAAM,GACN;IACE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,sBAAsB,CAAC;IAC9B,OAAO,CAAC,EAAE,yBAAyB,CAAC;CACrC,CAAC;AAEN;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,KAAG;IAAE,IAAI,EAAE,uBAAuB,CAAA;CAiB7G,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,kBAAkB,GAAI,YAAY,OAAO,CAAC,oBAAoB,CAAC,KAAG,oBAY9E,CAAC"}

package/dist/settings.presets.js

@@ -1,137 +0,0 @@
-/**
- * Index settings presets for common Elasticsearch scenarios.
- *
- * These are standalone functions that return `IndicesIndexSettings` objects.
- * Use them with `indexBuilder().settings()` for index creation, or pass directly
- * to the ES `_settings` API for runtime changes.
- *
- * Typical lifecycle:
- * 1. Create index: `indexBuilder().mappings(schema).settings(productionSearchSettings()).build()`
- * 2. Before bulk ingest: apply `fastIngestSettings()` via ES `_settings` API
- * 3. Perform bulk ingest
- * 4. After bulk ingest: apply `productionSearchSettings()` via ES `_settings` API
- * 5. Refresh: `POST /index/_refresh`
- */
-/**
- * Balanced production settings for search workloads.
- *
- * Defaults:
- * - `number_of_replicas: 1` — one replica for redundancy
- * - `refresh_interval: '5s'` — near-real-time search without excessive refresh overhead
- *
- * @param overrides - Override or extend any setting. Applied after defaults.
- *
- * @example
- * const index = indexBuilder()
- *   .mappings(schema)
- *   .settings(productionSearchSettings())
- *   .build();
- *
- * @example
- * // With best_compression for disk savings
- * productionSearchSettings({ codec: 'best_compression' })
- *
- * @example
- * // Restore production settings after bulk ingest
- * await client.indices.putSettings({
- *   index: 'my-index',
- *   body: productionSearchSettings(),
- * });
- * await client.indices.refresh({ index: 'my-index' });
- */
-export const productionSearchSettings = (overrides) => ({
-    number_of_replicas: 1,
-    refresh_interval: '5s',
-    ...overrides
-});
-/**
- * Generate index sort settings from a field→direction (or full spec) map.
- *
- * Index-time sorting improves compression (similar values stored together) and
- * enables early termination when query sort matches index sort. Combine with
- * `trackTotalHits(false)` for fastest sorted queries.
- *
- * The returned object lives at the top level of `IndicesIndexSettings` — spread it
- * directly into a settings object (do NOT wrap it under an `index` key, the
- * `@elastic/elasticsearch` client normalises that form).
- *
- * Pass a bare `'asc' | 'desc'` for simple cases; pass `{ order, mode?, missing? }`
- * when you need `mode` (`min`/`max`/`median`/`avg`) or `missing` (`_first`/`_last`).
- *
- * @param fields - Map of field names to sort direction or full spec.
- * @returns A `{ sort: IndicesIndexSegmentSort }` fragment to spread into your settings.
- *
- * @example
- * const index = indexBuilder()
- *   .mappings(schema)
- *   .settings({
- *     ...productionSearchSettings(),
- *     ...indexSortSettings({ timestamp: 'desc', status: 'asc' }),
- *   })
- *   .build();
- *
- * @example
- * indexSortSettings({
- *   price: { order: 'asc', mode: 'min', missing: '_last' },
- *   created_at: 'desc'
- * })
- */
-export const indexSortSettings = (fields) => {
-    const entries = Object.entries(fields);
-    const normalize = (spec) => (typeof spec === 'string' ? { order: spec } : spec);
-    const hasAnyMode = entries.some(([, spec]) => typeof spec !== 'string' && spec.mode !== undefined);
-    const hasAnyMissing = entries.some(([, spec]) => typeof spec !== 'string' && spec.missing !== undefined);
-    return {
-        sort: {
-            field: entries.map(([name]) => name),
-            order: entries.map(([, spec]) => normalize(spec).order),
-            ...(hasAnyMode && {
-                mode: entries.map(([, spec]) => normalize(spec).mode ?? 'min')
-            }),
-            ...(hasAnyMissing && {
-                missing: entries.map(([, spec]) => normalize(spec).missing ?? '_last')
-            })
-        }
-    };
-};
-/**
- * Settings optimized for maximum indexing speed during bulk operations.
- *
- * Apply via the ES `_settings` API before starting bulk ingest, then revert
- * with `productionSearchSettings()` afterward. Do not use these as permanent
- * index settings — they trade durability and search availability for speed.
- *
- * Defaults:
- * - `refresh_interval: '-1'` — disables refresh (can improve reindex time by 70%+)
- * - `number_of_replicas: 0` — no replication overhead during ingest
- * - `translog.durability: 'async'` — async translog for faster writes
- * - `translog.sync_interval: '30s'` — less frequent translog sync
- *
- * @param overrides - Override or extend any setting. Applied after defaults.
- * `translog` overrides are deep-merged so individual translog keys can be
- * changed without clobbering the other defaults.
- *
- * @example
- * // Apply before bulk ingest via ES client
- * await client.indices.putSettings({
- *   index: 'my-index',
- *   body: fastIngestSettings(),
- * });
- *
- * @example
- * // With custom overrides
- * fastIngestSettings({ number_of_shards: 3 })
- */
-export const fastIngestSettings = (overrides) => {
-    const { translog, ...rest } = overrides ?? {};
-    return {
-        number_of_replicas: 0,
-        refresh_interval: '-1',
-        translog: {
-            durability: 'async',
-            sync_interval: '30s',
-            ...translog
-        },
-        ...rest
-    };
-};

package/dist/suggester.builder.d.ts

@@ -1,23 +0,0 @@
-/**
- * Suggester builder
- * Provides query suggestions, phrase corrections, and autocomplete functionality
- */
-import type { FieldTypeString } from './index-management.types.js';
-import type { MappingsSchema } from './mapping.types.js';
-import { SuggesterBuilder, SuggesterState } from './suggester.types.js';
-/**
- * Creates a suggester builder
- * @returns SuggesterBuilder instance
- */
-export declare const createSuggesterBuilder: <M extends Record<string, FieldTypeString>>(state?: SuggesterState) => SuggesterBuilder<M>;
-/**
- * Factory function to create a new suggester builder
- * @example
- * ```typescript
- * const suggestions = suggest(productMappings)
- *   .term('name-suggestions', 'laptop', { field: 'name', size: 5 })
- *   .build();
- * ```
- */
-export declare const suggest: <M extends Record<string, FieldTypeString>>(_schema: MappingsSchema<M>) => SuggesterBuilder<M>;
-//# sourceMappingURL=suggester.builder.d.ts.map

package/dist/suggester.builder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"suggester.builder.d.ts","sourceRoot":"","sources":["../src/suggester.builder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,EAC9E,QAAO,cAAmB,KACzB,gBAAgB,CAAC,CAAC,CAmCnB,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE,SAAS,cAAc,CAAC,CAAC,CAAC,wBAChE,CAAC"}

package/dist/suggester.builder.js

@@ -1,51 +0,0 @@
-/**
- * Suggester builder
- * Provides query suggestions, phrase corrections, and autocomplete functionality
- */
-/**
- * Creates a suggester builder
- * @returns SuggesterBuilder instance
- */
-export const createSuggesterBuilder = (state = {}) => ({
-    term: (name, text, options) => {
-        return createSuggesterBuilder({
-            ...state,
-            [name]: {
-                text,
-                term: options
-            }
-        });
-    },
-    phrase: (name, text, options) => {
-        return createSuggesterBuilder({
-            ...state,
-            [name]: {
-                text,
-                phrase: options
-            }
-        });
-    },
-    completion: (name, prefix, options) => {
-        return createSuggesterBuilder({
-            ...state,
-            [name]: {
-                prefix,
-                completion: options
-            }
-        });
-    },
-    // eslint-disable-next-line functional/functional-parameters
-    build: () => ({
-        suggest: state
-    })
-});
-/**
- * Factory function to create a new suggester builder
- * @example
- * ```typescript
- * const suggestions = suggest(productMappings)
- *   .term('name-suggestions', 'laptop', { field: 'name', size: 5 })
- *   .build();
- * ```
- */
-export const suggest = (_schema) => createSuggesterBuilder();

package/dist/suggester.types.d.ts

@@ -1,90 +0,0 @@
-/**
- * Type definitions for Elasticsearch Suggesters
- * Derived from official @elastic/elasticsearch types for accuracy and completeness.
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html
- */
-import type { SearchTermSuggester, SearchPhraseSuggester, SearchCompletionSuggester, SearchDirectGenerator, SearchPhraseSuggestCollate, SearchSmoothingModelContainer, SearchCompletionContext } from '@elastic/elasticsearch/lib/api/types';
-/**
- * Phrase suggester direct-generator config — re-exported from official @elastic/elasticsearch types.
- * Used in `PhraseSuggesterOptions.direct_generator`.
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html#phrase-suggester
- */
-export type PhraseSuggestDirectGenerator = SearchDirectGenerator;
-/**
- * Phrase suggester collate config — re-exported from official @elastic/elasticsearch types.
- * Used in `PhraseSuggesterOptions.collate` to run a query against each candidate phrase.
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html#_collate
- */
-export type PhraseSuggestCollate = SearchPhraseSuggestCollate;
-/**
- * Phrase suggester smoothing-model container — re-exported from official @elastic/elasticsearch types.
- * Used in `PhraseSuggesterOptions.smoothing`.
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html#_smoothing_models
- */
-export type PhraseSuggestSmoothingModel = SearchSmoothingModelContainer;
-/**
- * Completion suggester context — re-exported from official @elastic/elasticsearch types.
- * Used in `CompletionSuggesterOptions.contexts`.
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/suggester-context.html
- */
-export type CompletionSuggestContext = SearchCompletionContext;
-import type { FieldTypeString } from './index-management.types.js';
-import type { TextFields, KeywordFields, CompletionFields } from './mapping.types.js';
-/**
- * Options for term suggester — mirrors the official `SearchTermSuggester` type.
- * `field`, `text`, and `prefix` are omitted because they are supplied by the builder
- * as explicit arguments (`field` is re-added below, narrowed to the mapping schema).
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html#term-suggester
- */
-export type TermSuggesterOptions<M extends Record<string, FieldTypeString>> = Omit<SearchTermSuggester, 'field' | 'text' | 'prefix'> & {
-    field: (TextFields<M> | KeywordFields<M>) & string;
-};
-/**
- * Options for phrase suggester — mirrors the official `SearchPhraseSuggester` type
- * with `field`, `text`, and `prefix` removed (builder-owned).
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html#phrase-suggester
- */
-export type PhraseSuggesterOptions<M extends Record<string, FieldTypeString>> = Omit<SearchPhraseSuggester, 'field' | 'text' | 'prefix'> & {
-    field: (TextFields<M> | KeywordFields<M>) & string;
-};
-/**
- * Options for completion suggester — mirrors the official `SearchCompletionSuggester` type
- * with `field`, `text`, and `prefix` removed (builder-owned).
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html#completion-suggester
- */
-export type CompletionSuggesterOptions<M extends Record<string, FieldTypeString>> = Omit<SearchCompletionSuggester, 'field' | 'text' | 'prefix'> & {
-    field: CompletionFields<M> & string;
-};
-/**
- * Suggester state for build output.
- *
- * The state carries the suggester DSL as Elasticsearch accepts it — options still
- * embed `field` internally after the builder writes them, since that is how the
- * underlying wire format works. The type-safety benefit lives at the method
- * boundary: callers cannot pass a non-existent field to `.term()`/`.phrase()`/`.completion()`.
- */
-export type SuggesterState = {
-    [suggesterName: string]: {
-        text?: string;
-        prefix?: string;
-        term?: Omit<SearchTermSuggester, 'text' | 'prefix'>;
-        phrase?: Omit<SearchPhraseSuggester, 'text' | 'prefix'>;
-        completion?: Omit<SearchCompletionSuggester, 'text' | 'prefix'>;
-    };
-};
-/**
- * Suggester builder interface
- */
-export type SuggesterBuilder<M extends Record<string, FieldTypeString>> = {
-    /** Term suggester - suggests corrections for individual terms */
-    term: (name: string, text: string, options: TermSuggesterOptions<M>) => SuggesterBuilder<M>;
-    /** Phrase suggester - suggests corrections for entire phrases */
-    phrase: (name: string, text: string, options: PhraseSuggesterOptions<M>) => SuggesterBuilder<M>;
-    /** Completion suggester - autocomplete functionality */
-    completion: (name: string, prefix: string, options: CompletionSuggesterOptions<M>) => SuggesterBuilder<M>;
-    /** Build suggester DSL */
-    build: () => {
-        suggest: SuggesterState;
-    };
-};
-//# sourceMappingURL=suggester.types.d.ts.map

package/dist/suggester.types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"suggester.types.d.ts","sourceRoot":"","sources":["../src/suggester.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,6BAA6B,EAC7B,uBAAuB,EACxB,MAAM,sCAAsC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,qBAAqB,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,0BAA0B,CAAC;AAE9D;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,6BAA6B,CAAC;AAExE;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,uBAAuB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,IAAI,CAChF,mBAAmB,EACnB,OAAO,GAAG,MAAM,GAAG,QAAQ,CAC5B,GAAG;IACF,KAAK,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;CACpD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,IAAI,CAClF,qBAAqB,EACrB,OAAO,GAAG,MAAM,GAAG,QAAQ,CAC5B,GAAG;IACF,KAAK,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;CACpD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,IAAI,CACtF,yBAAyB,EACzB,OAAO,GAAG,MAAM,GAAG,QAAQ,CAC5B,GAAG;IACF,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,aAAa,EAAE,MAAM,GAAG;QACvB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,IAAI,CAAC,mBAAmB,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;QACpD,MAAM,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;QACxD,UAAU,CAAC,EAAE,IAAI,CAAC,yBAAyB,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;KACjE,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI;IACxE,iEAAiE;IACjE,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,KAAK,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAE5F,iEAAiE;IACjE,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEhG,wDAAwD;IACxD,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,CAAC,KAAK,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAE1G,0BAA0B;IAC1B,KAAK,EAAE,MAAM;QAAE,OAAO,EAAE,cAAc,CAAA;KAAE,CAAC;CAC1C,CAAC"}

package/dist/suggester.types.js

@@ -1,6 +0,0 @@
-/**
- * Type definitions for Elasticsearch Suggesters
- * Derived from official @elastic/elasticsearch types for accuracy and completeness.
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html
- */
-export {};

package/dist/vector.types.d.ts

@@ -1,17 +0,0 @@
-/**
- * Type definitions for Elasticsearch vector search and KNN queries
- * Derived from official @elastic/elasticsearch types for accuracy and completeness.
- * Requires Elasticsearch 8.0+
- */
-import type { KnnSearch, MappingDenseVectorProperty } from '@elastic/elasticsearch/lib/api/types';
-/**
- * Options for KNN (k-nearest neighbors) query (excludes 'field' and 'query_vector' which are handled by the builder)
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/knn-search.html
- */
-export type KnnOptions = Omit<KnnSearch, 'field' | 'query_vector'>;
-/**
- * Options for dense_vector field mapping (excludes 'type' which is always 'dense_vector')
- * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html
- */
-export type DenseVectorOptions = Omit<MappingDenseVectorProperty, 'type'>;
-//# sourceMappingURL=vector.types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"vector.types.d.ts","sourceRoot":"","sources":["../src/vector.types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAC;AAElG;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,EAAE,OAAO,GAAG,cAAc,CAAC,CAAC;AAEnE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC"}

package/dist/vector.types.js

@@ -1,6 +0,0 @@
-/**
- * Type definitions for Elasticsearch vector search and KNN queries
- * Derived from official @elastic/elasticsearch types for accuracy and completeness.
- * Requires Elasticsearch 8.0+
- */
-export {};