refactor: move bulk imports logic to shared pkgs

... to enable reuse in other contexts

Author: NiloCK

packages/platform-ui/src/utils/bulkImport/cardParser.ts renamed to packages/common/src/bulkImport/cardParser.ts

@@ -1,4 +1,4 @@
-import { ParsedCard } from './types';
+import { ParsedCard } from './types.js';
 
 /**
  * Configuration for the bulk card parser
@@ -25,12 +25,15 @@ export const CARD_DELIMITER = '\n---\n---\n';
 
 /**
  * Parses a single card string into a structured object
- * 
+ *
  * @param cardString - Raw string containing card content
  * @param config - Optional parser configuration
  * @returns ParsedCard object or null if parsing fails
  */
-export function parseCard(cardString: string, config: CardParserConfig = DEFAULT_PARSER_CONFIG): ParsedCard | null {
+export function parseCard(
+  cardString: string,
+  config: CardParserConfig = DEFAULT_PARSER_CONFIG
+): ParsedCard | null {
   const trimmedCardString = cardString.trim();
   if (!trimmedCardString) {
     return null;
@@ -40,18 +43,18 @@ export function parseCard(cardString: string, config: CardParserConfig = DEFAULT
   let tags: string[] = [];
   let elo: number | undefined = undefined;
   const markdownLines = [...lines];
-  
+
   // Process the lines from bottom to top to handle metadata
   let metadataLines = 0;
-  
+
   // Get the configured identifiers
   const tagId = config.tagIdentifier || DEFAULT_PARSER_CONFIG.tagIdentifier;
   const eloId = config.eloIdentifier || DEFAULT_PARSER_CONFIG.eloIdentifier;
-  
+
   // Check the last few lines for metadata (tags and elo)
   for (let i = lines.length - 1; i >= 0 && i >= lines.length - 2; i--) {
     const line = lines[i].trim();
-    
+
     // Check for tags
     if (line.toLowerCase().startsWith(tagId!.toLowerCase())) {
       tags = line
@@ -71,7 +74,7 @@ export function parseCard(cardString: string, config: CardParserConfig = DEFAULT
       metadataLines++;
     }
   }
-  
+
   // Remove metadata lines from the end of the content
   if (metadataLines > 0) {
     markdownLines.splice(markdownLines.length - metadataLines);
@@ -82,20 +85,21 @@ export function parseCard(cardString: string, config: CardParserConfig = DEFAULT
     // Card must have some markdown content
     return null;
   }
-  
+
   return { markdown, tags, elo };
 }
 
 /**
  * Splits a bulk text input into individual card strings
- * 
+ *
  * @param bulkText - Raw string containing multiple cards
  * @returns Array of card strings
  */
 export function splitCardsText(bulkText: string): string[] {
-  return bulkText.split(CARD_DELIMITER)
-    .map(card => card.trim())
-    .filter(card => card); // Filter out empty strings
+  return bulkText
+    .split(CARD_DELIMITER)
+    .map((card) => card.trim())
+    .filter((card) => card); // Filter out empty strings
 }
 
 /**
@@ -105,7 +109,10 @@ export function splitCardsText(bulkText: string): string[] {
  * @param config - Optional parser configuration.
  * @returns Array of ParsedCard objects. Filters out cards that fail to parse.
  */
-export function parseBulkTextToCards(bulkText: string, config: CardParserConfig = DEFAULT_PARSER_CONFIG): ParsedCard[] {
+export function parseBulkTextToCards(
+  bulkText: string,
+  config: CardParserConfig = DEFAULT_PARSER_CONFIG
+): ParsedCard[] {
   const cardStrings = splitCardsText(bulkText);
   const parsedCards: ParsedCard[] = [];
 
@@ -120,11 +127,11 @@ export function parseBulkTextToCards(bulkText: string, config: CardParserConfig
 
 /**
  * Validates if a bulk text input has valid format
- * 
+ *
  * @param bulkText - Raw string containing multiple cards
  * @returns true if valid, false otherwise
  */
 export function isValidBulkFormat(bulkText: string): boolean {
   const cardStrings = splitCardsText(bulkText);
-  return cardStrings.length > 0 && cardStrings.some(card => !!card.trim());
-}
+  return cardStrings.length > 0 && cardStrings.some((card) => !!card.trim());
+}

packages/common/src/bulkImport/types.ts

@@ -0,0 +1,28 @@
+// We no longer need to import DataShape since we've moved the interfaces that used it
+// import { DataShape } from '@vue-skuilder/common';
+
+/**
+ * Interface representing a parsed card from bulk import
+ */
+export interface ParsedCard {
+  /** The markdown content of the card */
+  markdown: string;
+  /** Tags associated with the card */
+  tags: string[];
+  /** ELO rating for the card (optional) */
+  elo?: number;
+}
+
+/**
+ * Interface for card data ready to be stored in the database
+ */
+export interface CardData {
+  /** Card markdown content */
+  Input: string;
+  /** Card media uploads */
+  Uploads: any[];
+  /** Any additional fields can be added as needed */
+  [key: string]: any;
+}
+
+// ImportResult and BulkCardProcessorConfig have been moved to @vue-skuilder/db

packages/common/src/index.ts

@@ -6,6 +6,9 @@ export * from './logshim.js';
 export * from './validators.js';
 export * from './fieldConverters.js';
 
+export * from './bulkImport/cardParser.js';
+export * from './bulkImport/types.js';
+
 // interfaces
 export * from './interfaces/index.js';
 

packages/platform-ui/src/utils/bulkImport/cardProcessor.ts renamed to packages/db/src/core/bulkImport/cardProcessor.ts

@@ -1,10 +1,11 @@
-import { CourseElo, Status } from '@vue-skuilder/common';
-import { CourseDBInterface } from '@vue-skuilder/db';
-import { ParsedCard, ImportResult, BulkCardProcessorConfig, CardData } from './types';
+import { CourseElo, Status, ParsedCard, CardData } from '@vue-skuilder/common';
+import { CourseDBInterface } from '../../core/interfaces/courseDB';
+import { ImportResult, BulkCardProcessorConfig } from './types';
 
 /**
  * Processes multiple cards from bulk text input
  *
+ * @param parsedCards - Array of parsed cards to import
  * @param courseDB - Course database interface
  * @param config - Configuration for the card processor
  * @returns Array of import results

packages/db/src/core/bulkImport/index.ts

@@ -0,0 +1,2 @@
+export * from './cardProcessor.js';
+export * from './types.js';

packages/platform-ui/src/utils/bulkImport/types.ts renamed to packages/db/src/core/bulkImport/types.ts

@@ -14,30 +14,6 @@ export interface ImportResult {
   cardId?: string;
 }
 
-/**
- * Interface representing a parsed card from bulk import
- */
-export interface ParsedCard {
-  /** The markdown content of the card */
-  markdown: string;
-  /** Tags associated with the card */
-  tags: string[];
-  /** ELO rating for the card (optional) */
-  elo?: number;
-}
-
-/**
- * Interface for card data ready to be stored in the database
- */
-export interface CardData {
-  /** Card markdown content */
-  Input: string;
-  /** Card media uploads */
-  Uploads: any[];
-  /** Any additional fields can be added as needed */
-  [key: string]: any;
-}
-
 /**
  * Configuration for the bulk card processor
  */
@@ -48,4 +24,4 @@ export interface BulkCardProcessorConfig {
   courseCode: string;
   /** The username of the current user */
   userName: string;
-}
+}

packages/db/src/core/index.ts

@@ -5,3 +5,4 @@ export * from './types/types-legacy';
 export * from './types/user';
 export * from '../util/Loggable';
 export * from './util';
+export * from './bulkImport';

packages/platform-ui/src/components/Edit/BulkImportView.vue

@@ -144,19 +144,24 @@ tags: tagC"
 
 <script lang="ts">
 import { defineComponent, PropType } from 'vue';
-import { CourseConfig, DataShape, Status, NameSpacer } from '@vue-skuilder/common';
-import { BlanksCardDataShapes } from '@vue-skuilder/courses';
-import { getCurrentUser } from '@vue-skuilder/common-ui';
-import { getDataLayer, CourseDBInterface } from '@vue-skuilder/db';
-import { alertUser } from '@vue-skuilder/common-ui'; // For user feedback
-import {
-  ImportResult,
+import { 
+  CourseConfig, 
+  DataShape, 
+  Status, 
+  NameSpacer,
   ParsedCard,
   parseBulkTextToCards,
+  isValidBulkFormat 
+} from '@vue-skuilder/common';
+import { BlanksCardDataShapes } from '@vue-skuilder/courses';
+import { getCurrentUser, alertUser } from '@vue-skuilder/common-ui';
+import { 
+  getDataLayer, 
+  CourseDBInterface,
+  ImportResult,
   importParsedCards,
-  validateProcessorConfig,
-  isValidBulkFormat,
-} from '@/utils/bulkImport';
+  validateProcessorConfig
+} from '@vue-skuilder/db';
 
 export default defineComponent({
   name: 'BulkImportView',

packages/platform-ui/src/utils/bulkImport/index.ts

@@ -1,6 +1,22 @@
-export * from './types';
-export * from './cardParser';
-export * from './cardProcessor';
+// Re-export parsing utilities from common
+export {
+  ParsedCard,
+  CardData,
+  parseCard,
+  parseBulkTextToCards,
+  isValidBulkFormat,
+  splitCardsText,
+  CardParserConfig,
+  CARD_DELIMITER
+} from '@vue-skuilder/common';
+
+// Re-export database utilities from db
+export {
+  ImportResult,
+  BulkCardProcessorConfig,
+  importParsedCards,
+  validateProcessorConfig
+} from '@vue-skuilder/db';
 
 // Example usage for documentation purposes:
 /*
@@ -34,7 +50,7 @@ tags: tagC`;
     courseCode: 'COURSE-123',
     userName: 'user123'
   };
-  
+
   const validation = validateProcessorConfig(config);
   if (!validation.isValid) {
     console.error(validation.errorMessage);
@@ -48,7 +64,7 @@ tags: tagC`;
     return;
   }
   const parsedCardsArray = parseBulkTextToCards(bulkText);
-  
+
   if (parsedCardsArray.length === 0 && bulkText.trim().length > 0) {
     console.error("No cards could be parsed from the input.");
     // Potentially show an error or return if no cards were parsed,
@@ -58,12 +74,12 @@ tags: tagC`;
 
   // Step 2: Process the array of parsed cards
   const results = await importParsedCards(parsedCardsArray, courseDB, config);
-  
+
   // Check results
   console.log(`Attempted to import ${parsedCardsArray.length} cards.`);
   console.log(`Successfully imported: ${results.filter(r => r.status === 'success').length}`);
   console.log(`Failed: ${results.filter(r => r.status === 'error').length}`);
-  
+
   // Example of parsing a single card (remains the same)
   const singleCard = `Example card with a {{blank}}
 elo: 1600
@@ -75,4 +91,4 @@ tags: tag1, tag2`;
     elo: parsedSingle?.elo
   });
 }
-*/
+*/