@inizioevoke/veeva-astroclm-core 1.0.0

package/src/types/config.d.ts

@@ -0,0 +1,52 @@
+import type { IVeevaClmPresentation, IVeevaClmSlide, IVeevaClmSharedResource, IVeevaClmSlideSettings, Actions } from "./veeva";
+
+export type ThumbnailNameHandler = (config: IVeevaConfig, slide: IVeevaClmSlide, settings: IScreenshotSettings) => string;
+
+export interface IDimensions {
+  width?: number;
+  height?: number;
+}
+
+export interface IScreenshotSettings extends IDimensions {
+  filename?: string | ThumbnailNameHandler;
+  delay?: number;
+  queryStringParams?: Record<string, boolean | number | string>;
+  outDir?: string | string[] | ThumbnailNameHandler;
+}
+export interface IThumbnailSettings {
+  strategy?: 'append' | 'merge' | 'replace',
+  default?: IScreenshotSettings;
+  settings?: IScreenshotSettings[];
+}
+
+export interface IVeevaConfigSlide extends IVeevaClmSlide {
+  path: string;
+  enableActions?: Actions[];
+  thumbnails?: IThumbnailSettings;
+}
+
+export interface IVeevaConfigPresentation extends IVeevaClmPresentation {
+  shared?: IVeevaClmSharedResource & {
+    path?: string;
+  },
+  slides: IVeevaConfigSlide[]
+}
+
+
+
+export interface IVeevaConfig {
+  dimensions: { width: number, height: number };
+  slideSettings?: IVeevaClmSlideSettings; // legacy support
+  thumbnails?: Omit<IThumbnailSettings, 'strategy'>;
+  
+  presentation: IVeevaConfigPresentation & {
+    name: string;
+    presentationId: string;
+    slideSettings?: IVeevaClmSlideSettings;
+  };
+  externalPresentations?: {
+    name: string;
+    slide: string;
+    presentationId: string;
+  }[]
+}

package/src/types/env.d.ts

@@ -0,0 +1,7 @@
+export type BuildTarget = 'veeva' | 'web';
+export type WebEnv = 'development' | 'production';
+export type VeevaEnv = 'client' | 'evoke';
+export type VeevaPlatform = 'salesforce' | 'vault';
+export type LogLevel = 'disabled' | 'error' | 'debug';
+export type LogTime = 'none' | 'date' | 'time' | 'datetime' | 'performance';
+export type LogOutput = 'console' | 'screen';

package/src/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './config';
+export * from './env';
+export * from './veeva';
+
+export interface DataEvotrk {
+  slide?: string;
+  type?: string;
+  name?: string;
+}

package/src/types/veeva.d.ts

@@ -0,0 +1,58 @@
+export type MediaType = "HTML" | "Image" | "Video" | "PPTX" | "PDF";
+export type iOSResolution = "Default For Device" | "Scale To 1024x768" | "Scale To Fit";
+export type Actions = "Swipe" | "Pinch to Exit" | "Zoom" | "Rotation Lock" | "History Buttons" | "Navigation Bar" | "Reactions";
+export type CrmTarget = 'Salesforce' | 'Vault';
+
+export interface VeevaIdField {
+  id: string;
+}
+export interface VeevaCrmIdField<T = string> {
+  crmId: T;
+}
+export interface VeevaExternalIdField {
+  externalId: string;
+}
+
+export interface IVeevaClmBinderFields {
+  language?: 'English' & (string & {});
+  crmTarget?: CrmTarget;
+  crmOrg?: VeevaCrmIdField<string[]>;
+  crmProduct?: VeevaIdField;
+  crmContentGroup?: VeevaIdField | VeevaIdField[];
+  crmDetailGroup?: VeevaIdField;
+  detailGroup?: string;
+}
+
+
+export interface IVeevaClmItem {
+  externalId: string;
+  name?: string;
+  title?: string;
+}
+
+export interface IVeevaClmMedia {
+  mediaType?: MediaType;
+}
+
+export interface IVeevaClmSlideSettings extends IVeevaClmMedia, IVeevaClmBinderFields {
+  disableActions?: Actions[];
+  iosResolution?: iOSResolution;
+}
+
+export interface IVeevaClmSlide extends IVeevaClmItem, IVeevaClmMedia, IVeevaClmSlideSettings {}
+export interface IVeevaClmSharedResource extends IVeevaClmItem, IVeevaClmMedia, IVeevaClmBinderFields {}
+
+
+export interface IVeevaClmPresentation extends IVeevaClmItem, IVeevaClmBinderFields {
+  presentationId?: string;
+  product: string;
+  country?: 'United States' & (string & {});
+  startDate?: string;
+  endDate?: string;
+  isTraining?: boolean;
+  isHidden?: boolean;
+
+  shared?: IVeevaClmSharedResource;
+
+  slides: IVeevaClmSlide[]
+}

