@vue-skuilder/common 0.1.0 → 0.1.3

package/dist/bulkImport/cardParser.d.ts

@@ -0,0 +1,45 @@
+import { ParsedCard } from './types.js';
+/**
+ * Configuration for the bulk card parser
+ */
+export interface CardParserConfig {
+    /** Custom tag identifier (defaults to 'tags:') */
+    tagIdentifier?: string;
+    /** Custom ELO identifier (defaults to 'elo:') */
+    eloIdentifier?: string;
+}
+/**
+ * Card delimiter used to separate cards in bulk input
+ */
+export declare 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 declare function parseCard(cardString: string, config?: CardParserConfig): ParsedCard | null;
+/**
+ * Splits a bulk text input into individual card strings
+ *
+ * @param bulkText - Raw string containing multiple cards
+ * @returns Array of card strings
+ */
+export declare function splitCardsText(bulkText: string): string[];
+/**
+ * Parses a bulk text input into an array of structured ParsedCard objects.
+ *
+ * @param bulkText - Raw string containing multiple cards.
+ * @param config - Optional parser configuration.
+ * @returns Array of ParsedCard objects. Filters out cards that fail to parse.
+ */
+export declare function parseBulkTextToCards(bulkText: string, config?: CardParserConfig): ParsedCard[];
+/**
+ * Validates if a bulk text input has valid format
+ *
+ * @param bulkText - Raw string containing multiple cards
+ * @returns true if valid, false otherwise
+ */
+export declare function isValidBulkFormat(bulkText: string): boolean;
+//# sourceMappingURL=cardParser.d.ts.map

package/dist/bulkImport/cardParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cardParser.d.ts","sourceRoot":"","sources":["../../src/bulkImport/cardParser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iDAAiD;IACjD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAUD;;GAEG;AACH,eAAO,MAAM,cAAc,iBAAiB,CAAC;AAE7C;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,gBAAwC,GAC/C,UAAU,GAAG,IAAI,CAsDnB;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAKzD;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAwC,GAC/C,UAAU,EAAE,CAWd;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAG3D"}

