@rimori/client 2.4.0 → 2.5.0-next.1

package/.github/workflows/pre-release.yml

@@ -1,126 +0,0 @@
-name: Pre-Release Rimori Client
-
-on:
-  push:
-    branches: [dev]
-    paths:
-      - '**'
-      - '!.github/workflows/**'
-
-jobs:
-  pre-release:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          fetch-depth: 0
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          registry-url: 'https://registry.npmjs.org'
-          cache: 'yarn'
-          cache-dependency-path: yarn.lock
-
-      - name: Update npm
-        run: npm install -g npm@latest
-
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile
-
-      - name: Build rimori-client (TypeScript verification)
-        run: yarn build
-
-      - name: Calculate next pre-release version
-        id: version
-        run: |
-          # Read current version from package.json (may be base or pre-release)
-          CURRENT_VERSION=$(node -p "require('./package.json').version")
-
-          # Extract base version (strip any pre-release suffix)
-          # Examples: "2.2.0" -> "2.2.0", "2.2.0-next.5" -> "2.2.0"
-          if [[ "$CURRENT_VERSION" =~ ^([0-9]+\.[0-9]+\.[0-9]+) ]]; then
-            BASE_VERSION="${BASH_REMATCH[1]}"
-          else
-            BASE_VERSION="$CURRENT_VERSION"
-          fi
-
-          # Try to get latest next version from npm
-          LATEST_NEXT=$(npm view @rimori/client@next version 2>/dev/null || echo "none")
-
-          if [ "$LATEST_NEXT" != "none" ]; then
-            # Extract base version and pre-release number from latest next version
-            # Example: "2.2.0-next.5" -> extract "2.2.0" and "5"
-            if [[ "$LATEST_NEXT" =~ ^([0-9]+\.[0-9]+\.[0-9]+)-next\.([0-9]+)$ ]]; then
-              LATEST_BASE="${BASH_REMATCH[1]}"
-              PRERELEASE_NUM="${BASH_REMATCH[2]}"
-              
-              # If base version changed, reset to 1, otherwise increment
-              if [ "$LATEST_BASE" != "$BASE_VERSION" ]; then
-                NEW_NUM=1
-              else
-                NEW_NUM=$((PRERELEASE_NUM + 1))
-              fi
-            else
-              # Fallback: if format doesn't match, start at 1
-              NEW_NUM=1
-            fi
-          else
-            # First pre-release
-            NEW_NUM=1
-          fi
-
-          NEW_VERSION="${BASE_VERSION}-next.${NEW_NUM}"
-          echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
-          echo "Base version: $BASE_VERSION"
-          echo "Calculated next version: $NEW_VERSION"
-
-      - name: Update package.json version
-        run: |
-          # Use node to update version directly (yarn version creates git tags)
-          node -e "const fs = require('fs'); const pkg = JSON.parse(fs.readFileSync('package.json')); pkg.version = '${{ steps.version.outputs.new_version }}'; fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2) + '\n');"
-
-      - name: Publish to npm
-        run: npm publish --tag next --access public
-        # Uses OIDC token automatically (no NODE_AUTH_TOKEN needed)
-        # Requires npm 11.5.1+ and id-token: write permission (already set)
-
-      - name: Output published version
-        run: |
-          echo "✅ Published @rimori/client@${{ steps.version.outputs.new_version }} to npm with @next tag"
-
-      - name: Create git tag
-        run: |
-          git config --local user.email "action@github.com"
-          git config --local user.name "GitHub Action"
-          git tag "v${{ steps.version.outputs.new_version }}" -m "Pre-release v${{ steps.version.outputs.new_version }}"
-          git push origin "v${{ steps.version.outputs.new_version }}"
-          echo "🏷️ Created and pushed tag v${{ steps.version.outputs.new_version }}"
-
-      - name: Notify Slack
-        if: always()
-        uses: slackapi/slack-github-action@v1.24.0
-        with:
-          channel-id: ${{ secrets.SLACK_CHANNEL_ID }}
-          payload: |
-            {
-              "text": "Pre-Release Pipeline Status",
-              "blocks": [
-                {
-                  "type": "section",
-                  "text": {
-                    "type": "mrkdwn",
-                    "text": "📦 *@rimori/client Pre-Release*\n\n*Branch:* ${{ github.ref_name }}\n*Version:* ${{ steps.version.outputs.new_version }}\n*Author:* ${{ github.actor }}\n*Pipeline:* <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View Run>\n\n${{ job.status == 'success' && '✅ Successfully published to npm with @next tag!' || '❌ Pipeline failed. Check the logs for details.' }}"
-                  }
-                }
-              ]
-            }
-        env:
-          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}

package/.prettierignore

@@ -1,35 +0,0 @@
-# Dependencies
-node_modules/
-yarn.lock
-package-lock.json
-bun.lockb
-
-# Build outputs
-dist/
-build/
-*.tsbuildinfo
-
-# Generated files
-*.d.ts
-*.js.map
-
-# IDE files
-.vscode/
-.idea/
-
-# OS files
-.DS_Store
-Thumbs.db
-
-# Logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Coverage
-coverage/
-
-# Temporary files
-*.tmp
-*.temp