package/src/veeva/readme.md

@@ -0,0 +1,77 @@
+# Veeva Configuration
+
+This document describes the structure and usage of the `veeva/config.ts` module.
+
+## Overview
+
+`veeva/config.ts` exports a default factory function that returns an object conforming to `IVeevaConfig` used throughout the build and deployment process for Veeva-enabled presentations.
+
+The configuration object includes settings for dimensions, slide behaviour, thumbnail generation, presentation metadata, and references to external content.
+
+The factory accepts an optional arguments object allowing callers to specify environment-specific details.
+
+## Factory Function
+
+```ts
+export default function ({ veevaEnv = 'client', isTraining = false }: IVeevaConfigArgs): IVeevaConfig
+```
+
+### Parameters
+
+- `veevaEnv` *(optional)*: (`VeevaEnv`) Indicates the running environment. Typical values are `'client'` for the Veeva Client application, or another value when building/testing.
+- `isTraining` *(optional)*: (`boolean`) When set to `true`, the configuration uses training-specific identifiers and appends `[Training]` to the presentation name.
+
+### Returns
+
+An `IVeevaConfig` object with all the required properties for Veeva workflows.
+
+## Key Concepts
+
+### EXT_ID and Naming
+
+- `EXT_ID` is a base external identifier for the presentation. When training mode is enabled, `'_TRN'` is appended.
+- `PRESENTATION_NAME` is a constant string, altered by the training flag when necessary.
+- `formatExtId` is a local helper wrapping `lib/utils`'s `formatExtId` utility to produce unique external IDs for slides and shared content.
+
+### Structure of the Returned Configuration
+
+| Property                | Description |
+|-------------------------|-------------|
+| `dimensions`            | Width/height for the content display. |
+| `slideSettings`         | Global slide defaults (media type, disabled actions, iOS resolution). |
+| `thumbnails`            | Instructions for generating thumbnails; query params applied globally. |
+| `presentation`          | Metadata describing the presentation itself. |
+| `externalPresentations` | Array of additional presentations (name, slide, id) included in the package. |
+
+### Presentation Metadata
+
+Within `presentation`, the object includes:
+
+- `externalId`, `presentationId`, `product`, `name`, `country`, `language` (conditional on environment), `isTraining`.
+- `shared.externalId` used for shared resources.
+- `slides`: an array of slide descriptors, each with:
+  - `path`, `title`, `externalId`
+  - optional `disableActions`, `enableActions`, and extra thumbnails config per slide.
+
+## Example Usage
+
+```ts
+import createConfig from './veeva/config';
+
+const config = createConfig({ veevaEnv: 'client', isTraining: true });
+// pass `config` to build/deploy tasks
+```
+
+## Dependencies
+
+- `IVeevaConfig` and `VeevaEnv` types are imported from `./types`.
+- Utility `formatExtId` comes from `./lib/utils`.
+
+## Notes
+
+- Adjust the constants `EXT_ID` and `PRESENTATION_NAME` to match actual project values.
+- Modification of slides, external presentations, or other properties should maintain the shape defined by `IVeevaConfig`.
+
+---
+
+This file is intended as a reference for developers working on Veeva-related tooling and should be updated if the configuration schema changes.

package/src/veeva/slideManager.ts

