@inizioevoke/veeva-astroclm-core 1.3.9 → 1.4.1

package/dist/apps/veeva-config-manager/templates/config.ts.txt

@@ -44,6 +44,7 @@ export default function ({ veevaEnv = 'client', isTraining = false }: IVeevaConf
 
       shared: {
         externalId: formatExtId('SHARED'),
+        // zipFileName: 'shared.zip',
         ...binderFields
       },
 

package/dist/lib/utils.js

@@ -2,7 +2,7 @@ export function formatExtId(...ids) {
     return ids.map((id) => { return id.toUpperCase(); }).join('_');
 }
 export function pathToSlideZip(path) {
-    return `${flattenPath(path, { slashes: false })}.zip`;
+    return `${flattenPath(path, { slashes: false }).replace(/\.zip$/i, '')}.zip`;
 }
 export function flattenPath(path, { slashes = true } = {}) {
     return `${slashes ? '/' : ''}${path.toLowerCase().split('/').filter(s => s !== '').join('-')}${slashes ? '/' : ''}`;

package/dist/tasks/create-csv.js

@@ -152,7 +152,7 @@ function createSlideRow(headers, config, slide, additional) {
     addColumn(headers, row, HEADER_SLIDE_REACTIONS, disable.has('Reactions') ? ',a,b,c' : '');
     disable.delete('Reactions');
     addColumn(headers, row, HEADER_SLIDE_DISABLE_ACTIONS, [...disable].join(','));
-    addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(slide.path));
+    addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(slide.zipFileName ?? slide.path));
     addColumn(headers, row, HEADER_SLIDE_RELATED_SHARED, config.presentation.shared?.externalId ?? '');
     addColumn(headers, row, HEADER_SLIDE_CLM_CONTENT, VEEVA_YES);
     addColumn(headers, row, HEADER_PRESENTATION, config.presentation.externalId);
@@ -180,7 +180,7 @@ function createSharedRow(headers, config, additional) {
     addColumn(headers, row, HEADER_SLIDE_PRODUCT, config.presentation.product);
     addColumn(headers, row, HEADER_SLIDE_COUNTRY, config.presentation.country);
     addColumn(headers, row, HEADER_SLIDE_MEDIA_TYPE, shared.mediaType ?? VEEVA_MEDIATYPE_HTML);
-    addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(shared.path ?? 'shared'));
+    addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(shared.zipFileName ?? shared.path ?? 'shared'));
     addColumn(headers, row, HEADER_SLIDE_CLM_CONTENT, VEEVA_YES);
     addColumn(headers, row, HEADER_SLIDE_CRM_SHARED, VEEVA_YES);
     addColumn(headers, row, HEADER_LIFECYCLE, VEEVA_LIFECYCLE_CRM_CONTENT);

package/dist/tasks/create-zips.d.ts

@@ -1,5 +1,7 @@
+import { IVeevaConfig } from '../types';
 interface Params {
+    config: IVeevaConfig;
     deployDir: string;
 }
-export default function ({ deployDir }: Params): Promise<void>;
+export default function ({ config, deployDir }: Params): Promise<void>;
 export {};

package/dist/tasks/create-zips.js

@@ -3,14 +3,18 @@ import { join } from 'node:path';
 import Zip from 'adm-zip';
 import logger from '../lib/logger.js';
 import { pathToSlideZip } from '../lib/utils.js';
