@salesforce/plugin-lightning-dev 1.0.26-alpha.0

package/lib/commands/lightning/dev/site.js

@@ -0,0 +1,77 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import fs from 'node:fs';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { expDev } from '@lwrjs/api';
+import { PromptUtils } from '../../../shared/prompt.js';
+import { ExperienceSite } from '../../../shared/experience/expSite.js';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.site');
+export default class LightningDevSite extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        name: Flags.string({
+            summary: messages.getMessage('flags.name.summary'),
+            char: 'n',
+            required: false,
+        }),
+        debug: Flags.boolean({
+            summary: messages.getMessage('flags.debug.summary'),
+        }),
+        'target-org': Flags.optionalOrg({ summary: messages.getMessage('flags.target-org.summary') }),
+    };
+    async run() {
+        const { flags } = await this.parse(LightningDevSite);
+        try {
+            const org = flags['target-org'];
+            let siteName = flags.name;
+            // If user doesn't specify a site, prompt the user for one
+            if (!siteName) {
+                const allSites = await ExperienceSite.getAllExpSites(org);
+                siteName = await PromptUtils.promptUserToSelectSite(allSites);
+            }
+            const selectedSite = new ExperienceSite(org, siteName);
+            let siteZip;
+            if (!selectedSite.isSiteSetup()) {
+                this.log(`[local-dev] initializing: ${siteName}`);
+                siteZip = await selectedSite.downloadSite();
+            }
+            else {
+                // If local-dev is already setup, check if an updated site has been published to download
+                const updateAvailable = await selectedSite.isUpdateAvailable();
+                if (updateAvailable) {
+                    const shouldUpdate = await PromptUtils.promptUserToConfirmUpdate(siteName);
+                    if (shouldUpdate) {
+                        this.log(`[local-dev] updating: ${siteName}`);
+                        siteZip = await selectedSite.downloadSite();
+                        // delete oldSitePath recursive
+                        const oldSitePath = selectedSite.getExtractDirectory();
+                        if (fs.existsSync(oldSitePath)) {
+                            fs.rmdirSync(oldSitePath, { recursive: true });
+                        }
+                    }
+                }
+            }
+            // Start the dev server
+            await expDev({
+                open: true,
+                port: 3000,
+                logLevel: 'error',
+                mode: 'dev',
+                siteZip,
+                siteDir: selectedSite.getSiteDirectory(),
+            });
+        }
+        catch (e) {
+            this.log('Local Development setup failed', e);
+        }
+    }
+}
+//# sourceMappingURL=site.js.map

package/lib/commands/lightning/dev/site.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site.js","sourceRoot":"","sources":["../../../../src/commands/lightning/dev/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAEvE,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,kCAAkC,EAAE,oBAAoB,CAAC,CAAC;AAEjG,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,SAAe;IACpD,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC;YACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC;SACpD,CAAC;QACF,YAAY,EAAE,KAAK,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE,CAAC;KAC9F,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QAErD,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;YAChC,IAAI,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC;YAE1B,0DAA0D;YAC1D,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;gBAC1D,QAAQ,GAAG,MAAM,WAAW,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;YAChE,CAAC;YAED,MAAM,YAAY,GAAG,IAAI,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACvD,IAAI,OAA2B,CAAC;YAEhC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,GAAG,CAAC,6BAA6B,QAAQ,EAAE,CAAC,CAAC;gBAClD,OAAO,GAAG,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC;YAC9C,CAAC;iBAAM,CAAC;gBACN,yFAAyF;gBACzF,MAAM,eAAe,GAAG,MAAM,YAAY,CAAC,iBAAiB,EAAE,CAAC;gBAC/D,IAAI,eAAe,EAAE,CAAC;oBACpB,MAAM,YAAY,GAAG,MAAM,WAAW,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;oBAC3E,IAAI,YAAY,EAAE,CAAC;wBACjB,IAAI,CAAC,GAAG,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAC;wBAC9C,OAAO,GAAG,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC;wBAC5C,+BAA+B;wBAC/B,MAAM,WAAW,GAAG,YAAY,CAAC,mBAAmB,EAAE,CAAC;wBACvD,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/B,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;wBACjD,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YAED,uBAAuB;YACvB,MAAM,MAAM,CAAC;gBACX,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,IAAI;gBACV,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,KAAK;gBACX,OAAO;gBACP,OAAO,EAAE,YAAY,CAAC,gBAAgB,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,gCAAgC,EAAE,CAAC,CAAC,CAAC;QAChD,CAAC;IACH,CAAC"}

