@roots/bud-client 6.14.3 → 6.15.0

package/lib/dom-ready.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Calls once document has loaded.
+ *
+ * @remarks
+ * Callback function may be async or sync
+ *
+ * @param onReady - callback function
+ * @returns void
+ */
+interface domReady {
+    (onReady: () => (() => Promise<unknown>) | unknown): void;
+}
+declare const domReady: domReady;
+export default domReady;

package/lib/dom-ready.js

@@ -0,0 +1,6 @@
+const domReady = onReady => {
+    window.requestAnimationFrame(async function check() {
+        document.body ? await onReady() : window.requestAnimationFrame(check);
+    });
+};
+export default domReady;

package/lib/index.d.ts

@@ -9,4 +9,6 @@
  *
  *  @packageDocumentation
  */
-export {};
+import domReady from '@roots/bud-client/dom-ready';
+import lazy from '@roots/bud-client/lazy';
+export { domReady, lazy };

package/lib/index.js

@@ -11,4 +11,6 @@
  *
  *  @packageDocumentation
  */
-export {};
+import domReady from '@roots/bud-client/dom-ready';
+import lazy from '@roots/bud-client/lazy';
+export { domReady, lazy };

package/lib/lazy.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Lazy import helper
+ *
+ * @remarks
+ * Callback function may be async or sync
+ *
+ * @param onReady - callback function
+ * @returns void
+ */
+interface lazy {
+    <T = any>(module: Promise<{
+        default: T;
+    }>, handler: (module: T) => Promise<unknown> | unknown, errorHandler?: (error: unknown) => unknown): Promise<unknown>;
+}
+declare const lazy: lazy;
+export default lazy;

package/lib/lazy.js

@@ -0,0 +1,19 @@
+/**
+ * Default error handler
+ *
+ * @throws Error
+ */
+const defaultErrorHandler = (error) => {
+    throw error;
+};
+const lazy = async function lazy(module, handler, errorHandler) {
+    try {
+        const { default: request } = await module;
+        return await handler(request);
+    }
+    catch (error) {
+        const handle = errorHandler ? errorHandler : defaultErrorHandler;
+        handle(error);
+    }
+};
+export default lazy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roots/bud-client",
-  "version": "6.14.3",
+  "version": "6.15.0",
   "description": "Client scripts for @roots/bud",
   "engines": {
     "node": ">=16"
@@ -46,6 +46,8 @@
   "type": "module",
   "exports": {
     ".": "./lib/index.js",
+    "./dom-ready": "./lib/dom-ready.js",
+    "./lazy": "./lib/lazy.js",
     "./lib/*": "./lib/*"
   },
   "typesVersions": {
@@ -53,7 +55,13 @@
       ".": [
         "./lib/index.d.ts"
       ],
-      "./lib/*": [
+      "dom-ready": [
+        "./lib/dom-ready.d.ts"
+      ],
+      "lazy": [
+        "./lib/lazy.d.ts"
+      ],
+      "lib/*": [
         "./lib/*"
       ]
     }
@@ -61,9 +69,9 @@
   "types": "./lib/index.d.ts",
   "module": "./lib/index.mjs",
   "devDependencies": {
-    "@roots/bud": "6.14.3",
+    "@roots/bud": "6.15.0",
     "@skypack/package-check": "0.2.2",
-    "@types/node": "18.16.18",
+    "@types/node": "18.16.19",
     "@types/webpack-env": "1.18.1"
   },
   "dependencies": {

package/src/dom-ready.ts

@@ -0,0 +1,20 @@
+/**
+ * Calls once document has loaded.
+ *
+ * @remarks
+ * Callback function may be async or sync
+ *
+ * @param onReady - callback function
+ * @returns void
+ */
+interface domReady {
+  (onReady: () => (() => Promise<unknown>) | unknown): void
+}
+
+const domReady: domReady = onReady => {
+  window.requestAnimationFrame(async function check() {
+    document.body ? await onReady() : window.requestAnimationFrame(check)
+  })
+}
+
+export default domReady

package/src/hot/client.ts

@@ -83,10 +83,11 @@ export const client = async (
    * Webpack HMR error handler
    */
   const onErrored = (error: any) => {
-    window.bud.controllers.map(controller =>
-      controller?.update({
-        errors: [error],
-      }),
+    window.bud.controllers.map(
+      controller =>
+        controller?.update({
+          errors: [error],
+        }),
     )
   }
 

package/src/index.ts

@@ -13,4 +13,7 @@
  *  @packageDocumentation
  */
 
-export {}
+import domReady from '@roots/bud-client/dom-ready'
+import lazy from '@roots/bud-client/lazy'
+
+export {domReady, lazy}

package/src/lazy.ts

@@ -0,0 +1,41 @@
+/**
+ * Lazy import helper
+ *
+ * @remarks
+ * Callback function may be async or sync
+ *
+ * @param onReady - callback function
+ * @returns void
+ */
+interface lazy {
+  <T = any>(
+    module: Promise<{default: T}>,
+    handler: (module: T) => Promise<unknown> | unknown,
+    errorHandler?: (error: unknown) => unknown,
+  ): Promise<unknown>
+}
+
+/**
+ * Default error handler
+ *
+ * @throws Error
+ */
+const defaultErrorHandler = (error: unknown) => {
+  throw error
+}
+
+const lazy: lazy = async function lazy<T = any>(
+  module: Promise<{default: T}>,
+  handler: (module: T) => Promise<unknown> | unknown,
+  errorHandler?: (error: unknown) => unknown,
+) {
+  try {
+    const {default: request} = await module
+    return await handler(request)
+  } catch (error: unknown) {
+    const handle = errorHandler ? errorHandler : defaultErrorHandler
+    handle(error)
+  }
+}
+
+export default lazy