@rimori/client 1.3.1 → 1.4.3

package/eslint.config.js

@@ -0,0 +1,53 @@
+import js from '@eslint/js';
+import globals from 'globals';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import tseslint from 'typescript-eslint';
+import prettier from 'eslint-plugin-prettier';
+import prettierConfig from 'eslint-config-prettier';
+
+export default [
+  { ignores: ['dist', 'node_modules', 'build', '*.js'] },
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  prettierConfig,
+  {
+    files: ['**/*.{ts,tsx,js,jsx}'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.jest,
+      },
+      sourceType: 'module',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    plugins: {
+      'react-hooks': reactHooks,
+      'react-refresh': reactRefresh,
+      prettier: prettier,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
+      '@typescript-eslint/no-unused-vars': 'warn',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      '@typescript-eslint/explicit-function-return-type': 'warn',
+      '@typescript-eslint/explicit-module-boundary-types': 'warn',
+      '@typescript-eslint/no-unsafe-assignment': 'warn',
+      '@typescript-eslint/no-unsafe-member-access': 'warn',
+      '@typescript-eslint/no-unsafe-call': 'warn',
+      '@typescript-eslint/no-unsafe-return': 'warn',
+      '@typescript-eslint/no-inferrable-types': 'warn',
+      '@typescript-eslint/no-non-null-assertion': 'warn',
+      '@typescript-eslint/ban-ts-comment': 'warn',
+      'prettier/prettier': 'error',
+    },
+  },
+];

package/example/docs/devdocs.md

@@ -13,41 +13,44 @@ All communication uses the Rimori event bus with the pattern: `<plugin_id>.<area
 ### 1. Create Flashcards
 
 #### Basic Creation
+
 ```javascript
 // Create a simple flashcard
