@stacksjs/search-engine 0.70.37 → 0.70.42

package/dist/src/drivers/algolia.d.ts

@@ -0,0 +1,231 @@
+/**
+ * Configure Algolia client
+ */
+export declare function configure(options: AlgoliaConfig): void;
+/**
+ * Search an index
+ */
+export declare function search(indexName: string, params?: AlgoliaSearchParams): Promise<AlgoliaSearchResponse>;
+/**
+ * Multi-index search
+ */
+export declare function multiSearch(queries: Array<{ indexName: string, params?: AlgoliaSearchParams }>): Promise<{ results: AlgoliaSearchResponse[] }>;
+/**
+ * Add or update a single object
+ */
+export declare function saveObject(indexName: string, object: Record<string, any>, objectID?: string): Promise<AlgoliaTask>;
+/**
+ * Add or update multiple objects
+ */
+export declare function saveObjects(indexName: string, objects: Array<Record<string, any>>): Promise<AlgoliaTask>;
+/**
+ * Partially update an object
+ */
+export declare function partialUpdateObject(indexName: string, objectID: string, attributes: Record<string, any>, createIfNotExists?: boolean): Promise<AlgoliaTask>;
+/**
+ * Delete an object
+ */
+export declare function deleteObject(indexName: string, objectID: string): Promise<AlgoliaTask>;
+/**
+ * Delete multiple objects
+ */
+export declare function deleteObjects(indexName: string, objectIDs: string[]): Promise<AlgoliaTask>;
+/**
+ * Delete objects matching a filter
+ */
+export declare function deleteBy(indexName: string, filters: string): Promise<AlgoliaTask>;
+/**
+ * Get an object by ID
+ */
+export declare function getObject(indexName: string, objectID: string, attributesToRetrieve?: string[]): Promise<AlgoliaHit>;
+/**
+ * Get multiple objects by IDs
+ */
+export declare function getObjects(indexName: string, objectIDs: string[], attributesToRetrieve?: string[]): Promise<{ results: AlgoliaHit[] }>;
+/**
+ * Clear all objects from an index
+ */
+export declare function clearObjects(indexName: string): Promise<AlgoliaTask>;
+/**
+ * Get index settings
+ */
+export declare function getSettings(indexName: string): Promise<AlgoliaIndexSettings>;
+/**
+ * Update index settings
+ */
+export declare function setSettings(indexName: string, settings: AlgoliaIndexSettings, forwardToReplicas?: boolean): Promise<AlgoliaTask>;
+/**
+ * List all indices
+ */
+export declare function listIndices(): Promise<{
+  items: Array<{
+    name: string
+    createdAt: string
+    updatedAt: string
+    entries: number
+    dataSize: number
+    fileSize: number
+    lastBuildTimeS: number
+    numberOfPendingTasks: number
+    pendingTask: boolean
+    primary?: string
+    replicas?: string[]
+  }>
+}>;
+/**
+ * Copy an index
+ */
+export declare function copyIndex(srcIndexName: string, dstIndexName: string, scope?: Array<'settings' | 'synonyms' | 'rules'>): Promise<AlgoliaTask>;
+/**
+ * Move an index
+ */
+export declare function moveIndex(srcIndexName: string, dstIndexName: string): Promise<AlgoliaTask>;
+/**
+ * Delete an index
+ */
+export declare function deleteIndex(indexName: string): Promise<AlgoliaTask>;
+/**
+ * Check if an index exists
+ */
+export declare function indexExists(indexName: string): Promise<boolean>;
+/**
+ * Wait for a task to complete
+ */
+export declare function waitTask(indexName: string, taskID: number, timeoutMs?: number, intervalMs?: number): Promise<{ status: 'published' | 'notPublished' }>;
+/**
+ * Add a synonym
+ */
+export declare function saveSynonym(indexName: string, synonym: {
+    objectID: string
+    type: 'synonym' | 'oneWaySynonym' | 'altCorrection1' | 'altCorrection2' | 'placeholder'
+    synonyms?: string[]
+    input?: string
+    word?: string
+    corrections?: string[]
+    placeholder?: string
+    replacements?: string[]
+  }, forwardToReplicas?: boolean): Promise<AlgoliaTask>;
+/**
+ * Search synonyms
+ */
+export declare function searchSynonyms(indexName: string, query?: string, type?: string, page?: number, hitsPerPage?: number): Promise<{ hits: any[], nbHits: number }>;
+/**
+ * Clear all synonyms
+ */
+export declare function clearSynonyms(indexName: string, forwardToReplicas?: boolean): Promise<AlgoliaTask>;
+/**
+ * Add a rule
+ */
+export declare function saveRule(indexName: string, rule: {
+    objectID: string
+    conditions?: Array<{
+      pattern?: string
+      anchoring?: 'is' | 'startsWith' | 'endsWith' | 'contains'
+      context?: string
+    }>
+    consequence: {
+      params?: Record<string, any>
+      promote?: Array<{ objectID: string, position: number }>
+      hide?: Array<{ objectID: string }>
+      userData?: Record<string, any>
+    }
+    description?: string
+    enabled?: boolean
+    validity?: Array<{ from: number, until: number }>
+  }, forwardToReplicas?: boolean): Promise<AlgoliaTask>;
+/**
+ * Search rules
+ */
+export declare function searchRules(indexName: string, query?: string, anchoring?: string, context?: string, page?: number, hitsPerPage?: number): Promise<{ hits: any[], nbHits: number }>;
+/**
+ * Clear all rules
+ */
+export declare function clearRules(indexName: string, forwardToReplicas?: boolean): Promise<AlgoliaTask>;
+/**
+ * Browse all records in an index
+ */
+export declare function browse(indexName: string, params?: AlgoliaSearchParams): AsyncGenerator<AlgoliaHit>;
+export declare const algolia: {
+  
+};
+export declare interface AlgoliaConfig {
+  appId: string
+  apiKey: string
+  searchOnlyApiKey?: string
+}
+export declare interface AlgoliaSearchParams {
+  query?: string
+  page?: number
+  hitsPerPage?: number
+  filters?: string
+  facets?: string[]
+  attributesToRetrieve?: string[]
+  attributesToHighlight?: string[]
+  attributesToSnippet?: string[]
+  sortBy?: string
+}
+export declare interface AlgoliaHit {
+  objectID: string
+  [key: string]: any
+}
+export declare interface AlgoliaSearchResponse {
+  hits: AlgoliaHit[]
+  nbHits: number
+  page: number
+  nbPages: number
+  hitsPerPage: number
+  processingTimeMS: number
+  query: string
+  params: string
+  facets?: Record<string, Record<string, number>>
+}
+export declare interface AlgoliaIndexSettings {
+  searchableAttributes?: string[]
+  attributesForFaceting?: string[]
+  unretrievableAttributes?: string[]
+  attributesToRetrieve?: string[]
+  ranking?: string[]
+  customRanking?: string[]
+  replicas?: string[]
+  maxValuesPerFacet?: number
+  sortFacetValuesBy?: 'count' | 'alpha'
+  attributesToHighlight?: string[]
+  attributesToSnippet?: string[]
+  highlightPreTag?: string
+  highlightPostTag?: string
+  snippetEllipsisText?: string
+  restrictHighlightAndSnippetArrays?: boolean
+  minWordSizefor1Typo?: number
+  minWordSizefor2Typos?: number
+  typoTolerance?: boolean | 'min' | 'strict'
+  allowTyposOnNumericTokens?: boolean
+  disableTypoToleranceOnAttributes?: string[]
+  ignorePlurals?: boolean | string[]
+  removeStopWords?: boolean | string[]
+  separatorsToIndex?: string
+  queryType?: 'prefixLast' | 'prefixAll' | 'prefixNone'
+  removeWordsIfNoResults?: 'none' | 'lastWords' | 'firstWords' | 'allOptional'
+  advancedSyntax?: boolean
+  optionalWords?: string[]
+  disablePrefixOnAttributes?: string[]
+  disableExactOnAttributes?: string[]
+  exactOnSingleWordQuery?: 'attribute' | 'none' | 'word'
+  alternativesAsExact?: Array<'ignorePlurals' | 'singleWordSynonym' | 'multiWordsSynonym'>
+  numericAttributesForFiltering?: string[]
+  allowCompressionOfIntegerArray?: boolean
+  attributeForDistinct?: string
+  distinct?: boolean | number
+  replaceSynonymsInHighlight?: boolean
+  minProximity?: number
+  responseFields?: string[]
+  maxFacetHits?: number
+  paginationLimitedTo?: number
+}
+export declare interface AlgoliaTask {
+  taskID: number
+  objectID?: string
+  objectIDs?: string[]
+  createdAt?: string
+  updatedAt?: string
+}
+export default algolia;

