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

package/lib/shared/experience/expSite.js

@@ -0,0 +1,200 @@
+/*
+ * 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 fs from 'node:fs';
+import path from 'node:path';
+import { SfError } from '@salesforce/core';
+/**
+ * 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 class ExperienceSite {
+    siteDisplayName;
+    siteName;
+    org;
+    metadataCache = {};
+    constructor(org, siteName) {
+        this.org = org;
+        this.siteDisplayName = siteName.trim();
+        this.siteName = this.siteDisplayName.replace(' ', '_');
+    }
+    /**
+     * 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) {
+        const siteJsonPath = path.join('.localdev', siteName.trim().replace(' ', '_'), 'site.json');
+        const siteJson = fs.readFileSync(siteJsonPath, 'utf8');
+        const site = JSON.parse(siteJson);
+        return site;
+    }
+    /**
+     * Fetches all experience site bundles that are published to MRT.
+     *
+     * @param {Connection} conn - Salesforce connection object.
+     * @returns {Promise<ExperienceSite[]>} - List of experience sites.
+     */
+    static async getAllPublishedExpSites(org) {
+        const result = await org
+            .getConnection()
+            .query("SELECT Id, Name, LastModifiedDate FROM StaticResource WHERE Name LIKE 'MRT%_'");
+        // Example of creating ExperienceSite instances
+        const experienceSites = result.records.map((record) => new ExperienceSite(org, getSiteNameFromStaticResource(record.Name)));
+        return experienceSites;
+    }
+    /**
+     * Fetches all current experience sites
+     *
+     * @param {Connection} conn - Salesforce connection object.
+     * @returns {Promise<string[]>} - List of experience sites.
+     */
+    static async getAllExpSites(org) {
+        const result = await org.getConnection().query('SELECT Id, Name, LastModifiedDate, UrlPathPrefix, Status FROM Network');
+        const experienceSites = result.records.map((record) => record.Name);
+        return experienceSites;
+    }
+    async isUpdateAvailable() {
+        const localMetadata = this.getLocalMetadata();
+        if (!localMetadata) {
+            return true; // If no local metadata, assume update is available
+        }
+        const remoteMetadata = await this.getRemoteMetadata();
+        if (!remoteMetadata) {
+            return false; // If no org bundle found, no update available
+        }
+        return new Date(remoteMetadata.bundleLastModified) > new Date(localMetadata.bundleLastModified);
+    }
+    // Is the site extracted locally
+    isSiteSetup() {
+        return fs.existsSync(path.join(this.getExtractDirectory(), 'ssr.js'));
+    }
+    // Is the static resource available on the server
+    async isSitePublished() {
+        const remoteMetadata = await this.getRemoteMetadata();
+        if (!remoteMetadata) {
+            return false;
+        }
+        return true;
+    }
+    // Is there a local gz file of the site
+    isSiteDownloaded() {
+        const metadata = this.getLocalMetadata();
+        if (!metadata) {
+            return false;
+        }
+        return fs.existsSync(this.getSiteZipPath(metadata));
+    }
+    saveMetadata(metadata) {
+        const siteJsonPath = path.join(this.getSiteDirectory(), 'site.json');
+        const siteJson = JSON.stringify(metadata, null, 2);
+        fs.writeFileSync(siteJsonPath, siteJson);
+    }
+    getLocalMetadata() {
+        if (this.metadataCache.localMetadata)
+            return this.metadataCache.localMetadata;
+        const siteJsonPath = path.join(this.getSiteDirectory(), 'site.json');
+        let siteJson;
+        if (fs.existsSync(siteJsonPath)) {
+            try {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                siteJson = JSON.parse(fs.readFileSync(siteJsonPath, 'utf-8'));
+                this.metadataCache.localMetadata = siteJson;
+            }
+            catch (error) {
+                // eslint-disable-next-line no-console
+                console.error('Error reading site.json file', error);
+            }
+        }
+        return siteJson;
+    }
+    async getRemoteMetadata() {
+        if (this.metadataCache.remoteMetadata)
+            return this.metadataCache.remoteMetadata;
+        const result = await this.org
+            .getConnection()
+            .query(`SELECT Name, LastModifiedDate FROM StaticResource WHERE Name LIKE 'MRT_experience_%_${this.siteName}'`);
+        if (result.records.length === 0) {
+            return undefined;
+        }
+        const staticResource = result.records[0];
+        this.metadataCache.remoteMetadata = {
+            bundleName: staticResource.Name,
+            bundleLastModified: staticResource.LastModifiedDate,
+        };
+        return this.metadataCache.remoteMetadata;
+    }
+    /**
+     * Get the local site directory path
+     *
+     * @returns the path to the site
+     */
+    getSiteDirectory() {
+        return path.join('.localdev', this.siteName);
+    }
+    getExtractDirectory() {
+        return path.join('.localdev', this.siteName, 'app');
+    }
+    getSiteZipPath(metadata) {
+        const lastModifiedDate = new Date(metadata.bundleLastModified);
+        const timestamp = `${lastModifiedDate.getMonth() + 1}-${lastModifiedDate.getDate()}_${lastModifiedDate.getHours()}-${lastModifiedDate.getMinutes()}`;
+        const fileName = `${metadata.bundleName}_${timestamp}.gz`;
+        const resourcePath = path.join(this.getSiteDirectory(), fileName);
+        return resourcePath;
+    }
+    /**
+     * Download and return the site resource bundle
+     *
+     * @returns path of downloaded site zip
+     */
+    async downloadSite() {
+        const remoteMetadata = await this.getRemoteMetadata();
+        if (!remoteMetadata) {
+            throw new SfError(`No published site found for: ${this.siteDisplayName}`);
+        }
+        // Download the site from static resources
+        // eslint-disable-next-line no-console
+        console.log('[local-dev] Downloading site...'); // TODO spinner
+        const resourcePath = this.getSiteZipPath(remoteMetadata);
+        const staticresource = await this.org.getConnection().metadata.read('StaticResource', remoteMetadata.bundleName);
+        if (staticresource?.content) {
+            // Save the static resource
+            fs.mkdirSync(this.getSiteDirectory(), { recursive: true });
+            const buffer = Buffer.from(staticresource.content, 'base64');
+            fs.writeFileSync(resourcePath, buffer);
+            // Save the site's metadata
+            this.saveMetadata(remoteMetadata);
+        }
+        else {
+            throw new SfError(`Error occurred downloading your site: ${this.siteDisplayName}`);
+        }
+        return resourcePath;
+    }
+}
+/**
+ * Return the site name given the name of its static resource bundle
+ *
+ * @param staticResourceName the static resource bundle name
+ * @returns the name of the site
+ */
+function getSiteNameFromStaticResource(staticResourceName) {
+    const parts = staticResourceName.split('_');
+    if (parts.length < 5) {
+        throw new Error(`Unexpected static resource name: ${staticResourceName}`);
+    }
+    return parts.slice(4).join(' ');
+}
+//# sourceMappingURL=expSite.js.map