-export default async function ({ deployDir }) {
+export default async function ({ config, deployDir }) {
     logger.info('Creating ZIP files');
     const dirs = await readdir(deployDir);
     for (const dir of dirs) {
         const dirPath = join(deployDir, dir);
         const zip = new Zip();
         zip.addLocalFolder(dirPath);
-        await zip.writeZipPromise(join(deployDir, pathToSlideZip(dir)));
+        await zip.writeZipPromise(join(deployDir, getZipFileName(config, dir)));
         await rm(dirPath, { recursive: true });
     }
 }
+function getZipFileName(config, dir) {
+    const zipFileName = dir === 'shared' ? config.presentation.shared?.zipFileName : config.presentation.slides.find(s => s.zipFileName === dir)?.zipFileName;
+    return pathToSlideZip(zipFileName ?? dir);
+}

package/dist/tasks/deploy.js

@@ -1,7 +1,9 @@
 import { existsSync } from 'node:fs';
 import { mkdir, rm, readdir } from 'node:fs/promises';
 import { join } from "node:path";
+import { fileURLToPath } from 'node:url';
 import { preview } from "astro";
+import { validateConfig } from "astro/config";
 import parseArgv from '../lib/parse-argv.js';
 import copyFiles from './copy-files.js';
 import generateThumbs from './generate-thumbs.js';
@@ -15,10 +17,12 @@ const argv = parseArgv({
 export default async function ({ root, config, env, csvOnly = false, serverPort = 4320 }) {
     const rootDir = root ?? process.cwd();
     // we could import the astro config and see if the outDir was set but right now it's not necessary
-    const astroDistDir = join(rootDir, 'dist');
+    const astroConfig = await getAstroConfig(root);
+    const outDir = astroConfig ? fileURLToPath(astroConfig.outDir).replace(root, '') : 'dist';
+    const astroDistDir = join(rootDir, outDir);
     const buildName = `${env}${config.presentation.isTraining === true ? '-training' : ''}`;
     const buildType = argv.mode ?? buildName;
-    const deployDir = join(rootDir, 'deploy', buildType);
+    const deployDir = join(rootDir, outDir !== 'deploy' ? 'deploy' : 'deploy-veeva', buildType);
     if (existsSync(deployDir)) {
         const items = await readdir(deployDir);
         for (const item of items) {
@@ -44,7 +48,28 @@ export default async function ({ root, config, env, csvOnly = false, serverPort
             root
         });
         await server.stop();
-        await createZips({ deployDir });
+        await createZips({ config, deployDir });
     }
     await createCsv({ config, deployDir, buildName, fieldsOnly: csvOnly });
 }
+async function getAstroConfig(root) {
+    let config = undefined;
+    try {
+        config = await validateConfig({}, root, 'build');
+    }
+    catch (err) {
+        console.error('Failed to parse Astro config');
+    }
+    return config;
+    // console.log('Searching for Astro config');
+    // const files = await readdir(root, { withFileTypes: true });
+    // const configFile = files.find((f) => {
+    //   return f.isFile() || /^astro\.config\.(?:js|cjs|mjs|ts)$/i.test(f.name);
+    // });
+    // if (!configFile) {
+    //   throw new Error('Could not locate Astro config file');
+    // }
+    // const { default: astroConfig } = await import(pathToFileURL(join(root, configFile.name)).toString());
+    // console.log(astroConfig);
+    // return astroConfig;
+}

package/dist/tasks/generate-thumbs.js

@@ -1,7 +1,8 @@
 import { writeFile } from "node:fs/promises";
-import { join } from "node:path";
+import { extname, join } from "node:path";
 import puppeteer from "puppeteer";
 import sharp from 'sharp';
+import { pdf } from "pdf-to-img";
 import logger from '../lib/logger.js';
 export default async function ({ config, root, deployDir, server }) {
     logger.info('Generating thumbnails');
@@ -18,21 +19,41 @@ export default async function ({ config, root, deployDir, server }) {
     });
     try {
         for (const slide of config.presentation.slides) {
+            if (slide.thumbnails === false)
+                continue;
+            // this shouldn't ever be the case after initThumbSettings runs but it keeps typescript happy
+            if (!slide.thumbnails || !slide.thumbnails.settings)
+                continue;
             for (const settings of slide.thumbnails.settings) {
-                logger.info(`Generating /${settings.path ?? slide.path}/`);
-                const url = `${server.protocol ?? 'http'}://${server.host}:${server.port}/${settings.path ?? slide.path}/${settings.queryStringParams ? `?${objToQS(settings.queryStringParams)}` : ''}`;
-                await page.goto(url, {
-                    waitUntil: 'networkidle0'
-                });
-                if (settings.delay && settings.delay > 0) {
-                    logger.info(`Delaying thumbnail generation for ${settings.delay}ms`);
-                    await sleep(settings.delay);
+                const settingsPath = settings.path ?? slide.path;
+                const urlPath = `${settingsPath.startsWith('/') ? '' : '/'}${settingsPath}${extname(settingsPath) !== '' ? '' : '/'}`;
+                logger.info(`Generating ${urlPath}`);
+                let screenshot;
+                switch (slide.mediaType) {
+                    case 'PDF': {
+                        await using document = await pdf(join(deployDir, settingsPath), { scale: 2 });
+                        screenshot = await document.getPage(1);
+                        break;
+                    }
+                    case 'HTML':
+                    default: {
+                        const url = `${server.protocol ?? 'http'}://${server.host}:${server.port}${urlPath}${settings.queryStringParams ? `?${objToQS(settings.queryStringParams)}` : ''}`;
+                        await page.goto(url, {
+                            waitUntil: 'networkidle0'
+                        });
+                        if (settings.delay && settings.delay > 0) {
+                            logger.info(`Delaying thumbnail generation for ${settings.delay}ms`);
+                            await sleep(settings.delay);
+                        }
+                        screenshot = await page.screenshot();
+                        break;
+                    }
                 }
-                let screenshot = await page.screenshot();
                 let thumb = await (sharp(screenshot)
                     .resize({
                     width: settings.width,
-                    height: settings.height
+                    height: settings.height,
+                    fit: 'inside'
                 })
                     .png({
                     palette: settings.palette ?? true,
@@ -165,6 +186,8 @@ function initThumbSettings(config) {
     //   }
     // }
     for (const slide of config.presentation.slides) {
+        if (slide.thumbnails === false)
+            continue;
         if (!slide.thumbnails) {
             slide.thumbnails = {};
         }
@@ -200,6 +223,9 @@ function initThumbSettings(config) {
                 }
             }
         }
+        for (let i = 0; i < slide.thumbnails.settings.length; i++) {
+            slide.thumbnails.settings[i].width ??= config.thumbnails[0]?.width ?? DEFAULT_WIDTH;
+        }
     }
 }
 function sleep(timeout = 0) {

package/dist/tasks/update-shared.js

@@ -1,4 +1,5 @@
 import { readdir, readFile, writeFile } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
 import { join, extname } from 'node:path';
 import logger from '../lib/logger.js';
 export default async function ({ deployDir }) {
@@ -29,13 +30,19 @@ async function handleShared(deployDir, dir) {
     }
 }
 async function handleHTML(deployDir, dir) {
-    await updateSharedPath(join(deployDir, dir, 'index.html'));
+    const index = join(deployDir, dir, 'index.html');
+    if (!existsSync(index))
+        return;
+    await updateSharedPath(index);
 }
 async function updateSharedPath(filepath) {
     const str = await readFile(filepath, 'utf8');
     let shared = './shared/';
-    if (extname(filepath) === '.css') { // relative paths inside a css
-        shared = './';
+    switch (extname(filepath)) {
+        case '.css':
+        case '.js':
+            shared = './';
+            break;
     }
     await writeFile(filepath, str.replace(/(?:\.*\/)*shared\//g, shared));
 }

package/dist/types/config.d.ts

@@ -37,12 +37,14 @@ export interface ISlideThumbnailSettings {
 export interface IVeevaConfigSlide extends IVeevaClmSlide {
   path: string;
   enableActions?: Actions[];
-  thumbnails?: ISlideThumbnailSettings;
+  thumbnails?: false | ISlideThumbnailSettings;
+  zipFileName?: string;
 }
 
 export interface IVeevaConfigPresentation extends IVeevaClmPresentation {
   shared?: IVeevaClmSharedResource & {
     path?: string;
+    zipFileName?: string;
   },
   slides: IVeevaConfigSlide[]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inizioevoke/veeva-astroclm-core",
-  "version": "1.3.9",
+  "version": "1.4.1",
   "description": "",
   "license": "ISC",
   "author": "",
@@ -34,6 +34,7 @@
   "dependencies": {
     "@clack/prompts": "^1.4.0",
     "adm-zip": "^0.5.17",
+    "pdf-to-img": "^7.0.0",
     "puppeteer": "^24.43.1",
     "sharp": "^0.34.5",
     "yaml": "^2.9.0"

package/src/apps/veeva-config-manager/templates/config.ts.txt

@@ -44,6 +44,7 @@ export default function ({ veevaEnv = 'client', isTraining = false }: IVeevaConf
 
       shared: {
         externalId: formatExtId('SHARED'),
+        // zipFileName: 'shared.zip',
         ...binderFields
       },
 

package/src/lib/utils.ts

@@ -5,7 +5,7 @@ export function formatExtId(...ids: string[]) {
 }
 
 export function pathToSlideZip(path: string) {
-  return `${flattenPath(path, { slashes: false })}.zip`;
+  return `${flattenPath(path, { slashes: false }).replace(/\.zip$/i,'')}.zip`;
 }
 
 export function flattenPath(path: string, { slashes = true }: { slashes?: boolean } = {}) {

package/src/tasks/create-csv.ts

@@ -229,7 +229,7 @@ function createSlideRow(headers: string[], config: IVeevaConfig, slide: IVeevaCo
   disable.delete('Reactions');
   addColumn(headers, row, HEADER_SLIDE_DISABLE_ACTIONS, [...disable].join(','));
   
-  addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(slide.path));
+  addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(slide.zipFileName ?? slide.path));
   addColumn(headers, row, HEADER_SLIDE_RELATED_SHARED, config.presentation.shared?.externalId ?? '');
   addColumn(headers, row, HEADER_SLIDE_CLM_CONTENT, VEEVA_YES);
   addColumn(headers, row, HEADER_PRESENTATION, config.presentation.externalId);
@@ -260,7 +260,7 @@ function createSharedRow(headers: string[], config: IVeevaConfig, additional?: A
   addColumn(headers, row, HEADER_SLIDE_PRODUCT, config.presentation.product);
   addColumn(headers, row, HEADER_SLIDE_COUNTRY, config.presentation.country);
   addColumn(headers, row, HEADER_SLIDE_MEDIA_TYPE, shared.mediaType ?? VEEVA_MEDIATYPE_HTML);
-  addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(shared.path ?? 'shared'));
+  addColumn(headers, row, HEADER_SLIDE_FILE_NAME, pathToSlideZip(shared.zipFileName ?? shared.path ?? 'shared'));
   addColumn(headers, row, HEADER_SLIDE_CLM_CONTENT, VEEVA_YES);
   addColumn(headers, row, HEADER_SLIDE_CRM_SHARED, VEEVA_YES);
   addColumn(headers, row, HEADER_LIFECYCLE, VEEVA_LIFECYCLE_CRM_CONTENT);

package/src/tasks/create-zips.ts

@@ -3,11 +3,13 @@ import { join } from 'node:path';
 import Zip from 'adm-zip';
 import logger from '../lib/logger.js';
 import { pathToSlideZip } from '../lib/utils.js';
+import { IVeevaConfig } from '../types';
 
 interface Params {
+  config: IVeevaConfig;
   deployDir: string;
 }
-export default async function({ deployDir }: Params) {
+export default async function({ config, deployDir }: Params) {
   logger.info('Creating ZIP files');
   const dirs = await readdir(deployDir);
 
@@ -15,7 +17,13 @@ export default async function({ deployDir }: Params) {
     const dirPath = join(deployDir, dir);
     const zip = new Zip();
     zip.addLocalFolder(dirPath);
-    await zip.writeZipPromise(join(deployDir, pathToSlideZip(dir)));
+    await zip.writeZipPromise(join(deployDir, getZipFileName(config, dir)));
     await rm(dirPath, { recursive: true });
   }
+}
+
+function getZipFileName(config: IVeevaConfig, dir: string) {
+  const zipFileName = dir === 'shared' ? config.presentation.shared?.zipFileName : config.presentation.slides.find(s => s.zipFileName === dir)?.zipFileName;
+  
+  return pathToSlideZip(zipFileName ?? dir);
 }

package/src/tasks/deploy.ts

@@ -1,7 +1,9 @@
 import { existsSync } from 'node:fs';
 import { mkdir, rm, readdir } from 'node:fs/promises';
-import { join, resolve as resolvePath } from "node:path"
-import { preview } from "astro";
+import { join, resolve as resolvePath } from "node:path";
+import { pathToFileURL, fileURLToPath } from 'node:url';
+import { AstroConfig, preview } from "astro";
+import { validateConfig } from "astro/config";
 import { IVeevaConfig } from '../types';
 import loadEnv from '../lib/env.js';
 import logger from '../lib/logger.js';
@@ -29,10 +31,12 @@ interface Opts {
 export default async function({ root, config, env, csvOnly = false, serverPort = 4320 }: Opts) {
   const rootDir = root ?? process.cwd();
   // we could import the astro config and see if the outDir was set but right now it's not necessary
-  const astroDistDir = join(rootDir, 'dist');
+  const astroConfig = await getAstroConfig(root);
+  const outDir = astroConfig ? fileURLToPath(astroConfig.outDir).replace(root, '') : 'dist';
+  const astroDistDir = join(rootDir, outDir);
   const buildName = `${env}${config.presentation.isTraining === true ? '-training' : ''}`;
   const buildType = argv.mode ?? buildName;
-  const deployDir = join(rootDir, 'deploy', buildType);
+  const deployDir = join(rootDir, outDir !== 'deploy' ? 'deploy' : 'deploy-veeva', buildType);
 
   if (existsSync(deployDir)) {
     const items = await readdir(deployDir);
@@ -63,11 +67,31 @@ export default async function({ root, config, env, csvOnly = false, serverPort =
 
     await server.stop();
 
-    await createZips({ deployDir });
+    await createZips({ config, deployDir });
   }
 
   await createCsv({ config, deployDir, buildName, fieldsOnly: csvOnly })
 }
 
 
+async function getAstroConfig(root: string) {
+  let config: AstroConfig | undefined = undefined;
+  try {
+    config = await validateConfig({}, root, 'build');
+  } catch (err) {
+    console.error('Failed to parse Astro config')
+  }
+  return config;
+  // console.log('Searching for Astro config');
+  // const files = await readdir(root, { withFileTypes: true });
+  // const configFile = files.find((f) => {
+  //   return f.isFile() || /^astro\.config\.(?:js|cjs|mjs|ts)$/i.test(f.name);
+  // });
+  // if (!configFile) {
+  //   throw new Error('Could not locate Astro config file');
+  // }
+  // const { default: astroConfig } = await import(pathToFileURL(join(root, configFile.name)).toString());
+  // console.log(astroConfig);
+  // return astroConfig;
+}
 

package/src/tasks/generate-thumbs.ts

@@ -1,7 +1,8 @@
 import { writeFile } from "node:fs/promises";
-import { join } from "node:path";
+import { extname, join } from "node:path";
 import puppeteer, { type Viewport } from "puppeteer";
 import sharp from 'sharp';
+import { pdf } from "pdf-to-img";
 
 import logger from '../lib/logger.js';
 import type { IVeevaConfig, IThumbnailSettings, IScreenshotSettings } from "../types";
@@ -34,23 +35,48 @@ export default async function({ config, root, deployDir, server }: Params) {
 
   try {
     for (const slide of config.presentation.slides) {
-      for (const settings of slide.thumbnails!.settings!) {
-        logger.info(`Generating /${settings.path ?? slide.path}/`);
-        const url = `${server.protocol ?? 'http'}://${server.host}:${server.port}/${settings.path ?? slide.path}/${settings.queryStringParams ? `?${objToQS(settings.queryStringParams)}` : ''}`
+      if (slide.thumbnails === false) continue;
 
-        await page.goto(url, { 
-          waitUntil: 'networkidle0'
-        });
-        if (settings.delay && settings.delay > 0) {
-          logger.info(`Delaying thumbnail generation for ${settings.delay}ms`);
-          await sleep(settings.delay);
+      // this shouldn't ever be the case after initThumbSettings runs but it keeps typescript happy
+      if (!slide.thumbnails || !slide.thumbnails.settings) continue; 
+
+
+
+
+      for (const settings of slide.thumbnails.settings) {
+        const settingsPath = settings.path ?? slide.path;
+        const urlPath = `${settingsPath.startsWith('/') ? '' : '/'}${settingsPath}${extname(settingsPath) !== '' ? '' : '/'}`;
+        logger.info(`Generating ${urlPath}`);
+
+        let screenshot: Buffer | Uint8Array;
+        switch (slide.mediaType) {
+          case 'PDF': {
+            await using document = await pdf(join(deployDir, settingsPath), { scale: 2 });
+            screenshot = await document.getPage(1);
+            break;
+          }
+          case 'HTML':
+          default: {
+            const url = `${server.protocol ?? 'http'}://${server.host}:${server.port}${urlPath}${settings.queryStringParams ? `?${objToQS(settings.queryStringParams)}` : ''}`
+
+            await page.goto(url, { 
+              waitUntil: 'networkidle0'
+            });
+            if (settings.delay && settings.delay > 0) {
+              logger.info(`Delaying thumbnail generation for ${settings.delay}ms`);
+              await sleep(settings.delay);
+            }
+            screenshot = await page.screenshot();
+            break;
+          }
         }
-        let screenshot = await page.screenshot();
+        
         let thumb = await (
           sharp(screenshot)
             .resize({
               width: settings.width,
-              height: settings.height
+              height: settings.height,
+              fit: 'inside'
             })
             .png({ 
               palette: settings.palette ?? true,
@@ -189,6 +215,8 @@ function initThumbSettings(config: IVeevaConfig) {
   // }
 
   for (const slide of config.presentation.slides) {
+    if (slide.thumbnails === false) continue;
+
     if (!slide.thumbnails) {
       slide.thumbnails = {};
     }
@@ -224,6 +252,10 @@ function initThumbSettings(config: IVeevaConfig) {
         }
       }
     }
+    for (let i=0; i<slide.thumbnails.settings.length; i++) {
+      slide.thumbnails.settings[i].width ??= config.thumbnails[0]?.width ?? DEFAULT_WIDTH;
+      
+    }
   }
 
 }

package/src/tasks/update-shared.ts

@@ -1,4 +1,5 @@
 import { readdir, readFile, writeFile } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
 import { join, extname } from 'node:path';
 
 import logger from '../lib/logger.js';
@@ -36,14 +37,19 @@ async function handleShared(deployDir: string, dir: string) {
 }
 
 async function handleHTML(deployDir: string, dir: string) {
-  await updateSharedPath(join(deployDir, dir, 'index.html'));
+  const index = join(deployDir, dir, 'index.html');
+  if (!existsSync(index)) return;
+  await updateSharedPath(index);
 }
 
 async function updateSharedPath(filepath: string) {
   const str = await readFile(filepath, 'utf8');
   let shared = './shared/';
-  if (extname(filepath) === '.css') { // relative paths inside a css
-    shared = './';
+  switch (extname(filepath)) {
+    case '.css':
+    case '.js':
+      shared = './';
+      break;
   }
   await writeFile(filepath, str.replace(/(?:\.*\/)*shared\//g, shared));
 }

package/src/types/config.d.ts

@@ -37,12 +37,14 @@ export interface ISlideThumbnailSettings {
 export interface IVeevaConfigSlide extends IVeevaClmSlide {
   path: string;
   enableActions?: Actions[];
-  thumbnails?: ISlideThumbnailSettings;
+  thumbnails?: false | ISlideThumbnailSettings;
+  zipFileName?: string;
 }
 
 export interface IVeevaConfigPresentation extends IVeevaClmPresentation {
   shared?: IVeevaClmSharedResource & {
     path?: string;
+    zipFileName?: string;
   },
   slides: IVeevaConfigSlide[]
 }