package/lib/configMeta.d.ts

@@ -0,0 +1,28 @@
+import { ConfigPropertyMeta } from '@salesforce/core';
+export type SerializedSSLCertificateData = {
+    derCertificate: string;
+    pemCertificate: string;
+    pemPrivateKey: string;
+    pemPublicKey: string;
+};
+export declare const enum ConfigVars {
+    /**
+     * The identity data is a data structure that links the local web server's
+     * identity token to the user's configured Salesforce orgs.
+     */
+    LOCAL_WEB_SERVER_IDENTITY_DATA = "local-web-server-identity-data",
+    /**
+     * The SSL certificate data to be used by local dev server
+     */
+    LOCAL_DEV_SERVER_HTTPS_CERT_DATA = "local-dev-server-certificate-data",
+    /**
+     * The port number of the local dev server.
+     */
+    LOCAL_DEV_SERVER_PORT = "local-dev-server-port",
+    /**
+     * The Workspace name of the local dev server.
+     */
+    LOCAL_DEV_SERVER_WORKSPACE = "local-dev-server-workspace"
+}
+declare const _default: ConfigPropertyMeta[];
+export default _default;

package/lib/configMeta.js

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { Workspace } from '@lwc/lwc-dev-server';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'shared.utils');
+const IDENTITY_DATA_DESC = messages.getMessage('config-utils.data-desc');
+const LOCAL_DEV_SERVER_CERT_DESC = messages.getMessage('config-utils.cert-desc');
+const LOCAL_DEV_SERVER_CERT_ERROR_MESSAGE = messages.getMessage('config-utils.cert-error-message');
+const LOCAL_DEV_SERVER_PORT_DESC = messages.getMessage('config-utils.port-desc');
+const LOCAL_DEV_SERVER_PORT_ERROR_MESSAGE = messages.getMessage('config-utils.port-error-message');
+const LOCAL_DEV_SERVER_WORKSPACE_DESC = messages.getMessage('config-utils.workspace-desc');
+const LOCAL_DEV_SERVER_WORKSPACE_ERROR_MESSAGE = messages.getMessage('config-utils.workspace-error-message');
+export default [
+    {
+        key: "local-web-server-identity-data" /* ConfigVars.LOCAL_WEB_SERVER_IDENTITY_DATA */,
+        description: IDENTITY_DATA_DESC,
+        hidden: true,
+        encrypted: true,
+    },
+    {
+        key: "local-dev-server-certificate-data" /* ConfigVars.LOCAL_DEV_SERVER_HTTPS_CERT_DATA */,
+        description: LOCAL_DEV_SERVER_CERT_DESC,
+        input: {
+            validator: (value) => {
+                const data = value;
+                if (!data?.derCertificate || !data?.pemCertificate || !data?.pemPrivateKey) {
+                    return false;
+                }
+                return true;
+            },
+            failedMessage: LOCAL_DEV_SERVER_CERT_ERROR_MESSAGE,
+        },
+    },
+    {
+        key: "local-dev-server-port" /* ConfigVars.LOCAL_DEV_SERVER_PORT */,
+        description: LOCAL_DEV_SERVER_PORT_DESC,
+        input: {
+            validator: (value) => {
+                if (!value) {
+                    return false;
+                }
+                const parsedPort = parseInt(value, 10);
+                if (isNaN(parsedPort) || parsedPort < 1 || parsedPort > 65_535) {
+                    return false;
+                }
+                return true;
+            },
+            failedMessage: LOCAL_DEV_SERVER_PORT_ERROR_MESSAGE,
+        },
+    },
+    {
+        key: "local-dev-server-workspace" /* ConfigVars.LOCAL_DEV_SERVER_WORKSPACE */,
+        description: LOCAL_DEV_SERVER_WORKSPACE_DESC,
+        input: {
+            validator: (value) => {
+                if (!value) {
+                    return false;
+                }
+                const workspace = value;
+                if (workspace === Workspace.SfCli || workspace === Workspace.Mrt) {
+                    return true;
+                }
+                return false;
+            },
+            failedMessage: LOCAL_DEV_SERVER_WORKSPACE_ERROR_MESSAGE,
+        },
+    },
+];
+//# sourceMappingURL=configMeta.js.map