@@ -0,0 +1,139 @@
+import fs from 'fs';
+import path from 'path';
+
+const configPath = path.resolve(__dirname, 'config.ts');
+
+function readConfig(): string {
+  return fs.readFileSync(configPath, 'utf8');
+}
+
+function writeConfig(text: string): void {
+  fs.writeFileSync(configPath, text, 'utf8');
+}
+
+function mutateSlides(mutate: (current: string) => string): void {
+  const content = readConfig();
+  const slidesSection = /slides\s*:\s*\[([\s\S]*?)\]/m;
+  const match = content.match(slidesSection);
+  if (!match) {
+    throw new Error('Unable to locate slides array in config.ts');
+  }
+
+  const before = content.slice(0, match.index);
+  const after = content.slice((match.index ?? 0) + match[0].length);
+  const current = match[1];
+  const updated = mutate(current);
+  const newSection = `slides: [${updated}]`;
+  writeConfig(before + newSection + after);
+}
+
+/**
+ * Create an editor instance that loads the slides section once and allows
+ * multiple mutations before committing the change back to disk.
+ */
+export function createEditor() {
+  const slidesSection = /slides\s*:\s*\[([\s\S]*?)\]/m;
+  let content = readConfig();
+  const match = content.match(slidesSection);
+  if (!match) {
+    throw new Error('Unable to locate slides array in config.ts');
+  }
+
+  const prefix = content.slice(0, match.index);
+  const suffix = content.slice((match.index ?? 0) + match[0].length);
+  let current = match[1];
+
+  function commit() {
+    const newSection = `slides: [${current}]`;
+    writeConfig(prefix + newSection + suffix);
+  }
+
+  function removePaths(targetPaths: string[]) {
+    if (targetPaths.length === 0) return;
+    for (const p of targetPaths) {
+      const esc = p.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+      const re = new RegExp(`\{[\s\S]*?path:\s*['"]${esc}['"][\s\S]*?\}(,?)`, 'm');
+      current = current.replace(re, '');
+    }
+    current = current.replace(/,\s*,/g, ',');
+    current = current.replace(/,\s*$/m, '');
+  }
+
+  function insert(slide: { path: string; title: string; externalId: string }) {
+    const trimmed = current.trim();
+    const formatted = `
+      { path: '${slide.path}', title: '${slide.title}', externalId: '${slide.externalId}' }`;
+    if (trimmed === '') {
+      current = formatted + '\n';
+    } else {
+      current = trimmed.replace(/\s*$/, '') + ',' + formatted + '\n';
+    }
+  }
+
+  function updatePath(oldPath: string, newPath: string) {
+    const escOld = oldPath.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    current = current.replace(
+      new RegExp(`(path:\s*['"])${escOld}(['"])`),
+      `$1${newPath}$2`
+    );
+  }
+
+  return {
+    removePaths,
+    insert,
+    updatePath,
+    commit,
+    // expose current for inspection/testing
+    getCurrent: () => current
+  };
+}
+
+/**
+ * Remove every slide whose `path` matches one of the provided keys.
+ */
+export function removeSlides(targetPaths: string[]): void {
+  if (targetPaths.length === 0) return;
+  mutateSlides(current => {
+    let txt = current;
+    for (const p of targetPaths) {
+      const esc = p.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+      const re = new RegExp(`\{[\s\S]*?path:\s*['"]${esc}['"][\s\S]*?\}(,?)`, 'm');
+      txt = txt.replace(re, '');
+    }
+    // clean up extra commas
+    txt = txt.replace(/,\s*,/g, ',');
+    txt = txt.replace(/,\s*$/m, '');
+    return txt;
+  });
+}
+
+/**
+ * Append a slide object to the end of the slides array.  The caller should
+ * provide values already formatted as they should appear in the file (quotes
+ * around strings, etc.).  We simply ensure there is a comma between entries.
+ */
+export function insertSlide(slide: { path: string; title: string; externalId: string }): void {
+  mutateSlides(current => {
+    const trimmed = current.trim();
+    const formatted = `
+      { path: '${slide.path}', title: '${slide.title}', externalId: '${slide.externalId}' }`;
+    if (trimmed === '') {
+      return formatted + '\n';
+    }
+    return trimmed.replace(/\s*$/, '') + ',' + formatted + '\n';
+  });
+}
+
+/**
+ * Change the `path` value of the first slide object that has `oldPath`.
+ */
+export function updateSlidePath(oldPath: string, newPath: string): void {
+  mutateSlides(current => {
+    const escOld = oldPath.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+    return current.replace(
+      new RegExp(`(path:\s*['"])${escOld}(['"])`),
+      `$1${newPath}$2`
+    );
+  });
+}
+

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "types": [
+      "node"
+    ],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+    "plugins": [{
+      "name": "@astrojs/ts-plugin"
+    }]
+  },
+  "include": [
+    "./src/**/*.ts"
+  ],
+  "exclude": [
+    "./dist",
+    "./node_modules"
+  ]
+}