package/dist/bulkImport/cardParser.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CARD_DELIMITER = void 0;
+exports.parseCard = parseCard;
+exports.splitCardsText = splitCardsText;
+exports.parseBulkTextToCards = parseBulkTextToCards;
+exports.isValidBulkFormat = isValidBulkFormat;
+/**
+ * Default configuration for the card parser
+ */
+const DEFAULT_PARSER_CONFIG = {
+    tagIdentifier: 'tags:',
+    eloIdentifier: 'elo:',
+};
+/**
+ * Card delimiter used to separate cards in bulk input
+ */
+exports.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
+ */
+function parseCard(cardString, config = DEFAULT_PARSER_CONFIG) {
+    const trimmedCardString = cardString.trim();
+    if (!trimmedCardString) {
+        return null;
+    }
+    const lines = trimmedCardString.split('\n');
+    let tags = [];
+    let elo = 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
+                .substring(tagId.length)
+                .split(',')
+                .map((tag) => tag.trim())
+                .filter((tag) => tag);
+            metadataLines++;
+        }
+        // Check for ELO
+        else if (line.toLowerCase().startsWith(eloId.toLowerCase())) {
+            const eloValue = line.substring(eloId.length).trim();
+            const parsedElo = parseInt(eloValue, 10);
+            if (!isNaN(parsedElo)) {
+                elo = parsedElo;
+            }
+            metadataLines++;
+        }
+    }
+    // Remove metadata lines from the end of the content
+    if (metadataLines > 0) {
+        markdownLines.splice(markdownLines.length - metadataLines);
+    }
+    const markdown = markdownLines.join('\n').trim();
+    if (!markdown) {
+        // 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
+ */
+function splitCardsText(bulkText) {
+    return bulkText
+        .split(exports.CARD_DELIMITER)
+        .map((card) => card.trim())
+        .filter((card) => card); // Filter out empty strings
+}
+/**
+ * Parses a bulk text input into an array of structured ParsedCard objects.
+ *
+ * @param bulkText - Raw string containing multiple cards.
+ * @param config - Optional parser configuration.
+ * @returns Array of ParsedCard objects. Filters out cards that fail to parse.
+ */
+function parseBulkTextToCards(bulkText, config = DEFAULT_PARSER_CONFIG) {
+    const cardStrings = splitCardsText(bulkText);
+    const parsedCards = [];
+    for (const cardString of cardStrings) {
+        const parsedCard = parseCard(cardString, config);
+        if (parsedCard) {
+            parsedCards.push(parsedCard);
+        }
+    }
+    return parsedCards;
+}
+/**
+ * Validates if a bulk text input has valid format
+ *
+ * @param bulkText - Raw string containing multiple cards
+ * @returns true if valid, false otherwise
+ */
+function isValidBulkFormat(bulkText) {
+    const cardStrings = splitCardsText(bulkText);
+    return cardStrings.length > 0 && cardStrings.some((card) => !!card.trim());
+}
+//# sourceMappingURL=cardParser.js.map

package/dist/bulkImport/cardParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cardParser.js","sourceRoot":"","sources":["../../src/bulkImport/cardParser.ts"],"names":[],"mappings":"AAYA;;GAEG;AACH,MAAM,qBAAqB,GAAqB;IAC9C,aAAa,EAAE,OAAO;IACtB,aAAa,EAAE,MAAM;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,cAAc,CAAC;AAE7C;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,UAAkB,EAClB,SAA2B,qBAAqB;IAEhD,MAAM,iBAAiB,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;IAC5C,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5C,IAAI,IAAI,GAAa,EAAE,CAAC;IACxB,IAAI,GAAG,GAAuB,SAAS,CAAC;IACxC,MAAM,aAAa,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAEjC,0DAA0D;IAC1D,IAAI,aAAa,GAAG,CAAC,CAAC;IAEtB,iCAAiC;IACjC,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAC1E,MAAM,KAAK,GAAG,MAAM,CAAC,aAAa,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAE1E,uDAAuD;IACvD,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QACpE,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAE7B,iBAAiB;QACjB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,KAAM,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACxD,IAAI,GAAG,IAAI;iBACR,SAAS,CAAC,KAAM,CAAC,MAAM,CAAC;iBACxB,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;iBACxB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;YACxB,aAAa,EAAE,CAAC;QAClB,CAAC;QACD,gBAAgB;aACX,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,KAAM,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,KAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;gBACtB,GAAG,GAAG,SAAS,CAAC;YAClB,CAAC;YACD,aAAa,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IAED,oDAAoD;IACpD,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;QACtB,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,uCAAuC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,OAAO,QAAQ;SACZ,KAAK,CAAC,cAAc,CAAC;SACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;SAC1B,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,2BAA2B;AACxD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAgB,EAChB,SAA2B,qBAAqB;IAEhD,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,WAAW,GAAiB,EAAE,CAAC;IAErC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACjD,IAAI,UAAU,EAAE,CAAC;YACf,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAgB;IAChD,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;AAC7E,CAAC"}

package/dist/bulkImport/cardParser.mjs

@@ -0,0 +1,106 @@
+/**
+ * Default configuration for the card parser
+ */
+const DEFAULT_PARSER_CONFIG = {
+    tagIdentifier: 'tags:',
+    eloIdentifier: 'elo:',
+};
+/**
+ * Card delimiter used to separate cards in bulk input
+ */
+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, config = DEFAULT_PARSER_CONFIG) {
+    const trimmedCardString = cardString.trim();
+    if (!trimmedCardString) {
+        return null;
+    }
+    const lines = trimmedCardString.split('\n');
+    let tags = [];
+    let elo = 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
+                .substring(tagId.length)
+                .split(',')
+                .map((tag) => tag.trim())
+                .filter((tag) => tag);
+            metadataLines++;
+        }
+        // Check for ELO
+        else if (line.toLowerCase().startsWith(eloId.toLowerCase())) {
+            const eloValue = line.substring(eloId.length).trim();
+            const parsedElo = parseInt(eloValue, 10);
+            if (!isNaN(parsedElo)) {
+                elo = parsedElo;
+            }
+            metadataLines++;
+        }
+    }
+    // Remove metadata lines from the end of the content
+    if (metadataLines > 0) {
+        markdownLines.splice(markdownLines.length - metadataLines);
+    }
+    const markdown = markdownLines.join('\n').trim();
+    if (!markdown) {
+        // 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) {
+    return bulkText
+        .split(CARD_DELIMITER)
+        .map((card) => card.trim())
+        .filter((card) => card); // Filter out empty strings
+}
+/**
+ * Parses a bulk text input into an array of structured ParsedCard objects.
+ *
+ * @param bulkText - Raw string containing multiple cards.
+ * @param config - Optional parser configuration.
+ * @returns Array of ParsedCard objects. Filters out cards that fail to parse.
+ */
+export function parseBulkTextToCards(bulkText, config = DEFAULT_PARSER_CONFIG) {
+    const cardStrings = splitCardsText(bulkText);
+    const parsedCards = [];
+    for (const cardString of cardStrings) {
+        const parsedCard = parseCard(cardString, config);
+        if (parsedCard) {
+            parsedCards.push(parsedCard);
+        }
+    }
+    return parsedCards;
+}
+/**
+ * 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) {
+    const cardStrings = splitCardsText(bulkText);
+    return cardStrings.length > 0 && cardStrings.some((card) => !!card.trim());
+}
+//# sourceMappingURL=cardParser.js.map

package/dist/bulkImport/types.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 BulkImportCardData {
+    /** Card markdown content */
+    Input: string;
+    /** Card media uploads */
+    Uploads: unknown[];
+    /** Any additional fields can be added as needed */
+    [key: string]: unknown;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/bulkImport/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/bulkImport/types.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,mDAAmD;IACnD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB"}

