@rimori/client 2.5.26-next.0 → 2.5.26-next.2

package/dist/cli/types/DatabaseTypes.d.ts

@@ -8,7 +8,15 @@
  *  2. Add an `updated_at` trigger so the image-sync cron can detect recently
  *     modified entries. The cron derives which columns to scan from release.db_schema.
  */
-type DbColumnType = 'decimal' | 'integer' | 'text' | 'boolean' | 'json' | 'timestamp' | 'uuid' | 'markdown';
+/**
+ * 'vector' is stored as `vector(1536)` in the database (pgvector).
+ * Marking a column as 'vector' causes the migration system to:
+ *  1. Create the column as `vector(1536)` with nullable constraint.
+ *  2. Create an IVFFlat index for cosine similarity search.
+ *  3. The column MUST be named 'embedding' and only one per table is allowed.
+ *  4. Requires `source_column` — the column whose content is embedded async on insert.
+ */
+type DbColumnType = 'decimal' | 'integer' | 'text' | 'boolean' | 'json' | 'timestamp' | 'uuid' | 'markdown' | 'vector';
 /**
  * Foreign key relationship configuration with cascade delete support.
  * Defines a relationship where the source record is deleted when the destination record is deleted.
@@ -22,11 +30,11 @@ interface ForeignKeyRelation {
     on_delete_cascade: boolean;
 }
 /**
- * Database column definition with support for types, constraints, and relationships.
+ * Regular (non-vector) database column definition with support for types, constraints, and relationships.
  */