-plugin.event.emit("pl123456789.flashcard.create", {
-  front: "Hello",
-  back: "Hola", 
-  deckId: "deck-123", // optional, uses default deck if omitted
-  frontTags: ["lang:en"],
-  backTags: ["lang:es"]
+plugin.event.emit('pl123456789.flashcard.create', {
+  front: 'Hello',
+  back: 'Hola',
+  deckId: 'deck-123', // optional, uses default deck if omitted
+  frontTags: ['lang:en'],
+  backTags: ['lang:es'],
 });
 ```
 
 #### Language-based Creation
+
 ```javascript
 // Create flashcard with automatic lookup
-plugin.event.emit("pl123456789.flashcard.createLangCard", {
-  word: "perro",
-  language: "es", // optional, uses user's mother tongue if omitted
-  deckId: "spanish-nouns" // optional
+plugin.event.emit('pl123456789.flashcard.createLangCard', {
+  word: 'perro',
+  language: 'es', // optional, uses user's mother tongue if omitted
+  deckId: 'spanish-nouns', // optional
 });
 ```
 
 ### 2. Lookup Requests
 
 #### Basic Translation
+
 ```javascript
 // Request word translation
-const translation = await plugin.event.request("pl123456789.lookup.requestBasic", {
-  word: "laufen",
-  language: "de" // optional
+const translation = await plugin.event.request('pl123456789.lookup.requestBasic', {
+  word: 'laufen',
+  language: 'de', // optional
 });
 
 // Returns:
 // {
 //   input: "laufen",
-//   language: "de", 
+//   language: "de",
 //   type: "verb",
 //   swedish_translation: "att springa",
 //   translation: "to run"
@@ -55,11 +58,12 @@ const translation = await plugin.event.request("pl123456789.lookup.requestBasic"
 ```
 
 #### Advanced Lookup
+
 ```javascript
 // Get detailed word information
-const details = await plugin.event.request("pl123456789.lookup.request", {
-  word: "laufen",
-  language: "de"
+const details = await plugin.event.request('pl123456789.lookup.request', {
+  word: 'laufen',
+  language: 'de',
 });
 
 // Returns extended object with grammar, examples, tenses, etc.
@@ -68,14 +72,15 @@ const details = await plugin.event.request("pl123456789.lookup.request", {
 ### 3. Deck Management
 
 #### Get Available Decks
+
 ```javascript
-const decks = await plugin.event.request("pl123456789.deck.requestOpenToday");
+const decks = await plugin.event.request('pl123456789.deck.requestOpenToday');
 
 // Returns:
 // [
 //   {
 //     id: "deck-123",
-//     name: "Spanish Vocabulary", 
+//     name: "Spanish Vocabulary",
 //     total_new: 5,
 //     total_learning: 12,
 //     total_review: 8
@@ -84,9 +89,10 @@ const decks = await plugin.event.request("pl123456789.deck.requestOpenToday");
 ```
 
 #### Create New Deck
+
 ```javascript
-const newDeck = await plugin.event.request("pl123456789.deck.create", {
-  name: "German Verbs"
+const newDeck = await plugin.event.request('pl123456789.deck.create', {
+  name: 'German Verbs',
 });
 
 // Returns: { id: "deck-456", name: "German Verbs", last_used: "2025-01-06T..." }
@@ -95,35 +101,37 @@ const newDeck = await plugin.event.request("pl123456789.deck.create", {
 ### 4. Trigger Training
 
 #### Open Flashcard Training
+
 ```javascript
 // Open training in main panel
-plugin.event.emit("global.mainPanel.triggerAction", {
-  pluginId: "pl123456789",
-  actionKey: "flashcards",
-  deck: "latest", // or "random", "oldest", "mix", deck ID
-  total_amount: 20 // or "default"
+plugin.event.emit('global.mainPanel.triggerAction', {
+  pluginId: 'pl123456789',
+  actionKey: 'flashcards',
+  deck: 'latest', // or "random", "oldest", "mix", deck ID
+  total_amount: 20, // or "default"
 });
 ```
 
 ## Worker Function Example
 
 ### Background Deck Sync
+
 ```javascript
 // worker/listeners/deck-sync.ts
 import { WorkerEventListener } from '@rimori/client';
 
 export const deckSyncListener: WorkerEventListener = {
   eventName: 'pl123456789.deck.syncProgress',
-  
+
   async handler(data: { userId: string; deckId: string }) {
     const { userId, deckId } = data;
-    
+
     // Calculate learning statistics
     const stats = await calculateDeckProgress(deckId, userId);
-    
+
     // Update user's learning streak
     await updateLearningStreak(userId, stats);
-    
+
     // Send progress update to main thread
     self.postMessage({
       type: 'progress-updated',
@@ -143,10 +151,10 @@ async function calculateDeckProgress(deckId: string, userId: string) {
     .select('*')
     .eq('deck_id', deckId)
     .eq('user_id', userId);
-    
+
   const reviewed = cards.filter(c => c.last_review_date >= getTodayStart());
   const accuracy = reviewed.reduce((acc, c) => acc + c.ease_factor, 0) / reviewed.length;
-  
+
   return {
     reviewed: reviewed.length,
     accuracy: Math.round(accuracy * 100),
@@ -185,6 +193,7 @@ interface Deck {
 ## Integration Examples
 
 ### Dictionary Plugin → Flashcards
+
 ```javascript
 // When user looks up a word in dictionary
 function onWordLookup(word: string, translation: string) {
@@ -198,15 +207,16 @@ function onWordLookup(word: string, translation: string) {
 }
 ```
 
-### Study Planner → Flashcards  
+### Study Planner → Flashcards
+
 ```javascript
 // Trigger daily flashcard session
 function scheduleDailyReview() {
-  plugin.event.emit("global.mainPanel.triggerAction", {
-    pluginId: "pl123456789", 
-    actionKey: "flashcards",
-    deck: "mix",
-    total_amount: 30
+  plugin.event.emit('global.mainPanel.triggerAction', {
+    pluginId: 'pl123456789',
+    actionKey: 'flashcards',
+    deck: 'mix',
+    total_amount: 30,
   });
 }
 ```
@@ -215,9 +225,9 @@ function scheduleDailyReview() {
 
 ```javascript
 try {
-  await plugin.event.request("pl123456789.flashcard.create", cardData);
+  await plugin.event.request('pl123456789.flashcard.create', cardData);
 } catch (error) {
-  console.error("Failed to create flashcard:", error);
+  console.error('Failed to create flashcard:', error);
   // Handle error appropriately
 }
 ```

package/example/docs/overview.md

@@ -9,7 +9,7 @@ Simple Flashcards uses proven spaced repetition algorithms to help you memorize
 ## 🎯 Perfect for
 
 - **Language learners** building vocabulary with audio pronunciation
-- **Students** memorizing facts, formulas, and definitions  
+- **Students** memorizing facts, formulas, and definitions
 - **Professionals** learning technical terms and concepts
 - **Anyone** who wants to remember information long-term
 

package/example/docs/userdocs.md

@@ -62,7 +62,7 @@ Speed up your review sessions with keyboard shortcuts that eliminate the need fo
 - **Spacebar** - Reveal the answer when studying the front of a card
 - **Number keys 1-4** - Rate your recall (Again, Hard, Good, Easy respectively)
 - **5 key** - Play audio for the front of the card (if language tags are present)
-- **h key** - Play audio for the back of the card (if language tags are present) 
+- **h key** - Play audio for the back of the card (if language tags are present)
 - **v key** - Edit the current flashcard during review
 
 These shortcuts allow you to maintain focus and rhythm during your learning sessions.
@@ -109,15 +109,18 @@ To get the most out of your flashcard learning:
 ## Troubleshooting Common Issues
 
 **Audio not playing when expected?**
+
 - Verify that your device volume is turned up and not muted
 - Check that the flashcard has proper language tags (e.g., `lang:en` for English)
 - Try refreshing the page if audio features seem unresponsive
 
 **Flashcards not saving properly?**
+
 - Ensure you have a stable internet connection for data synchronization
 - Verify you clicked the save icon after entering card content
 - Try creating the card again if the first attempt failed
 
 **Progress not updating correctly?**
+
 - Refresh the page to ensure you're seeing the latest data
 - Check that you're rating cards rather than just viewing them

package/example/rimori.config.ts

@@ -1,4 +1,4 @@
-import { RimoriPluginConfig } from "@rimori/client";
+import { RimoriPluginConfig } from '@rimori/client';
 
 /**
  * This is an example of a Rimori plugin configuration file. It is based on the Rimori Flashcards plugin.
@@ -6,84 +6,86 @@ import { RimoriPluginConfig } from "@rimori/client";
  */
 
 const config: RimoriPluginConfig = {
-  id: "pl1234567890",  // This is the plugin id. You can find it in the plugin's package.json file.
+  id: 'pl1234567890', // This is the plugin id. You can find it in the plugin's package.json file.
   info: {
-    title: "Flashcards",
-    description: "The Rimori Flashcards Plugin is a powerful tool for learning and memorization using spaced repetition. It helps you efficiently review information, whether you're learning a language, preparing for exams, or mastering new skills. The plugin uses advanced algorithms to schedule your reviews at optimal intervals, maximizing retention while minimizing study time.",
-    logo: "logo.png",
-    website: "https://rimori.se",
+    title: 'Flashcards',
+    description:
+      "The Rimori Flashcards Plugin is a powerful tool for learning and memorization using spaced repetition. It helps you efficiently review information, whether you're learning a language, preparing for exams, or mastering new skills. The plugin uses advanced algorithms to schedule your reviews at optimal intervals, maximizing retention while minimizing study time.",
+    logo: 'logo.png',
+    website: 'https://rimori.se',
   },
   pages: {
     main: [
       {
-        id: "1",
-        url: "#/",
+        id: '1',
+        url: '#/',
         show: true,
-        name: "Flashcards",
-        root: "vocabulary",
-        description: "Quickly memorizing info by using flashcards."
+        name: 'Flashcards',
+        root: 'vocabulary',
+        description: 'Quickly memorizing info by using flashcards.',
       },
-      { // This is a page that is not shown in the navbar. It is used to trigger the flashcards action.
-        id: "2",
-        url: "#/deck/custom",
+      {
+        // This is a page that is not shown in the navbar. It is used to trigger the flashcards action.
+        id: '2',
+        url: '#/deck/custom',
         show: false,
-        root: "vocabulary",
-        name: "Latest flashcard deck training",
-        description: "Training the latest flashcards.",
+        root: 'vocabulary',
+        name: 'Latest flashcard deck training',
+        description: 'Training the latest flashcards.',
         action: {
-          key: "flashcards",
+          key: 'flashcards',
           parameters: {
             total_amount: {
               type: 'number',
-              description: 'Number of flashcards to practice. Default is 70 (10 new + 20 reviewed + 40 forgotten).'
+              description: 'Number of flashcards to practice. Default is 70 (10 new + 20 reviewed + 40 forgotten).',
             },
             deck: {
               type: 'string',
               enum: ['latest', 'random', 'oldest', 'mix', 'best_known'],
-              description: 'Type of deck to practice from'
-            }
-          }
-        }
-      }
+              description: 'Type of deck to practice from',
+            },
+          },
+        },
+      },
     ],
     sidebar: [
       {
-        id: "translate",
-        url: "#/sidebar/translate",
-        name: "Translate",
-        icon: "translate.png",
-        description: "Translate words."
+        id: 'translate',
+        url: '#/sidebar/translate',
+        name: 'Translate',
+        icon: 'translate.png',
+        description: 'Translate words.',
       },
       {
-        id: "flashcard_quick_add",
-        url: "#/sidebar/add",
-        name: "Quick add",
-        icon: "logo.png",
-        description: "Quickly add a word to your flashcards."
-      }
+        id: 'flashcard_quick_add',
+        url: '#/sidebar/add',
+        name: 'Quick add',
+        icon: 'logo.png',
+        description: 'Quickly add a word to your flashcards.',
+      },
     ],
-    settings: "/settings",
+    settings: '/settings',
   },
   context_menu_actions: [
     {
-      text: "Translate",
-      plugin_id: "pl1234567890",
-      action_key: "translate"
+      text: 'Translate',
+      plugin_id: 'pl1234567890',
+      action_key: 'translate',
     },
     {
-      text: "Quick add",
-      plugin_id: "pl1234567890",
-      action_key: "flashcard_quick_add"
-    }
+      text: 'Quick add',
+      plugin_id: 'pl1234567890',
+      action_key: 'flashcard_quick_add',
+    },
   ],
   documentation: {
-    overview_path: "docs/overview.md",
-    user_path: "docs/userdocs.md",
-    developer_path: "docs/devdocs.md"
+    overview_path: 'docs/overview.md',
+    user_path: 'docs/userdocs.md',
+    developer_path: 'docs/devdocs.md',
   },
   worker: {
-    url: "web-worker.js",
-  }
+    url: 'web-worker.js',
+  },
 };
 
-export default config;
+export default config;

package/example/worker/vite.config.ts

@@ -1,5 +1,5 @@
-import { defineConfig } from 'vite'
-import path from 'path'
+import { defineConfig } from 'vite';
+import path from 'path';
 
 export default defineConfig({
   root: __dirname,
@@ -20,4 +20,4 @@ export default defineConfig({
       },
     },
   },
-})
+});

package/example/worker/worker.ts

@@ -4,8 +4,8 @@ setupWorker(async (client: RimoriClient) => {
   console.log('[Worker] initialized');
 
   // listening to events for this plugin to create flashcards
-  client.event.respond<{ front: string, back: string }>('flashcards.create', ({ data }) => {
+  client.event.respond<{ front: string; back: string }>('flashcards.create', ({ data }) => {
     console.log('[Worker] creating flashcards in database', data);
     return { success: true };
   });
-});
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "1.3.1",
+  "version": "1.4.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -25,7 +25,12 @@
   "scripts": {
     "build": "tsc && sass src/style.scss:dist/style.css",
     "dev": "tsc -w  --preserveWatchOutput",
-    "css-dev": "sass --watch src/style.scss:dist/style.css"
+    "css-dev": "sass --watch src/style.scss:dist/style.css",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "check": "yarn lint && yarn format:check"
   },
   "peerDependencies": {
     "react": "^18.0.0",
@@ -39,12 +44,20 @@
     "html2canvas": "1.4.1",
     "react-icons": "5.4.0",
     "react-markdown": "10.1.0",
-    "tiptap-markdown": "0.8.10"
+    "tiptap-markdown": "0.8.10",
+    "prettier": "^3.6.2"
   },
   "devDependencies": {
     "form-data": "^4.0.2",
     "node-fetch": "^3.3.2",
     "sass": "^1.82.0",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.2",
+    "@eslint/js": "^9.37.0",
+    "eslint-plugin-react-hooks": "^7.0.0",
+    "eslint-plugin-react-refresh": "^0.4.23",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^16.4.0",
+    "typescript-eslint": "^8.46.0"
   }
 }

package/prettier.config.js

@@ -0,0 +1,8 @@
+export default {
+  printWidth: 120,
+  singleQuote: true,
+  trailingComma: 'all',
+  semi: true,
+  tabWidth: 2,
+  useTabs: false,
+};

package/src/cli/scripts/init/dev-registration.ts

@@ -31,7 +31,7 @@ export async function askForCredentials(): Promise<UserCredentials> {
       const passwordRl = readline.createInterface({
         input: process.stdin,
         output: process.stdout,
-        terminal: false
+        terminal: false,
       });
 
       process.stdout.write('Enter your password: ');
@@ -113,10 +113,7 @@ export async function askForPort(): Promise<number> {
  * @returns Promise resolving to JWT access token.
  * @throws {Error} if authentication fails.
  */
-export async function authenticateWithSupabase({
-  email,
-  password,
-}: UserCredentials): Promise<string> {
+export async function authenticateWithSupabase({ email, password }: UserCredentials): Promise<string> {
   console.log('🔐 Authenticating with Supabase...');
 
   // Initialize Supabase client (you may need to adjust the URL and key)
@@ -159,13 +156,13 @@ export async function registerDeveloper(jwtToken: string, port: number): Promise
   try {
     const currentFolderName = path.basename(process.cwd());
     const body: any = { port, pluginName: currentFolderName };
-    const backendUrl = process.env.RIMORI_BACKEND_URL || "https://api.rimori.se";
+    const backendUrl = process.env.RIMORI_BACKEND_URL || 'https://api.rimori.se';
 
     const response = await fetch(backendUrl + '/developer/register', {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
-        'Authorization': `Bearer ${jwtToken}`,
+        Authorization: `Bearer ${jwtToken}`,
       },
       body: JSON.stringify(body),
     });
@@ -189,4 +186,4 @@ export async function registerDeveloper(jwtToken: string, port: number): Promise
     console.error(error);
     throw new Error(`Developer registration failed: ${error}`);
   }
-} 
+}

package/src/cli/scripts/init/env-setup.ts

@@ -41,4 +41,4 @@ export function updateGitignore(): void {
   } else {
     console.log('.env already in .gitignore, skipping update');
   }
-} 
+}

package/src/cli/scripts/init/file-operations.ts

@@ -55,4 +55,4 @@ export function copyPluginFiles(): void {
   }
 
   console.log('Plugin file copying completed.');
-} 
+}

package/src/cli/scripts/init/html-cleaner.ts

@@ -8,10 +8,7 @@ import * as path from 'path';
  */
 function removeUnwantedMetaTags(htmlContent: string): string {
   // Remove all meta tags except those with name="viewport" or charset attribute
-  let cleanedContent = htmlContent.replace(
-    /<meta\s+(?![^>]*(?:name\s*=\s*["']viewport["']|charset\s*=))[^>]*>/gi,
-    ''
-  );
+  let cleanedContent = htmlContent.replace(/<meta\s+(?![^>]*(?:name\s*=\s*["']viewport["']|charset\s*=))[^>]*>/gi, '');
 
   // Remove empty lines left behind
   cleanedContent = cleanedContent.replace(/^\s*[\r\n]/gm, '');
@@ -45,4 +42,4 @@ export function cleanHtmlMetaTags(): void {
   } catch (error) {
     console.error(`Error processing HTML file ${filePath}:`, error);
   }
-} 
+}

package/src/cli/scripts/init/main.ts

@@ -2,12 +2,7 @@
 
 import * as fs from 'fs';
 import * as path from 'path';
-import {
-  askForCredentials,
-  askForPort,
-  authenticateWithSupabase,
-  registerDeveloper,
-} from './dev-registration.js';
+import { askForCredentials, askForPort, authenticateWithSupabase, registerDeveloper } from './dev-registration.js';
 import { setupEnvFile, updateGitignore } from './env-setup.js';
 import { copyPluginFiles } from './file-operations.js';
 import { cleanHtmlMetaTags } from './html-cleaner.js';
@@ -42,8 +37,12 @@ async function main(): Promise<void> {
             console.log('❌ Plugin is already initialized!');
             console.log(`Plugin ID: ${packageJson.r_id}`);
             console.log('');
-            console.log('If you want to reinitialize the plugin, please remove the "r_id" field from package.json first.');
-            console.log('Or use the --upgrade flag to upgrade the plugin configuration without changing the plugin ID.');
+            console.log(
+              'If you want to reinitialize the plugin, please remove the "r_id" field from package.json first.',
+            );
+            console.log(
+              'Or use the --upgrade flag to upgrade the plugin configuration without changing the plugin ID.',
+            );
             process.exit(0);
           }
         } catch (error) {
@@ -83,7 +82,6 @@ async function main(): Promise<void> {
 
       // Update gitignore
       updateGitignore();
-
     } else {
       // Step 1: Get user credentials
       const credentials = await askForCredentials();
@@ -125,7 +123,9 @@ async function main(): Promise<void> {
       updateViteConfigBase();
       console.log('✅ Vite config base updated');
     } catch (error) {
-      console.warn(`Warning: Could not update vite.config.ts base property: ${error instanceof Error ? error.message : error}`);
+      console.warn(
+        `Warning: Could not update vite.config.ts base property: ${error instanceof Error ? error.message : error}`,
+      );
     }
 
     // Clean meta tags from index.html after vite adaptation
@@ -152,13 +152,16 @@ async function main(): Promise<void> {
     console.log('Next steps:');
     console.log('1. Check out ./rimori/readme.md for more information about how to make the most out of the plugin.');
     console.log('2. Adapt the ./rimori/rimori.config.ts file to your needs.');
-    console.log('3. Under ./public/docs/ you can find the documentation for an example flashcard plugin to get started easier.');
+    console.log(
+      '3. Under ./public/docs/ you can find the documentation for an example flashcard plugin to get started easier.',
+    );
     console.log('4. Start development with: yarn dev');
     console.log('');
     console.log(`The plugin should now be accessible at: http://localhost:${3000}`);
     console.log('');
-    console.log('If you want to release the plugin, simply run: "yarn release:<alpha|beta|stable>" (details are available in ./rimori/readme.md)');
-
+    console.log(
+      'If you want to release the plugin, simply run: "yarn release:<alpha|beta|stable>" (details are available in ./rimori/readme.md)',
+    );
   } catch (error) {
     console.error(`❌ Error: ${error instanceof Error ? error.message : error}`);
     console.error('');