npm - @patch-adams/core - Versions diffs - 1.4.37 → 1.5.0 - Mend

@patch-adams/core 1.4.37 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/dist/index.d.cts CHANGED Viewed

@@ -291,6 +291,8 @@ declare const PatchAdamsConfigSchema: z.ZodObject<{
         /** Whether this plugin is enabled */
         enabled: z.ZodDefault<z.ZodBoolean>;
     }, z.ZodTypeAny, "passthrough">>>>;
+    /** Optional skin name — adds 'pa-skinned' + skin class to <html>, loads skin CSS/JS after core files */
+    skin: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     remoteDomain: string;
     htmlClass: string;
@@ -341,6 +343,7 @@ declare const PatchAdamsConfigSchema: z.ZodObject<{
         /** Whether this plugin is enabled */
         enabled: z.ZodDefault<z.ZodBoolean>;
     }, z.ZodTypeAny, "passthrough">>;
+    skin?: string | undefined;
 }, {
     remoteDomain: string;
     htmlClass?: string | undefined;
@@ -391,6 +394,7 @@ declare const PatchAdamsConfigSchema: z.ZodObject<{
         /** Whether this plugin is enabled */
         enabled: z.ZodDefault<z.ZodBoolean>;
     }, z.ZodTypeAny, "passthrough">> | undefined;
+    skin?: string | undefined;
 }>;
 type PatchAdamsConfig = z.infer<typeof PatchAdamsConfigSchema>;
 type LrsBridgeConfig = z.infer<typeof LrsBridgeConfigSchema>;
@@ -698,6 +702,14 @@ declare class HtmlInjector {
      * Inject JS After loader at end of <body> (after __loadEntry)
      */
     private injectJsAfter;
+    /**
+     * Inject Skin CSS loader after CSS After (before </head>)
+     */
+    private injectSkinCss;
+    /**
+     * Inject Skin JS loader after JS After (before </body>)
+     */
+    private injectSkinJs;
 }
 /**
@@ -770,6 +782,14 @@ declare class StorylineHtmlInjector {
      * We inject before </body> so our code runs before the bootstrapper.
      */
     private injectJsAfter;
+    /**
+     * Inject Skin CSS loader after CSS After (before </head>)
+     */
+    private injectSkinCss;
+    /**
+     * Inject Skin JS loader after JS After (before </body>)
+     */
+    private injectSkinJs;
 }
 interface ManifestPaths {
@@ -777,6 +797,8 @@ interface ManifestPaths {
     cssAfter?: string;
     jsBefore?: string;
     jsAfter?: string;
+    skinCss?: string;
+    skinJs?: string;
 }
 /**
  * Update manifest files to include injected assets
@@ -840,6 +862,8 @@ interface PatchOptions {
     jsAfterContent?: string;
     /** Skip fetching remote files even if fetchFallbacks is enabled in config */
     skipFetch?: boolean;
+    /** Optional skin name — per-call override for config.skin */
+    skin?: string;
 }
 /**
  * Main Patcher class for patching e-learning course packages
@@ -912,7 +936,7 @@ declare class Patcher {
      * @param buffer - Input ZIP file as Buffer
      * @returns Patched ZIP file as Buffer
      */
-    patchBuffer(buffer: Buffer): Promise<Buffer>;
+    patchBuffer(buffer: Buffer, options?: PatchOptions): Promise<Buffer>;
 }
 /**
@@ -1030,6 +1054,8 @@ interface JsBeforeOptions {
     metadata: CourseMetadata | null;
     /** LRS Bridge configuration */
     lrsBridge: LrsBridgeOptions;
+    /** Optional skin name */
+    skin?: string;
 }
 /**
  * Generate the blocking JS loader for the "before" slot

package/dist/index.d.ts CHANGED Viewed

@@ -291,6 +291,8 @@ declare const PatchAdamsConfigSchema: z.ZodObject<{
         /** Whether this plugin is enabled */
         enabled: z.ZodDefault<z.ZodBoolean>;
     }, z.ZodTypeAny, "passthrough">>>>;
+    /** Optional skin name — adds 'pa-skinned' + skin class to <html>, loads skin CSS/JS after core files */
+    skin: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     remoteDomain: string;
     htmlClass: string;