package/lib/configMeta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configMeta.js","sourceRoot":"","sources":["../src/configMeta.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAmC,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE7E,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,kCAAkC,EAAE,cAAc,CAAC,CAAC;AAC3F,MAAM,kBAAkB,GAAG,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;AACzE,MAAM,0BAA0B,GAAG,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;AACjF,MAAM,mCAAmC,GAAG,QAAQ,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;AACnG,MAAM,0BAA0B,GAAG,QAAQ,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;AACjF,MAAM,mCAAmC,GAAG,QAAQ,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;AACnG,MAAM,+BAA+B,GAAG,QAAQ,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;AAC3F,MAAM,wCAAwC,GAAG,QAAQ,CAAC,UAAU,CAAC,sCAAsC,CAAC,CAAC;AAgC7G,eAAe;IACb;QACE,GAAG,kFAA2C;QAC9C,WAAW,EAAE,kBAAkB;QAC/B,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,IAAI;KAChB;IACD;QACE,GAAG,uFAA6C;QAChD,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE;YACL,SAAS,EAAE,CAAC,KAAkB,EAAW,EAAE;gBACzC,MAAM,IAAI,GAAG,KAAqC,CAAC;gBACnD,IAAI,CAAC,IAAI,EAAE,cAAc,IAAI,CAAC,IAAI,EAAE,cAAc,IAAI,CAAC,IAAI,EAAE,aAAa,EAAE,CAAC;oBAC3E,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,OAAO,IAAI,CAAC;YACd,CAAC;YACD,aAAa,EAAE,mCAAmC;SACnD;KACF;IACD;QACE,GAAG,gEAAkC;QACrC,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE;YACL,SAAS,EAAE,CAAC,KAAkB,EAAW,EAAE;gBACzC,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAe,EAAE,EAAE,CAAC,CAAC;gBAEjD,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,MAAM,EAAE,CAAC;oBAC/D,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,aAAa,EAAE,mCAAmC;SACnD;KACF;IACD;QACE,GAAG,0EAAuC;QAC1C,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE;YACL,SAAS,EAAE,CAAC,KAAkB,EAAW,EAAE;gBACzC,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,SAAS,GAAG,KAAkB,CAAC;gBAErC,IAAI,SAAS,KAAK,SAAS,CAAC,KAAK,IAAI,SAAS,KAAK,SAAS,CAAC,GAAG,EAAE,CAAC;oBACjE,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,aAAa,EAAE,wCAAwC;SACxD;KACF;CACsB,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,EAAE,CAAC"}

package/lib/lwc-dev-server/index.d.ts

@@ -0,0 +1,7 @@
+import { LWCServer, Workspace } from '@lwc/lwc-dev-server';
+import { Logger } from '@salesforce/core';
+import { SSLCertificateData } from '@salesforce/lwc-dev-mobile-core';
+export declare function startLWCServer(logger: Logger, rootDir: string, token: string, serverPorts?: {
+    httpPort: number;
+    httpsPort: number;
+}, certData?: SSLCertificateData, workspace?: Workspace): Promise<LWCServer>;

