@salesforce/webapps-features-experimental 1.68.0

package/dist/types.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import type { Logger } from "./logger.js";
+/**
+ * Schema structure from features.json files
+ */
+export interface FileCopySchema {
+    /** Other features that must be installed first */
+    featureDependencies?: string[];
+    /** npm packages to add to dependencies */
+    packageDependencies?: Record<string, string>;
+    /** npm packages to add to devDependencies */
+    packageDevDependencies?: Record<string, string>;
+    /** File/directory copy operations */
+    copy?: CopyOperation[];
+}
+/**
+ * A single copy operation
+ */
+export interface CopyOperation {
+    /** Source path relative to package's dist/ directory */
+    from: string;
+    /** Destination path (may contain <webapp> placeholder) */
+    to: string;
+    /** Optional description of what this copies */
+    description?: string;
+    /** For __example__ files: the target file where patterns should be integrated */
+    integrationTarget?: string;
+}
+/**
+ * Conflict handling mode
+ */
+export type ConflictMode = "prompt" | "error" | "skip" | "overwrite";
+/**
+ * User's choice for handling a specific conflict
+ */
+export type ConflictResolution = "skip" | "overwrite" | "cancel";
+/**
+ * Map of file paths to conflict resolutions
+ */
+export type ConflictResolutionMap = Record<string, ConflictResolution>;
+/**
+ * Shared context for installation operations
+ */
+export interface InstallationContext {
+    /** SFDX metadata root directory (e.g., force-app/main/default) */
+    sfdxRoot: string;
+    /** Specific webapp directory (e.g., force-app/main/default/webapplications/mywebapp) */
+    webappDir: string;
+    /** Webapp name extracted from webappDir (e.g., "mywebapp") */
+    webappName: string;
+    /** Enable verbose logging */
+    verbose: boolean;
+    /** Dry run mode - show what would be done without changes */
+    dryRun: boolean;
+    /** Conflict handling mode */
+    conflictMode: ConflictMode;
+    /** Conflict resolution map (from file or interactive prompts) */
+    conflictResolutions: ConflictResolutionMap;
+    /** Track installed features to prevent duplicates */
+    installedFeatures: Set<string>;
+    /** Track all copied example files with their integration targets */
+    copiedExampleFiles: {
+        file: string;
+        integrationTarget?: string;
+    }[];
+    /** Logger instance (verbose-aware) */
+    logger: Logger;
+}
+/**
+ * Feature registry entry
+ */
+export interface FeatureDefinition {
+    /** Display name for the feature */
+    name: string;
+    /** npm package name */
+    package: string;
+    /** Optional description */
+    description?: string;
+}
+/**
+ * Feature registry mapping feature names to packages
+ */
+export type FeatureRegistry = Record<string, string>;
+/**
+ * Detailed feature metadata
+ */
+export interface FeatureMetadata {
+    /** Display name */
+    name: string;
+    /** npm package name */
+    package: string;
+    /** Short description (1-2 sentences) */
+    shortDescription: string;
+    /** Long description (detailed explanation) */
+    longDescription: string;
+    /** Search keywords */
+    keywords: string[];
+    /** Feature dependencies */
+    featureDependencies?: string[];
+    /** Package dependencies */
+    packageDependencies?: Record<string, string>;
+    /** Package dev dependencies */
+    packageDevDependencies?: Record<string, string>;
+    /** Copy operations (includes __example__ files with integrationTarget) */
+    copy?: CopyOperation[];
+    /** List of feature capabilities */
+    features?: string[];
+    /** List of included components */
+    components?: string[];
+    /** Status (for features pending schema implementation) */
+    status?: "schema-pending" | "ready";
+}
+/**
+ * Features metadata collection
+ */
+export interface FeaturesMetadata {
+    features: Record<string, FeatureMetadata>;
+}
+/**
+ * Search result with scoring information
+ */
+export interface SearchResult {
+    /** The feature that matched the search */
+    feature: FeatureMetadata;
+    /** Relevance score (higher = more relevant) */
+    score: number;
+    /** Fields that matched the search terms (for debugging) */
+    matchedFields: string[];
+}
+/**
+ * CLI options
+ */
+export interface CliOptions {
+    sfdxRoot?: string;
+    webappDir?: string;
+    verbose?: boolean;
+    dryRun?: boolean;
+    yes?: boolean;
+    onConflict?: ConflictMode;
+    conflictResolution?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B,0CAA0C;IAC1C,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE7C,6CAA6C;IAC7C,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhD,qCAAqC;IACrC,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IAEb,0DAA0D;IAC1D,EAAE,EAAE,MAAM,CAAC;IAEX,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iFAAiF;IACjF,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IAEjB,wFAAwF;IACxF,SAAS,EAAE,MAAM,CAAC;IAElB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC;IAEnB,6BAA6B;IAC7B,OAAO,EAAE,OAAO,CAAC;IAEjB,6DAA6D;IAC7D,MAAM,EAAE,OAAO,CAAC;IAEhB,6BAA6B;IAC7B,YAAY,EAAE,YAAY,CAAC;IAE3B,iEAAiE;IACjE,mBAAmB,EAAE,qBAAqB,CAAC;IAE3C,qDAAqD;IACrD,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAE/B,oEAAoE;IACpE,kBAAkB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAEnE,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IACjC,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAEhB,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,CAAC;IAEzB,8CAA8C;IAC9C,eAAe,EAAE,MAAM,CAAC;IAExB,sBAAsB;IACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB,2BAA2B;IAC3B,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B,2BAA2B;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE7C,+BAA+B;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhD,0EAA0E;IAC1E,IAAI,CAAC,EAAE,aAAa,EAAE,CAAC;IAEvB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,0CAA0C;IAC1C,OAAO,EAAE,eAAe,CAAC;IAEzB,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;IAEd,2DAA2D;IAC3D,aAAa,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B"}

package/dist/types.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/utils.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+/**
+ * Check if a path exists
+ */
+export declare function pathExists(path: string): boolean;
+/**
+ * Resolve an absolute path from a potentially relative path
+ */
+export declare function resolvePath(path: string, base?: string): string;
+/**
+ * Extract webapp name from webapp directory path
+ */
+export declare function extractWebappName(webappDir: string): string;
+/**
+ * Check if a path points to SFDX metadata (Apex classes, objects, etc.)
+ */
+export declare function isSfdxMetadataPath(path: string): boolean;
+/**
+ * Check if a path contains the webapp placeholder
+ */
+export declare function hasWebappPlaceholder(path: string): boolean;
+/**
+ * Normalize path separators to forward slashes
+ */
+export declare function normalizePath(path: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAK/D;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAE3D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAcxD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD"}

package/dist/utils.js

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2026, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+import { existsSync } from "fs";
+import { basename, resolve } from "path";
+/**
+ * Check if a path exists
+ */
+export function pathExists(path) {
+    return existsSync(path);
+}
+/**
+ * Resolve an absolute path from a potentially relative path
+ */
+export function resolvePath(path, base) {
+    if (base) {
+        return resolve(base, path);
+    }
+    return resolve(path);
+}
+/**
+ * Extract webapp name from webapp directory path
+ */
+export function extractWebappName(webappDir) {
+    return basename(webappDir);
+}
+/**
+ * Check if a path points to SFDX metadata (Apex classes, objects, etc.)
+ */
+export function isSfdxMetadataPath(path) {
+    const sfdxPatterns = [
+        "force-app/main/default/classes",
+        "force-app/main/default/objects",
+        "force-app/main/default/triggers",
+        "force-app/main/default/lwc",
+        "force-app/main/default/aura",
+        "force-app/main/default/staticresources",
+        "force-app/main/default/layouts",
+        "force-app/main/default/permissionsets",
+        "force-app/main/default/profiles",
+    ];
+    return sfdxPatterns.some((pattern) => path.startsWith(pattern));
+}
+/**
+ * Check if a path contains the webapp placeholder
+ */
+export function hasWebappPlaceholder(path) {
+    return path.includes("<webapp>");
+}
+/**
+ * Normalize path separators to forward slashes
+ */
+export function normalizePath(path) {
+    return path.replace(/\\/g, "/");
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEzC;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY;IACtC,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,IAAa;IACtD,IAAI,IAAI,EAAE,CAAC;QACV,OAAO,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,SAAiB;IAClD,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC9C,MAAM,YAAY,GAAG;QACpB,gCAAgC;QAChC,gCAAgC;QAChC,iCAAiC;QACjC,4BAA4B;QAC5B,6BAA6B;QAC7B,wCAAwC;QACxC,gCAAgC;QAChC,uCAAuC;QACvC,iCAAiC;KACjC,CAAC;IAEF,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY;IACzC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACjC,CAAC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@salesforce/webapps-features-experimental",
+  "version": "1.68.0",
+  "description": "CLI tool for searching and installing UI features into Salesforce webapps",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "type": "module",
+  "main": "./dist/install-feature.js",
+  "bin": {
+    "webapps-features-experimental": "./dist/install-feature.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc --build && cp src/features.json dist/features.json",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "dev": "tsx src/install-feature.ts",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:unit": "vitest run unit",
+    "test:e2e": "vitest run e2e",
+    "test:coverage": "vitest run --coverage"
+  },
+  "keywords": [
+    "salesforce",
+    "ui",
+    "features",
+    "cli",
+    "installer"
+  ],
+  "dependencies": {
+    "commander": "^13.0.0",
+    "inquirer": "^12.0.0",
+    "ora": "^9.3.0",
+    "zod": "^3.24.1"
+  },
+  "devDependencies": {
+    "@types/inquirer": "^9.0.9",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^4.0.17",
+    "tsx": "^4.19.2",
+    "typescript": "~5.9.3",
+    "vitest": "^4.0.17"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}