@progressive-development/pd-provider-firebase-functions 0.3.5 → 0.4.0

package/dist/import-templates.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Reusable Mail Templates Import
+ *
+ * Imports mail templates from a templates directory into Firestore.
+ * Each template consists of three files:
+ *   - {name}.json          — metadata (name, subject)
+ *   - {name}.html.hbs      — HTML template
+ *   - {name}.txt.hbs       — Text template
+ */
+export interface ImportTemplatesConfig {
+    /** Path to the mail-templates/ directory */
+    templatesDir: string;
+    /** Path to the serviceAccountKey.json */
+    serviceAccountPath: string;
+    /** Optional Firestore named database */
+    databaseId?: string;
+    /** Optional collection name (default: "emailTemplates") */
+    collection?: string;
+    /** Optional single template name to import */
+    templateFilter?: string;
+    /** If true, no writes are performed (default: false) */
+    dryRun?: boolean;
+}
+/**
+ * Import mail templates into Firestore.
+ */
+export declare function runImportTemplates(config: ImportTemplatesConfig): Promise<void>;
+//# sourceMappingURL=import-templates.d.ts.map

package/dist/import-templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-templates.d.ts","sourceRoot":"","sources":["../src/import-templates.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,MAAM,WAAW,qBAAqB;IACpC,4CAA4C;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wDAAwD;IACxD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AA6CD;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CA2FrF"}

package/dist/import-templates.js

@@ -0,0 +1,109 @@
+import { existsSync, readdirSync, readFileSync } from 'fs';
+import { scriptLog, createScriptContext } from './script-helpers.js';
+
+function findTemplates(templatesDir) {
+  const files = readdirSync(templatesDir);
+  const jsonFiles = files.filter((f) => f.endsWith(".json") && f !== "serviceAccountKey.json");
+  return jsonFiles.map((f) => f.replace(".json", ""));
+}
+function loadTemplate(templatesDir, name) {
+  const jsonPath = `${templatesDir}/${name}.json`;
+  const htmlPath = `${templatesDir}/${name}.html.hbs`;
+  const textPath = `${templatesDir}/${name}.txt.hbs`;
+  if (!existsSync(jsonPath)) {
+    scriptLog(`Metadata not found: ${jsonPath}`, "error");
+    return null;
+  }
+  if (!existsSync(htmlPath)) {
+    scriptLog(`HTML template not found: ${htmlPath}`, "error");
+    return null;
+  }
+  if (!existsSync(textPath)) {
+    scriptLog(`Text template not found: ${textPath}`, "error");
+    return null;
+  }
+  const metadata = JSON.parse(readFileSync(jsonPath, "utf-8"));
+  const html = readFileSync(htmlPath, "utf-8");
+  const text = readFileSync(textPath, "utf-8");
+  return { ...metadata, html, text };
+}
+async function runImportTemplates(config) {
+  const {
+    templatesDir,
+    serviceAccountPath,
+    databaseId,
+    collection = "emailTemplates",
+    templateFilter,
+    dryRun = false
+  } = config;
+  if (!existsSync(templatesDir)) {
+    scriptLog(`Templates directory not found: ${templatesDir}`, "error");
+    process.exit(1);
+  }
+  const { db } = createScriptContext({
+    title: "Mail Templates Import",
+    serviceAccountPath,
+    databaseId,
+    dryRun
+  });
+  scriptLog(`Templates dir: ${templatesDir}`);
+  scriptLog(`Target collection: ${collection}`);
+  let templates = findTemplates(templatesDir);
+  if (templateFilter) {
+    templates = templates.filter((t) => t === templateFilter);
+    if (templates.length === 0) {
+      scriptLog(`Template not found: ${templateFilter}`, "error");
+      process.exit(1);
+    }
+  }
+  scriptLog(`Found ${templates.length} template(s): ${templates.join(", ")}`);
+  console.log("");
+  let successCount = 0;
+  let errorCount = 0;
+  for (const templateName of templates) {
+    const template = loadTemplate(templatesDir, templateName);
+    if (!template) {
+      errorCount++;
+      continue;
+    }
+    const docId = `${templateName}Id`;
+    console.log(`
+  ${templateName}`);
+    console.log(`   Document ID: ${docId}`);
+    console.log(`   Subject: ${template.subject}`);
+    console.log(`   HTML: ${template.html.length} chars`);
+    console.log(`   Text: ${template.text.length} chars`);
+    if (!dryRun) {
+      try {
+        await db.collection(collection).doc(docId).set({
+          name: template.name,
+          subject: template.subject,
+          html: template.html,
+          text: template.text,
+          updatedAt: (/* @__PURE__ */ new Date()).toISOString()
+        });
+        scriptLog(`Imported: ${templateName} -> ${docId}`, "success");
+        successCount++;
+      } catch (error) {
+        scriptLog(`Failed to import ${templateName}: ${error}`, "error");
+        errorCount++;
+      }
+    } else {
+      scriptLog(`Would import: ${templateName} -> ${docId}`, "info");
+      successCount++;
+    }
+  }
+  console.log("\n" + "-".repeat(50));
+  console.log(`
+Summary:`);
+  console.log(`   Success: ${successCount}`);
+  console.log(`   Errors:  ${errorCount}`);
+  if (dryRun) {
+    console.log(`
+   Run without --dry-run to apply changes.
+`);
+  }
+  process.exit(errorCount > 0 ? 1 : 0);
+}
+
+export { runImportTemplates };

