Improve Settings

src/types/index.ts

@@ -1,3 +1,4 @@
+export * from "./settings.js";
 export * from "./task_and_batch.js";
 export * from "./token.js";
 export * from "./types.js";

src/types/settings.ts

@@ -0,0 +1,127 @@
+import type { NonNullableDeepRecordValues } from "./shared.js";
+
+/** {@link https://www.meilisearch.com/docs/reference/api/settings#proximity-precision} */
+export type ProximityPrecision = "byWord" | "byAttribute";
+
+/** @see `minWordSizeForTypos` at {@link https://www.meilisearch.com/docs/reference/api/settings#typo-tolerance} */
+export type MinWordSizeForTypos = {
+  oneTypo?: number | null;
+  twoTypos?: number | null;
+};
+
+/** {@link https://www.meilisearch.com/docs/reference/api/settings#typo-tolerance} */
+export type TypoTolerance = {
+  enabled?: boolean | null;
+  minWordSizeForTypos?: MinWordSizeForTypos | null;
+  disableOnWords?: string[] | null;
+  disableOnAttributes?: string[] | null;
+};
+
+/** @see `sortFacetValuesBy` at {@link https://www.meilisearch.com/docs/reference/api/settings#faceting} */
+export type FacetOrder = "alpha" | "count";
+
+/** {@link https://www.meilisearch.com/docs/reference/api/settings#faceting} */
+export type Faceting = {
+  maxValuesPerFacet?: number | null;
+  sortFacetValuesBy?: Record<string, FacetOrder> | null;
+};
+
+/** {@link https://www.meilisearch.com/docs/reference/api/settings#pagination} */
+export type PaginationSettings = { maxTotalHits?: number | null };
+
+/** @see `distribution` at {@link https://www.meilisearch.com/docs/reference/api/settings#embedders-experimental} */
+export type Distribution = {
+  mean: number;
+  sigma: number;
+};
+
+/** @see `source` at {@link https://www.meilisearch.com/docs/reference/api/settings#embedders-experimental} */
+export type EmbedderSource =
+  | "openAi"
+  | "huggingFace"
+  | "ollama"
+  | "userProvided"
+  | "rest";
+
+/** {@link https://www.meilisearch.com/docs/reference/api/settings#embedders-experimental} */
+export type EmbeddingSettings = {
+  source?: EmbedderSource | null;
+  model?: string | null;
+  revision?: string | null;
+  apiKey?: string | null;
+  dimensions?: number | null;
+  binaryQuantized?: boolean | null;
+  documentTemplate?: string | null;
+  documentTemplateMaxBytes?: number | null;
+  url?: string | null;
+  request?: unknown;
+  response?: unknown;
+  headers?: Record<string, string> | null;
+  distribution?: Distribution | null;
+};
+
+/** {@link https://www.meilisearch.com/docs/reference/api/settings#localized-attributes} */
+export type LocalizedAttribute = {
+  attributePatterns: string[] | null;
+  locales: string[] | null;
+};
+
+/** {@link https://www.meilisearch.com/docs/reference/api/settings#prefix-search} */
+export type PrefixSearch = "indexingTime" | "disabled";
+
+/** A version of {@link Settings} that can be used to update the settings. */
+export type UpdatableSettings = {
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#displayed-attributes} */
+  displayedAttributes?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#searchable-attributes} */
+  searchableAttributes?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes} */
+  filterableAttributes?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#sortable-attributes} */
+  sortableAttributes?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#ranking-rules} */
+  rankingRules?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#stop-words} */
+  stopWords?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#non-separator-tokens} */
+  nonSeparatorTokens?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#separator-tokens} */
+  separatorTokens?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#dictionary} */
+  dictionary?: string[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#synonyms} */
+  synonyms?: Record<string, string[]> | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#distinct-attribute} */
+  distinctAttribute?: string | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#proximity-precision} */
+  proximityPrecision?: ProximityPrecision | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#typo-tolerance} */
+  typoTolerance?: TypoTolerance | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#faceting} */
+  faceting?: Faceting | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#pagination} */
+  pagination?: PaginationSettings | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#embedders-experimental} */
+  embedders?: Record<string, EmbeddingSettings> | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#search-cutoff} */
+  searchCutoffMs?: number | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#localized-attributes} */
+  localizedAttributes?: LocalizedAttribute[] | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#facet-search} */
+  facetSearch?: boolean | null;
+  /** {@link https://www.meilisearch.com/docs/reference/api/settings#prefix-search} */
+  prefixSearch?: PrefixSearch | null;
+};
+
+/**
+ * A version of {@link UpdatableSettings}, the first layer of properties of which
+ * is used to update or get individual settings.
+ */
+export type IndividualSettings = Required<UpdatableSettings>;
+
+/**
+ * {@link https://www.meilisearch.com/docs/reference/api/settings#body}
+ *
+ * @see `meilisearch_types::settings::Settings` at {@link https://github.com/meilisearch/meilisearch}
+ */
+export type Settings = NonNullableDeepRecordValues<UpdatableSettings>;

