@schandlergarcia/sf-web-components 1.9.31 → 1.9.33

package/README.md

@@ -68,6 +68,21 @@ This library includes:
 - Filter components
 - Layout components
 
+## Sample Data
+
+The package includes pre-seeded sample data in the `data/` directory:
+- **Engine Travel Command Center** sample data with real Salesforce field names
+- Dashboard-ready data (map markers, chart data, metrics, etc.)
+- Easy to swap for live data later
+
+**Copy to your project:**
+```bash
+# From your webapp directory
+cp node_modules/@schandlergarcia/sf-web-components/data/engine-sample-data.js src/data/
+```
+
+See `data/README.md` and `data/USAGE.md` in the package for full documentation.
+
 ## Utilities
 
 ```tsx

package/data/USAGE.md

@@ -0,0 +1,81 @@
+# Using Sample Data from the Package
+
+When you install `@schandlergarcia/sf-web-components`, the sample data is included in the package.
+
+## Quick Copy Command
+
+From your webapp directory:
+
+```bash
+# Copy sample data to your webapp's src/data directory
+cp node_modules/@schandlergarcia/sf-web-components/data/engine-sample-data.js src/data/
+
+# Or use the included copy script
+bash node_modules/@schandlergarcia/sf-web-components/data/copy-to-webapp.sh .
+```
+
+## Manual Copy
+
+```bash
+# Create data directory if it doesn't exist
+mkdir -p src/data
+
+# Copy the sample data file
+cp node_modules/@schandlergarcia/sf-web-components/data/engine-sample-data.js src/data/
+```
+
+## Import in Your Components
+
+Once copied to `src/data/`, import the data:
+
+```javascript
+import {
+  MAP_MARKERS,
+  MAP_ARCS,
+  MAP_OVERLAYS,
+  FLIGHT_STATUS_LIST,
+  TRAVELER_CARDS,
+  DISRUPTION_CARDS,
+  EVA_ACTIONS,
+  BOOKING_ROWS,
+  POLICY_ITEMS,
+  DESTINATION_CHART_DATA,
+  SPEND_CHART_DATA,
+  METRICS,
+} from '@/data/engine-sample-data';
+
+// Use in components
+<GeoMap markers={MAP_MARKERS} arcs={MAP_ARCS} overlays={MAP_OVERLAYS} />
+```
+
+## What's Included
+
+See the [README.md](./README.md) for full documentation of available data exports.
+
+**Raw Salesforce records:**
+- AIRPORTS, TRAVELERS, TRIPS, FLIGHTS, HOTELS, DISRUPTIONS, BOOKINGS, etc.
+
+**Dashboard-ready derivatives:**
+- MAP_MARKERS, MAP_ARCS, FLIGHT_STATUS_LIST, TRAVELER_CARDS, etc.
+
+All data uses real Salesforce API field names, making it easy to swap for live data later.
+
+## Why Copy Instead of Import Directly?
+
+The data file is intentionally designed to be copied to your `src/` directory rather than imported directly from `node_modules` because:
+
+1. **Customization** - You can modify the sample data to match your specific use case
+2. **Version control** - Your data lives in your repo, not tied to package updates
+3. **Build optimization** - Some bundlers work better with files in `src/`
+4. **Switching to live data** - When ready, you replace the file with live queries
+
+## Switching to Live Data
+
+When you're ready to use live Salesforce data:
+
+1. Create a new file `src/data/live-data.js`
+2. Query the Salesforce objects (Trip__c, Flight__c, etc.) using GraphQL
+3. Transform the results to match the same shape as the sample data
+4. Update your imports from `engine-sample-data` to `live-data`
+
+Your components don't need to change - just the data source!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schandlergarcia/sf-web-components",
-  "version": "1.9.31",
+  "version": "1.9.33",
   "description": "Reusable Salesforce web components library with Tailwind CSS v4 and shadcn/ui",
   "type": "module",
   "main": "./dist/index.js",

package/scripts/postinstall.mjs

@@ -0,0 +1,116 @@
+#!/usr/bin/env node
+
+/**
+ * Post-install script for @schandlergarcia/sf-web-components
+ *
+ * Automatically copies sample data to the consuming project's src/data directory
+ */
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+// Get the package root (one level up from scripts/)
+const PACKAGE_ROOT = path.resolve(__dirname, '..');
+
+// Get the project root (where the consuming project installed this package)
+// Go up from node_modules/@schandlergarcia/sf-web-components
+const PROJECT_ROOT = path.resolve(PACKAGE_ROOT, '../../..');
+
+console.log('\n📦 @schandlergarcia/sf-web-components post-install');
+
+// Check if we're in a node_modules context (not during package development)
+if (!PACKAGE_ROOT.includes('node_modules')) {
+  console.log('  ℹ️  Running in development mode, skipping data copy');
+  process.exit(0);
+}
+
+// Find src/data directory in the consuming project
+const possiblePaths = [
+  path.join(PROJECT_ROOT, 'src/data'),
+  path.join(PROJECT_ROOT, 'force-app/main/default/webapplications/src/data'),
+];
+
+// Try to find an existing src directory
+let targetDir = null;
+for (const p of possiblePaths) {
+  const srcDir = path.dirname(p); // Get src directory
+  if (fs.existsSync(srcDir)) {
+    targetDir = p;
+    break;
+  }
+}
+
+// If no src directory found, look for any webapp with src/
+const webappPattern = /force-app\/main\/default\/webapplications\/[^/]+$/;
+if (!targetDir) {
+  try {
+    const webappRoot = path.join(PROJECT_ROOT, 'force-app/main/default/webapplications');
+    if (fs.existsSync(webappRoot)) {
+      const webapps = fs.readdirSync(webappRoot, { withFileTypes: true });
+      for (const webapp of webapps) {
+        if (webapp.isDirectory()) {
+          const srcDir = path.join(webappRoot, webapp.name, 'src');
+          if (fs.existsSync(srcDir)) {
+            targetDir = path.join(srcDir, 'data');
+            break;
+          }
+        }
+      }
+    }
+  } catch (err) {
+    // Ignore errors
+  }
+}
+
+if (!targetDir) {
+  console.log('  ⚠️  Could not find src/ directory in project');
+  console.log('  ℹ️  To manually copy sample data, run:');
+  console.log('');
+  console.log('      mkdir -p src/data');
+  console.log('      cp node_modules/@schandlergarcia/sf-web-components/data/engine-sample-data.js src/data/');
+  console.log('');
+  process.exit(0);
+}
+
+// Create target directory if it doesn't exist
+try {
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+} catch (err) {
+  console.error('  ❌ Failed to create data directory:', err.message);
+  process.exit(0); // Don't fail the install
+}
+
+// Copy sample data file
+const sourceFile = path.join(PACKAGE_ROOT, 'data/engine-sample-data.js');
+const targetFile = path.join(targetDir, 'engine-sample-data.js');
+
+try {
+  // Only copy if target doesn't exist (don't overwrite user's modifications)
+  if (!fs.existsSync(targetFile)) {
+    fs.copyFileSync(sourceFile, targetFile);
+    console.log('  ✅ Sample data copied to:', path.relative(PROJECT_ROOT, targetFile));
+    console.log('');
+    console.log('  Import in your components:');
+    console.log('');
+    console.log("    import { MAP_MARKERS, METRICS } from '@/data/engine-sample-data';");
+    console.log('');
+  } else {
+    console.log('  ℹ️  Sample data already exists (not overwriting)');
+    console.log('  📁', path.relative(PROJECT_ROOT, targetFile));
+    console.log('');
+  }
+} catch (err) {
+  console.error('  ⚠️  Could not copy sample data:', err.message);
+  console.log('  ℹ️  To manually copy, run:');
+  console.log('');
+  console.log('      cp node_modules/@schandlergarcia/sf-web-components/data/engine-sample-data.js src/data/');
+  console.log('');
+}
+
+process.exit(0);