@lwrjs/shared-utils 0.9.0-alpha.2 → 0.9.0-alpha.21

package/build/es/site-metadata.d.ts

@@ -0,0 +1,27 @@
+import type { SiteAssets, SiteBundles, SiteMetadata, SiteResources } from '@lwrjs/types';
+declare type Options = {
+    rootDir: string;
+};
+export declare class SiteMetadataImpl implements SiteMetadata {
+    private options;
+    private siteBundles;
+    private siteResources;
+    private siteAssets;
+    constructor(options: Options);
+    getSiteRootDir(): string;
+    getSiteBundles(): SiteBundles;
+    getSiteResources(): SiteResources;
+    getSiteAssets(): SiteAssets;
+    persistSiteMetadata(): Promise<void>;
+    private readStaticBundleMetadata;
+    /**
+     * Read the metadata about the pre-built resources of the current site.
+     */
+    private readStaticResourceMetadata;
+    /**
+     * Read the metadata about the pre-built assets of the current site.
+     */
+    private readStaticAssetsMetadata;
+}
+export {};
+//# sourceMappingURL=site-metadata.d.ts.map

package/build/es/site-metadata.js

@@ -0,0 +1,105 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { logger } from './logger.js';
+const SITE_METADATA_PATH = '.metadata';
+const STATIC_BUNDLE_METADATA_PATH = path.join(SITE_METADATA_PATH, '/bundle-metadata.json');
+const STATIC_RESOURCE_METADATA_PATH = path.join(SITE_METADATA_PATH, '/resource-metadata.json');
+const STATIC_ASSET_METADATA_PATH = path.join(SITE_METADATA_PATH, '/asset-metadata.json');
+export class SiteMetadataImpl {
+    constructor(options) {
+        this.options = options;
+        this.siteBundles = this.readStaticBundleMetadata(options.rootDir);
+        this.siteResources = this.readStaticResourceMetadata(options.rootDir);
+        this.siteAssets = this.readStaticAssetsMetadata(options.rootDir);
+    }
+    getSiteRootDir() {
+        return this.options.rootDir;
+    }
+    getSiteBundles() {
+        return this.siteBundles;
+    }
+    getSiteResources() {
+        return this.siteResources;
+    }
+    getSiteAssets() {
+        return this.siteAssets;
+    }
+    async persistSiteMetadata() {
+        // Create the metadata directory if if does not exist
+        const siteMetadataPath = path.join(this.options.rootDir, SITE_METADATA_PATH);
+        if (!(await fs.pathExists(siteMetadataPath))) {
+            await fs.mkdir(siteMetadataPath, { recursive: true });
+        }
+        // Save Bundle Metadata
+        const bundleMetadataPath = path.join(this.options.rootDir, STATIC_BUNDLE_METADATA_PATH);
+        await fs.writeJSON(bundleMetadataPath, this.siteBundles, { spaces: 2 });
+        // Save Resource Metadata
+        const resourceMetadataPath = path.join(this.options.rootDir, STATIC_RESOURCE_METADATA_PATH);
+        await fs.writeJSON(resourceMetadataPath, this.siteResources, { spaces: 2 });
+        // Save Resource Metadata
+        const assetMetadataPath = path.join(this.options.rootDir, STATIC_ASSET_METADATA_PATH);
+        return fs.writeJSON(assetMetadataPath, this.siteAssets, { spaces: 2 });
+    }
+    readStaticBundleMetadata(staticRoot) {
+        let bundleMetadataPath;
+        let siteBundles = { bundles: {} };
+        try {
+            bundleMetadataPath = path.join(staticRoot, STATIC_BUNDLE_METADATA_PATH);
+            const savedMetadata = fs.readJSONSync(bundleMetadataPath);
+            siteBundles = savedMetadata;
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                logger.debug(`[SiteMetadata] Failed to load Static Bundle Metadata: ${bundleMetadataPath}`);
+            }
+            else {
+                throw error;
+            }
+        }
+        return siteBundles;
+    }
+    /**
+     * Read the metadata about the pre-built resources of the current site.
+     */
+    readStaticResourceMetadata(staticRoot) {
+        let resourceMetadataPath;
+        let siteResources = { resources: {} };
+        try {
+            resourceMetadataPath = path.join(staticRoot, STATIC_RESOURCE_METADATA_PATH);
+            const savedMetadata = fs.readJSONSync(resourceMetadataPath);
+            siteResources = savedMetadata;
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                logger.debug(`[SiteMetadata] Failed to load Static Resource Metadata: ${resourceMetadataPath}`);
+            }
+            else {
+                throw error;
+            }
+        }
+        return siteResources;
+    }
+    /**
+     * Read the metadata about the pre-built assets of the current site.
+     */
+    readStaticAssetsMetadata(staticRoot) {
+        let assetMetadataPath;
+        let siteAssets = {
+            assets: {},
+        };
+        try {
+            assetMetadataPath = path.join(staticRoot, STATIC_ASSET_METADATA_PATH);
+            siteAssets = fs.readJSONSync(assetMetadataPath);
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                logger.debug(`[SiteMetadata] Failed to load Static Resource Metadata: ${assetMetadataPath}`);
+            }
+            else {
+                throw error;
+            }
+        }
+        return siteAssets;
+    }
+}
+//# sourceMappingURL=site-metadata.js.map