package/dist/bulkImport/types.js

@@ -0,0 +1,6 @@
+"use strict";
+// We no longer need to import DataShape since we've moved the interfaces that used it
+// import { DataShape } from '@vue-skuilder/common';
+Object.defineProperty(exports, "__esModule", { value: true });
+// ImportResult and BulkCardProcessorConfig have been moved to @vue-skuilder/db
+//# sourceMappingURL=types.js.map

package/dist/bulkImport/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/bulkImport/types.ts"],"names":[],"mappings":"AAAA,sFAAsF;AACtF,oDAAoD;;AA0BpD,+EAA+E"}

package/dist/bulkImport/types.mjs

@@ -0,0 +1,5 @@
+// We no longer need to import DataShape since we've moved the interfaces that used it
+// import { DataShape } from '@vue-skuilder/common';
+export {};
+// ImportResult and BulkCardProcessorConfig have been moved to @vue-skuilder/db
+//# sourceMappingURL=types.js.map

package/dist/course-data.d.ts

@@ -0,0 +1,17 @@
+import { DisplayableData } from './db.js';
+import { DataShape } from './interfaces/DataShape.js';
+export declare function prepareNote55(courseID: string, codeCourse: string, shape: DataShape, data: any, author: string, _tags: string[], uploads?: {
+    [x: string]: PouchDB.Core.FullAttachment;
+}): DisplayableData;
+/**
+ * Question components
+ */
+export interface Evaluation {
+    isCorrect: boolean;
+    performance: Performance;
+}
+type Performance = number | {
+    [dimension: string]: Performance;
+};
+export {};
+//# sourceMappingURL=course-data.d.ts.map

package/dist/course-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"course-data.d.ts","sourceRoot":"","sources":["../src/course-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAW,MAAM,SAAS,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAKtD,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,SAAS,EAGhB,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,CAAC,EAAE;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAA;CAAE,GACrD,eAAe,CAsFjB;AAED;;GAEG;AAEH,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED,KAAK,WAAW,GACZ,MAAM,GACN;IACE,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW,CAAC;CAClC,CAAC"}

