coursecode 0.1.1 → 0.1.2

package/framework/docs/FRAMEWORK_GUIDE.md

@@ -130,18 +130,17 @@ The ZIP never includes preview/stub player assets. Preview is a separate concern
 
 #### Re-Stamping for Different Formats
 
-`lib/build-packaging.js` exports `stampFormatInHtml(htmlPath, format)` for re-stamping the meta tag:
+`lib/build-packaging.js` exports `stampFormat(html, format)` for re-stamping the meta tag:
 
 ```javascript
-import { stampFormatInHtml } from 'coursecode/build-packaging';
+import { stampFormat } from 'coursecode/build-packaging';
 import { generateManifest } from 'coursecode/manifest';
 
-// Re-stamp dist/index.html for a different format
-stampFormatInHtml('/path/to/dist/index.html', 'scorm2004');
+// Re-stamp HTML string for a different format (no filesystem needed)
+const stampedHtml = stampFormat(indexHtml, 'scorm2004');
 
 // Generate the format-specific manifest
 const { filename, content } = generateManifest('scorm2004', config, files, options);
-fs.writeFileSync(`/path/to/dist/${filename}`, content);
 ```
 
 Both are pure Node utilities
@@ -152,7 +151,7 @@ Both are pure Node utilities
 |------|---------|
 | `framework/js/state/lms-connection.js` | `getLMSFormat()` — runtime priority chain (meta → env → default) |
 | `framework/js/drivers/driver-factory.js` | Dynamic `import()` switch — loads one driver at runtime |
-| `lib/build-packaging.js` | `stampFormatInHtml()` — meta tag re-stamping utility |
+| `lib/build-packaging.js` | `stampFormat()` — pure string meta tag re-stamping; `stampFormatInHtml()` — file-based wrapper |
 | `lib/manifest/manifest-factory.js` | `generateManifest()` — generates format-specific manifests |
 | Both `vite.config.js` files | Post-build `closeBundle` hook stamps meta tag into `dist/index.html` |
 
@@ -586,7 +585,7 @@ User: coursecode build → uploads dist/
     └────────────┘
 ```
 
-**Cloud dependencies:** The cloud app imports `stampFormatInHtml` and `generateManifest` directly from the `coursecode` npm package. These are pure Node utilities — no Vite, no dynamic imports of user code, no `eval`. All inputs (title, version, file list) come from scanning the uploaded `dist/` or the cloud's own database.
+**Cloud dependencies:** The cloud app imports `stampFormat` and `generateManifest` directly from the `coursecode` npm package. These are pure functions — no filesystem, no Vite, no dynamic imports of user code, no `eval`. All inputs (title, version, file list) come from scanning the uploaded `dist/` or the cloud's own database.
 
 **Security boundary:** The cloud never executes `course-config.js` or any user-authored JavaScript. The meta tag and manifest are the only format-specific artifacts, and both are generated from trusted framework source code.
 ---

package/lib/build-packaging.d.ts

@@ -1,3 +1,4 @@
+export function stampFormat(html: string, format: string): string
 export function stampFormatInHtml(htmlPath: string, format: string): void
 
 export function validateExternalHostingConfig(config: Record<string, unknown>): void

package/lib/build-packaging.js

@@ -61,24 +61,31 @@ export function validateExternalHostingConfig(config) {
 }
 
 /**
- * Re-stamp the lms-format meta tag in an index.html file.
- * Used when creating format-specific ZIPs from a universal dist/.
- * @param {string} htmlPath - Absolute path to the index.html to modify
+ * Re-stamp the lms-format meta tag in an HTML string.
+ * Pure string transform — no filesystem access. Use this in cloud/serverless environments.
+ * @param {string} html - The HTML string to modify
  * @param {string} format - The LMS format to stamp (e.g., 'scorm2004', 'cmi5')
+ * @returns {string} The modified HTML string
  */
-export function stampFormatInHtml(htmlPath, format) {
-    let html = fs.readFileSync(htmlPath, 'utf-8');
-    // Replace existing meta tag or insert after charset
+export function stampFormat(html, format) {
     const existingMeta = /<meta\s+name="lms-format"\s+content="[^"]*"\s*\/?>/;
     if (existingMeta.test(html)) {
-        html = html.replace(existingMeta, `<meta name="lms-format" content="${format}" />`);
-    } else {
-        html = html.replace(
-            '<meta charset="UTF-8" />',
-            `<meta charset="UTF-8" />\n  <meta name="lms-format" content="${format}" />`
-        );
+        return html.replace(existingMeta, `<meta name="lms-format" content="${format}" />`);
     }
-    fs.writeFileSync(htmlPath, html, 'utf-8');
+    return html.replace(
+        '<meta charset="UTF-8" />',
+        `<meta charset="UTF-8" />\n  <meta name="lms-format" content="${format}" />`
+    );
+}
+
+/**
+ * Re-stamp the lms-format meta tag in an index.html file on disk.
+ * @param {string} htmlPath - Absolute path to the index.html to modify
+ * @param {string} format - The LMS format to stamp (e.g., 'scorm2004', 'cmi5')
+ */
+export function stampFormatInHtml(htmlPath, format) {
+    const html = fs.readFileSync(htmlPath, 'utf-8');
+    fs.writeFileSync(htmlPath, stampFormat(html, format), 'utf-8');
 }
 
 export async function createStandardPackage({ rootDir, distDir, config, outputDir }) {

package/lib/index.d.ts

@@ -25,6 +25,7 @@ export function resolveElementByPath(elements: Record<string, unknown>[], target
 export function build(options?: Record<string, unknown>): Promise<void>
 
 // Build Packaging
+export function stampFormat(html: string, format: string): string
 export function stampFormatInHtml(htmlPath: string, format: string): void
 export function validateExternalHostingConfig(config: Record<string, unknown>): void
 export function createStandardPackage(options: Record<string, unknown>): Promise<string>

package/lib/index.js

@@ -24,6 +24,7 @@ export {
 // Build utilities
 export { build } from './build.js';
 export {
+  stampFormat,
   createStandardPackage,
   createProxyPackage,
   createRemotePackage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coursecode",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Multi-format course authoring framework with CLI tools (SCORM 2004, SCORM 1.2, cmi5, LTI 1.3)",
   "type": "module",
   "bin": {