package/lib/lwc-dev-server/index.js

@@ -0,0 +1,102 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { existsSync, lstatSync, readFileSync } from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+import { LogLevel, startLwcDevServer } from '@lwc/lwc-dev-server';
+import { ConfigUtils, LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT, LOCAL_DEV_SERVER_DEFAULT_WORKSPACE, } from '../shared/configUtils.js';
+/**
+ * Map sf cli log level to lwc dev server log level
+ * https://github.com/salesforcecli/cli/wiki/Code-Your-Plugin#logging-levels
+ *
+ * @param cliLogLevel
+ * @returns number
+ */
+function mapLogLevel(cliLogLevel) {
+    switch (cliLogLevel) {
+        case 10:
+            return LogLevel.verbose;
+        case 20:
+            return LogLevel.debug;
+        case 30:
+            return LogLevel.info;
+        case 40:
+            return LogLevel.warn;
+        case 50:
+            return LogLevel.error;
+        case 60:
+            return LogLevel.silent;
+        default:
+            return LogLevel.error;
+    }
+}
+async function createLWCServerConfig(logger, rootDir, token, serverPorts, certData, workspace) {
+    const sfdxConfig = path.resolve(rootDir, 'sfdx-project.json');
+    if (!existsSync(sfdxConfig) || !lstatSync(sfdxConfig).isFile()) {
+        throw new Error(`sfdx-project.json not found in ${rootDir}`);
+    }
+    const sfdxConfigJson = readFileSync(sfdxConfig, 'utf-8');
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const { packageDirectories } = JSON.parse(sfdxConfigJson);
+    const namespacePaths = [];
+    for (const dir of packageDirectories) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        if (dir.path) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-argument
+            const resolvedDir = path.resolve(rootDir, dir.path, 'main', 'default');
+            if (existsSync(resolvedDir) && lstatSync(resolvedDir).isDirectory()) {
+                logger.debug(`Adding ${resolvedDir} to namespace paths`);
+                namespacePaths.push(resolvedDir);
+            }
+            else {
+                logger.warn(`Skipping ${resolvedDir} because it does not exist or is not a directory`);
+            }
+        }
+    }
+    const ports = serverPorts ??
+        (await ConfigUtils.getLocalDevServerPorts()) ?? {
+        httpPort: LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT,
+        httpsPort: LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT + 1,
+    };
+    const serverConfig = {
+        rootDir,
+        // use custom port if any is provided, or fetch from config file (if any), otherwise use the default port
+        port: ports.httpPort,
+        paths: namespacePaths,
+        // use custom workspace if any is provided, or fetch from config file (if any), otherwise use the default workspace
+        workspace: workspace ?? (await ConfigUtils.getLocalDevServerWorkspace()) ?? LOCAL_DEV_SERVER_DEFAULT_WORKSPACE,
+        identityToken: token,
+        logLevel: mapLogLevel(logger.getLevel()),
+    };
+    if (certData?.pemCertificate && certData.pemPrivateKey) {
+        serverConfig.https = {
+            cert: certData.pemCertificate,
+            key: certData.pemPrivateKey,
+            port: ports.httpsPort,
+        };
+    }
+    return serverConfig;
+}
+export async function startLWCServer(logger, rootDir, token, serverPorts, certData, workspace) {
+    const config = await createLWCServerConfig(logger, rootDir, token, serverPorts, certData, workspace);
+    logger.trace(`Starting LWC Dev Server with config: ${JSON.stringify(config)}`);
+    let lwcDevServer = await startLwcDevServer(config);
+    const cleanup = () => {
+        if (lwcDevServer) {
+            logger.trace('Stopping LWC Dev Server');
+            lwcDevServer.stopServer();
+            lwcDevServer = null;
+        }
+    };
+    [
+        'exit', // normal exit flow
+        'SIGINT', // when a user presses ctrl+c
+        'SIGTERM', // when a user kills the process
+    ].forEach((signal) => process.on(signal, cleanup));
+    return lwcDevServer;
+}
+//# sourceMappingURL=index.js.map

