@rimori/client 2.4.0 → 2.5.0-next.1

package/example/rimori.config.ts

@@ -1,91 +0,0 @@
-import { RimoriPluginConfig } from '@rimori/client';
-
-/**
- * This is an example of a Rimori plugin configuration file. It is based on the Rimori Flashcards plugin.
- * It is used to configure the plugin and its pages, sidebar, settings, context menu actions, documentation, and worker.
- */
-
-const config: RimoriPluginConfig = {
-  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',
-  },
-  pages: {
-    main: [
-      {
-        id: '1',
-        url: '#/',
-        show: true,
-        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',
-        show: false,
-        root: 'vocabulary',
-        name: 'Latest flashcard deck training',
-        description: 'Training the latest flashcards.',
-        action: {
-          key: 'flashcards',
-          parameters: {
-            total_amount: {
-              type: 'number',
-              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',
-            },
-          },
-        },
-      },
-    ],
-    sidebar: [
-      {
-        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.',
-      },
-    ],
-    settings: '/settings',
-  },
-  context_menu_actions: [
-    {
-      text: 'Translate',
-      plugin_id: 'pl1234567890',
-      action_key: 'translate',
-    },
-    {
-      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',
-  },
-  worker: {
-    url: 'web-worker.js',
-  },
-};
-
-export default config;

package/example/worker/vite.config.ts

@@ -1,26 +0,0 @@
-import { defineConfig } from 'vite';
-import path from 'path';
-
-export default defineConfig({
-  root: __dirname,
-  build: {
-    minify: process.env.VITE_MINIFY === 'true',
-    lib: {
-      entry: 'worker.ts',
-      formats: ['iife'],
-      name: 'PluginFooWorker',
-      fileName: () => 'web-worker.js', // used in rollupOptions.entryFileNames
-    },
-    outDir: path.resolve(__dirname, '../public'),
-    emptyOutDir: false,
-    rollupOptions: {
-      // Exclude DOM-only libraries that can't run in workers
-      // html2canvas is provided by @rimori/react-client for browser contexts
-      external: ['html2canvas'],
-      output: {
-        inlineDynamicImports: true,
-        entryFileNames: 'web-worker.js',
-      },
-    },
-  },
-});

package/example/worker/worker.ts

@@ -1,11 +0,0 @@
-import { setupWorker, RimoriClient } from '@rimori/client/core';
-
-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 }) => {
-    console.log('[Worker] creating flashcards in database', data);
-    return { success: true };
-  });
-});

package/prettier.config.js

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

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