src/types/task_and_batch.ts

@@ -1,4 +1,4 @@
-import type { Settings } from "./types.js";
+import type { Settings } from "./settings.js";
 import type { CursorResults } from "./shared.js";
 import type { MeiliSearchErrorResponse } from "./types.js";
 

src/types/types.ts

@@ -492,156 +492,6 @@ export type UpdateDocumentsByFunctionOptions = {
   context?: RecordAny;
 };
 
-/*
- ** Settings
- */
-
-export type FilterableAttributes = string[] | null;
-export type DistinctAttribute = string | null;
-export type SearchableAttributes = string[] | null;
-export type SortableAttributes = string[] | null;
-export type DisplayedAttributes = string[] | null;
-export type RankingRules = string[] | null;
-export type StopWords = string[] | null;
-export type Synonyms = Record<string, string[]> | null;
-export type TypoTolerance = {
-  enabled?: boolean | null;
-  disableOnAttributes?: string[] | null;
-  disableOnWords?: string[] | null;
-  minWordSizeForTypos?: {
-    oneTypo?: number | null;
-    twoTypos?: number | null;
-  };
-} | null;
-export type SeparatorTokens = string[] | null;
-export type NonSeparatorTokens = string[] | null;
-export type Dictionary = string[] | null;
-export type ProximityPrecision = "byWord" | "byAttribute";
-
-export type Distribution = {
-  mean: number;
-  sigma: number;
-};
-
-export type OpenAiEmbedder = {
-  source: "openAi";
-  model?: string;
-  apiKey?: string;
-  documentTemplate?: string;
-  dimensions?: number;
-  distribution?: Distribution;
-  url?: string;
-  documentTemplateMaxBytes?: number;
-  binaryQuantized?: boolean;
-};
-
-export type HuggingFaceEmbedder = {
-  source: "huggingFace";
-  model?: string;
-  revision?: string;
-  documentTemplate?: string;
-  distribution?: Distribution;
-  documentTemplateMaxBytes?: number;
-  binaryQuantized?: boolean;
-};
-
-export type UserProvidedEmbedder = {
-  source: "userProvided";
-  dimensions: number;
-  distribution?: Distribution;
-  binaryQuantized?: boolean;
-};
-
-export type RestEmbedder = {
-  source: "rest";
-  url: string;
-  apiKey?: string;
-  dimensions?: number;
-  documentTemplate?: string;
-  distribution?: Distribution;
-  request: RecordAny;
-  response: RecordAny;
-  headers?: Record<string, string>;
-  documentTemplateMaxBytes?: number;
-  binaryQuantized?: boolean;
-};
-
-export type OllamaEmbedder = {
-  source: "ollama";
-  url?: string;
-  apiKey?: string;
-  model?: string;
-  documentTemplate?: string;
-  distribution?: Distribution;
-  dimensions?: number;
-  documentTemplateMaxBytes?: number;
-  binaryQuantized?: boolean;
-};
-
-export type Embedder =
-  | OpenAiEmbedder
-  | HuggingFaceEmbedder
-  | UserProvidedEmbedder
-  | RestEmbedder
-  | OllamaEmbedder
-  | null;
-
-export type Embedders = Record<string, Embedder> | null;
-
-export type FacetOrder = "alpha" | "count";
-
-export type Faceting = {
-  maxValuesPerFacet?: number | null;
-  sortFacetValuesBy?: Record<string, FacetOrder> | null;
-};
-
-export type PaginationSettings = {
-  maxTotalHits?: number | null;
-};
-
-export type SearchCutoffMs = number | null;
-
-export type LocalizedAttribute = {
-  attributePatterns: string[];
-  locales: Locale[];
-};
-
-export type LocalizedAttributes = LocalizedAttribute[] | null;
-
-export type PrefixSearch = "indexingTime" | "disabled";
-
-export type Settings = {
-  filterableAttributes?: FilterableAttributes;
-  distinctAttribute?: DistinctAttribute;
-  sortableAttributes?: SortableAttributes;
-  searchableAttributes?: SearchableAttributes;
-  displayedAttributes?: DisplayedAttributes;
-  rankingRules?: RankingRules;
-  stopWords?: StopWords;
-  synonyms?: Synonyms;
-  typoTolerance?: TypoTolerance;
-  faceting?: Faceting;
-  pagination?: PaginationSettings;
-  separatorTokens?: SeparatorTokens;
-  nonSeparatorTokens?: NonSeparatorTokens;
-  dictionary?: Dictionary;
-  proximityPrecision?: ProximityPrecision;
-  embedders?: Embedders;
-  searchCutoffMs?: SearchCutoffMs;
-  localizedAttributes?: LocalizedAttributes;
-
-  /**
-   * Enable facet searching on all the filters of an index (requires Meilisearch
-   * 1.12.0 or later)
-   */
-  facetSearch?: boolean;
-  /**
-   * Enable the ability to search a word by prefix on an index (requires
-   * Meilisearch 1.12.0 or later)
-   */
-  prefixSearch?: "indexingTime" | "disabled";
-};
-
 /*
  *** HEALTH
  */