package/lib/lwc-dev-server/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lwc-dev-server/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAa,QAAQ,EAAgB,iBAAiB,EAAa,MAAM,qBAAqB,CAAC;AAGtG,OAAO,EACL,WAAW,EACX,kCAAkC,EAClC,kCAAkC,GACnC,MAAM,0BAA0B,CAAC;AAElC;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,WAAmB;IACtC,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,EAAE;YACL,OAAO,QAAQ,CAAC,OAAO,CAAC;QAC1B,KAAK,EAAE;YACL,OAAO,QAAQ,CAAC,KAAK,CAAC;QACxB,KAAK,EAAE;YACL,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,KAAK,EAAE;YACL,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,KAAK,EAAE;YACL,OAAO,QAAQ,CAAC,KAAK,CAAC;QACxB,KAAK,EAAE;YACL,OAAO,QAAQ,CAAC,MAAM,CAAC;QACzB;YACE,OAAO,QAAQ,CAAC,KAAK,CAAC;IAC1B,CAAC;AACH,CAAC;AAED,KAAK,UAAU,qBAAqB,CAClC,MAAc,EACd,OAAe,EACf,KAAa,EACb,WAAqD,EACrD,QAA6B,EAC7B,SAAqB;IAErB,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IAE9D,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,kCAAkC,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,cAAc,GAAG,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACzD,mEAAmE;IACnE,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC1D,MAAM,cAAc,GAAa,EAAE,CAAC;IAEpC,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACrC,sEAAsE;QACtE,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YACb,6GAA6G;YAC7G,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;YACvE,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,SAAS,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;gBACpE,MAAM,CAAC,KAAK,CAAC,UAAU,WAAW,qBAAqB,CAAC,CAAC;gBACzD,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACnC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,YAAY,WAAW,kDAAkD,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,KAAK,GAAG,WAAW;QACvB,CAAC,MAAM,WAAW,CAAC,sBAAsB,EAAE,CAAC,IAAI;QAC9C,QAAQ,EAAE,kCAAkC;QAC5C,SAAS,EAAE,kCAAkC,GAAG,CAAC;KAClD,CAAC;IAEJ,MAAM,YAAY,GAAiB;QACjC,OAAO;QACP,yGAAyG;QACzG,IAAI,EAAE,KAAK,CAAC,QAAQ;QACpB,KAAK,EAAE,cAAc;QACrB,mHAAmH;QACnH,SAAS,EAAE,SAAS,IAAI,CAAC,MAAM,WAAW,CAAC,0BAA0B,EAAE,CAAC,IAAI,kCAAkC;QAC9G,aAAa,EAAE,KAAK;QACpB,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;KACzC,CAAC;IAEF,IAAI,QAAQ,EAAE,cAAc,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QACvD,YAAY,CAAC,KAAK,GAAG;YACnB,IAAI,EAAE,QAAQ,CAAC,cAAc;YAC7B,GAAG,EAAE,QAAQ,CAAC,aAAa;YAC3B,IAAI,EAAE,KAAK,CAAC,SAAS;SACtB,CAAC;IACJ,CAAC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAAc,EACd,OAAe,EACf,KAAa,EACb,WAAqD,EACrD,QAA6B,EAC7B,SAAqB;IAErB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IAErG,MAAM,CAAC,KAAK,CAAC,wCAAwC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/E,IAAI,YAAY,GAAqB,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAErE,MAAM,OAAO,GAAG,GAAS,EAAE;QACzB,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YACxC,YAAY,CAAC,UAAU,EAAE,CAAC;YAC1B,YAAY,GAAG,IAAI,CAAC;QACtB,CAAC;IACH,CAAC,CAAC;IAEF;QACE,MAAM,EAAE,mBAAmB;QAC3B,QAAQ,EAAE,6BAA6B;QACvC,SAAS,EAAE,gCAAgC;KAC5C,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAEnD,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/lib/shared/configUtils.d.ts