package/lib/shared/experience/expSite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"expSite.js","sourceRoot":"","sources":["../../../src/shared/experience/expSite.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAO,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAWhD;;;;;;;;GAQG;AACH,MAAM,OAAO,cAAc;IAClB,eAAe,CAAS;IACxB,QAAQ,CAAS;IAChB,GAAG,CAAM;IACT,aAAa,GAAsB,EAAE,CAAC;IAE9C,YAAmB,GAAQ,EAAE,QAAgB;QAC3C,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,eAAe,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,eAAe,CAAC,QAAgB;QAC5C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC;QAC5F,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAmB,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAQ;QAClD,MAAM,MAAM,GAAG,MAAM,GAAG;aACrB,aAAa,EAAE;aACf,KAAK,CACJ,+EAA+E,CAChF,CAAC;QAEJ,+CAA+C;QAC/C,MAAM,eAAe,GAAqB,MAAM,CAAC,OAAO,CAAC,GAAG,CAC1D,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,cAAc,CAAC,GAAG,EAAE,6BAA6B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAChF,CAAC;QAEF,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAQ;QACzC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC,KAAK,CAM3C,uEAAuE,CAAC,CAAC;QAC5E,MAAM,eAAe,GAAa,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9E,OAAO,eAAe,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,MAAM,aAAa,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9C,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,CAAC,mDAAmD;QAClE,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACtD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,KAAK,CAAC,CAAC,8CAA8C;QAC9D,CAAC;QAED,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;IAClG,CAAC;IAED,gCAAgC;IACzB,WAAW;QAChB,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,iDAAiD;IAC1C,KAAK,CAAC,eAAe;QAC1B,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACtD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uCAAuC;IAChC,gBAAgB;QACrB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,CAAC;IAEM,YAAY,CAAC,QAAsB;QACxC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,WAAW,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACnD,EAAE,CAAC,aAAa,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEM,gBAAgB;QACrB,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;QAC9E,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,WAAW,CAAC,CAAC;QACrE,IAAI,QAAQ,CAAC;QACb,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YAChC,IAAI,CAAC;gBACH,mEAAmE;gBACnE,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAiB,CAAC;gBAC9E,IAAI,CAAC,aAAa,CAAC,aAAa,GAAG,QAAQ,CAAC;YAC9C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc;YAAE,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;QAChF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG;aAC1B,aAAa,EAAE;aACf,KAAK,CACJ,uFAAuF,IAAI,CAAC,QAAQ,GAAG,CACxG,CAAC;QACJ,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,CAAC,aAAa,CAAC,cAAc,GAAG;YAClC,UAAU,EAAE,cAAc,CAAC,IAAI;YAC/B,kBAAkB,EAAE,cAAc,CAAC,gBAAgB;SACpD,CAAC;QACF,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,gBAAgB;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAEM,mBAAmB;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAEM,cAAc,CAAC,QAAsB;QAC1C,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;QAC/D,MAAM,SAAS,GAAG,GAChB,gBAAgB,CAAC,QAAQ,EAAE,GAAG,CAChC,IAAI,gBAAgB,CAAC,OAAO,EAAE,IAAI,gBAAgB,CAAC,QAAQ,EAAE,IAAI,gBAAgB,CAAC,UAAU,EAAE,EAAE,CAAC;QACjG,MAAM,QAAQ,GAAG,GAAG,QAAQ,CAAC,UAAU,IAAI,SAAS,KAAK,CAAC;QAC1D,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,QAAQ,CAAC,CAAC;QAClE,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY;QACvB,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACtD,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,MAAM,IAAI,OAAO,CAAC,gCAAgC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QAC5E,CAAC;QAED,0CAA0C;QAC1C,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC,CAAC,eAAe;QAC/D,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;QACzD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;QACjH,IAAI,cAAc,EAAE,OAAO,EAAE,CAAC;YAC5B,2BAA2B;YAC3B,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC7D,EAAE,CAAC,aAAa,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAEvC,2BAA2B;YAC3B,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,OAAO,CAAC,yCAAyC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;QACrF,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAED;;;;;GAKG;AACH,SAAS,6BAA6B,CAAC,kBAA0B;IAC/D,MAAM,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,oCAAoC,kBAAkB,EAAE,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC"}