@@ -1,189 +0,0 @@
-import { createClient } from '@supabase/supabase-js';
-import path from 'path';
-import * as readline from 'readline';
-import { DEFAULT_ANON_KEY, DEFAULT_ENDPOINT } from '../../../utils/endpoint.js';
-
-export interface UserCredentials {
-  email: string;
-  password: string;
-}
-
-export interface DeveloperRegisterResponse {
-  plugin_id: string;
-  access_token: string;
-}
-
-/**
- * Prompts user for email and password credentials.
- * @returns Promise resolving to user credentials.
- */
-export async function askForCredentials(): Promise<UserCredentials> {
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  return new Promise((resolve) => {
-    rl.question('Enter your email: ', (email) => {
-      rl.close();
-
-      // Create a new interface for password input with muted output
-      const passwordRl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-        terminal: false,
-      });
-
-      process.stdout.write('Enter your password: ');
-
-      // Set up stdin for raw input
-      process.stdin.setRawMode(true);
-      process.stdin.resume();
-
-      let password = '';
-
-      const onData = (buffer: Buffer) => {
-        const char = buffer.toString('utf8');
-
-        if (char === '\r' || char === '\n') {
-          // Enter pressed
-          process.stdin.setRawMode(false);
-          process.stdin.pause();
-          process.stdin.removeListener('data', onData);
-          process.stdout.write('\n');
-          passwordRl.close();
-          resolve({ email: email.trim(), password: password.trim() });
-        } else if (char === '\u0003') {
-          // Ctrl+C
-          process.stdin.setRawMode(false);
-          process.stdin.pause();
-          process.stdin.removeListener('data', onData);
-          process.stdout.write('\n');
-          process.exit(0);
-        } else if (char === '\u007f' || char === '\b') {
-          // Backspace
-          if (password.length > 0) {
-            password = password.slice(0, -1);
-            process.stdout.write('\b \b');
-          }
-        } else if (char.charCodeAt(0) >= 32 && char.charCodeAt(0) <= 126) {
-          // Printable characters
-          password += char;
-          process.stdout.write('*');
-        }
-      };
-
-      process.stdin.on('data', onData);
-    });
-  });
-}
-
-/**
- * Prompts user for development port with default value.
- * @returns Promise resolving to the selected port.
- */
-export async function askForPort(): Promise<number> {
-  const rl = readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  });
-
-  return new Promise((resolve) => {
-    rl.question('Enter development port (default: 3000): ', (answer) => {
-      rl.close();
-      const port = answer.trim() || '3000';
-
-      // Validate port is a number
-      const portNumber = parseInt(port, 10);
-      if (isNaN(portNumber) || portNumber < 1 || portNumber > 65535) {
-        console.error('Error: Port must be a valid number between 1 and 65535');
-        process.exit(1);
-      }
-
-      resolve(portNumber);
-    });
-  });
-}
-
-/**
- * Authenticates with Supabase using email and password.
- * @param param
- * @param param.email - User email address.
- * @param param.password - User password.
- * @returns Promise resolving to JWT access token.
- * @throws {Error} if authentication fails.
- */
-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)
-  const supabaseUrl = process.env.SUPABASE_URL || DEFAULT_ENDPOINT;
-  const supabaseKey = process.env.SUPABASE_ANON_KEY || DEFAULT_ANON_KEY;
-
-  const supabase = createClient(supabaseUrl, supabaseKey);
-
-  try {
-    const { data, error } = await supabase.auth.signInWithPassword({
-      email,
-      password,
-    });
-
-    if (error) {
-      throw new Error(`Authentication failed: ${error.message}`);
-    }
-
-    if (!data.session?.access_token) {
-      throw new Error('No access token received from authentication');
-    }
-
-    console.log('✅ Supabase authentication successful!');
-    return data.session.access_token;
-  } catch (error) {
-    throw new Error(`Supabase authentication failed: ${error}`);
-  }
-}
-
-/**
- * Registers developer and gets plugin credentials from the backend.
- * @param jwtToken - JWT token from Supabase authentication.
- * @param port - Development port for the plugin.
- * @returns Promise resolving to plugin ID and access token.
- * @throws {Error} if registration request fails.
- */
-export async function registerDeveloper(jwtToken: string, port: number): Promise<DeveloperRegisterResponse> {
-  console.log('🚀 Registering developer and creating plugin...');
-
-  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 response = await fetch(backendUrl + '/developer/register', {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        Authorization: `Bearer ${jwtToken}`,
-      },
-      body: JSON.stringify(body),
-    });
-
-    if (!response.ok) {
-      console.error(await response.text());
-      throw new Error(`HTTP error! status: ${response.status}`);
-    }
-
-    const data: DeveloperRegisterResponse = await response.json();
-
-    if (!data.plugin_id || !data.access_token) {
-      throw new Error('Invalid response: missing pluginId or access_token');
-    }
-
-    console.log('✅ Plugin registration successful!');
-    console.log(`Plugin ID: ${data.plugin_id}`);
-
-    return data;
-  } catch (error) {
-    console.error(error);
-    throw new Error(`Developer registration failed: ${error}`);
-  }
-}

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

@@ -1,44 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-
-/**
- * Creates or updates the .env file with the plugin token.
- * @param token - The plugin authentication token.
- */
-export function setupEnvFile(token: string): void {
-  const envPath = path.resolve('.env');
-  if (!fs.existsSync(envPath)) {
-    const envContent = `RIMORI_TOKEN=${token}\n`;
-    fs.writeFileSync(envPath, envContent, 'utf8');
-    console.log('Created .env file with RIMORI_TOKEN');
-  } else {
-    console.log('.env file already exists, skipping creation');
-  }
-}
-
-/**
- * Updates .gitignore to exclude .env files.
- */
-export function updateGitignore(): void {
-  const gitignorePath = path.resolve('.gitignore');
-  let gitignoreContent = '';
-  let needsUpdate = false;
-
-  if (fs.existsSync(gitignorePath)) {
-    gitignoreContent = fs.readFileSync(gitignorePath, 'utf8');
-    // Check if .env is already in .gitignore
-    if (!gitignoreContent.includes('.env')) {
-      needsUpdate = true;
-    }
-  } else {
-    needsUpdate = true;
-  }
-
-  if (needsUpdate) {
-    gitignoreContent += '\n.env\npublic/web-worker.js\n';
-    fs.writeFileSync(gitignorePath, gitignoreContent, 'utf8');
-    console.log('Added .env to .gitignore');
-  } else {
-    console.log('.env already in .gitignore, skipping update');
-  }
-}

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

