@stacksjs/types 0.70.310 → 0.70.312

package/dist/search-engine.d.ts

@@ -54,11 +54,28 @@ export declare interface SearchEngineOptions {
   }
   perPage?: number
 }
+/**
+ * Options for creating an index.
+ *
+ * Meilisearch is schemaless and only ever needed `primaryKey`. Typesense and
+ * OpenSearch are not: a collection has to declare its fields, their types, and
+ * which ones can be faceted or sorted, and it cannot be extended afterwards.
+ *
+ * Without somewhere to put that, those drivers created a collection holding
+ * `id` and nothing else. Documents imported cleanly and then every query
+ * failed with "Could not find a field named ... in the schema".
+ *
+ * Both extra fields are optional and ignored by schemaless engines.
+ */
+export declare interface CreateIndexOptions extends IndexOptions {
+  settings?: Settings
+  sampleDocument?: Record<string, unknown>
+}
 export declare interface SearchEngineDriver {
   client: () => Meilisearch
   resetClient?: () => void
   search: (index: string, params: any) => Promise<SearchResponse<Record<string, any>>>
-  createIndex: (name: string, options?: IndexOptions) => MaybePromise<EnqueuedTask>
+  createIndex: (name: string, options?: CreateIndexOptions) => MaybePromise<EnqueuedTask>
   getIndex: (name: string) => Promise<Index<Record<string, any>>>
   addDocument: (indexName: string, params: any) => Promise<EnqueuedTask>
   updateDocuments: (indexName: string, params: DocumentOptions[]) => Promise<EnqueuedTask>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.70.310",
+  "version": "0.70.312",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "contributors": [
@@ -71,7 +71,7 @@
     }
   },
   "devDependencies": {
-    "@stacksjs/validation": "0.70.310",
+    "@stacksjs/validation": "0.70.312",
     "better-dx": "^0.2.17",
     "meilisearch": "^0.59.0"
   },