Merge branch 'master' into develop

# Conflicts:
#	src/settings.ts

README.md

@@ -52,7 +52,7 @@ You can check the [CHANGELOG](./CHANGELOG.md) for more information on the differ
 - Supports Vim navigation keys
 
 **Note:** support of Chinese depends
-on [this additional plugin](https://github.com/aidenlx/cm-chs-patch). Please read its documentation for more
+on [this additional plugin](https://github.com/aidenlx/cm-chs-patch) (also you may need to clear search cache data to apply new Chinese index). Please read its documentation for more
 information.
 
 ## Projects that use Omnisearch

manifest-beta.json

@@ -1,7 +1,7 @@
 {
 	"id": "omnisearch",
 	"name": "Omnisearch",
-	"version": "1.24.0-beta.1",
+	"version": "1.24.0-beta.2",
 	"minAppVersion": "1.3.0",
 	"description": "A search engine that just works",
 	"author": "Simon Cambier",

src/cache-manager.ts

@@ -108,6 +108,7 @@ export class CacheManager {
     let content: string | null = null
 
     const extractor = this.plugin.getTextExtractor()
+    const aiImageAnalyzer = this.plugin.getAIImageAnalyzer()
 
     // ** Plain text **
     // Just read the file content
@@ -161,11 +162,19 @@ export class CacheManager {
     // ** Image **
     else if (
       isFileImage(path) &&
-      this.plugin.settings.imagesIndexing &&
+      ((this.plugin.settings.imagesIndexing &&
-      extractor?.canFileBeExtracted(path)
+      extractor?.canFileBeExtracted(path)) ||
+      (this.plugin.settings.aiImageIndexing &&
+      aiImageAnalyzer?.canBeAnalyzed(file)))
     ) {
+      if (this.plugin.settings.imagesIndexing && extractor?.canFileBeExtracted(path)){
         content = await extractor.extractText(file)
       }
+
+      if (this.plugin.settings.aiImageIndexing && aiImageAnalyzer?.canBeAnalyzed(file)) {
+        content = await aiImageAnalyzer.analyzeImage(file) + (content ?? '')
+      }
+    }
     // ** PDF **
     else if (
       isFilePDF(path) &&

src/globals.ts

@@ -98,6 +98,11 @@ export type TextExtractorApi = {
   canFileBeExtracted: (filePath: string) => boolean
 }
 
+export type AIImageAnalyzerAPI = {
+  analyzeImage: (file: TFile) => Promise<string>;
+  canBeAnalyzed: (file: TFile) => boolean;
+}
+
 export const SEPARATORS =
   /[|\t\n\r\^"= -#%-*,.`\/<>:;?@[-\]_{}\u00A0\u00A1\u00A7\u00AB\u00B6\u00B7\u00BB\u00BF\u037E\u0387\u055A-\u055F\u0589\u058A\u05BE\u05C0\u05C3\u05C6\u05F3\u05F4\u0609\u060A\u060C\u060D\u061B\u061E\u061F\u066A-\u066D\u06D4\u0700-\u070D\u07F7-\u07F9\u0830-\u083E\u085E\u0964\u0965\u0970\u09FD\u0A76\u0AF0\u0C77\u0C84\u0DF4\u0E4F\u0E5A\u0E5B\u0F04-\u0F12\u0F14\u0F3A-\u0F3D\u0F85\u0FD0-\u0FD4\u0FD9\u0FDA\u104A-\u104F\u10FB\u1360-\u1368\u1400\u166E\u1680\u169B\u169C\u16EB-\u16ED\u1735\u1736\u17D4-\u17D6\u17D8-\u17DA\u1800-\u180A\u1944\u1945\u1A1E\u1A1F\u1AA0-\u1AA6\u1AA8-\u1AAD\u1B5A-\u1B60\u1BFC-\u1BFF\u1C3B-\u1C3F\u1C7E\u1C7F\u1CC0-\u1CC7\u1CD3\u2000-\u200A\u2010-\u2029\u202F-\u2043\u2045-\u2051\u2053-\u205F\u207D\u207E\u208D\u208E\u2308-\u230B\u2329\u232A\u2768-\u2775\u27C5\u27C6\u27E6-\u27EF\u2983-\u2998\u29D8-\u29DB\u29FC\u29FD\u2CF9-\u2CFC\u2CFE\u2CFF\u2D70\u2E00-\u2E2E\u2E30-\u2E4F\u3000-\u3003\u3008-\u3011\u3014-\u301F\u3030\u303D\u30A0\u30FB\uA4FE\uA4FF\uA60D-\uA60F\uA673\uA67E\uA6F2-\uA6F7\uA874-\uA877\uA8CE\uA8CF\uA8F8-\uA8FA\uA8FC\uA92E\uA92F\uA95F\uA9C1-\uA9CD\uA9DE\uA9DF\uAA5C-\uAA5F\uAADE\uAADF\uAAF0\uAAF1\uABEB\uFD3E\uFD3F\uFE10-\uFE19\uFE30-\uFE52\uFE54-\uFE61\uFE63\uFE68\uFE6A\uFE6B\uFF01-\uFF03\uFF05-\uFF0A\uFF0C-\uFF0F\uFF1A\uFF1B\uFF1F\uFF20\uFF3B-\uFF3D\uFF3F\uFF5B\uFF5D\uFF5F-\uFF65]/
     .toString()

src/main.ts

@@ -19,6 +19,7 @@ import {
   indexingStep,
   IndexingStepType,
   type TextExtractorApi,
+  type AIImageAnalyzerAPI,
 } from './globals'
 import { notifyOnIndexed, registerAPI } from './tools/api'
 import { Database } from './database'
@@ -208,6 +209,14 @@ export default class OmnisearchPlugin extends Plugin {
     return (this.app as any).plugins?.plugins?.['text-extractor']?.api
   }
 
+  /**
+   * Plugin dependency - Ai Image Analyzer
+   * @returns
+   */
+  public getAIImageAnalyzer(): AIImageAnalyzerAPI | undefined {
+    return (this.app as any).plugins?.plugins?.['ai-image-analyzer']?.api
+  }
+
   private async populateIndex(): Promise<void> {
     console.time('Omnisearch - Indexing total time')
     indexingStep.set(IndexingStepType.ReadingFiles)

src/notes-indexer.ts

@@ -44,14 +44,17 @@ export class NotesIndexer {
   public isContentIndexable(path: string): boolean {
     const settings = this.plugin.settings
     const hasTextExtractor = !!this.plugin.getTextExtractor()
+    const hasAIImageAnalyzer = !!this.plugin.getAIImageAnalyzer()
     const canIndexPDF = hasTextExtractor && settings.PDFIndexing
     const canIndexImages = hasTextExtractor && settings.imagesIndexing
+    const canIndexImagesAI = hasAIImageAnalyzer && settings.aiImageIndexing
     return (
       this.isFilePlaintext(path) ||
       isFileCanvas(path) ||
       isFileFromDataloom(path) ||
       (canIndexPDF && isFilePDF(path)) ||
-      (canIndexImages && isFileImage(path))
+      (canIndexImages && isFileImage(path)) ||
+      (canIndexImagesAI && isFileImage(path))
     )
   }
 

src/settings.ts

@@ -45,6 +45,8 @@ export interface OmnisearchSettings extends WeightingSettings {
   imagesIndexing: boolean
   /** Enable Office documents indexing */
   officeIndexing: boolean
+  /** Enable image ai indexing */
+  aiImageIndexing: boolean
 
   /** Enable indexing of unknown files */
   unsupportedFilesIndexing: 'yes' | 'no' | 'default'
@@ -106,6 +108,7 @@ export class SettingsTab extends PluginSettingTab {
       await database.clearCache()
     }, 1000)
 
+    const aiImageAnalyzer = this.plugin.getAIImageAnalyzer()
     containerEl.empty()
 
     if (this.app.loadLocalStorage(K_DISABLE_OMNISEARCH) == '1') {
@@ -125,6 +128,24 @@ export class SettingsTab extends PluginSettingTab {
 
     //#region Indexing
 
+    const indexingDesc = new DocumentFragment()
+    indexingDesc.createSpan({}, span => {
+      span.innerHTML = `⚠️ <span style="color: var(--text-accent)">Changing indexing settings will clear the cache, and requires a restart of Obsidian.</span><br/><br/>`
+      if (textExtractor) {
+        span.innerHTML += `
+        👍 You have installed <a href="https://github.com/scambier/obsidian-text-extractor">Text Extractor</a>, Omnisearch can use it to index PDFs and images contents.
+            <br />Text extraction only works on desktop, but the cache can be synchronized with your mobile device.`
+      } else {
+        span.innerHTML += `⚠️ Omnisearch requires <a href="https://github.com/scambier/obsidian-text-extractor">Text Extractor</a> to index PDFs and images.`
+      }
+
+      if (aiImageAnalyzer) {
+        span.innerHTML += `<br/>👍 You have installed <a href="https://github.com/Swaggeroo/obsidian-ai-image-analyzer">AI Image Analyzer</a>, Omnisearch can use it to index images contents with ai.`
+      }else {
+        span.innerHTML += `<br/>⚠️ Omnisearch requires <a href="https://github.com/Swaggeroo/obsidian-ai-image-analyzer">AI Image Analyzer</a> to index images with ai.`
+      }
+    })
+
     new Setting(containerEl)
       .setName('Indexing')
       .setHeading()
@@ -191,6 +212,23 @@ export class SettingsTab extends PluginSettingTab {
       )
       .setDisabled(!textExtractor)
 
+    // AI Images Indexing
+    const aiIndexImagesDesc = new DocumentFragment()
+    aiIndexImagesDesc.createSpan({}, span => {
+      span.innerHTML = `Omnisearch will use AI Image Analyzer to index the content of your images with ai.`
+    })
+    new Setting(containerEl)
+      .setName(`Images AI indexing ${aiImageAnalyzer ? '' : '⚠️ Disabled'}`)
+      .setDesc(aiIndexImagesDesc)
+      .addToggle(toggle =>
+        toggle.setValue(settings.aiImageIndexing).onChange(async v => {
+          await database.clearCache()
+          settings.aiImageIndexing = v
+          await saveSettings(this.plugin)
+        })
+      )
+      .setDisabled(!aiImageAnalyzer)
+
     // Index filenames of unsupported files
     new Setting(containerEl)
       .setName('Index paths of unsupported files')
@@ -758,6 +796,7 @@ export function getDefaultSettings(app: App): OmnisearchSettings {
     PDFIndexing: false,
     officeIndexing: false,
     imagesIndexing: false,
+    aiImageIndexing: false,
     unsupportedFilesIndexing: 'default',
     splitCamelCase: false,
     openInNewPane: false,

versions.json

@@ -143,5 +143,6 @@
 	"1.23.0-beta.5": "1.3.0",
 	"1.23.0": "1.3.0",
 	"1.24.0-beta.1": "1.3.0",
-	"1.23.1": "1.3.0"
+	"1.23.1": "1.3.0",
+	"1.24.0-beta.2": "1.3.0"
 }