@@ -341,6 +343,7 @@ declare const PatchAdamsConfigSchema: z.ZodObject<{
         /** Whether this plugin is enabled */
         enabled: z.ZodDefault<z.ZodBoolean>;
     }, z.ZodTypeAny, "passthrough">>;
+    skin?: string | undefined;
 }, {
     remoteDomain: string;
     htmlClass?: string | undefined;
@@ -391,6 +394,7 @@ declare const PatchAdamsConfigSchema: z.ZodObject<{
         /** Whether this plugin is enabled */
         enabled: z.ZodDefault<z.ZodBoolean>;
     }, z.ZodTypeAny, "passthrough">> | undefined;
+    skin?: string | undefined;
 }>;
 type PatchAdamsConfig = z.infer<typeof PatchAdamsConfigSchema>;
 type LrsBridgeConfig = z.infer<typeof LrsBridgeConfigSchema>;
@@ -698,6 +702,14 @@ declare class HtmlInjector {
      * Inject JS After loader at end of <body> (after __loadEntry)
      */
     private injectJsAfter;
+    /**
+     * Inject Skin CSS loader after CSS After (before </head>)
+     */
+    private injectSkinCss;
+    /**
+     * Inject Skin JS loader after JS After (before </body>)
+     */
+    private injectSkinJs;
 }
 /**
@@ -770,6 +782,14 @@ declare class StorylineHtmlInjector {
      * We inject before </body> so our code runs before the bootstrapper.
      */
     private injectJsAfter;
+    /**
+     * Inject Skin CSS loader after CSS After (before </head>)
+     */
+    private injectSkinCss;
+    /**
+     * Inject Skin JS loader after JS After (before </body>)
+     */
+    private injectSkinJs;
 }
 interface ManifestPaths {
@@ -777,6 +797,8 @@ interface ManifestPaths {
     cssAfter?: string;
     jsBefore?: string;
     jsAfter?: string;
+    skinCss?: string;
+    skinJs?: string;
 }
 /**
  * Update manifest files to include injected assets
@@ -840,6 +862,8 @@ interface PatchOptions {
     jsAfterContent?: string;
     /** Skip fetching remote files even if fetchFallbacks is enabled in config */
     skipFetch?: boolean;
+    /** Optional skin name — per-call override for config.skin */
+    skin?: string;
 }
 /**
  * Main Patcher class for patching e-learning course packages
@@ -912,7 +936,7 @@ declare class Patcher {
      * @param buffer - Input ZIP file as Buffer
      * @returns Patched ZIP file as Buffer
      */
-    patchBuffer(buffer: Buffer): Promise<Buffer>;
+    patchBuffer(buffer: Buffer, options?: PatchOptions): Promise<Buffer>;
 }
 /**
@@ -1030,6 +1054,8 @@ interface JsBeforeOptions {
     metadata: CourseMetadata | null;
     /** LRS Bridge configuration */
     lrsBridge: LrsBridgeOptions;
+    /** Optional skin name */
+    skin?: string;
 }
 /**
  * Generate the blocking JS loader for the "before" slot

package/dist/index.js CHANGED Viewed

@@ -106,7 +106,9 @@ var PatchAdamsConfigSchema = z.object({
   /** LRS Bridge configuration for xAPI/LRS communication with Bravais */
   lrsBridge: LrsBridgeConfigSchema.default({}),
   /** Plugin configurations - each plugin is keyed by its name */
-  plugins: PluginsConfigSchema
+  plugins: PluginsConfigSchema,
+  /** Optional skin name — adds 'pa-skinned' + skin class to <html>, loads skin CSS/JS after core files */
+  skin: z.string().min(1).optional()
 });
 // src/config/defaults.ts
