@poppinss/utils 6.3.1-0 → 6.5.0-0

package/README.md

@@ -556,6 +556,17 @@ string.bytes.format(1024 * 1024 * 1000) // 1000MB
 string.bytes.format(1024 * 1024 * 1000, { thousandsSeparator: ',' }) // 1,000MB
 ```
 
+### String builder
+The string builder offers a fluent API for applying a set of transforms on a string value. You can create an instance of the string builder as follows.
+
+```ts
+import StringBuilder from '@poppinss/utils/string_builder'
+const builder = new StringBuilder('hello world')
+
+const value = builder.snakeCase().suffix('_controller').toString()
+assert(value === 'hello_world_controller')
+```
+
 ### JSON helpers
 
 Following are the helpers we use to `stringify` and `parse` JSON.
@@ -772,6 +783,7 @@ throw new ResourceNotFound()
 ```
 
 #### Anonymous error classes
+
 You can also create an anonymous exception class using the `createError` method. The return value is a class
 constructor that accepts an array of values to use for interpolation.
 
@@ -779,7 +791,10 @@ The interpolation of error message is performed using the `util.format` message.
 
 ```ts
 import { createError } from '@poppinss/utils'
-const E_RESOURCE_NOT_FOUND = createError('Unable to find resource with id %d', 'E_RESOURCE_NOT_FOUND')
+const E_RESOURCE_NOT_FOUND = createError(
+  'Unable to find resource with id %d',
+  'E_RESOURCE_NOT_FOUND'
+)
 
 const id = 1
 throw new E_RESOURCE_NOT_FOUND([id])
@@ -922,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.
@@ -1039,9 +1064,7 @@ Instead of writing conditionals, you can consider using the Object builder fluen
 ```ts
 const builder = new ObjectBuilder({ a: 1 })
 
-const plainObject = builder
-  .add('b', b)
-  .toObject()
+const plainObject = builder.add('b', b).toObject()
 ```
 
 By default, only the `undefined` values are ignored. However, you can also ignore `null` values.

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/build/src/string_builder.d.ts

@@ -0,0 +1,23 @@
+export default class StringBuilder {
+    #private;
+    constructor(value: string | StringBuilder);
+    dashCase(): this;
+    dotCase(): this;
+    snakeCase(): this;
+    pascalCase(): this;
+    camelCase(): this;
+    capitalCase(): this;
+    titleCase(): this;
+    sentenceCase(): this;
+    noCase(): this;
+    plural(): this;
+    singular(): this;
+    slugify(): this;
+    removeSuffix(suffix: string): this;
+    suffix(suffix: string): this;
+    removePrefix(prefix: string): this;
+    prefix(prefix: string): this;
+    removeExtension(): this;
+    ext(extension: string): this;
+    toString(): string;
+}

package/build/src/string_builder.js

@@ -0,0 +1,86 @@
+import { extname } from 'node:path';
+import string from './string/main.js';
+export default class StringBuilder {
+    #value;
+    constructor(value) {
+        this.#value = typeof value === 'string' ? value : value.toString();
+    }
+    dashCase() {
+        this.#value = string.dashCase(this.#value);
+        return this;
+    }
+    dotCase() {
+        this.#value = string.dotCase(this.#value);
+        return this;
+    }
+    snakeCase() {
+        this.#value = string.snakeCase(this.#value);
+        return this;
+    }
+    pascalCase() {
+        this.#value = string.pascalCase(this.#value);
+        return this;
+    }
+    camelCase() {
+        this.#value = string.camelCase(this.#value);
+        return this;
+    }
+    capitalCase() {
+        this.#value = string.capitalCase(this.#value);
+        return this;
+    }
+    titleCase() {
+        this.#value = string.titleCase(this.#value);
+        return this;
+    }
+    sentenceCase() {
+        this.#value = string.sentenceCase(this.#value);
+        return this;
+    }
+    noCase() {
+        this.#value = string.noCase(this.#value);
+        return this;
+    }
+    plural() {
+        this.#value = string.pluralize(this.#value);
+        return this;
+    }
+    singular() {
+        this.#value = string.singular(this.#value);
+        return this;
+    }
+    slugify() {
+        this.#value = string.slug(this.#value);
+        return this;
+    }
+    removeSuffix(suffix) {
+        this.#value = this.#value.replace(new RegExp(`[-_]?${suffix}$`, 'i'), '');
+        return this;
+    }
+    suffix(suffix) {
+        this.removeSuffix(suffix);
+        this.#value = `${this.#value}${suffix}`;
+        return this;
+    }
+    removePrefix(prefix) {
+        this.#value = this.#value.replace(new RegExp(`^${prefix}[-_]?`, 'i'), '');
+        return this;
+    }
+    prefix(prefix) {
+        this.removePrefix(prefix);
+        this.#value = `${prefix}${this.#value}`;
+        return this;
+    }
+    removeExtension() {
+        this.#value = this.#value.replace(new RegExp(`${extname(this.#value)}$`), '');
+        return this;
+    }
+    ext(extension) {
+        this.removeExtension();
+        this.#value = `${this.#value}.${extension.replace(/^\./, '')}`;
+        return this;
+    }
+    toString() {
+        return this.#value;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poppinss/utils",
-  "version": "6.3.1-0",
+  "version": "6.5.0-0",
   "description": "Handy utilities for repetitive work",
   "main": "build/index.js",
   "type": "module",
@@ -18,6 +18,7 @@
       "node": "./build/lodash/main.cjs"
     },
     "./string": "./build/src/string/main.js",
+    "./string_builder": "./build/src/string_builder.js",
     "./json": "./build/src/json/main.js",
     "./types": "./build/src/types.js"
   },
@@ -53,30 +54,30 @@
   "author": "virk,poppinss",
   "license": "MIT",
   "devDependencies": {
-    "@commitlint/cli": "^17.3.0",
-    "@commitlint/config-conventional": "^17.3.0",
+    "@commitlint/cli": "^17.4.2",
+    "@commitlint/config-conventional": "^17.4.2",
     "@japa/assert": "^1.3.6",
     "@japa/expect-type": "^1.0.2",
     "@japa/run-failed-tests": "^1.1.0",
     "@japa/runner": "^2.2.2",
     "@japa/spec-reporter": "^1.3.2",
-    "@swc/core": "^1.3.24",
-    "@types/fs-extra": "^9.0.13",
+    "@swc/core": "^1.3.29",
+    "@types/fs-extra": "^11.0.1",
     "@types/node": "^18.11.18",
     "c8": "^7.12.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.30.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-adonis": "^3.0.3",
     "eslint-plugin-prettier": "^4.2.1",
     "fs-extra": "^11.1.0",
     "github-label-sync": "^2.2.0",
-    "husky": "^8.0.1",
+    "husky": "^8.0.3",
     "lodash": "^4.17.21",
     "lodash-cli": "^4.17.5",
     "move-file-cli": "^3.0.0",
     "np": "^7.6.3",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.3",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4"
   },
@@ -89,7 +90,7 @@
     "flattie": "^1.1.0",
     "pluralize": "^8.0.0",
     "safe-stable-stringify": "^2.4.2",
-    "secure-json-parse": "^2.6.0",
+    "secure-json-parse": "^2.7.0",
     "slash": "^5.0.0",
     "slugify": "^1.6.5",
     "truncatise": "^0.0.8"