-export interface DbColumnDefinition {
+interface DbRegularColumnDefinition {
     /** The data type of the column */
-    type: DbColumnType;
+    type: Exclude<DbColumnType, 'vector'>;
     /** Human-readable description of the column's purpose */
     description: string;
     /** Whether the column can contain null values */
@@ -36,6 +44,8 @@ export interface DbColumnDefinition {
     /** Default value for the column. can also use sql functions like now(), auth.uid() or gen_random_uuid() */
     default_value?: string | number | boolean;
     /** Array of allowed values for enumerated columns */
+    /** Not allowed on non-vector columns */
+    source_column?: never;
     /** Foreign key relationship configuration */
     foreign_key?: ForeignKeyRelation;
     /** The name of the column before it was renamed. */
@@ -55,6 +65,39 @@ export interface DbColumnDefinition {
         lang_moderator?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
     };
 }
+/**
+ * Vector column definition for semantic search via pgvector.
+ * The column MUST be named 'embedding' and only one per table is allowed.
+ * The backend generates embeddings asynchronously from the source_column content.
+ */
+interface DbVectorColumnDefinition {
+    /** Must be 'vector' */
+    type: 'vector';
+    /** Human-readable description of the column's purpose */
+    description: string;
+    /** Vector columns must be nullable (embeddings are generated asynchronously) */
+    nullable: true;
+    /** The column whose content is embedded. Must reference an existing column in the same table. */
+    source_column: string;
+    /** Not applicable to vector columns */
+    unique?: never;
+    /** Not applicable to vector columns */
+    default_value?: never;
+    /** Not applicable to vector columns */
+    foreign_key?: never;
+    /** Not applicable to vector columns */
+    old_name?: never;
+    /** Not applicable to vector columns */
+    deprecated?: never;
+    /** Not applicable to vector columns */
+    restrict?: never;
+}
+/**
+ * Database column definition — discriminated union on `type`.
+ * Use `type: 'vector'` for embedding columns (enforces `nullable: true` and requires `source_column`).
+ * All other types forbid `source_column`.
+ */
+export type DbColumnDefinition = DbRegularColumnDefinition | DbVectorColumnDefinition;
 /**
  * Base table structure that all database tables inherit.
  * Includes standard audit fields for tracking creation and ownership.

package/dist/plugin/module/DbModule.d.ts

@@ -25,6 +25,21 @@ export type PublicityLevel = 'own' | 'guild' | 'lang';
  * Database module for plugin database operations.
  * Provides access to plugin tables with automatic prefixing and schema management.
  */
+export interface VectorSearchParams {
+    /** Table name without plugin prefix (e.g. 'pages') */
+    tableName: string;
+    /** The text query to search for */
+    query: string;
+    /** Maximum number of results (default: 5) */
+    limit?: number;
+    /** Similarity threshold 0-1 (default: 0.5) */
+    threshold?: number;
+    /** Which columns to return (default: all) */
+    selectColumns?: string[];
+}
+export type VectorSearchResult<T = Record<string, unknown>> = Array<T & {
+    similarity: number;
+}>;
 export declare class DbModule {
     private supabase;
     private rimoriInfo;
@@ -63,5 +78,12 @@ export declare class DbModule {
      * @param publicity The desired publicity level
      */
     setPublicity(table: string, entryId: string, publicity: PublicityLevel): Promise<void>;
+    /**
+     * Search a plugin table using vector similarity (cosine distance).
+     * The table must have a vector column named 'embedding' defined in db.config.ts.
+     * @param params Search parameters
+     * @returns Matching rows sorted by similarity
+     */
+    vectorSearch<T = Record<string, unknown>>(params: VectorSearchParams): Promise<VectorSearchResult<T>>;
 }
 export {};

package/dist/plugin/module/DbModule.js

@@ -7,10 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-/**
- * Database module for plugin database operations.
- * Provides access to plugin tables with automatic prefixing and schema management.
- */
 export class DbModule {
     constructor(supabase, communicationHandler, info) {
         this.supabase = supabase;
@@ -86,4 +82,26 @@ export class DbModule {
             });
         });
     }
+    /**
+     * Search a plugin table using vector similarity (cosine distance).
+     * The table must have a vector column named 'embedding' defined in db.config.ts.
+     * @param params Search parameters
+     * @returns Matching rows sorted by similarity
+     */
+    vectorSearch(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield fetch(`${this.rimoriInfo.backendUrl}/plugin-search/vector-search`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${this.rimoriInfo.token}`,
+                },
+                body: JSON.stringify(params),
+            });
+            if (!response.ok) {
+                throw new Error(`Vector search failed: ${response.statusText}`);
+            }
+            return yield response.json();
+        });
+    }
 }

package/dist/plugin/module/EventModule.d.ts

@@ -69,6 +69,13 @@ export declare class EventModule {
      * @param text Optional text to be used for the action like for example text that the translator would look up.
      */
     emitSidebarAction(pluginId: string, actionKey: string, text?: string, args?: Record<string, unknown>): void;
+    /**
+     * Trigger an action that opens a plugin in the main panel and triggers an action.
+     * @param pluginId The id of the plugin to trigger the action for.
+     * @param actionKey The key of the action to trigger.
+     * @param params Optional additional parameters to pass to the action.
+     */
+    emitMainPanelAction(pluginId: string, actionKey: string, params?: Record<string, string>): void;
     /**
      * Subscribe to main panel actions triggered by the user from the dashboard.
      * @param callback Handler function that receives the action data when a matching action is triggered.

package/dist/plugin/module/EventModule.js

@@ -167,6 +167,15 @@ export class EventModule {
     emitSidebarAction(pluginId, actionKey, text, args) {
         this.emit('global.sidebar.triggerAction', { plugin_id: pluginId, action_key: actionKey, text, args });
     }
+    /**
+     * Trigger an action that opens a plugin in the main panel and triggers an action.
+     * @param pluginId The id of the plugin to trigger the action for.
+     * @param actionKey The key of the action to trigger.
+     * @param params Optional additional parameters to pass to the action.
+     */
+    emitMainPanelAction(pluginId, actionKey, params) {
+        this.emit('global.mainPanel.triggerAction', Object.assign({ plugin_id: pluginId, action_key: actionKey }, params));
+    }
     /**
      * Subscribe to main panel actions triggered by the user from the dashboard.
      * @param callback Handler function that receives the action data when a matching action is triggered.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "2.5.26-next.0",
+  "version": "2.5.26-next.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {