@lwrjs/legacy-npm-module-provider 0.10.8

package/LICENSE

@@ -0,0 +1,10 @@
+MIT LICENSE
+
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/build/cjs/index.cjs

@@ -0,0 +1,89 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {get: all[name], enumerable: true});
+};
+var __exportStar = (target, module2, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && key !== "default")
+        __defProp(target, key, {get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable});
+  }
+  return target;
+};
+var __toModule = (module2) => {
+  return __exportStar(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? {get: () => module2.default, enumerable: true} : {value: module2, enumerable: true})), module2);
+};
+
+// packages/@lwrjs/legacy-npm-module-provider/src/index.ts
+__markAsModule(exports);
+__export(exports, {
+  default: () => src_default
+});
+var import_path = __toModule(require("path"));
+var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
+var import_resolveNpmModules = __toModule(require("./resolveNpmModules.cjs"));
+var LegacyNpmModuleProvider = class {
+  constructor(providerConfig = {}, {config: {cacheDir}}) {
+    this.name = "legacy-npm-module-provider";
+    this.moduleEntryVersionCache = new Map();
+    this.webModulesCacheDir = import_path.default.join(cacheDir, "web_modules");
+    this.providerConfig = providerConfig;
+  }
+  async getModule(moduleId) {
+    const moduleSource = await this.getModuleSource(moduleId);
+    if (!moduleSource) {
+      return;
+    }
+    return {
+      ...moduleSource,
+      compiledSource: moduleSource.originalSource
+    };
+  }
+  async getModuleSource(moduleId) {
+    const moduleEntry = await this.getModuleEntry(moduleId);
+    if (!moduleEntry) {
+      return;
+    }
+    const {namespace, name} = moduleId;
+    const {id, specifier, entry, version} = moduleEntry;
+    const originalSource = (0, import_shared_utils.readFile)(entry);
+    const ownHash = (0, import_shared_utils.hashContent)(originalSource);
+    return {
+      id,
+      namespace,
+      name: name || specifier,
+      version,
+      specifier,
+      moduleEntry,
+      ownHash,
+      originalSource
+    };
+  }
+  async getModuleEntry({specifier, version}) {
+    if (version && this.moduleEntryVersionCache.has(specifier)) {
+      const versions = this.moduleEntryVersionCache.get(specifier);
+      if (versions.has(version)) {
+        return versions.get(version);
+      }
+    }
+    const moduleEntry = await (0, import_resolveNpmModules.resolveNpmModuleSpecifierDeprecated)(specifier, this.webModulesCacheDir, this.providerConfig);
+    if (!moduleEntry) {
+      return;
+    }
+    let specifierVersions = this.moduleEntryVersionCache.get(specifier);
+    if (!specifierVersions) {
+      specifierVersions = new Map();
+      this.moduleEntryVersionCache.set(specifier, specifierVersions);
+    }
+    specifierVersions.set(moduleEntry.version, moduleEntry);
+    return moduleEntry;
+  }
+};
+var src_default = LegacyNpmModuleProvider;

package/build/cjs/resolveNpmModules.cjs