@@ -0,0 +1,27 @@
+import { Workspace } from '@lwc/lwc-dev-server';
+import { SSLCertificateData } from '@salesforce/lwc-dev-mobile-core';
+import { Config } from '@salesforce/core';
+export type IdentityTokenService = {
+    saveTokenToServer(token: string): Promise<string>;
+};
+export declare const LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT = 8081;
+export declare const LOCAL_DEV_SERVER_DEFAULT_WORKSPACE = Workspace.SfCli;
+export type LocalWebServerIdentityData = {
+    identityToken: string;
+    usernameToServerEntityIdMap: Record<string, string>;
+};
+export declare class ConfigUtils {
+    #private;
+    static getLocalConfig(): Promise<Config>;
+    static getGlobalConfig(): Promise<Config>;
+    static getOrCreateIdentityToken(username: string, tokenService: IdentityTokenService): Promise<string>;
+    static writeIdentityData(identityData: LocalWebServerIdentityData): Promise<void>;
+    static getCertData(): Promise<SSLCertificateData | undefined>;
+    static writeCertData(data: SSLCertificateData): Promise<void>;
+    static getLocalDevServerPorts(): Promise<{
+        httpPort: number;
+        httpsPort: number;
+    } | undefined>;
+    static getLocalDevServerWorkspace(): Promise<Workspace | undefined>;
+    static getIdentityData(): Promise<LocalWebServerIdentityData | undefined>;
+}

package/lib/shared/configUtils.js