package/dist/index.d.ts

@@ -10,4 +10,8 @@ export { moveToTrash, restoreFromTrash, permanentDelete, listTrash, getTrashItem
 export type { AuthTrashOptions } from './auth-trash';
 export { moveToTrashWithAuth, restoreFromTrashWithAuth, permanentDeleteWithAuth } from './auth-trash';
 export { logger } from './logger';
+export type { LogType, ScriptContextConfig, ScriptContext } from './script-helpers';
+export { scriptLog, initFirebaseAdmin, createScriptContext } from './script-helpers';
+export type { ImportTemplatesConfig } from './import-templates';
+export { runImportTemplates } from './import-templates';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGrC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGpK,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAGtE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAG3D,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGpC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAG3C,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGlG,YAAY,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGtG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAGrC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,iBAAiB,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAGpK,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAGtE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAG3D,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGpC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAG3C,YAAY,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAGlG,YAAY,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAGtG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,YAAY,EAAE,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGrF,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -7,3 +7,5 @@ export { getNextCounter } from './counter.js';
 export { getTrashItem, listTrash, moveToTrash, permanentDelete, restoreFromTrash } from './trash.js';
 export { moveToTrashWithAuth, permanentDeleteWithAuth, restoreFromTrashWithAuth } from './auth-trash.js';
 export { logger } from './logger.js';
+export { createScriptContext, initFirebaseAdmin, scriptLog } from './script-helpers.js';
+export { runImportTemplates } from './import-templates.js';

package/dist/script-helpers.d.ts

@@ -0,0 +1,35 @@
+import { Firestore } from 'firebase-admin/firestore';
+export type LogType = "info" | "success" | "error" | "warn";
+/**
+ * Print a prefixed log message to console.
+ */
+export declare function scriptLog(message: string, type?: LogType): void;
+/**
+ * Initialize Firebase Admin SDK if not already initialized.
+ */
+export declare function initFirebaseAdmin(serviceAccountPath: string): void;
+export interface ScriptContextConfig {
+    /** Script title shown in console header */
+    title: string;
+    /** Path to serviceAccountKey.json */
+    serviceAccountPath: string;
+    /** Optional Firestore named database */
+    databaseId?: string;
+    /** Dry-run mode (default: false) */
+    dryRun?: boolean;
+}
+export interface ScriptContext {
+    /** Firestore instance (cached via getDb) */
+    db: Firestore;
+    /** Whether dry-run mode is active */
+    dryRun: boolean;
+}
+/**
+ * Set up a script context: validates paths, initializes Firebase,
+ * returns a ready-to-use Firestore instance.
+ *
+ * Prints title, connection info, and dry-run banner.
+ * Calls `process.exit(1)` if the service account key is missing.
+ */
+export declare function createScriptContext(config: ScriptContextConfig): ScriptContext;
+//# sourceMappingURL=script-helpers.d.ts.map

package/dist/script-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"script-helpers.d.ts","sourceRoot":"","sources":["../src/script-helpers.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAQ1D,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,CAAC;AAS5D;;GAEG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,OAAgB,GAAG,IAAI,CAEvE;AAMD;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CASlE;AAMD,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,4CAA4C;IAC5C,EAAE,EAAE,SAAS,CAAC;IACd,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,mBAAmB,GAAG,aAAa,CA6B9E"}

package/dist/script-helpers.js

@@ -0,0 +1,48 @@
+import { getApps, initializeApp, cert } from 'firebase-admin/app';
+import { readFileSync, existsSync } from 'fs';
+import { getDb } from './firestore.js';
+
+const LOG_PREFIX = {
+  info: "i ",
+  success: "OK",
+  error: "X ",
+  warn: "! "
+};
+function scriptLog(message, type = "info") {
+  console.log(`${LOG_PREFIX[type]} ${message}`);
+}
+function initFirebaseAdmin(serviceAccountPath) {
+  if (getApps().length > 0) return;
+  const serviceAccount = JSON.parse(readFileSync(serviceAccountPath, "utf-8"));
+  initializeApp({
+    credential: cert(serviceAccount),
+    databaseURL: `https://${serviceAccount.projectId}.firebaseio.com`
+  });
+}
+function createScriptContext(config) {
+  const { title, serviceAccountPath, databaseId, dryRun = false } = config;
+  console.log(`
+${title}
+`);
+  console.log("-".repeat(50));
+  if (!existsSync(serviceAccountPath)) {
+    scriptLog("Service Account Key not found!", "error");
+    console.log(`
+   Expected: ${serviceAccountPath}`);
+    console.log(`
+   Download from Firebase Console:`);
+    console.log(`   Project Settings > Service Accounts > Generate new private key
+`);
+    process.exit(1);
+  }
+  initFirebaseAdmin(serviceAccountPath);
+  const db = getDb(databaseId);
+  scriptLog(`Firestore: ${databaseId ?? "(default)"}`);
+  if (dryRun) {
+    scriptLog("DRY RUN - No changes will be made", "warn");
+  }
+  console.log("-".repeat(50));
+  return { db, dryRun };
+}
+
+export { createScriptContext, initFirebaseAdmin, scriptLog };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progressive-development/pd-provider-firebase-functions",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "Firebase Functions v2 utilities for pd-spa-helper backend",
   "author": "PD Progressive Development",
   "license": "SEE LICENSE IN LICENSE",