@rimori/client 1.4.0 → 1.4.3

package/dist/utils/Language.js

@@ -1,61 +1,61 @@
 export const languageKeys = {
-    sq: "albanian",
-    ar: "arabic",
-    hy: "armenian",
-    az: "azerbaijani",
-    bn: "bengali",
-    bs: "bosnian",
-    bg: "bulgarian",
-    ca: "catalan",
-    zh: "chinese",
-    hr: "croatian",
-    cs: "czech",
-    da: "danish",
-    nl: "dutch",
-    en: "english",
-    et: "estonian",
-    fi: "finnish",
-    fr: "french",
-    gl: "galician",
-    de: "german",
-    el: "greek",
-    he: "hebrew",
-    hi: "hindi",
-    hu: "hungarian",
-    is: "icelandic",
-    id: "indonesian",
-    it: "italian",
-    ja: "japanese",
-    kn: "kannada",
-    kk: "kazakh",
-    ko: "korean",
-    lv: "latvian",
-    lt: "lithuanian",
-    mk: "macedonian",
-    ms: "malay",
-    mr: "marathi",
-    mi: "maori",
-    ne: "nepali",
-    no: "norwegian",
-    fa: "persian",
-    pl: "polish",
-    pt: "portuguese",
-    ro: "romanian",
-    ru: "russian",
-    sr: "serbian",
-    sk: "slovak",
-    sl: "slovenian",
-    es: "spanish",
-    sw: "swahili",
-    sv: "swedish",
-    tl: "filipino",
-    ta: "tamil",
-    th: "thai",
-    tr: "turkish",
-    uk: "ukrainian",
-    ur: "urdu",
-    vi: "vietnamese",
-    cy: "welsh"
+    sq: 'albanian',
+    ar: 'arabic',
+    hy: 'armenian',
+    az: 'azerbaijani',
+    bn: 'bengali',
+    bs: 'bosnian',
+    bg: 'bulgarian',
+    ca: 'catalan',
+    zh: 'chinese',
+    hr: 'croatian',
+    cs: 'czech',
+    da: 'danish',
+    nl: 'dutch',
+    en: 'english',
+    et: 'estonian',
+    fi: 'finnish',
+    fr: 'french',
+    gl: 'galician',
+    de: 'german',
+    el: 'greek',
+    he: 'hebrew',
+    hi: 'hindi',
+    hu: 'hungarian',
+    is: 'icelandic',
+    id: 'indonesian',
+    it: 'italian',
+    ja: 'japanese',
+    kn: 'kannada',
+    kk: 'kazakh',
+    ko: 'korean',
+    lv: 'latvian',
+    lt: 'lithuanian',
+    mk: 'macedonian',
+    ms: 'malay',
+    mr: 'marathi',
+    mi: 'maori',
+    ne: 'nepali',
+    no: 'norwegian',
+    fa: 'persian',
+    pl: 'polish',
+    pt: 'portuguese',
+    ro: 'romanian',
+    ru: 'russian',
+    sr: 'serbian',
+    sk: 'slovak',
+    sl: 'slovenian',
+    es: 'spanish',
+    sw: 'swahili',
+    sv: 'swedish',
+    tl: 'filipino',
+    ta: 'tamil',
+    th: 'thai',
+    tr: 'turkish',
+    uk: 'ukrainian',
+    ur: 'urdu',
+    vi: 'vietnamese',
+    cy: 'welsh',
 };
 /**
  * Get the language name from the language code

package/dist/utils/PluginUtils.js

@@ -2,11 +2,11 @@ export function isFullscreen() {
     return !!document.fullscreenElement;
 }
 export function triggerFullscreen(onStateChange, selector) {
-    document.addEventListener("fullscreenchange", () => {
+    document.addEventListener('fullscreenchange', () => {
         onStateChange(isFullscreen());
     });
     try {
-        const ref = document.querySelector(selector || "#root");
+        const ref = document.querySelector(selector || '#root');
         if (!isFullscreen()) {
             // @ts-ignore
             ref.requestFullscreen() || ref.webkitRequestFullscreen();
@@ -17,7 +17,7 @@ export function triggerFullscreen(onStateChange, selector) {
         }
     }
     catch (error) {
-        console.error("Failed to enter fullscreen", error.message);
+        console.error('Failed to enter fullscreen', error.message);
     }
     onStateChange(isFullscreen());
 }

package/dist/utils/difficultyConverter.d.ts

@@ -1,4 +1,4 @@
-export type LanguageLevel = "Pre-A1" | "A1" | "A2" | "B1" | "B2" | "C1" | "C2" | "Post-C2";
+export type LanguageLevel = 'Pre-A1' | 'A1' | 'A2' | 'B1' | 'B2' | 'C1' | 'C2' | 'Post-C2';
 export declare function getDifficultyLevel(difficulty: LanguageLevel): number;
 export declare function getDifficultyLabel(difficulty: number): LanguageLevel;
 export declare function getNeighborDifficultyLevel(difficulty: LanguageLevel, difficultyAdjustment: number): LanguageLevel;

package/dist/utils/difficultyConverter.js

@@ -1,4 +1,4 @@
-const codes = ["Pre-A1", "A1", "A2", "B1", "B2", "C1", "C2", "Post-C2"];
+const codes = ['Pre-A1', 'A1', 'A2', 'B1', 'B2', 'C1', 'C2', 'Post-C2'];
 export function getDifficultyLevel(difficulty) {
     return codes.indexOf(difficulty) + 1;
 }

package/dist/utils/endpoint.js

@@ -1,2 +1,2 @@
-export const DEFAULT_ENDPOINT = "https://pheptqdoqsdnadgoihvr.supabase.co";
-export const DEFAULT_ANON_KEY = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InBoZXB0cWRvcXNkbmFkZ29paHZyIiwicm9sZSI6ImFub24iLCJpYXQiOjE3MzE2OTY2ODcsImV4cCI6MjA0NzI3MjY4N30.4GPFAXTF8685FaXISdAPNCIM-H3RGLo8GbyhQpu1mP0";
+export const DEFAULT_ENDPOINT = 'https://pheptqdoqsdnadgoihvr.supabase.co';
+export const DEFAULT_ANON_KEY = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InBoZXB0cWRvcXNkbmFkZ29paHZyIiwicm9sZSI6ImFub24iLCJpYXQiOjE3MzE2OTY2ODcsImV4cCI6MjA0NzI3MjY4N30.4GPFAXTF8685FaXISdAPNCIM-H3RGLo8GbyhQpu1mP0';

package/dist/worker/WorkerSetup.d.ts

@@ -1,4 +1,4 @@
-import { RimoriClient } from "../plugin/RimoriClient";
+import { RimoriClient } from '../plugin/RimoriClient';
 /**
  * Sets up the web worker for the plugin to be able receive and send messages to Rimori.
  * @param pluginId - The id of the plugin to setup the worker for.

package/dist/worker/WorkerSetup.js

@@ -7,8 +7,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { EventBusHandler } from "../fromRimori/EventBus";
-import { PluginController } from "../plugin/PluginController";
+import { EventBusHandler } from '../fromRimori/EventBus';
+import { PluginController } from '../plugin/PluginController';
 /**
  * Sets up the web worker for the plugin to be able receive and send messages to Rimori.
  * @param pluginId - The id of the plugin to setup the worker for.
@@ -21,17 +21,17 @@ export function setupWorker(pluginId, init) {
             isWorker: true,
             location: {},
             parent: {
-                postMessage: () => { }
+                postMessage: () => { },
             },
-            addEventListener: () => { }
+            addEventListener: () => { },
         };
         // Assign the mock to globalThis.
         Object.assign(globalThis, { window: mockWindow });
-        EventBusHandler.getInstance("Worker EventBus");
+        EventBusHandler.getInstance('Worker EventBus');
         const rimoriClient = yield PluginController.getInstance(pluginId);
         console.debug('[Worker] RimoriClient initialized.');
         yield init(rimoriClient);
         console.debug('[Worker] Worker initialized.');
-        self.postMessage({ type: "rimori:acknowledged", pluginId: pluginId });
+        self.postMessage({ type: 'rimori:acknowledged', pluginId: pluginId });
     });
 }

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 };
   });
-});
+});