@@ -0,0 +1,108 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { Workspace } from '@lwc/lwc-dev-server';
+import { CryptoUtils } from '@salesforce/lwc-dev-mobile-core';
+import { Config, ConfigAggregator } from '@salesforce/core';
+import configMeta from './../configMeta.js';
+export const LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT = 8081;
+export const LOCAL_DEV_SERVER_DEFAULT_WORKSPACE = Workspace.SfCli;
+export class ConfigUtils {
+    static #localConfig;
+    static #globalConfig;
+    static async getLocalConfig() {
+        if (this.#localConfig) {
+            return this.#localConfig;
+        }
+        this.#localConfig = await Config.create({ isGlobal: false });
+        Config.addAllowedProperties(configMeta);
+        return this.#localConfig;
+    }
+    static async getGlobalConfig() {
+        if (this.#globalConfig) {
+            return this.#globalConfig;
+        }
+        this.#globalConfig = await Config.create({ isGlobal: true });
+        Config.addAllowedProperties(configMeta);
+        return this.#globalConfig;
+    }
+    static async getOrCreateIdentityToken(username, tokenService) {
+        let identityData = await this.getIdentityData();
+        if (!identityData) {
+            const token = CryptoUtils.generateIdentityToken();
+            const entityId = await tokenService.saveTokenToServer(token);
+            identityData = {
+                identityToken: token,
+                usernameToServerEntityIdMap: {},
+            };
+            identityData.usernameToServerEntityIdMap[username] = entityId;
+            await this.writeIdentityData(identityData);
+            return token;
+        }
+        else {
+            let entityId = identityData.usernameToServerEntityIdMap[username];
+            if (!entityId) {
+                entityId = await tokenService.saveTokenToServer(identityData.identityToken);
+                identityData.usernameToServerEntityIdMap[username] = entityId;
+                await this.writeIdentityData(identityData);
+            }
+            return identityData.identityToken;
+        }
+    }
+    static async writeIdentityData(identityData) {
+        const config = await this.getLocalConfig();
+        // TODO: JSON needs to be stringified in order for config.write to encrypt. When config.write()
+        //       can encrypt JSON data to write it into config we shall remove stringify().
+        config.set("local-web-server-identity-data" /* ConfigVars.LOCAL_WEB_SERVER_IDENTITY_DATA */, JSON.stringify(identityData));
+        await config.write();
+    }
+    static async getCertData() {
+        const config = await this.getGlobalConfig();
+        const serializedData = config.get("local-dev-server-certificate-data" /* ConfigVars.LOCAL_DEV_SERVER_HTTPS_CERT_DATA */);
+        if (serializedData) {
+            const deserializedData = {
+                derCertificate: Buffer.from(serializedData.derCertificate, 'base64'),
+                pemCertificate: serializedData.pemCertificate,
+                pemPrivateKey: serializedData.pemPrivateKey,
+                pemPublicKey: serializedData.pemPublicKey,
+            };
+            return deserializedData;
+        }
+        return undefined;
+    }
+    static async writeCertData(data) {
+        const config = await this.getGlobalConfig();
+        const serializedData = {
+            derCertificate: data.derCertificate.toString('base64'),
+            pemCertificate: data.pemCertificate,
+            pemPrivateKey: data.pemPrivateKey,
+            pemPublicKey: data.pemPublicKey,
+        };
+        config.set("local-dev-server-certificate-data" /* ConfigVars.LOCAL_DEV_SERVER_HTTPS_CERT_DATA */, serializedData);
+        await config.write();
+    }
+    static async getLocalDevServerPorts() {
+        const config = await this.getLocalConfig();
+        const ports = config.get("local-dev-server-port" /* ConfigVars.LOCAL_DEV_SERVER_PORT */);
+        return ports;
+    }
+    static async getLocalDevServerWorkspace() {
+        const config = await this.getLocalConfig();
+        const configWorkspace = config.get("local-dev-server-workspace" /* ConfigVars.LOCAL_DEV_SERVER_WORKSPACE */);
+        return configWorkspace;
+    }
+    static async getIdentityData() {
+        const config = await ConfigAggregator.create({ customConfigMeta: configMeta });
+        // Need to reload to make sure the values read are decrypted
+        await config.reload();
+        const identityJson = config.getPropertyValue("local-web-server-identity-data" /* ConfigVars.LOCAL_WEB_SERVER_IDENTITY_DATA */);
+        if (identityJson) {
+            return JSON.parse(identityJson);
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=configUtils.js.map

package/lib/shared/configUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configUtils.js","sourceRoot":"","sources":["../../src/shared/configUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAsB,MAAM,iCAAiC,CAAC;AAClF,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,UAAwD,MAAM,oBAAoB,CAAC;AAM1F,MAAM,CAAC,MAAM,kCAAkC,GAAG,IAAI,CAAC;AACvD,MAAM,CAAC,MAAM,kCAAkC,GAAG,SAAS,CAAC,KAAK,CAAC;AAOlE,MAAM,OAAO,WAAW;IACtB,MAAM,CAAC,YAAY,CAAS;IAC5B,MAAM,CAAC,aAAa,CAAS;IAEtB,MAAM,CAAC,KAAK,CAAC,cAAc;QAChC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,aAAa,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,QAAgB,EAAE,YAAkC;QAC/F,IAAI,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAChD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,KAAK,GAAG,WAAW,CAAC,qBAAqB,EAAE,CAAC;YAClD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAC7D,YAAY,GAAG;gBACb,aAAa,EAAE,KAAK;gBACpB,2BAA2B,EAAE,EAAE;aAChC,CAAC;YACF,YAAY,CAAC,2BAA2B,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;YAC9D,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAC3C,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,IAAI,QAAQ,GAAG,YAAY,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC;YAClE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,QAAQ,GAAG,MAAM,YAAY,CAAC,iBAAiB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;gBAC5E,YAAY,CAAC,2BAA2B,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;gBAC9D,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,YAAY,CAAC,aAAa,CAAC;QACpC,CAAC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,YAAwC;QAC5E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC3C,+FAA+F;QAC/F,mFAAmF;QACnF,MAAM,CAAC,GAAG,mFAA4C,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;QACpF,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,WAAW;QAC7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,uFAA6E,CAAC;QAC/G,IAAI,cAAc,EAAE,CAAC;YACnB,MAAM,gBAAgB,GAAuB;gBAC3C,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC;gBACpE,cAAc,EAAE,cAAc,CAAC,cAAc;gBAC7C,aAAa,EAAE,cAAc,CAAC,aAAa;gBAC3C,YAAY,EAAE,cAAc,CAAC,YAAY;aAC1C,CAAC;YAEF,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAwB;QACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,MAAM,cAAc,GAAiC;YACnD,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACtD,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;QACF,MAAM,CAAC,GAAG,wFAA8C,cAAc,CAAC,CAAC;QACxE,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB;QACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,gEAA6E,CAAC;QAEtG,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,0BAA0B;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC3C,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,0EAAoD,CAAC;QAEvF,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe;QACjC,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAC,CAAC;QAC/E,4DAA4D;QAC5D,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,MAAM,YAAY,GAAG,MAAM,CAAC,gBAAgB,kFAA2C,CAAC;QAExF,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,KAAK,CAAC,YAAsB,CAA+B,CAAC;QAC1E,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/lib/shared/experience/expSite.d.ts

@@ -0,0 +1,70 @@
+import { Org } from '@salesforce/core';
+export type SiteMetadata = {
+    bundleName: string;
+    bundleLastModified: string;
+};
+export type SiteMetadataCache = {
+    [key: string]: SiteMetadata;
+};
+/**
+ * Experience Site class.
+ * https://developer.salesforce.com/docs/platform/lwc/guide/get-started-test-components.html#enable-local-dev
+ *
+ * @param {string} siteName - The name of the experience site.
+ * @param {string} status - The status of the experience site.
+ * @param {string} bundleName - The static resource bundle name.
+ * @param {string} bundleLastModified - The lastModifiedDate of the static resource.
+ */
+export declare class ExperienceSite {
+    siteDisplayName: string;
+    siteName: string;
+    private org;
+    private metadataCache;
+    constructor(org: Org, siteName: string);
+    /**
+     * Get an experience site bundle by site name.
+     *
+     * @param conn - Salesforce connection object.
+     * @param siteName - The name of the experience site.
+     * @returns - The experience site.
+     *
+     * @param siteName
+     * @returns
+     */
+    static getLocalExpSite(siteName: string): ExperienceSite;
+    /**
+     * Fetches all experience site bundles that are published to MRT.
+     *
+     * @param {Connection} conn - Salesforce connection object.
+     * @returns {Promise<ExperienceSite[]>} - List of experience sites.
+     */
+    static getAllPublishedExpSites(org: Org): Promise<ExperienceSite[]>;
+    /**
+     * Fetches all current experience sites
+     *
+     * @param {Connection} conn - Salesforce connection object.
+     * @returns {Promise<string[]>} - List of experience sites.
+     */
+    static getAllExpSites(org: Org): Promise<string[]>;
+    isUpdateAvailable(): Promise<boolean>;
+    isSiteSetup(): boolean;
+    isSitePublished(): Promise<boolean>;
+    isSiteDownloaded(): boolean;
+    saveMetadata(metadata: SiteMetadata): void;
+    getLocalMetadata(): SiteMetadata | undefined;
+    getRemoteMetadata(): Promise<SiteMetadata | undefined>;
+    /**
+     * Get the local site directory path
+     *
+     * @returns the path to the site
+     */
+    getSiteDirectory(): string;
+    getExtractDirectory(): string;
+    getSiteZipPath(metadata: SiteMetadata): string;
+    /**
+     * Download and return the site resource bundle
+     *
+     * @returns path of downloaded site zip
+     */
+    downloadSite(): Promise<string>;
+}