package/eslint.config.js

@@ -1,53 +0,0 @@
-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

@@ -1,241 +0,0 @@
-# Simple Flashcards - Developer Guide
-
-## Overview
-
-The Simple Flashcards plugin provides spaced repetition learning through an event-based API. Other plugins can create flashcards, request lookups, and trigger training sessions.
-
-**Plugin ID:** `pl123456789`
-
-## Event-based Integration
-
-All communication uses the Rimori event bus with the pattern: `<plugin_id>.<area>.<action>`
-
-### 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'],
-});
-```
-
-#### 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
-});
-```
-
-### 2. Lookup Requests
-
-#### Basic Translation
-
-```javascript
-// Request word translation
-const translation = await plugin.event.request('pl123456789.lookup.request', {
-  word: 'laufen',
-  language: 'de', // optional
-});
-
-// Returns:
-// {
-//   input: "laufen",
-//   language: "de",
-//   type: "verb",
-//   swedish_translation: "att springa",
-//   translation: "to run"
-// }
-```
-
-#### Advanced Lookup
-
-```javascript
-// Get detailed word information
-const details = await plugin.event.request('pl123456789.lookup.request', {
-  word: 'laufen',
-  language: 'de',
-});
-
-// Returns extended object with grammar, examples, tenses, etc.
-```
-
-### 3. Deck Management
-
-#### Get Available Decks
-
-```javascript
-const decks = await plugin.event.request('pl123456789.deck.requestOpenToday');
-
-// Returns:
-// [
-//   {
-//     id: "deck-123",
-//     name: "Spanish Vocabulary",
-//     total_new: 5,
-//     total_learning: 12,
-//     total_review: 8
-//   }
-// ]
-```
-
-#### Create New Deck
-
-```javascript
-const newDeck = await plugin.event.request('pl123456789.deck.create', {
-  name: 'German Verbs',
-});
-
-// Returns: { id: "deck-456", name: "German Verbs", last_used: "2025-01-06T..." }
-```
-
-### 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"
-});
-```
-
-## 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',
-      deckId,
-      stats: {
-        cardsReviewed: stats.reviewed,
-        accuracy: stats.accuracy,
-        streak: stats.streak
-      }
-    });
-  }
-};
-
-async function calculateDeckProgress(deckId: string, userId: string) {
-  // Database queries to calculate progress
-  const cards = await db.from('flashcards')
-    .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),
-    streak: await calculateStreak(userId)
-  };
-}
-```
-
-## Database Schema Pattern
-
-```typescript
-// Example table structure
-interface Flashcard {
-  id: string;
-  user_id: string;
-  deck_id: string;
-  front: string;
-  back: string;
-  front_tags: string[];
-  back_tags: string[];
-  ease_factor: number;
-  interval: number;
-  due_date: string;
-  last_review_date?: string;
-}
-
-interface Deck {
-  id: string;
-  user_id: string;
-  name: string;
-  last_used: string;
-  created_at: string;
-}
-```
-
-## Integration Examples
-
-### Dictionary Plugin → Flashcards
-
-```javascript
-// When user looks up a word in dictionary
-function onWordLookup(word: string, translation: string) {
-  // Automatically create flashcard
-  plugin.event.emit("pl123456789.flashcard.create", {
-    front: word,
-    back: translation,
-    frontTags: ["lang:sv"],
-    backTags: ["lang:en", "dictionary-lookup"]
-  });
-}
-```
-
-### 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,
-  });
-}
-```
-
-## Error Handling
-
-```javascript
-try {
-  await plugin.event.request('pl123456789.flashcard.create', cardData);
-} catch (error) {
-  console.error('Failed to create flashcard:', error);
-  // Handle error appropriately
-}
-```
-
-## Best Practices
-
-- Always provide meaningful error messages
-- Use consistent tagging for language features
-- Batch operations when creating multiple cards
-- Respect user's daily review limits
-- Include proper TypeScript types for payloads

package/example/docs/overview.md

@@ -1,29 +0,0 @@
-# Simple Flashcards - Spaced Repetition Learning
-
-**Transform your vocabulary learning with intelligent flashcards that adapt to your memory**
-
-## ✨ What it does
-
-Simple Flashcards uses proven spaced repetition algorithms to help you memorize vocabulary, facts, and concepts efficiently. The plugin schedules your reviews at optimal intervals, showing cards just before you're likely to forget them.
-
-## 🎯 Perfect for
-
-- **Language learners** building vocabulary with audio pronunciation
-- **Students** memorizing facts, formulas, and definitions
-- **Professionals** learning technical terms and concepts
-- **Anyone** who wants to remember information long-term
-
-## 🔥 Key Features
-
-- **Smart scheduling** - Cards appear when you need to review them most
-- **Audio support** - Hear correct pronunciation for language learning
-- **Multiple decks** - Organize cards by topic, subject, or difficulty
-- **Simple rating** - Just rate how well you remembered (Again, Hard, Good, Easy)
-- **Progress tracking** - See your learning streak and daily progress
-- **Cross-plugin integration** - Other plugins can add cards automatically
-
-## 🚀 Get Started in 30 seconds
-
-1. Create your first deck
-2. Add some flashcards (front/back)
-3. Start reviewing - the algorithm handles the rest!

package/example/docs/userdocs.md

@@ -1,126 +0,0 @@
-# Simple Flashcards - User Guide
-
-## Getting Started
-
-Simple Flashcards uses spaced repetition to help you learn and retain information efficiently. The plugin automatically schedules your reviews at optimal intervals, showing cards just before you're likely to forget them.
-
-### Create Your First Deck
-
-Before you can start learning, you'll need to create a deck to organize your flashcards. To create your first deck:
-
-1. Navigate to the main flashcards page where you'll see your deck overview
-2. Click the "Add deck" button located at the bottom of the page
-3. Enter a descriptive name for your deck (e.g., "Spanish Vocabulary" or "Biology Terms")
-4. Click save to create your new deck
-
-Your new deck will appear in the deck overview, ready for you to add flashcards.
-
-### Adding Flashcards
-
-Once you have a deck, you can start adding flashcards to build your learning material. To add new flashcards:
-
-1. Click on your deck name to enter the deck and access its training interface
-2. Click the "+" button to open the flashcard creation form
-3. Enter your question, word, or prompt on the **front** of the card
-4. Enter the corresponding answer, translation, or explanation on the **back**
-5. Optionally add tags like `lang:es` to enable features such as Spanish audio pronunciation
-6. Click the save icon to create your flashcard
-
-The new card will be added to your deck and will appear in your learning session when you start reviewing.
-
-### Learning with Flashcards
-
-The learning process follows a simple but effective pattern designed to maximize retention:
-
-1. **Start a session** by clicking on a deck name from the overview page
-2. **Study the front** of each card carefully and try to recall the answer from memory
-3. **Reveal the answer** by pressing the spacebar or clicking the "Show answer" button
-4. **Rate your recall** honestly using one of four options:
-   - **Again (1)** - You didn't remember or got it wrong; the card will reappear soon
-   - **Hard (2)** - You remembered but with significant difficulty; shorter interval before next review
-   - **Good (3)** - You remembered correctly with some effort; optimal spaced interval
-   - **Easy (4)** - You remembered effortlessly; longer interval before next review
-
-Your ratings help the algorithm determine the best time to show each card again, optimizing your learning efficiency.
-
-## Key Features
-
-### Audio Pronunciation Support
-
-For language learning, audio pronunciation is essential. The plugin supports text-to-speech functionality:
-
-- **Enable audio** by adding language tags such as `lang` for generic audio or `lang:es` for Spanish-specific pronunciation
-- **Play audio** by clicking the speaker icon that appears on cards with language tags
-- **Keyboard shortcuts** for audio: press **5** to play the front audio or **h** to play the back audio
-
-The audio feature helps you learn correct pronunciation while building vocabulary, making it especially valuable for language learners.
-
-### Efficient Keyboard Navigation
-
-Speed up your review sessions with keyboard shortcuts that eliminate the need for mouse clicking:
-
-- **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)
-- **v key** - Edit the current flashcard during review
-
-These shortcuts allow you to maintain focus and rhythm during your learning sessions.
-
-### Deck Organization and Progress Tracking
-
-The deck overview provides clear visual indicators of your progress:
-
-- **Orange numbers** next to deck names show cards you're actively learning (new or recently difficult cards)
-- **Green numbers** indicate cards that are due for review today based on the spaced repetition schedule
-- **Deck names** can be clicked to immediately start a study session with that deck
-
-This system helps you quickly identify which decks need attention and track your daily progress.
-
-### Tagging System for Organization
-
-Tags provide a flexible way to categorize and enhance your flashcards:
-
-- **Organizational tags** like `grammar`, `verbs`, or `beginner` help you categorize content by topic or difficulty
-- **Language tags** such as `lang:de` for German enable specific features like pronunciation
-- **Multiple tags** can be applied to each card for comprehensive organization
-
-Tags make it easier to manage large collections of flashcards and enable special features like audio playback.
-
-## Settings and Customization
-
-The plugin offers several settings to personalize your learning experience:
-
-- **Auto-play new cards** - When enabled, automatically plays audio pronunciation for new cards that have appropriate language tags, helping you learn pronunciation from the first encounter
-- **Auto-add lookups** - Automatically creates flashcards from words you look up in other parts of the Rimori workspace, streamlining the process of building your vocabulary deck
-
-These settings help integrate the flashcard system with your broader learning workflow.
-
-## Best Practices and Tips
-
-To get the most out of your flashcard learning:
-
-- **Keep cards simple** - Focus on one concept, word, or fact per card for optimal retention
-- **Review consistently** - Even a brief 10-minute daily session is more effective than longer, infrequent sessions
-- **Use audio features** - Take advantage of pronunciation features for language learning
-- **Edit problematic cards** - If you consistently struggle with a card, rewrite it to be clearer or break it into smaller pieces
-- **Be honest with ratings** - Accurate self-assessment helps the algorithm schedule reviews optimally
-
-## 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