package/lib/shared/orgUtils.d.ts

@@ -0,0 +1,14 @@
+import { Connection } from '@salesforce/core';
+export declare class OrgUtils {
+    /**
+     * Given an app name, it queries the org to find the matching app id. To do so,
+     * it will first attempt at finding the app with a matching DeveloperName. If
+     * no match is found, it will then attempt at finding the app with a matching
+     * Label. If multiple matches are found, then the first match is returned.
+     *
+     * @param connection the connection to the org
+     * @param appName the name of the app
+     * @returns the app id or undefined if no match is found
+     */
+    static getAppId(connection: Connection, appName: string): Promise<string | undefined>;
+}

package/lib/shared/orgUtils.js

@@ -0,0 +1,36 @@
+/*
+ * 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
+ */
+export class OrgUtils {
+    /**
+     * Given an app name, it queries the org to find the matching app id. To do so,
+     * it will first attempt at finding the app with a matching DeveloperName. If
+     * no match is found, it will then attempt at finding the app with a matching
+     * Label. If multiple matches are found, then the first match is returned.
+     *
+     * @param connection the connection to the org
+     * @param appName the name of the app
+     * @returns the app id or undefined if no match is found
+     */
+    static async getAppId(connection, appName) {
+        // NOTE: We have to break up the query and run against different columns separately instead
+        // of using OR statement, otherwise we'll get the error 'Disjunctions not supported'
+        const devNameQuery = `SELECT DurableId FROM AppDefinition WHERE DeveloperName LIKE '${appName}'`;
+        const labelQuery = `SELECT DurableId FROM AppDefinition WHERE Label LIKE '${appName}'`;
+        // First attempt to resolve using DeveloperName
+        let result = await connection.query(devNameQuery);
+        if (result.totalSize > 0) {
+            return result.records[0].DurableId;
+        }
+        // If no matches, then resolve using Label
+        result = await connection.query(labelQuery);
+        if (result.totalSize > 0) {
+            return result.records[0].DurableId;
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=orgUtils.js.map

package/lib/shared/orgUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"orgUtils.js","sourceRoot":"","sources":["../../src/shared/orgUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,MAAM,OAAO,QAAQ;IACnB;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAsB,EAAE,OAAe;QAClE,2FAA2F;QAC3F,oFAAoF;QACpF,MAAM,YAAY,GAAG,iEAAiE,OAAO,GAAG,CAAC;QACjG,MAAM,UAAU,GAAG,yDAAyD,OAAO,GAAG,CAAC;QAEvF,+CAA+C;QAC/C,IAAI,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CAAwB,YAAY,CAAC,CAAC;QACzE,IAAI,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrC,CAAC;QAED,0CAA0C;QAC1C,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CAAwB,UAAU,CAAC,CAAC;QACnE,IAAI,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,CAAC;YACzB,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/lib/shared/previewUtils.d.ts

@@ -0,0 +1,126 @@
+import { Logger } from '@salesforce/core';
+import { AndroidAppPreviewConfig, AndroidVirtualDevice, IOSAppPreviewConfig, IOSSimulatorDevice, LaunchArgument, Platform, SSLCertificateData } from '@salesforce/lwc-dev-mobile-core';
+import { Progress, Spinner } from '@salesforce/sf-plugins-core';
+export declare class PreviewUtils {
+    static generateWebSocketUrlForLocalDevServer(platform: string, ports: {
+        httpPort: number;
+        httpsPort: number;
+    }, logger?: Logger): string;
+    /**
+     * Returns a pair of port numbers to be used by the local dev server for http and https.
+     *
+     * It starts by checking whether the user has configured a port in their config file.
+     * If so then we are only allowed to use that port, regardless of whether it is in use
+     * or not.
+     *
+     * If the user has not configured a port in their config file then we are free to choose
+     * one. We'll start with the default port (8081) and checks to see if it is in use or not.
+     * If it is in use then we increment the port number by 2 and check if it is in use or not.
+     * This process is repeated until a port that is not in use is found.
+     *
+     * @returns a pair of port numbers to be used by the local dev server for http and https.
+     */
+    static getNextAvailablePorts(): Promise<{
+        httpPort: number;
+        httpsPort: number;
+    }>;
+    /**
+     * Attempts to fetch the targeted mobile device for previewing.
+     *
+     * @param platform A mobile platform (iOS or Android)
+     * @param deviceId An optional device identifier (such as name or UDID)
+     * @param logger An optional logger to be used for logging
+     * @returns The iOS or Android device, or `undefined` if not found
+     */
+    static getMobileDevice(platform: Platform.ios | Platform.android, deviceId?: string, logger?: Logger): Promise<IOSSimulatorDevice | AndroidVirtualDevice | undefined>;
+    /**
+     * Attempts to boot a device.
+     *
+     * @param platform A mobile platform (iOS or Android)
+     * @param deviceId The identifier (such as name or UDID) of the target device
+     * @param logger An optional logger to be used for logging
+     * @returns For Android devices returns the emulator port number. For iOS devices returns `undefined`
+     */
+    static bootMobileDevice(platform: Platform.ios | Platform.android, deviceId: string, logger?: Logger): Promise<number | undefined>;
+    /**
+     * Generates the proper set of arguments to be used for launching desktop browser and navigating to the right location.
+     *
+     * @param ldpServerUrl The URL for the local dev server
+     * @param entityId Record ID for the identity token
+     * @param appId An optional app id for a targeted LEX app
+     * @param targetOrg An optional org id
+     * @param auraMode An optional Aura Mode (defaults to DEVPREVIEW)
+     * @returns Array of arguments to be used by Org:Open command for launching desktop browser
+     */
+    static generateDesktopPreviewLaunchArguments(ldpServerUrl: string, entityId: string, appId?: string, targetOrg?: string, auraMode?: string): string[];
+    /**
+     * Generates the proper set of arguments to be used for launching a mobile app with custom launch arguments.
+     *
+     * @param ldpServerUrl The URL for the local dev server
+     * @param entityId Record ID for the identity token
+     * @param appName An optional app name for a targeted LEX app
+     * @param appId An optional app id for a targeted LEX app
+     * @param auraMode An optional Aura Mode (defaults to DEVPREVIEW)
+     * @returns Array of arguments to be used as custom launch arguments when launching a mobile app.
+     */
+    static generateMobileAppPreviewLaunchArguments(ldpServerUrl: string, entityId: string, appName?: string, appId?: string, auraMode?: string): LaunchArgument[];
+    /**
+     * Generates a self-signed certificate and saves it to a file at the specified location.
+     *
+     * @param platform A mobile platform (iOS or Android)
+     * @param saveLocation Path to a folder where the generated certificated will be saved to (defaults to the current working directory)
+     * @returns Path to the generated certificate file and the certificate data
+     */
+    static generateSelfSignedCert(platform: Platform.ios | Platform.android, saveLocation?: string): Promise<{
+        certData: SSLCertificateData;
+        certFilePath: string;
+    }>;
+    /**
+     * Launches the specified mobile app on the specified device.
+     *
+     * @param platform A mobile platform (iOS or Android)
+     * @param deviceId The identifier (such as name or UDID) of the target device
+     * @param appConfig The app configuration containing info about the mobile app to be launched
+     * @param emulatorPort Optional - only needed when platform is Android and specifies the ADB port of the booted Android virtual device
+     * @param logger An optional logger to be used for logging
+     */
+    static launchMobileApp(platform: Platform.ios | Platform.android, appConfig: IOSAppPreviewConfig | AndroidAppPreviewConfig, deviceId: string, emulatorPort?: number, appBundlePath?: string, logger?: Logger): Promise<void>;
+    /**
+     * Verifies whether a particular app is installed on a mobile device.
+     *
+     * @param platform A mobile platform (iOS or Android)
+     * @param appConfig The app configuration containing info about the mobile app such as name and bundle/package id
+     * @param deviceId The identifier (such as name or UDID) of the target device
+     * @param emulatorPort Optional - only needed when platform is Android and specifies the ADB port of the booted Android virtual device
+     * @param logger An optional logger to be used for logging
+     * @returns `true` if app is installed, `false` otherwise
+     */
+    static verifyMobileAppInstalled(platform: Platform.ios | Platform.android, appConfig: IOSAppPreviewConfig | AndroidAppPreviewConfig, deviceId: string, emulatorPort?: number, logger?: Logger): Promise<boolean>;
+    /**
+     * Downloads the Salesforce Mobile App into a temp folder and returns the path to downloaded file.
+     *
+     * @param platform A mobile platform (iOS or Android)
+     * @param logger An optional logger to be used for logging
+     * @param progress An optional spinner indicator for reporting messages
+     * @param progress An optional progress indicator for reporting progress
+     * @returns The path to downloaded file.
+     */
+    static downloadSalesforceMobileAppBundle(platform: Platform.ios | Platform.android, logger?: Logger, spinner?: Spinner, progress?: Progress): Promise<string>;
+    /**
+     * Given an sfdc.co shortened url it returns the actual/full url that this will redirect to.
+     *
+     * @param httpsUrl The sfdc.co shortened url
+     * @returns The actual/full url
+     */
+    static fetchFullUrlFromSfdc(httpsUrl: string): Promise<string>;
+    /**
+     * Extracts a ZIP archive to an output directory.
+     *
+     * @param zipFilePath The path to the ZIP archive
+     * @param outputDir An optional output directory - if omitted then defaults to the same directory as the ZIP file
+     * @param logger An optional logger to be used for logging
+     */
+    static extractZIPArchive(zipFilePath: string, outputDir?: string, logger?: Logger): Promise<void>;
+    static getEntityId(username: string): Promise<string>;
+    private static doGetNextAvailablePort;
+}