package/dist/course-data.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prepareNote55 = prepareNote55;
+const db_js_1 = require("./db.js");
+const namespacer_js_1 = require("./namespacer.js");
+const FieldType_js_1 = require("./enums/FieldType.js");
+function prepareNote55(courseID, codeCourse, shape, 
+// [ ] add typing
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+data, author, _tags, uploads) {
+    const dataShapeId = namespacer_js_1.NameSpacer.getDataShapeString({
+        course: codeCourse,
+        dataShape: shape.name,
+    });
+    const attachmentFields = shape.fields
+        .map((field) => {
+        // make a copy, in order NOT to append to the datashape
+        const copy = {
+            name: field.name,
+            type: field.type,
+        };
+        return copy;
+    })
+        .filter((field) => {
+        return field.type === FieldType_js_1.FieldType.IMAGE || field.type === FieldType_js_1.FieldType.AUDIO;
+    })
+        .concat([
+        {
+            name: 'autoplayAudio',
+            type: FieldType_js_1.FieldType.AUDIO,
+        },
+    ]);
+    for (let i = 1; i < 11; i++) {
+        if (data[`audio-${i}`]) {
+            attachmentFields.push({
+                name: `audio-${i}`,
+                type: FieldType_js_1.FieldType.AUDIO,
+            });
+        }
+        if (data[`image-${i}`]) {
+            attachmentFields.push({
+                name: `image-${i}`,
+                type: FieldType_js_1.FieldType.IMAGE,
+            });
+        }
+    }
+    if (data[`audio-11`]) {
+        throw new Error('Too many audio attachments');
+    }
+    if (data[`image-11`]) {
+        throw new Error('Too many image attachments');
+    }
+    const attachments = {};
+    const payload = {
+        course: courseID,
+        data: [],
+        docType: db_js_1.DocType.DISPLAYABLE_DATA,
+        id_datashape: dataShapeId,
+    };
+    if (author) {
+        payload.author = author;
+    }
+    attachmentFields.forEach((attField) => {
+        attachments[attField.name] = data[attField.name];
+    });
+    //
+    if (uploads) {
+        Object.keys(uploads).forEach((k) => {
+            attachments[k] = uploads[k];
+        });
+    }
+    if (attachmentFields.length !== 0 || (uploads && Object.keys(uploads).length)) {
+        payload._attachments = attachments;
+    }
+    shape.fields
+        .filter((field) => {
+        return field.type !== FieldType_js_1.FieldType.IMAGE && field.type !== FieldType_js_1.FieldType.AUDIO;
+    })
+        .forEach((field) => {
+        payload.data.push({
+            name: field.name,
+            data: data[field.name],
+        });
+    });
+    return payload;
+}
+//# sourceMappingURL=course-data.js.map