@@ -4377,7 +4379,7 @@ function escapeJs(str) {
   return str.replace(/\\/g, "\\\\").replace(/'/g, "\\'").replace(/"/g, '\\"').replace(/\n/g, "\\n").replace(/\r/g, "\\r");
 }
 function generateJsBeforeLoader(options) {
-  const { remoteUrl, localPath, htmlClass, loadingClass, metadata, lrsBridge } = options;
+  const { remoteUrl, localPath, htmlClass, loadingClass, metadata, lrsBridge, skin } = options;
   const lrsBridgeCode = generateLrsBridgeCode(lrsBridge);
   const courseLines = [];
   if (metadata) {
@@ -4420,12 +4422,13 @@ ${courseLines.join("\n")}
 window.pa_patcher = window.pa_patcher || {
   version: '1.0.25',
   htmlClass: '${htmlClass}',
-  loadingClass: '${loadingClass}',${courseBlock}
+  loadingClass: '${loadingClass}',${skin ? `
+  skin: '${escapeJs(skin)}',` : ""}${courseBlock}
   loaded: {
     cssBefore: false,
     cssAfter: false,
     jsBefore: false,
-    jsAfter: false
+    jsAfter: false${skin ? ",\n    skinCss: false,\n    skinJs: false" : ""}
   }
 };
@@ -4546,7 +4549,8 @@ function buildJsBeforeOptions(config, metadata) {
     htmlClass: config.htmlClass,
     loadingClass: config.loadingClass,
     metadata: metadata ?? null,
-    lrsBridge
+    lrsBridge,
+    skin: config.skin
   };
 }
@@ -4669,6 +4673,196 @@ function buildJsAfterOptions(config) {
   };
 }
