@poppinss/utils 6.4.0-0 → 6.5.0-0

package/README.md

@@ -937,6 +937,16 @@ await Promise.all(
 )
 ```
 
+#### importDefault
+A helper function that assert a lazy import function output to have a `default export`, otherwise raises an exception.
+
+We use dynamic default exports a lot in AdonisJS apps, so extracting the check to a helper function.
+
+```ts
+import { importDefault } from '@poppinss/utils'
+const defaultVal = await importDefault(() => import('./some_module.js'))
+```
+
 #### naturalSort
 
 A sorting function to use natural sort for ordering an array.

package/build/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 export { base64 } from './src/base64.js';
 export { compose } from './src/compose.js';
+export { importDefault } from './src/import_default.js';
 export { defineStaticProperty } from './src/define_static_property.js';
 export { Exception, createError } from './src/exception.js';
 export { flatten } from './src/flatten.js';

package/build/index.js

@@ -2,6 +2,7 @@ import { fileURLToPath } from 'node:url';
 import { dirname as pathDirname } from 'node:path';
 export { base64 } from './src/base64.js';
 export { compose } from './src/compose.js';
+export { importDefault } from './src/import_default.js';
 export { defineStaticProperty } from './src/define_static_property.js';
 export { Exception, createError } from './src/exception.js';
 export { flatten } from './src/flatten.js';

package/build/src/import_default.d.ts

@@ -0,0 +1,3 @@
+export declare function importDefault<T extends object>(importFn: () => Promise<T>, filePath?: string): Promise<T extends {
+    default: infer A;
+} ? A : never>;

package/build/src/import_default.js

@@ -0,0 +1,15 @@
+import { RuntimeException } from './exceptions/runtime_exception.js';
+export async function importDefault(importFn, filePath) {
+    const moduleExports = await importFn();
+    if (!('default' in moduleExports)) {
+        const errorMessage = filePath
+            ? `Missing "export default" in module "${filePath}"`
+            : `Missing "export default" from lazy import "${importFn}"`;
+        throw new RuntimeException(errorMessage, {
+            cause: {
+                source: importFn,
+            },
+        });
+    }
+    return moduleExports.default;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poppinss/utils",
-  "version": "6.4.0-0",
+  "version": "6.5.0-0",
   "description": "Handy utilities for repetitive work",
   "main": "build/index.js",
   "type": "module",
@@ -61,7 +61,7 @@
     "@japa/run-failed-tests": "^1.1.0",
     "@japa/runner": "^2.2.2",
     "@japa/spec-reporter": "^1.3.2",
-    "@swc/core": "^1.3.27",
+    "@swc/core": "^1.3.29",
     "@types/fs-extra": "^11.0.1",
     "@types/node": "^18.11.18",
     "c8": "^7.12.0",