@@ -1,58 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { dirname } from 'path';
-import { fileURLToPath } from 'url';
-
-// ES module equivalent of __dirname
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-
-/**
- * Configuration mapping source files to destination files.
- * Key: Source path relative to __dirname
- * Value: Destination path relative to current working directory
- */
-const FILE_COPY_MAP: Record<string, string> = {
-  '../../../../example/rimori.config.ts': './rimori/rimori.config.ts',
-  '../../../../README.md': './rimori/readme.md',
-  '../../../../example/docs/overview.md': './public/docs/overview.md',
-  '../../../../example/docs/devdocs.md': './public/docs/devdocs.md',
-  '../../../../example/docs/userdocs.md': './public/docs/userdocs.md',
-  '../../../../example/worker/worker.ts': './worker/worker.ts',
-  '../../../../example/worker/vite.config.ts': './worker/vite.config.ts',
-};
-
-/**
- * Copies necessary files and creates directories for the plugin setup.
- */
-export function copyPluginFiles(): void {
-  console.log('Copying plugin files...');
-
-  for (const [srcRelativePath, destRelativePath] of Object.entries(FILE_COPY_MAP)) {
-    const srcPath = path.resolve(__dirname, srcRelativePath);
-    const destPath = path.resolve(destRelativePath);
-    const destDir = path.dirname(destPath);
-
-    // Check if source file exists
-    if (!fs.existsSync(srcPath)) {
-      console.log(`Warning: Source file not found: ${srcPath}`);
-      continue;
-    }
-
-    // Create destination directory if it doesn't exist
-    if (!fs.existsSync(destDir)) {
-      console.log(`Creating directory: ${destDir}`);
-      fs.mkdirSync(destDir, { recursive: true });
-    }
-
-    // Only copy if destination file doesn't exist
-    if (!fs.existsSync(destPath)) {
-      fs.copyFileSync(srcPath, destPath);
-      console.log(`Copied: ${srcRelativePath} -> ${destRelativePath}`);
-    } else {
-      console.log(`File already exists, skipping: ${destRelativePath}`);
-    }
-  }
-
-  console.log('Plugin file copying completed.');
-}

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

@@ -1,45 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-
-/**
- * Removes all meta tags from HTML content except viewport and charset.
- * @param htmlContent - The HTML content to process.
- * @returns The processed HTML content with unwanted meta tags removed.
- */
-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, '');
-
-  // Remove empty lines left behind
-  cleanedContent = cleanedContent.replace(/^\s*[\r\n]/gm, '');
-
-  return cleanedContent;
-}
-
-/**
- * Processes HTML files to remove unwanted meta tags.
- */
-export function cleanHtmlMetaTags(): void {
-  const filePath = path.resolve('./index.html');
-
-  if (!filePath.endsWith('.html')) {
-    return;
-  }
-
-  if (!fs.existsSync(filePath)) {
-    console.log(`Warning: HTML file not found: ${filePath}`);
-    return;
-  }
-
-  try {
-    const content = fs.readFileSync(filePath, 'utf8');
-    const cleanedContent = removeUnwantedMetaTags(content);
-
-    if (content !== cleanedContent) {
-      fs.writeFileSync(filePath, cleanedContent, 'utf8');
-      console.log(`Cleaned meta tags in: ${filePath}`);
-    }
-  } catch (error) {
-    console.error(`Error processing HTML file ${filePath}:`, error);
-  }
-}

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