+// src/templates/skin-css.ts
+function generateSkinCssLoader(options) {
+  const { remoteUrl, localPath, timeout } = options;
+  return `<!-- === PATCH-ADAMS: SKIN CSS (async with fallback) === -->
+<script data-pa="skin-css-loader">
+(function() {
+  'use strict';
+  var REMOTE_URL = "${remoteUrl}";
+  var LOCAL_PATH = "${localPath}";
+  var TIMEOUT = ${timeout};
+  function loadCSS(url, onSuccess, onError) {
+    var link = document.createElement('link');
+    link.rel = 'stylesheet';
+    link.href = url;
+    link.setAttribute('data-pa', 'skin-css');
+    link.onload = function() {
+      if (onSuccess) onSuccess();
+    };
+    link.onerror = function() {
+      if (onError) onError();
+    };
+    document.head.appendChild(link);
+    return link;
+  }
+  function loadCSSWithFallback() {
+    var loaded = false;
+    var timeoutId;
+    // Try remote first
+    var remoteLink = loadCSS(
+      REMOTE_URL,
+      function() {
+        if (loaded) return;
+        loaded = true;
+        clearTimeout(timeoutId);
+        console.log('[PA-Patcher] Skin CSS loaded from remote:', REMOTE_URL);
+      },
+      function() {
+        if (loaded) return;
+        loaded = true;
+        clearTimeout(timeoutId);
+        loadLocalFallback();
+      }
+    );
+    // Timeout fallback
+    timeoutId = setTimeout(function() {
+      if (loaded) return;
+      loaded = true;
+      console.warn('[PA-Patcher] Skin CSS timed out, using local fallback');
+      if (remoteLink.parentNode) {
+        document.head.removeChild(remoteLink);
+      }
+      loadLocalFallback();
+    }, TIMEOUT);
+  }
+  function loadLocalFallback() {
+    loadCSS(
+      LOCAL_PATH,
+      function() {
+        console.log('[PA-Patcher] Skin CSS loaded from local fallback:', LOCAL_PATH);
+      },
+      function() {
+        console.error('[PA-Patcher] Skin CSS failed to load from both remote and local');
+      }
+    );
+  }
+  // Execute immediately
+  loadCSSWithFallback();
+})();
+</script>`;
+}
+function buildSkinCssOptions(config) {
+  if (!config.skin) return null;
+  return {
+    remoteUrl: `${config.remoteDomain}/skin/${config.skin}.css`,
+    localPath: `skin/${config.skin}.css`,
+    timeout: config.cssAfter.timeout
+    // reuse cssAfter timeout
+  };
+}
+// src/templates/skin-js.ts
+function generateSkinJsLoader(options) {
+  const { remoteUrl, localPath, timeout } = options;
+  return `<!-- === PATCH-ADAMS: SKIN JS (async with fallback) === -->
+<script data-pa="skin-js-loader">
+(function() {
+  'use strict';
+  var REMOTE_URL = "${remoteUrl}";
+  var LOCAL_PATH = "${localPath}";
+  var TIMEOUT = ${timeout};
+  function loadJS(url, onSuccess, onError) {
+    var script = document.createElement('script');
+    script.src = url;
+    script.async = true;
+    script.setAttribute('data-pa', 'skin-js');
+    script.onload = function() {
+      if (onSuccess) onSuccess();
+    };
+    script.onerror = function() {
+      if (onError) onError();
+    };
+    document.body.appendChild(script);
+    return script;
+  }
+  function loadJSWithFallback() {
+    var loaded = false;
+    var timeoutId;
+    // Try remote first
+    var remoteScript = loadJS(
+      REMOTE_URL,
+      function() {
+        if (loaded) return;
+        loaded = true;
+        clearTimeout(timeoutId);
+        console.log('[PA-Patcher] Skin JS loaded from remote:', REMOTE_URL);
+        if (window.pa_patcher && window.pa_patcher.loaded) {
+          window.pa_patcher.loaded.skinJs = true;
+        }
+      },
+      function() {
+        if (loaded) return;
+        loaded = true;
+        clearTimeout(timeoutId);
+        loadLocalFallback();
+      }
+    );
+    // Timeout fallback
+    timeoutId = setTimeout(function() {
+      if (loaded) return;
+      loaded = true;
+      console.warn('[PA-Patcher] Skin JS timed out, using local fallback');
+      if (remoteScript.parentNode) {
+        document.body.removeChild(remoteScript);
+      }
+      loadLocalFallback();
+    }, TIMEOUT);
+  }
+  function loadLocalFallback() {
+    loadJS(
+      LOCAL_PATH,
+      function() {
+        console.log('[PA-Patcher] Skin JS loaded from local fallback:', LOCAL_PATH);
+        if (window.pa_patcher && window.pa_patcher.loaded) {
+          window.pa_patcher.loaded.skinJs = true;
+        }
+      },
+      function() {
+        console.error('[PA-Patcher] Skin JS failed to load from both remote and local');
+      }
+    );
+  }
+  // Execute after DOM is ready
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', function() {
+      setTimeout(loadJSWithFallback, 150);
+    });
+  } else {
+    setTimeout(loadJSWithFallback, 150);
+  }
+})();
+</script>`;
+}
+function buildSkinJsOptions(config) {
+  if (!config.skin) return null;
+  return {
+    remoteUrl: `${config.remoteDomain}/skin/${config.skin}.js`,
+    localPath: `skin/${config.skin}.js`,
+    timeout: config.jsAfter.timeout
+    // reuse jsAfter timeout
+  };
+}
 // src/patcher/html-injector.ts
 var HtmlInjector = class {
   config;
@@ -4732,6 +4926,10 @@ var HtmlInjector = class {
     if (this.config.jsAfter.enabled) {
       result = this.injectJsAfter(result);
     }
+    if (this.config.skin) {
+      result = this.injectSkinCss(result);
+      result = this.injectSkinJs(result);
+    }
     if (this.pluginAssets) {
       result = this.injectPluginAssets(result);
     }
@@ -4778,8 +4976,8 @@ ${pluginJs}
    * Also adds data attributes for course metadata
    */
   addHtmlAttributes(html) {
-    const { htmlClass, loadingClass } = this.config;
-    const classes = `${htmlClass} ${loadingClass}`;
+    const { htmlClass, loadingClass, skin } = this.config;
+    const classes = `${htmlClass} ${loadingClass}${skin ? ` pa-skinned ${skin}` : ""}`;
     const dataAttrs = [];
     if (this.metadata) {
       dataAttrs.push(`data-pa-course-id="${this.escapeAttr(this.metadata.courseId)}"`);
@@ -4788,6 +4986,9 @@ ${pluginJs}
         dataAttrs.push(`data-pa-title="${this.escapeAttr(this.metadata.title)}"`);
       }
     }
+    if (skin) {
+      dataAttrs.push(`data-pa-skin="${this.escapeAttr(skin)}"`);
+    }
     const dataAttrString = dataAttrs.length > 0 ? " " + dataAttrs.join(" ") : "";
     const htmlTagPattern = /<html([^>]*)>/i;
     const match = html.match(htmlTagPattern);
@@ -4866,6 +5067,26 @@ ${loader}`);
 ${loader}`);
     }
     return html.replace(/<\/body>/i, `${loader}
+</body>`);
+  }
+  /**
+   * Inject Skin CSS loader after CSS After (before </head>)
+   */
+  injectSkinCss(html) {
+    const options = buildSkinCssOptions(this.config);
+    if (!options) return html;
+    const loader = generateSkinCssLoader(options);
+    return html.replace(/<\/head>/i, `${loader}
+</head>`);
+  }
+  /**
+   * Inject Skin JS loader after JS After (before </body>)
+   */
+  injectSkinJs(html) {
+    const options = buildSkinJsOptions(this.config);
+    if (!options) return html;
+    const loader = generateSkinJsLoader(options);
+    return html.replace(/<\/body>/i, `${loader}
 </body>`);
   }
 };
