@m2c2kit/build-helpers 0.3.2

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+import { InputOptions } from 'rollup';
+
+/**
+ * rollup plugin to hash m2c2kit assets and enable cache busting.
+ *
+ * @remarks On repeated deployments, a file with the same name may be
+ * cached by browsers. Thus, the old file will be used, not the updated
+ * one. To enable cache busting, this rollup plugin adds hashes to filenames
+ * for m2c2kit assets: index.js, canvaskit.wasm, images, and fonts. This is
+ * done by: 1) parsing index.html and finding the links to css and index.js,
+ * calculating a hash of these assets, adding a hash to the asset filenames,
+ * and updating the links in index.html to reflect the hash. 2) parsing
+ * index.js into an AST, finding string literals that are the urls of fonts,
+ * images, and canvaskit.wam, calculating a hash of these assets, adding a
+ * hash to the asset filenames, and updating the urls to reflect the hash.
+ *
+ * Note: index.js is transpiled from TypeScript and no longer has types, so
+ * finding the asset urls in the AST assumes that there will be no
+ * user code with the same structure as the asset urls. In other words:
+ * Don't use a define a property named "canvasKitWasmUrl" that refers to
+ * a string literal, don't define a property named "fontUrls" that refers
+ * to an array expression of string literals, and don't define a property
+ * called "images" that refers to an array expression of object expressions
+ * with properties named "imageName", "height", "width", and "url". Otherwise,
+ * this plugin may alter your code in unexpected ways (although most likely
+ * it will simply give warnings, because it's unlikely there will be valid
+ * file assets that will be found and hashed).
+ *
+ * @param rootDir - root directory of build, usually "dist" because you
+ * usually hash only production builds
+ * @returns
+ */
+declare function hashM2c2kitAssets(rootDir: string): {
+    name: string;
+    closeBundle: {
+        sequential: boolean;
+        handler(): Promise<void>;
+    };
+};
+
+declare function makeM2c2kitServiceWorker(rootDir: string, additionalFiles?: Array<string>): {
+    name: string;
+    buildStart: {
+        handler(options: InputOptions): void;
+    };
+    transform: {
+        handler(code: string, id: any): string;
+    };
+    closeBundle: {
+        sequential: boolean;
+        handler(): Promise<void>;
+    };
+};
+
+export { hashM2c2kitAssets, makeM2c2kitServiceWorker };