@entrinsik/vite-plugin-informer 1.0.0 → 1.0.2

package/bin/deploy.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import dotenv from 'dotenv';
-import { readFile } from 'node:fs/promises';
+import { readFile, writeFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { deploy } from '../src/deploy.js';
 
@@ -24,33 +24,58 @@ if (!baseUrl || (!apiKey && (!user || !pass))) {
 }
 
 // Read project metadata from package.json
-let slug;
+const pkgPath = resolve('package.json');
+let pkg;
 let displayName;
 let description;
+let savedId;
+
 try {
-    const pkg = JSON.parse(await readFile(resolve('package.json'), 'utf8'));
-    slug = pkg.name;
-    // Strip scope prefix if present (e.g. @org/my-report -> my-report)
-    if (slug && slug.startsWith('@') && slug.includes('/')) {
-        slug = slug.split('/')[1];
-    }
-    // Read display name and description from informer config section
+    pkg = JSON.parse(await readFile(pkgPath, 'utf8'));
+
+    // Read display name, description, and saved ID from informer config section
     displayName = pkg.informer?.name;
     description = pkg.informer?.description;
+    savedId = pkg.informer?.id;
 } catch {
     console.error('Could not read package.json in current directory.');
     process.exit(1);
 }
 
-if (!slug) {
-    console.error('package.json must have a "name" field.');
+if (!displayName) {
+    // Fall back to package name for display
+    displayName = pkg.name;
+    if (displayName && displayName.startsWith('@') && displayName.includes('/')) {
+        displayName = displayName.split('/')[1];
+    }
+}
+
+if (!displayName) {
+    console.error('package.json must have an "informer.name" or "name" field.');
     process.exit(1);
 }
 
 const distDir = resolve('dist');
 
 try {
-    await deploy({ baseUrl, apiKey, user, pass, slug, distDir, name: displayName, description });
+    const result = await deploy({
+        baseUrl,
+        apiKey,
+        user,
+        pass,
+        distDir,
+        name: displayName,
+        description,
+        id: savedId
+    });
+
+    // Save the report ID back to package.json for future deploys
+    if (result.id && result.id !== savedId) {
+        if (!pkg.informer) pkg.informer = {};
+        pkg.informer.id = result.id;
+        await writeFile(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
+        console.log(`Saved report ID "${result.id}" to package.json`);
+    }
 } catch (err) {
     console.error('Deploy failed:', err.message);
     process.exit(1);

package/bin/init.js

@@ -4,6 +4,7 @@ import { readFile, writeFile, mkdir, cp, access, readdir } from 'node:fs/promise
 import { resolve, dirname, join, basename } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { createInterface } from 'node:readline';
+import { randomUUID } from 'node:crypto';
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const cwd = process.cwd();
@@ -176,27 +177,17 @@ function prompt(question, defaultValue) {
 }
 
 /**
- * Convert slug to friendly name.
+ * Convert package name to friendly display name.
  * "magic-quickbooks-report" -> "Magic Quickbooks Report"
+ * "@org/my-report" -> "My Report"
  */
-function slugToName(slug) {
-    return slug
+function packageNameToDisplayName(name) {
+    return name
         .replace(/^@[^/]+\//, '') // Remove scope
         .replace(/[-_]/g, ' ')
         .replace(/\b\w/g, c => c.toUpperCase());
 }
 
-/**
- * Convert name to slug.
- * "Magic Quickbooks Report" -> "magic-quickbooks-report"
- */
-function nameToSlug(name) {
-    return name
-        .toLowerCase()
-        .replace(/[^a-z0-9]+/g, '-')
-        .replace(/^-|-$/g, '');
-}
-
 async function init() {
     console.log('Initializing Informer Magic Report project...\n');
 
@@ -219,24 +210,21 @@ async function init() {
     }
 
     // 3. Get report info from user
-    const defaultSlug = (pkg.name || basename(cwd)).replace(/^@[^/]+\//, '');
-    const existingName = pkg.informer?.name;
-    const defaultName = existingName || slugToName(defaultSlug);
+    const defaultName = pkg.informer?.name || packageNameToDisplayName(pkg.name || basename(cwd));
 
     console.log('Configure your Magic Report:\n');
 
     const reportName = await prompt('Report name', defaultName);
-    const reportSlug = await prompt('Report slug', nameToSlug(reportName) || defaultSlug);
 
     console.log('');
 
     // 4. Update package.json
     if (!pkg.informer) pkg.informer = {};
     pkg.informer.name = reportName;
-
-    // Update package name to match slug if it was the default
-    if (pkg.name === defaultSlug || !pkg.name) {
-        pkg.name = reportSlug;
+    // Generate a stable UUID for this report
+    if (!pkg.informer.id) {
+        pkg.informer.id = randomUUID();
+        console.log(`Generated report ID: ${pkg.informer.id}`);
     }
 
     // 5. Add plugin to dependencies if not present
@@ -254,7 +242,7 @@ async function init() {
     }
 
     await writeFile(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
-    console.log(`Configured report: "${reportName}" (slug: ${reportSlug})`);
+    console.log(`Updated package.json with informer.name="${reportName}"`);
 
     // 7. Update vite.config
     await updateViteConfig();
@@ -269,9 +257,6 @@ INFORMER_API_KEY=your-api-key
 # Option 2: Basic auth
 # INFORMER_USER=admin
 # INFORMER_PASS=yourpassword
-
-# Optional: defaults to current user
-# INFORMER_OWNER=admin
 `;
 
     const envExamplePath = resolve(cwd, '.env.example');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@entrinsik/vite-plugin-informer",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Vite plugin and publish tool for local Magic Report development",
   "type": "module",
   "main": "./src/index.js",
@@ -10,7 +10,8 @@
   },
   "bin": {
     "informer-deploy": "./bin/deploy.js",
-    "informer-init": "./bin/init.js"
+    "informer-init": "./bin/init.js",
+    "create-magic-report": "./bin/init.js"
   },
   "files": [
     "src",

package/src/deploy.js

@@ -16,38 +16,51 @@ const ROOT_CONFIG_FILES = ['data-access.yaml'];
 /**
  * Deploy a built Vite project to Informer as a Magic Report.
  *
- * @param {{ baseUrl: string, apiKey?: string, user?: string, pass?: string, slug: string, distDir: string, name?: string, description?: string }} opts
+ * @param {{ baseUrl: string, apiKey?: string, user?: string, pass?: string, distDir: string, name: string, description?: string, id?: string }} opts
+ * @returns {Promise<{ id: string, url: string }>} The report's natural ID and URL
  */
-export async function deploy({ baseUrl, apiKey, user, pass, slug, distDir, name, description }) {
+export async function deploy({ baseUrl, apiKey, user, pass, distDir, name, description, id }) {
     const api = createClient({ baseUrl, apiKey, user, pass });
 
-    // 1. Get current user for natural ID
-    const me = await api.get('me');
-    const naturalId = `${me.username}:${slug}`;
+    let report = null;
+    let naturalId = null;
 
-    // 2. Lookup report by natural ID
-    let report = await api.get(`reports/${naturalId}`);
+    // 1. If we have a saved ID, try to look it up
+    if (id) {
+        console.log(`Looking up report "${id}"...`);
+        report = await api.get(`reports/${id}`);
+        if (report) {
+            naturalId = report.naturalId || id;
+            console.log(`Found existing report: ${naturalId}`);
+        } else {
+            console.log(`Report "${id}" not found, will create new...`);
+        }
+    }
 
-    // 3. Create if not found
+    // 2. Create if not found (or no ID was provided)
     if (!report) {
-        console.log(`Report "${naturalId}" not found, creating...`);
-        await api.post('reports', {
+        console.log(`Creating new report "${name}"...`);
+        const payload = {
             type: 'magicReport',
-            name: name || slug,
+            name: name,
             description: description || ''
-        });
-        // Re-fetch to get the full report
-        report = await api.get(`reports/${naturalId}`);
-        if (!report) {
-            throw new Error(`Failed to create report "${naturalId}"`);
+        };
+        // If we have a saved ID (UUID), use it for the new report
+        if (id) {
+            payload.id = id;
         }
-        console.log(`Created report: ${report.id}`);
+        report = await api.post('reports', payload);
+        if (!report || !report.id) {
+            throw new Error(`Failed to create report "${name}"`);
+        }
+        naturalId = report.naturalId || `${report.ownerId}:${report.slug}`;
+        console.log(`Created report: ${naturalId}`);
     }
 
-    // 4. Update name/description if provided
+    // 3. Update name/description if provided (for existing reports)
     const updates = {};
-    if (name) updates.name = name;
-    if (description !== undefined) updates.description = description;
+    if (name && report.name !== name) updates.name = name;
+    if (description !== undefined && report.description !== description) updates.description = description;
     if (Object.keys(updates).length > 0) {
         await api.put(`reports/${naturalId}`, updates);
     }
@@ -125,10 +138,13 @@ export async function deploy({ baseUrl, apiKey, user, pass, slug, distDir, name,
         }
     }
 
-    // 9. Print report URL
+    // 9. Print report URL and return UUID for saving
     const totalFiles = entries.length + configCount;
     const reportUrl = `${baseUrl.replace(/\/+$/, '')}/reports/r/${naturalId}`;
     console.log(`\nPublished ${totalFiles} files to: ${reportUrl}`);
+
+    // Return the stable UUID (not natural ID) for package.json storage
+    return { id: report.id, url: reportUrl };
 }
 
 /**