@@ -4909,6 +5130,10 @@ var StorylineHtmlInjector = class {
     if (this.config.jsAfter.enabled) {
       result = this.injectJsAfter(result);
     }
+    if (this.config.skin) {
+      result = this.injectSkinCss(result);
+      result = this.injectSkinJs(result);
+    }
     if (this.pluginAssets) {
       result = this.injectPluginAssets(result);
     }
@@ -4953,8 +5178,8 @@ ${pluginJs}
    * Also adds data attributes for course metadata
    */
   addHtmlAttributes(html) {
-    const { htmlClass, loadingClass } = this.config;
-    const classes = `${htmlClass} ${loadingClass}`;
+    const { htmlClass, loadingClass, skin } = this.config;
+    const classes = `${htmlClass} ${loadingClass}${skin ? ` pa-skinned ${skin}` : ""}`;
     const dataAttrs = [];
     if (this.metadata) {
       dataAttrs.push(`data-pa-course-id="${this.escapeAttr(this.metadata.courseId)}"`);
@@ -4964,6 +5189,9 @@ ${pluginJs}
         dataAttrs.push(`data-pa-title="${this.escapeAttr(this.metadata.title)}"`);
       }
     }
+    if (skin) {
+      dataAttrs.push(`data-pa-skin="${this.escapeAttr(skin)}"`);
+    }
     const dataAttrString = dataAttrs.length > 0 ? " " + dataAttrs.join(" ") : "";
     const htmlTagPattern = /<html([^>]*)>/i;
     const match = html.match(htmlTagPattern);
@@ -5041,6 +5269,26 @@ ${loader}`);
     const options = buildJsAfterOptions(this.config);
     const loader = generateJsAfterLoader(options);
     return html.replace(/<\/body>/i, `${loader}
+</body>`);
+  }
+  /**
+   * Inject Skin CSS loader after CSS After (before </head>)
+   */
+  injectSkinCss(html) {
+    const options = buildSkinCssOptions(this.config);
+    if (!options) return html;
+    const loader = generateSkinCssLoader(options);
+    return html.replace(/<\/head>/i, `${loader}
+</head>`);
+  }
+  /**
+   * Inject Skin JS loader after JS After (before </body>)
+   */
+  injectSkinJs(html) {
+    const options = buildSkinJsOptions(this.config);
+    if (!options) return html;
+    const loader = generateSkinJsLoader(options);
+    return html.replace(/<\/body>/i, `${loader}
 </body>`);
   }
 };
@@ -5091,7 +5339,9 @@ var ManifestUpdater = class {
         paths.cssBefore,
         paths.cssAfter,
         paths.jsBefore,
-        paths.jsAfter
+        paths.jsAfter,
+        paths.skinCss,
+        paths.skinJs
       ].filter(Boolean);
       if (filesToAdd.length === 0) {
         return [];
@@ -5881,6 +6131,20 @@ var Patcher = class {
         })
       );
     }
+    if (this.config.skin) {
+      const skinCssUrl = `${remoteDomain}/skin/${this.config.skin}.css`;
+      fetchPromises.push(
+        this.fetchFile(skinCssUrl).then((content) => {
+          fetched.skinCss = content;
+        })
+      );
+      const skinJsUrl = `${remoteDomain}/skin/${this.config.skin}.js`;
+      fetchPromises.push(
+        this.fetchFile(skinJsUrl).then((content) => {
+          fetched.skinJs = content;
+        })
+      );
+    }
     await Promise.all(fetchPromises);
     return fetched;
   }
@@ -5964,6 +6228,16 @@ var Patcher = class {
           console.log(`[Patcher] Wrote generated UUID to manifest identifier`);
         }
       }
+      const effectiveSkin = options.skin || this.config.skin;
+      if (options.skin && options.skin !== this.config.skin) {
+        this.config.skin = options.skin;
+        this.riseHtmlInjector = new HtmlInjector(this.config);
+        this.storylineHtmlInjector = new StorylineHtmlInjector(this.config);
+        console.log(`[Patcher] Using per-call skin override: ${options.skin}`);
+      }
+      if (effectiveSkin) {
+        console.log(`[Patcher] Skin: ${effectiveSkin}`);
+      }
       const htmlInjector = this.getHtmlInjector(toolInfo.tool);
       htmlInjector.setMetadata(metadata);
       let fetchedFallbacks = {};
@@ -6092,7 +6366,11 @@ var Patcher = class {
   buildManifestPaths(addedFiles) {
     const paths = {};
     for (const filePath of addedFiles) {
-      if (filePath.endsWith(this.config.cssBefore.filename)) {
+      if (this.config.skin && filePath.endsWith(`skin/${this.config.skin}.css`)) {
+        paths.skinCss = filePath;
+      } else if (this.config.skin && filePath.endsWith(`skin/${this.config.skin}.js`)) {
+        paths.skinJs = filePath;
+      } else if (filePath.endsWith(this.config.cssBefore.filename)) {
         paths.cssBefore = filePath;
       } else if (filePath.endsWith(this.config.cssAfter.filename)) {
         paths.cssAfter = filePath;
@@ -6176,6 +6454,22 @@ var Patcher = class {
       added.push(path);
       if (fetched.jsAfter) console.log(`[Patcher] Using fetched content for ${path}`);
     }
+    if (this.config.skin) {
+      const skinCssPath = `${basePath}skin/${this.config.skin}.css`;
+      const skinCssContent = fetched.skinCss ?? `/* PA-Patcher: Skin CSS (${this.config.skin}) */
+`;
+      zip.addFile(skinCssPath, Buffer.from(skinCssContent, "utf-8"));
+      added.push(skinCssPath);
+      if (fetched.skinCss) console.log(`[Patcher] Using fetched skin CSS for ${skinCssPath}`);
+      else console.log(`[Patcher] Added placeholder skin CSS: ${skinCssPath}`);
+      const skinJsPath = `${basePath}skin/${this.config.skin}.js`;
+      const skinJsContent = fetched.skinJs ?? `// PA-Patcher: Skin JS (${this.config.skin})
+`;
+      zip.addFile(skinJsPath, Buffer.from(skinJsContent, "utf-8"));
+      added.push(skinJsPath);
+      if (fetched.skinJs) console.log(`[Patcher] Using fetched skin JS for ${skinJsPath}`);
+      else console.log(`[Patcher] Added placeholder skin JS: ${skinJsPath}`);
+    }
     return added;
   }
   /**
@@ -6190,9 +6484,9 @@ var Patcher = class {
    * @param buffer - Input ZIP file as Buffer
    * @returns Patched ZIP file as Buffer
    */
-  async patchBuffer(buffer) {
+  async patchBuffer(buffer, options) {
     console.log(`[Patcher] patchBuffer called with ${buffer.length} bytes`);
-    const { buffer: patchedBuffer, result } = await this.patch(buffer);
+    const { buffer: patchedBuffer, result } = await this.patch(buffer, options);
     console.log(`[Patcher] Patch result:`, JSON.stringify(result, null, 2));
     console.log(`[Patcher] Returning ${patchedBuffer.length} bytes`);
     return patchedBuffer;