@@ -0,0 +1,140 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {get: all[name], enumerable: true});
+};
+var __exportStar = (target, module2, desc) => {
+  if (module2 && typeof module2 === "object" || typeof module2 === "function") {
+    for (let key of __getOwnPropNames(module2))
+      if (!__hasOwnProp.call(target, key) && key !== "default")
+        __defProp(target, key, {get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable});
+  }
+  return target;
+};
+var __toModule = (module2) => {
+  return __exportStar(__markAsModule(__defProp(module2 != null ? __create(__getProtoOf(module2)) : {}, "default", module2 && module2.__esModule && "default" in module2 ? {get: () => module2.default, enumerable: true} : {value: module2, enumerable: true})), module2);
+};
+
+// packages/@lwrjs/legacy-npm-module-provider/src/resolveNpmModules.ts
+__markAsModule(exports);
+__export(exports, {
+  resolveNpmModuleSpecifierBlock: () => resolveNpmModuleSpecifierBlock,
+  resolveNpmModuleSpecifierDeprecated: () => resolveNpmModuleSpecifierDeprecated
+});
+var import_path = __toModule(require("path"));
+var import_esinstall = __toModule(require("esinstall"));
+var import_fs = __toModule(require("fs"));
+var import_resolve = __toModule(require("resolve"));
+var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
+function getPkgVersion(specifier) {
+  const pkgPath = import_resolve.default.sync((0, import_path.join)(specifier, "/package.json"));
+  return JSON.parse((0, import_fs.readFileSync)(pkgPath, "utf-8")).version;
+}
+function readModuleMapping(moduleMappingPath) {
+  return (0, import_fs.existsSync)(moduleMappingPath) ? JSON.parse((0, import_fs.readFileSync)(moduleMappingPath, "utf-8")) : {imports: {}};
+}
+function writeModuleMapping(loc, importMap) {
+  (0, import_fs.writeFileSync)(loc, JSON.stringify(importMap, void 0, 2), {encoding: "utf-8"});
+}
+async function resolveNpmModuleSpecifierBlock(specifier, dest, config) {
+  try {
+    const tmpFolder = (0, import_path.join)(dest, "__tmp", specifier.replace(/[/|@]/g, "_"));
+    (0, import_fs.mkdirSync)(tmpFolder, {recursive: true});
+    const moduleMappingPath = (0, import_path.join)(dest, "import-map-cache.json");
+    const currentModuleMapping = readModuleMapping(moduleMappingPath);
+    const version = getPkgVersion(specifier);
+    const cacheKey = `${specifier}@${version}`;
+    if (currentModuleMapping.imports[cacheKey]) {
+      return {
+        id: cacheKey,
+        specifier,
+        entry: currentModuleMapping.imports[cacheKey],
+        version
+      };
+    }
+    const external = config.external?.filter((e) => e !== specifier) || [];
+    const polyfillNode = config.polyfillNode ?? true;
+    await (0, import_esinstall.install)([specifier], {
+      dest: tmpFolder,
+      importMap: currentModuleMapping,
+      logger: {
+        debug: () => void 0,
+        log: () => void 0,
+        warn: () => void 0,
+        error: () => void 0
+      },
+      polyfillNode,
+      external
+    });
+    const moduleMapping = readModuleMapping((0, import_path.join)(tmpFolder, "import-map.json"));
+    const moduleRelativePath = moduleMapping.imports[specifier];
+    const moduleAbsPath = (0, import_path.join)(tmpFolder, moduleRelativePath);
+    const moduleEntry = (0, import_path.join)(dest, moduleRelativePath);
+    (0, import_fs.mkdirSync)((0, import_path.dirname)(moduleEntry), {recursive: true});
+    (0, import_fs.copyFileSync)(moduleAbsPath, moduleEntry);
+    const mergedMapping = {
+      imports: {
+        ...currentModuleMapping.imports,
+        [cacheKey]: moduleEntry
+      }
+    };
+    writeModuleMapping(moduleMappingPath, mergedMapping);
+    return {
+      id: cacheKey,
+      entry: moduleEntry,
+      specifier,
+      version
+    };
+  } catch (err) {
+    import_shared_utils.logger.error(`[npm-module-provider][esintsall] resolveNpmModules: ${specifier} ${dest}`, {err});
+  }
+}
+var Queue = class {
+  constructor() {
+    this.queue = [];
+    this.workingOnPromise = false;
+    this.pendingPromise = false;
+  }
+  enqueue(promise) {
+    return new Promise((resolve2, reject) => {
+      this.queue.push({promise, resolve: resolve2, reject});
+      this.dequeue();
+    });
+  }
+  dequeue() {
+    if (this.workingOnPromise) {
+      return false;
+    }
+    const item = this.queue.shift();
+    if (!item) {
+      return false;
+    }
+    this.workingOnPromise = true;
+    try {
+      item.promise().then((value) => {
+        this.workingOnPromise = false;
+        item.resolve(value);
+        this.dequeue();
+      }).catch((err) => {
+        this.workingOnPromise = false;
+        item.reject(err);
+        this.dequeue();
+      });
+    } catch (err) {
+      this.workingOnPromise = false;
+      item.reject(err);
+      this.dequeue();
+    }
+    return true;
+  }
+};
+var RESOLVER_QUEUE = new Queue();
+async function resolveNpmModuleSpecifierDeprecated(specifier, dest, config) {
+  return RESOLVER_QUEUE.enqueue(resolveNpmModuleSpecifierBlock.bind(null, specifier, dest, config));
+}

package/build/es/index.d.ts

