static-file-mapper-build 0.3.0

package/README.md

@@ -0,0 +1,3 @@
+# Static File Mapper 
+
+Helps with managing static files for frontend deployments during deployments.

package/dist/src/staticFileMapperBuild.d.ts

@@ -0,0 +1,50 @@
+import { StaticFileMapper } from 'static-file-mapper';
+export interface StaticFileMapping {
+    name: string;
+    generatedName: string;
+}
+export declare type MappingStore = StaticFileMapping[];
+/**
+ * Allows defining static file mappings during build.
+ */
+export interface StaticFileMapperManager extends StaticFileMapper {
+    put({ name, generatedName, content, }: {
+        name: string;
+        generatedName: string;
+        content: string;
+    }): Promise<void>;
+    remove({ name }: {
+        name: string;
+    }): Promise<void>;
+    reset(): Promise<void>;
+    resolve({ name }: {
+        name: string;
+    }): Promise<string>;
+}
+export declare class StaticFileMapperBuild implements StaticFileMapperManager {
+    private dir;
+    private storePath;
+    private createContentHash;
+    private readStore;
+    private writeStore;
+    put({ name, generatedName, content, }: {
+        name: string;
+        generatedName: string;
+        content: string;
+    }): Promise<void>;
+    remove({ name }: {
+        name: string;
+    }): Promise<void>;
+    resolve({ name }: {
+        name: string;
+    }): Promise<string>;
+    has({ name }: {
+        name: string;
+    }): Promise<boolean>;
+    reset(): Promise<void>;
+    constructor({ dir, storePath }: {
+        dir: string;
+        storePath: string;
+    });
+}
+//# sourceMappingURL=staticFileMapperBuild.d.ts.map

package/dist/src/staticFileMapperBuild.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticFileMapperBuild.d.ts","sourceRoot":"","sources":["../../src/staticFileMapperBuild.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;CACvB;AAID,oBAAY,YAAY,GAAG,iBAAiB,EAAE,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,GAAG,CAAC,EACF,IAAI,EACJ,aAAa,EACb,OAAO,GACR,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACtD;AAED,qBAAa,qBAAsB,YAAW,uBAAuB;IACnE,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAS;IAE1B,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,UAAU;IAOL,GAAG,CAAC,EACf,IAAI,EACJ,aAAa,EACb,OAAO,GACR,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoCJ,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAejD,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAUpD,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAQjD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;gBAKvB,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;CAInE"}

package/dist/src/staticFileMapperBuild.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticFileMapperBuild = void 0;
+const utils_sh_1 = require("@goldstack/utils-sh");
+const path_1 = require("path");
+const crypto_1 = require("crypto");
+class StaticFileMapperBuild {
+    constructor({ dir, storePath }) {
+        this.dir = dir;
+        this.storePath = storePath;
+    }
+    createContentHash(content) {
+        const hash = (0, crypto_1.createHash)('md5').update(content).digest('hex');
+        return hash;
+    }
+    readStore() {
+        if (this.storePath) {
+            return JSON.parse((0, utils_sh_1.read)(this.storePath));
+        }
+        throw new Error('Cannot read static file mapper store');
+    }
+    writeStore(store) {
+        if (!this.storePath) {
+            throw new Error('Cannot write static file mapper store');
+        }
+        (0, utils_sh_1.write)(JSON.stringify(store, null, 2), this.storePath);
+    }
+    async put({ name, generatedName, content, }) {
+        let hashedName = generatedName;
+        if (hashedName.indexOf('[hash]') !== -1) {
+            const hash = this.createContentHash(content);
+            hashedName = hashedName.replace('[hash]', hash);
+        }
+        const path = `${this.dir}/${hashedName}`;
+        (0, utils_sh_1.mkdir)('-p', (0, path_1.dirname)(path));
+        (0, utils_sh_1.write)(content, path);
+        const store = this.readStore();
+        let found = false;
+        store.map((mapping) => {
+            if (mapping.name === name) {
+                // clear out replaced file locally
+                // should still continue to exist in S3
+                // bucket
+                if (mapping.generatedName !== hashedName) {
+                    (0, utils_sh_1.rm)('-f', `${this.dir}/${mapping.generatedName}`);
+                    mapping.generatedName = hashedName;
+                }
+                found = true;
+            }
+        });
+        if (!found) {
+            store.push({
+                name,
+                generatedName: hashedName,
+            });
+        }
+        this.writeStore(store);
+    }
+    async remove({ name }) {
+        let store = this.readStore();
+        const element = store.find((el) => el.name === name);
+        if (element) {
+            // clear out removed file locally
+            // should still continue to exist in S3
+            // bucket
+            (0, utils_sh_1.rm)('-f', `${this.dir}/${element.generatedName}`);
+        }
+        store = store.filter((el) => {
+            return el.name !== name;
+        });
+        this.writeStore(store);
+    }
+    async resolve({ name }) {
+        const store = this.readStore();
+        const mapping = store.find((mapping) => mapping.name === name);
+        if (!mapping) {
+            throw new Error(`Cannot find static file mapping for ${name}`);
+        }
+        return mapping.generatedName;
+    }
+    async has({ name }) {
+        const store = this.readStore();
+        const mapping = store.find((mapping) => mapping.name === name);
+        return !!mapping;
+    }
+    async reset() {
+        this.writeStore([]);
+        await (0, utils_sh_1.rmSafe)(this.dir);
+    }
+}
+exports.StaticFileMapperBuild = StaticFileMapperBuild;
+//# sourceMappingURL=staticFileMapperBuild.js.map