package/dist/src/drivers/meilisearch.d.ts

@@ -0,0 +1,2 @@
+declare const meilisearch: SearchEngineDriver;
+export default meilisearch;

package/dist/src/drivers/opensearch.d.ts

@@ -0,0 +1,48 @@
+//
+// const host = searchEngine.openSearch?.host
+// const protocol = searchEngine.openSearch?.protocol
+// const port = searchEngine.openSearch?.port
+// const auth = searchEngine.openSearch?.auth
+//
+// const client = new Client({
+//   node: `${protocol}://${auth}@${host}:${port}`,
+// })
+//
+// async function search(index: string, params?: any) {
+//   const response = await client.search({
+//     index,
+//     body: params.query,
+//   })
+//
+//   return response
+// }
+//
+// async function createIndex(indexName: string, settings?: any): Promise<ApiResponse<any, any>> {
+//   return await client.indices.create({ index: indexName, body: settings })
+// }
+// // async function updateIndex(indexName: string,  settings?: any): Promise<ApiResponse<any, any>> {
+// //   return await client.indices.update({ index: indexName, body: settings })
+// // }
+//
+// async function deleteIndex(indexName: string): Promise<ApiResponse<any, any>> {
+//   return await client.indices.delete({ index: indexName })
+// }
+//
+// async function addDocument(indexName: string, document: any): Promise<ApiResponse<any, any>> {
+//   return await client.index({
+//     id: document.id,
+//     index: indexName,
+//     body: document,
+//     refresh: true,
+//   })
+// }
+//
+// async function deleteDocument(indexName: string, document: any): Promise<ApiResponse<any, any>> {
+//   return await client.delete({
+//     id: document.id,
+//     index: indexName,
+//   })
+// }
+//
+declare const opensearch: SearchEngineDriver;
+export default opensearch;

package/dist/src/index.d.ts

@@ -7,5 +7,5 @@ export declare function useAlgolia(): typeof algolia;
 export declare function useMeilisearch(): typeof meilisearch;
 export declare function useOpensearch(): typeof opensearch;
 export type SearchDriver = 'meilisearch' | 'algolia' | 'opensearch';
-export * from './documents';
+export * from './documents/index';
 export { algolia, meilisearch, opensearch };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/search-engine",
   "type": "module",
-  "version": "0.70.37",
+  "version": "0.70.42",
   "description": "The Stacks search engine integrations.",
   "author": "Chris Breuer",
   "contributors": [
@@ -54,7 +54,7 @@
     "prepublishOnly": "bun run build"
   },
   "devDependencies": {
-    "@stacksjs/config": "0.70.30",
+    "@stacksjs/config": "^0.70.42",
     "better-dx": "^0.2.12"
   }
 }