package/dist/course-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"course-data.js","sourceRoot":"","sources":["../src/course-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,OAAO,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAI7C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,MAAM,UAAU,aAAa,CAC3B,QAAgB,EAChB,UAAkB,EAClB,KAAgB;AAChB,iBAAiB;AACjB,8DAA8D;AAC9D,IAAS,EACT,MAAc,EACd,KAAe,EACf,OAAsD;IAEtD,MAAM,WAAW,GAAG,UAAU,CAAC,kBAAkB,CAAC;QAChD,MAAM,EAAE,UAAU;QAClB,SAAS,EAAE,KAAK,CAAC,IAAI;KACtB,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM;SAClC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,uDAAuD;QACvD,MAAM,IAAI,GAAoB;YAC5B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,KAAK,CAAC;IAC1E,CAAC,CAAC;SACD,MAAM,CAAC;QACN;YACE,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,SAAS,CAAC,KAAK;SACtB;KACF,CAAC,CAAC;IAEL,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;YACvB,gBAAgB,CAAC,IAAI,CAAC;gBACpB,IAAI,EAAE,SAAS,CAAC,EAAE;gBAClB,IAAI,EAAE,SAAS,CAAC,KAAK;aACtB,CAAC,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC;YACvB,gBAAgB,CAAC,IAAI,CAAC;gBACpB,IAAI,EAAE,SAAS,CAAC,EAAE;gBAClB,IAAI,EAAE,SAAS,CAAC,KAAK;aACtB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,WAAW,GAAqD,EAAE,CAAC;IACzE,MAAM,OAAO,GAAoB;QAC/B,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,OAAO,CAAC,gBAAgB;QACjC,YAAY,EAAE,WAAW;KAC1B,CAAC;IAEF,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED,gBAAgB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACpC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE;IACF,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACjC,WAAW,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9E,OAAO,CAAC,YAAY,GAAG,WAAW,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,MAAM;SACT,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QAChB,OAAO,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,KAAK,CAAC;IAC1E,CAAC,CAAC;SACD,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;SACvB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEL,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/course-data.mjs

@@ -0,0 +1,84 @@
+import { DocType } from './db.mjs';
+import { NameSpacer } from './namespacer.mjs';
+import { FieldType } from './enums/FieldType.mjs';
+export function prepareNote55(courseID, codeCourse, shape, 
+// [ ] add typing
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+data, author, _tags, uploads) {
+    const dataShapeId = NameSpacer.getDataShapeString({
+        course: codeCourse,
+        dataShape: shape.name,
+    });
+    const attachmentFields = shape.fields
+        .map((field) => {
+        // make a copy, in order NOT to append to the datashape
+        const copy = {
+            name: field.name,
+            type: field.type,
+        };
+        return copy;
+    })
+        .filter((field) => {
+        return field.type === FieldType.IMAGE || field.type === FieldType.AUDIO;
+    })
+        .concat([
+        {
+            name: 'autoplayAudio',
+            type: FieldType.AUDIO,
+        },
+    ]);
+    for (let i = 1; i < 11; i++) {
+        if (data[`audio-${i}`]) {
+            attachmentFields.push({
+                name: `audio-${i}`,
+                type: FieldType.AUDIO,
+            });
+        }
+        if (data[`image-${i}`]) {
+            attachmentFields.push({
+                name: `image-${i}`,
+                type: FieldType.IMAGE,
+            });
+        }
+    }
+    if (data[`audio-11`]) {
+        throw new Error('Too many audio attachments');
+    }
+    if (data[`image-11`]) {
+        throw new Error('Too many image attachments');
+    }
+    const attachments = {};
+    const payload = {
+        course: courseID,
+        data: [],
+        docType: DocType.DISPLAYABLE_DATA,
+        id_datashape: dataShapeId,
+    };
+    if (author) {
+        payload.author = author;
+    }
+    attachmentFields.forEach((attField) => {
+        attachments[attField.name] = data[attField.name];
+    });
+    //
+    if (uploads) {
+        Object.keys(uploads).forEach((k) => {
+            attachments[k] = uploads[k];
+        });
+    }
+    if (attachmentFields.length !== 0 || (uploads && Object.keys(uploads).length)) {
+        payload._attachments = attachments;
+    }
+    shape.fields
+        .filter((field) => {
+        return field.type !== FieldType.IMAGE && field.type !== FieldType.AUDIO;
+    })
+        .forEach((field) => {
+        payload.data.push({
+            name: field.name,
+            data: data[field.name],
+        });
+    });
+    return payload;
+}
+//# sourceMappingURL=course-data.js.map

package/dist/db.d.ts

@@ -0,0 +1,140 @@
+import { Evaluation } from './course-data.js';
+import { Answer } from './interfaces/AnswerInterfaces.js';
+import { CourseElo } from './elo.js';
+import { Moment } from 'moment';
+export declare enum DocType {
+    DISPLAYABLE_DATA = "DISPLAYABLE_DATA",
+    CARD = "CARD",
+    DATASHAPE = "DATASHAPE",
+    QUESTIONTYPE = "QUESTION",
+    VIEW = "VIEW",
+    PEDAGOGY = "PEDAGOGY",
+    CARDRECORD = "CARDRECORD",
+    SCHEDULED_CARD = "SCHEDULED_CARD",
+    TAG = "TAG"
+}
+/**
+ * Interface for all data on course content and pedagogy stored
+ * in the c/pouch database.
+ */
+export interface SkuilderCourseData {
+    course: string;
+    docType: DocType;
+}
+export interface Tag extends SkuilderCourseData {
+    docType: DocType.TAG;
+    name: string;
+    snippet: string;
+    wiki: string;
+    taggedCards: PouchDB.Core.DocumentId[];
+}
+export interface TagStub {
+    name: string;
+    snippet: string;
+    count: number;
+}
+export interface CardData extends SkuilderCourseData {
+    docType: DocType.CARD;
+    id_displayable_data: PouchDB.Core.DocumentId[];
+    id_view: PouchDB.Core.DocumentId;
+    elo: CourseElo;
+}
+/** A list of populated courses in the DB */
+export interface CourseListData extends PouchDB.Core.Response {
+    courses: string[];
+}
+/**
+ * The data used to hydrate viewable components (questions, info, etc)
+ */
+export interface DisplayableData extends SkuilderCourseData {
+    docType: DocType.DISPLAYABLE_DATA;
+    author?: string;
+    id_datashape: PouchDB.Core.DocumentId;
+    data: Field[];
+    _attachments?: {
+        [index: string]: PouchDB.Core.FullAttachment;
+    };
+}
+export interface Field {
+    data: unknown;
+    name: string;
+}
+export interface DataShapeData extends SkuilderCourseData {
+    docType: DocType.DATASHAPE;
+    _id: PouchDB.Core.DocumentId;
+    questionTypes: PouchDB.Core.DocumentId[];
+}
+export interface QuestionData extends SkuilderCourseData {
+    docType: DocType.QUESTIONTYPE;
+    _id: PouchDB.Core.DocumentId;
+    viewList: string[];
+    dataShapeList: PouchDB.Core.DocumentId[];
+}
+export declare function getCardHistoryID(courseID: string, cardID: string): PouchDB.Core.DocumentId;
+export declare function parseCardHistoryID(id: string): {
+    courseID: string;
+    cardID: string;
+};
+export interface CardHistory<T extends CardRecord> {
+    _id: PouchDB.Core.DocumentId;
+    /**
+     * The CouchDB id of the card
+     */
+    cardID: PouchDB.Core.DocumentId;
+    /**
+     * The ID of the course
+     */
+    courseID: string;
+    /**
+     * The to-date largest interval between successful
+     * card reviews. `0` indicates no successful reviews.
+     */
+    bestInterval: number;
+    /**
+     * The number of times that a card has been
+     * failed in review
+     */
+    lapses: number;
+    /**
+     * The number of consecutive successful impressions
+     * on this card
+     */
+    streak: number;
+    records: T[];
+}
+export interface CardRecord {
+    /**
+     * The CouchDB id of the card
+     */
+    cardID: string;
+    /**
+     * The ID of the course
+     */
+    courseID: string;
+    /**
+     * Number of milliseconds that the user spent before dismissing
+     * the card (ie, "I've read this" or "here is my answer")
+     *
+     * //TODO: this (sometimes?) wants to be replaced with a rich
+     *         recording of user activity in working the question
+     */
+    timeSpent: number;
+    /**
+     * The date-time that the card was rendered. timeStamp + timeSpent will give the
+     * time of user submission.
+     */
+    timeStamp: Moment;
+}
+export interface QuestionRecord extends CardRecord, Evaluation {
+    userAnswer: Answer;
+    /**
+     * The number of incorrect user submissions prededing this submisstion.
+     *
+     * eg, if a user is asked 7*6=__, submitting 46, 48, 42 will result in three
+     * records being created having 0, 1, and 2 as their recorded 'priorAttempts' values
+     */
+    priorAttemps: number;
+}
+export declare function areQuestionRecords(h: CardHistory<CardRecord>): h is CardHistory<QuestionRecord>;
+export declare function isQuestionRecord(c: CardRecord): c is QuestionRecord;
+//# sourceMappingURL=db.d.ts.map

package/dist/db.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../src/db.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,oBAAY,OAAO;IACjB,gBAAgB,qBAAqB;IACrC,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,YAAY,aAAa;IACzB,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,cAAc,mBAAmB;IACjC,GAAG,QAAQ;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,GAAI,SAAQ,kBAAkB;IAC7C,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;CACxC;AACD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,QAAS,SAAQ,kBAAkB;IAClD,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC;IACtB,mBAAmB,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;IAC/C,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;IACjC,GAAG,EAAE,SAAS,CAAC;CAChB;AAED,4CAA4C;AAC5C,MAAM,WAAW,cAAe,SAAQ,OAAO,CAAC,IAAI,CAAC,QAAQ;IAC3D,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;IACtC,IAAI,EAAE,KAAK,EAAE,CAAC;IACd,YAAY,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAA;KAAE,CAAC;CACjE;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC;IAC3B,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC;IAC9B,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;IAC7B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;CAC1C;AAID,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAE1F;AAED,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB,CAeA;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,UAAU;IAC/C,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;IAC7B;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;IAEhC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,CAAC,EAAE,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU,EAAE,UAAU;IAC5D,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,WAAW,CAAC,cAAc,CAAC,CAE/F;AAED,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,IAAI,cAAc,CAEnE"}