package/build/es/typescript.js

@@ -1,8 +1,9 @@
 import fs from 'fs';
 import { join, dirname, extname } from 'path';
 import esbuildEsm from 'esbuild';
-// Workaround until this is fixed:
 // https://github.com/evanw/esbuild/issues/706
+// Fixed in 0.11.0 but upgrading past 0.9.7 has caused breaking changes for consumers...
+// https://github.com/salesforce-experience-platform-emu/lwr/issues/1014
 let esbuild = esbuildEsm;
 if (!esbuildEsm) {
     try {

package/package.json

@@ -4,18 +4,18 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.9.0-alpha.2",
+    "version": "0.9.0-alpha.21",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
-        "url": "https://github.com/salesforce/lwr.git",
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr.git",
         "directory": "packages/@lwrjs/shared-utils"
     },
     "scripts": {
         "build": "tsc -b"
     },
     "bugs": {
-        "url": "https://github.com/salesforce/lwr/issues"
+        "url": "https://github.com/salesforce-experience-platform-emu/lwr/issues"
     },
     "type": "module",
     "types": "build/es/index.d.ts",
@@ -25,6 +25,18 @@
         ".": {
             "import": "./build/es/index.js",
             "require": "./build/cjs/index.cjs"
+        },
+        "./fs-watch": {
+            "import": "./build/es/fs-watch.js",
+            "require": "./build/cjs/fs-watch.cjs"
+        },
+        "./typescript": {
+            "import": "./build/es/typescript.js",
+            "require": "./build/cjs/typescript.cjs"
+        },
+        "./compiler": {
+            "import": "./build/es/compiler.js",
+            "require": "./build/cjs/compiler.cjs"
         }
     },
     "files": [
@@ -33,25 +45,29 @@
         "build/**/*.d.ts"
     ],
     "dependencies": {
-        "chokidar": "^3.4.0",
         "es-module-lexer": "^0.3.18",
-        "esbuild": "^0.9.7",
         "fast-json-stable-stringify": "^2.1.0",
         "magic-string": "^0.25.7",
         "mime-types": "^2.1.33",
+        "ms": "^2.1.3",
         "parse5-sax-parser": "^6.0.1",
         "path-to-regexp": "^6.2.0",
-        "slugify": "^1.4.5",
-        "winston": "^3.7.2"
+        "slugify": "^1.4.5"
+    },
+    "peerDependencies": {
+        "@locker/compiler": "0.18.9",
+        "chokidar": "^3.5.3",
+        "esbuild": "^0.9.7",
+        "rollup": "~2.45.2"
     },
     "devDependencies": {
-        "@lwrjs/diagnostics": "0.9.0-alpha.2",
-        "@lwrjs/types": "0.9.0-alpha.2",
+        "@lwrjs/diagnostics": "0.9.0-alpha.21",
+        "@lwrjs/types": "0.9.0-alpha.21",
         "@types/mime-types": "2.1.1",
         "@types/path-to-regexp": "^1.7.0"
     },
     "engines": {
         "node": ">=14.15.4 <19"
     },
-    "gitHead": "bcf63de23d1a2a53fb0e961dba4396e8753710dd"
+    "gitHead": "a89adcac80601f657becd6fd734c765e6b2a2745"
 }