tests/displayed_attributes.test.ts

@@ -1,5 +1,5 @@
 import { afterAll, expect, test, describe, beforeEach } from "vitest";
-import { ErrorStatusCode } from "../src/types/index.js";
+import { ErrorStatusCode } from "../src/index.js";
 import {
   clearAllIndexes,
   config,

tests/distinct_attribute.test.ts

@@ -1,5 +1,5 @@
 import { afterAll, expect, test, describe, beforeEach } from "vitest";
-import { ErrorStatusCode } from "../src/types/index.js";
+import { ErrorStatusCode } from "../src/index.js";
 import {
   clearAllIndexes,
   config,

tests/dump.test.ts

@@ -1,5 +1,5 @@
 import { expect, test, describe, beforeEach, assert } from "vitest";
-import { ErrorStatusCode } from "../src/types/index.js";
+import { ErrorStatusCode } from "../src/index.js";
 import {
   clearAllIndexes,
   config,

tests/embedders.test.ts

@@ -1,5 +1,5 @@
 import { afterAll, expect, test, describe, beforeEach } from "vitest";
-import type { Embedders } from "../src/types/index.js";
+import type { IndividualSettings } from "../src/index.js";
 import {
   clearAllIndexes,
   config,
@@ -68,7 +68,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
 
     test(`${permission} key: Update embedders with 'userProvided' source`, async () => {
       const client = await getClient(permission);
-      const newEmbedder: Embedders = {
+      const newEmbedder: IndividualSettings["embedders"] = {
         default: {
           source: "userProvided",
           dimensions: 1,
@@ -89,7 +89,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
 
     test(`${permission} key: Update embedders with 'openAi' source`, async () => {
       const client = await getClient(permission);
-      const newEmbedder: Embedders = {
+      const newEmbedder: IndividualSettings["embedders"] = {
         default: {
           source: "openAi",
           apiKey: "<your-OpenAI-API-key>",
@@ -120,7 +120,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
 
     test(`${permission} key: Update embedders with 'huggingFace' source`, async () => {
       const client = await getClient(permission);
-      const newEmbedder: Embedders = {
+      const newEmbedder: IndividualSettings["embedders"] = {
         default: {
           source: "huggingFace",
           model: "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
@@ -146,7 +146,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
 
     test(`${permission} key: Update embedders with 'rest' source`, async () => {
       const client = await getClient(permission);
-      const newEmbedder: Embedders = {
+      const newEmbedder: IndividualSettings["embedders"] = {
         default: {
           source: "rest",
           url: "https://api.openai.com/v1/embeddings",
@@ -191,7 +191,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
 
     test(`${permission} key: Update embedders with 'ollama' source`, async () => {
       const client = await getClient(permission);
-      const newEmbedder: Embedders = {
+      const newEmbedder: IndividualSettings["embedders"] = {
         default: {
           source: "ollama",
           url: "http://localhost:11434/api/embeddings",
@@ -222,7 +222,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
     test(`${permission} key: Update embedders with a specific name`, async () => {
       const client = await getClient(permission);
 
-      const newEmbedder: Embedders = {
+      const newEmbedder: IndividualSettings["embedders"] = {
         image: {
           source: "userProvided",
           dimensions: 512,
@@ -303,7 +303,7 @@ describe.each([{ permission: "Master" }, { permission: "Admin" }])(
     test(`${permission} key: search for similar documents`, async () => {
       const client = await getClient(permission);
 
-      const newEmbedder: Embedders = {
+      const newEmbedder: IndividualSettings["embedders"] = {
         manual: {
           source: "userProvided",
           dimensions: 3,

tests/facet_search_settings.test.ts

@@ -1,5 +1,5 @@
 import { afterAll, expect, test, describe, beforeEach } from "vitest";
-import { ErrorStatusCode } from "../src/types/index.js";
+import { ErrorStatusCode } from "../src/index.js";
 import {
   clearAllIndexes,
   config,