@@ -0,0 +1,19 @@
+import type { AbstractModuleId, ModuleCompiled, ModuleEntry, ModuleProvider, ModuleSource, ProviderContext } from '@lwrjs/types';
+export interface LegacyNpmModuleProviderConfig {
+    external?: string[];
+    polyfillNode?: boolean;
+}
+/**
+ * @deprecated please use @lwrjs/npm-module-provider
+ */
+export default class LegacyNpmModuleProvider implements ModuleProvider {
+    name: string;
+    private providerConfig;
+    private webModulesCacheDir;
+    private moduleEntryVersionCache;
+    constructor(providerConfig: LegacyNpmModuleProviderConfig | undefined, { config: { cacheDir } }: ProviderContext);
+    getModule(moduleId: AbstractModuleId): Promise<ModuleCompiled | undefined>;
+    getModuleSource(moduleId: AbstractModuleId): Promise<ModuleSource | undefined>;
+    getModuleEntry({ specifier, version }: AbstractModuleId): Promise<ModuleEntry | undefined>;
+}
+//# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -0,0 +1,66 @@
+import path from 'path';
+import { hashContent, readFile } from '@lwrjs/shared-utils';
+import { resolveNpmModuleSpecifierDeprecated } from './resolveNpmModules.js';
+/**
+ * @deprecated please use @lwrjs/npm-module-provider
+ */
+export default class LegacyNpmModuleProvider {
+    constructor(providerConfig = {}, { config: { cacheDir } }) {
+        this.name = 'legacy-npm-module-provider';
+        this.moduleEntryVersionCache = new Map();
+        this.webModulesCacheDir = path.join(cacheDir, 'web_modules');
+        this.providerConfig = providerConfig;
+    }
+    async getModule(moduleId) {
+        const moduleSource = await this.getModuleSource(moduleId);
+        if (!moduleSource) {
+            return;
+        }
+        return {
+            ...moduleSource,
+            compiledSource: moduleSource.originalSource,
+        };
+    }
+    async getModuleSource(moduleId) {
+        const moduleEntry = await this.getModuleEntry(moduleId);
+        if (!moduleEntry) {
+            return;
+        }
+        const { namespace, name } = moduleId;
+        const { id, specifier, entry, version } = moduleEntry;
+        const originalSource = readFile(entry);
+        const ownHash = hashContent(originalSource);
+        return {
+            id,
+            namespace,
+            name: name || specifier,
+            version,
+            specifier,
+            moduleEntry,
+            ownHash,
+            originalSource,
+        };
+    }
+    async getModuleEntry({ specifier, version }) {
+        // Check cache
+        if (version && this.moduleEntryVersionCache.has(specifier)) {
+            const versions = this.moduleEntryVersionCache.get(specifier);
+            if (versions.has(version)) {
+                return versions.get(version);
+            }
+        }
+        const moduleEntry = await resolveNpmModuleSpecifierDeprecated(specifier, this.webModulesCacheDir, this.providerConfig);
+        if (!moduleEntry) {
+            return;
+        }
+        // Store in cache
+        let specifierVersions = this.moduleEntryVersionCache.get(specifier);
+        if (!specifierVersions) {
+            specifierVersions = new Map();
+            this.moduleEntryVersionCache.set(specifier, specifierVersions);
+        }
+        specifierVersions.set(moduleEntry.version, moduleEntry);
+        return moduleEntry;
+    }
+}
+//# sourceMappingURL=index.js.map

package/build/es/resolveNpmModules.d.ts

@@ -0,0 +1,5 @@
+import type { FsModuleEntry } from '@lwrjs/types';
+import type { LegacyNpmModuleProviderConfig } from './index';
+export declare function resolveNpmModuleSpecifierBlock(specifier: string, dest: string, config: LegacyNpmModuleProviderConfig): Promise<FsModuleEntry | undefined>;
+export declare function resolveNpmModuleSpecifierDeprecated(specifier: string, dest: string, config: LegacyNpmModuleProviderConfig): Promise<FsModuleEntry | undefined>;
+//# sourceMappingURL=resolveNpmModules.d.ts.map

package/build/es/resolveNpmModules.js