package/dist/src/staticFileMapperBuild.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staticFileMapperBuild.js","sourceRoot":"","sources":["../../src/staticFileMapperBuild.ts"],"names":[],"mappings":";;;AAAA,kDAAqE;AACrE,+BAA+B;AAO/B,mCAAoC;AAsBpC,MAAa,qBAAqB;IAyGhC,YAAY,EAAE,GAAG,EAAE,SAAS,EAAsC;QAChE,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAxGO,iBAAiB,CAAC,OAAe;QACvC,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,SAAS;QACf,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAA,eAAI,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;SACzC;QACD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IAEO,UAAU,CAAC,KAAmB;QACpC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC1D;QACD,IAAA,gBAAK,EAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,EACf,IAAI,EACJ,aAAa,EACb,OAAO,GAKR;QACC,IAAI,UAAU,GAAG,aAAa,CAAC;QAE/B,IAAI,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC7C,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACjD;QACD,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,UAAU,EAAE,CAAC;QAEzC,IAAA,gBAAK,EAAC,IAAI,EAAE,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC;QAC3B,IAAA,gBAAK,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAErB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAE/B,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACpB,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE;gBACzB,kCAAkC;gBAClC,uCAAuC;gBACvC,SAAS;gBACT,IAAI,OAAO,CAAC,aAAa,KAAK,UAAU,EAAE;oBACxC,IAAA,aAAE,EAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;oBACjD,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC;iBACpC;gBACD,KAAK,GAAG,IAAI,CAAC;aACd;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,CAAC,IAAI,CAAC;gBACT,IAAI;gBACJ,aAAa,EAAE,UAAU;aAC1B,CAAC,CAAC;SACJ;QACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAoB;QAC5C,IAAI,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACrD,IAAI,OAAO,EAAE;YACX,iCAAiC;YACjC,uCAAuC;YACvC,SAAS;YACT,IAAA,aAAE,EAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;SAClD;QACD,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;YAC1B,OAAO,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC;QAC1B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,OAAO,CAAC,EAAE,IAAI,EAAoB;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAE/B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,uCAAuC,IAAI,EAAE,CAAC,CAAC;SAChE;QACD,OAAO,OAAO,CAAC,aAAa,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,EAAoB;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QAE/B,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAE/D,OAAO,CAAC,CAAC,OAAO,CAAC;IACnB,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACpB,MAAM,IAAA,iBAAM,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;CAMF;AA7GD,sDA6GC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "static-file-mapper-build",
+  "version": "0.3.0",
+  "description": "Helps tracking path to generated static files for deployment bundles",
+  "keywords": [
+    "javascript"
+  ],
+  "homepage": "https://goldstack.party",
+  "bugs": {
+    "url": "https://github.com/goldstack/goldstack/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goldstack/goldstack.git"
+  },
+  "license": "MIT",
+  "author": "Max Rohde",
+  "sideEffects": false,
+  "main": "dist/src/staticFileMapperBuild.js",
+  "scripts": {
+    "build": "yarn clean && yarn compile",
+    "build:watch": "yarn clean && yarn compile-watch",
+    "clean": "rimraf ./dist",
+    "compile": "tsc -p tsconfig.json",
+    "compile-watch": "tsc -p tsconfig.json --watch",
+    "compile-watch:light": "nodemon --watch ./src/ -e '*' --exec 'yarn compile'",
+    "coverage": "jest --collect-coverage --passWithNoTests --config=./jest.config.js --runInBand",
+    "prepublishOnly": "yarn run build",
+    "publish": "utils-git changed --exec \"yarn npm publish $@\"",
+    "test-ci": "jest --passWithNoTests --config=./jest.config.js --runInBand",
+    "version:apply": "utils-git changed --exec \"yarn version $@ && yarn version apply\""
+  },
+  "dependencies": {
+    "@goldstack/utils-sh": "0.5.0",
+    "static-file-mapper": "0.3.0"
+  },
+  "devDependencies": {
+    "@goldstack/utils-git": "0.2.0",
+    "@types/aws-lambda": "^8.10.88",
+    "@types/jest": "^28.1.8",
+    "@types/node": "^18.7.13",
+    "jest": "^28.1.0",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.2",
+    "typescript": "^4.7.4"
+  },
+  "publishConfig": {
+    "main": "dist/src/staticFileMapperBuild.js"
+  }
+}