@@ -1,175 +0,0 @@
-#!/usr/bin/env node
-
-import * as fs from 'fs';
-import * as path from 'path';
-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';
-import { updatePackageJson, type PackageJson } from './package-setup.js';
-import { transformAppRouter } from './router-transformer.js';
-import { updateTailwindConfig } from './tailwind-config.js';
-import { updateViteConfigBase } from './vite-config.js';
-import 'dotenv/config';
-
-/**
- * Main function that handles the complete plugin setup flow.
- */
-async function main(): Promise<void> {
-  try {
-    // Check for --upgrade flag
-    const isUpgrade = process.argv.includes('--upgrade');
-
-    if (isUpgrade) {
-      console.log('🔄 Starting Rimori Plugin Upgrade...');
-    } else {
-      console.log('🎯 Starting Rimori Plugin Setup...');
-    }
-    console.log('');
-
-    // Check if plugin is already initialized (skip for upgrade mode)
-    if (!isUpgrade) {
-      const packageJsonPath = path.resolve('./package.json');
-      if (fs.existsSync(packageJsonPath)) {
-        try {
-          const packageJson: PackageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-          if (packageJson.r_id) {
-            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.',
-            );
-            process.exit(0);
-          }
-        } catch (error) {
-          console.warn('Warning: Could not read package.json, continuing with setup...');
-        }
-      }
-    }
-
-    let pluginId: string = '';
-
-    if (isUpgrade) {
-      // For upgrade mode, only ask for port and setup plugin
-      console.log('🔄 Upgrade mode: Skipping authentication and plugin registration...');
-      console.log('');
-
-      // Get plugin ID from existing package.json
-      try {
-        const packageJsonPath = path.resolve('./package.json');
-        const packageJson: PackageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-        pluginId = packageJson.r_id || '';
-      } catch (error) {
-        console.warn('Warning: Could not read plugin ID from package.json');
-      }
-
-      // Ask for development port
-      const port = await askForPort();
-      console.log('');
-
-      // Update package.json in upgrade mode
-      updatePackageJson({
-        port,
-        isUpgrade: true,
-      });
-
-      // Copy files
-      copyPluginFiles();
-
-      // Update gitignore
-      updateGitignore();
-    } else {
-      // Step 1: Get user credentials
-      const credentials = await askForCredentials();
-      console.log('');
-
-      // Step 2: Authenticate with Supabase
-      const jwtToken = await authenticateWithSupabase(credentials);
-      console.log('');
-
-      // Step 3: Ask for development port
-      const port = await askForPort();
-      console.log('');
-
-      // Step 4: Register developer and get plugin credentials
-      const { plugin_id, access_token } = await registerDeveloper(jwtToken, port);
-      pluginId = plugin_id;
-      console.log('');
-
-      // Step 5: Update package.json
-      updatePackageJson({
-        pluginId: plugin_id,
-        port,
-        isUpgrade: false,
-      });
-
-      // Step 6: Setup environment file
-      setupEnvFile(access_token);
-
-      // Step 7: Copy necessary files
-      copyPluginFiles();
-
-      // Step 8: Update gitignore
-      updateGitignore();
-    }
-
-    // Setup vite config base
-    try {
-      console.log('Updating vite config base...');
-      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}`,
-      );
-    }
-
-    // Clean meta tags from index.html after vite adaptation
-    cleanHtmlMetaTags();
-    console.log('✅ Meta tags cleaned from index.html');
-
-    // Update Tailwind CSS configuration
-    updateTailwindConfig();
-
-    // Transform App.tsx to use PluginProvider with HashRouter
-    if (pluginId) {
-      try {
-        transformAppRouter(pluginId);
-      } catch (error) {
-        console.warn(`Warning: Could not transform App.tsx router: ${error instanceof Error ? error.message : error}`);
-      }
-    } else {
-      console.warn('Warning: Plugin ID not available, skipping router transformation');
-    }
-
-    console.log('');
-    console.log('✅ Plugin ' + (isUpgrade ? 'upgrade' : 'setup') + ' completed successfully!');
-    console.log('');
-    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('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)',
-    );
-  } catch (error) {
-    console.error(`❌ Error: ${error instanceof Error ? error.message : error}`);
-    console.error('');
-    console.error('Make sure that:');
-    console.error('1. Your Supabase credentials are correct');
-    console.error('2. You have internet connection for authentication');
-    process.exit(1);
-  }
-}
-
-main();