@@ -0,0 +1,127 @@
+/* istanbul ignore file */
+import { dirname, join } from 'path';
+import { install } from 'esinstall';
+import { readFileSync, copyFileSync, mkdirSync, existsSync, writeFileSync } from 'fs';
+import resolve from 'resolve';
+import { logger } from '@lwrjs/shared-utils';
+function getPkgVersion(specifier) {
+    const pkgPath = resolve.sync(join(specifier, '/package.json'));
+    return JSON.parse(readFileSync(pkgPath, 'utf-8')).version;
+}
+function readModuleMapping(moduleMappingPath) {
+    return existsSync(moduleMappingPath)
+        ? JSON.parse(readFileSync(moduleMappingPath, 'utf-8'))
+        : { imports: {} };
+}
+function writeModuleMapping(loc, importMap) {
+    writeFileSync(loc, JSON.stringify(importMap, undefined, 2), { encoding: 'utf-8' });
+}
+export async function resolveNpmModuleSpecifierBlock(specifier, dest, config) {
+    try {
+        // TODO: file an issue on snowpack so they don't wipe the folder every-time
+        // in the mean time we have to do hackery that will be likely to break when upgrading
+        const tmpFolder = join(dest, '__tmp', specifier.replace(/[/|@]/g, '_'));
+        mkdirSync(tmpFolder, { recursive: true });
+        const moduleMappingPath = join(dest, 'import-map-cache.json');
+        const currentModuleMapping = readModuleMapping(moduleMappingPath);
+        const version = getPkgVersion(specifier);
+        const cacheKey = `${specifier}@${version}`;
+        if (currentModuleMapping.imports[cacheKey]) {
+            return {
+                id: cacheKey,
+                specifier,
+                entry: currentModuleMapping.imports[cacheKey],
+                version,
+            };
+        }
+        const external = config.external?.filter((e) => e !== specifier) || [];
+        const polyfillNode = config.polyfillNode ?? true;
+        // Unfortunately esinstall APIs its  not very programatic instead its file oriented...
+        await install([specifier], {
+            dest: tmpFolder,
+            importMap: currentModuleMapping,
+            logger: {
+                debug: () => void 0,
+                log: () => void 0,
+                warn: () => void 0,
+                error: () => void 0,
+            },
+            polyfillNode,
+            external,
+        });
+        // esinstall produces a new module mapping, read it to get the generated file
+        const moduleMapping = readModuleMapping(join(tmpFolder, 'import-map.json'));
+        const moduleRelativePath = moduleMapping.imports[specifier];
+        const moduleAbsPath = join(tmpFolder, moduleRelativePath);
+        const moduleEntry = join(dest, moduleRelativePath);
+        // create module's namespaced dir if it's namespaced, i.e.
+        // no namespace: 'utils' -> web_modules/utils.js
+        // namespace: '@mynamespace/utils' -> web_modules/@mynamespace/utils.js
+        mkdirSync(dirname(moduleEntry), { recursive: true });
+        // copy from _tmp to main folder and update the importMap for caching
+        copyFileSync(moduleAbsPath, moduleEntry);
+        const mergedMapping = {
+            imports: {
+                ...currentModuleMapping.imports,
+                [cacheKey]: moduleEntry,
+            },
+        };
+        writeModuleMapping(moduleMappingPath, mergedMapping);
+        return {
+            id: cacheKey,
+            entry: moduleEntry,
+            specifier,
+            version,
+        };
+    }
+    catch (err) {
+        logger.error(`[npm-module-provider][esintsall] resolveNpmModules: ${specifier} ${dest}`, { err });
+    }
+}
+class Queue {
+    constructor() {
+        this.queue = [];
+        this.workingOnPromise = false;
+        this.pendingPromise = false;
+    }
+    enqueue(promise) {
+        return new Promise((resolve, reject) => {
+            this.queue.push({ promise, resolve, reject });
+            this.dequeue();
+        });
+    }
+    dequeue() {
+        if (this.workingOnPromise) {
+            return false;
+        }
+        const item = this.queue.shift();
+        if (!item) {
+            return false;
+        }
+        this.workingOnPromise = true;
+        try {
+            item.promise()
+                .then((value) => {
+                this.workingOnPromise = false;
+                item.resolve(value);
+                this.dequeue();
+            })
+                .catch((err) => {
+                this.workingOnPromise = false;
+                item.reject(err);
+                this.dequeue();
+            });
+        }
+        catch (err) {
+            this.workingOnPromise = false;
+            item.reject(err);
+            this.dequeue();
+        }
+        return true;
+    }
+}
+const RESOLVER_QUEUE = new Queue();
+export async function resolveNpmModuleSpecifierDeprecated(specifier, dest, config) {
+    return RESOLVER_QUEUE.enqueue(resolveNpmModuleSpecifierBlock.bind(null, specifier, dest, config));
+}
+//# sourceMappingURL=resolveNpmModules.js.map

package/package.json

@@ -0,0 +1,55 @@
+{
+    "name": "@lwrjs/legacy-npm-module-provider",
+    "description": "DEPRECATED: This package provides our legacy npm-module-provider functionality. Use at your own risk.",
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    },
+    "version": "0.10.8",
+    "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr.git",
+        "directory": "packages/@lwrjs/legacy-npm-module-provider"
+    },
+    "bugs": {
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr/issues"
+    },
+    "type": "module",
+    "types": "build/es/index.d.ts",
+    "main": "build/cjs/index.cjs",
+    "module": "build/es/index.js",
+    "exports": {
+        ".": {
+            "import": "./build/es/index.js",
+            "require": "./build/cjs/index.cjs"
+        }
+    },
+    "files": [
+        "build/**/*.js",
+        "build/**/*.cjs",
+        "build/**/*.d.ts"
+    ],
+    "scripts": {
+        "build": "tsc -b",
+        "clean": "rm -rf build node_modules",
+        "test": "jest"
+    },
+    "devDependencies": {
+        "@lwrjs/types": "0.10.8",
+        "jest": "^26.6.3",
+        "ts-jest": "^26.5.6",
+        "typescript": "^4.9.5"
+    },
+    "dependencies": {
+        "@lwrjs/shared-utils": "0.10.8",
+        "esinstall": "^1.1.7"
+    },
+    "engines": {
+        "node": ">=16.0.0"
+    },
+    "volta": {
+        "extends": "../../../package.json"
+    },
+    "gitHead": "2c09d011be6fe83186aa3d1358b2aa9814a02008"
+}