@poppinss/utils 6.5.0-3 → 6.5.0-4

package/build/src/string_builder.d.ts

@@ -1,23 +1,82 @@
-export default class StringBuilder {
+/**
+ * String builder to transform the string using the fluent API
+ */
+declare class StringBuilder {
     #private;
     constructor(value: string | StringBuilder);
+    /**
+     * Applies dash case transformation
+     */
     dashCase(): this;
+    /**
+     * Applies dot case transformation
+     */
     dotCase(): this;
+    /**
+     * Applies snake case transformation
+     */
     snakeCase(): this;
+    /**
+     * Applies pascal case transformation
+     */
     pascalCase(): this;
+    /**
+     * Applies camelcase case transformation
+     */
     camelCase(): this;
+    /**
+     * Applies capital case transformation
+     */
     capitalCase(): this;
+    /**
+     * Applies title case transformation
+     */
     titleCase(): this;
+    /**
+     * Applies sentence case transformation
+     */
     sentenceCase(): this;
+    /**
+     * Removes all sorts of casing from the string
+     */
     noCase(): this;
+    /**
+     * Converts value to its plural form
+     */
     plural(): this;
+    /**
+     * Converts value to its singular form
+     */
     singular(): this;
+    /**
+     * Converts value to a URL friendly slug
+     */
     slugify(): this;
+    /**
+     * Removes a given suffix from the string
+     */
     removeSuffix(suffix: string): this;
+    /**
+     * Adds suffix to the string
+     */
     suffix(suffix: string): this;
+    /**
+     * Removes a given prefix from the string
+     */
     removePrefix(prefix: string): this;
+    /**
+     * Adds prefix to the string
+     */
     prefix(prefix: string): this;
+    /**
+     * Removes extension from the value
+     */
     removeExtension(): this;
+    /**
+     * Adds extension to the value
+     */
     ext(extension: string): this;
     toString(): string;
 }
+
+export { StringBuilder as default };

package/build/src/string_builder.js

@@ -1,86 +1,148 @@
-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;
-    }
-}
+import {
+  main_default
+} from "../chunk-OKRMWJO4.js";
+import "../chunk-PWRXO3NF.js";
+
+// src/string_builder.ts
+import { extname } from "node:path";
+var StringBuilder = class {
+  #value;
+  constructor(value) {
+    this.#value = typeof value === "string" ? value : value.toString();
+  }
+  /**
+   * Applies dash case transformation
+   */
+  dashCase() {
+    this.#value = main_default.dashCase(this.#value);
+    return this;
+  }
+  /**
+   * Applies dot case transformation
+   */
+  dotCase() {
+    this.#value = main_default.dotCase(this.#value);
+    return this;
+  }
+  /**
+   * Applies snake case transformation
+   */
+  snakeCase() {
+    this.#value = main_default.snakeCase(this.#value);
+    return this;
+  }
+  /**
+   * Applies pascal case transformation
+   */
+  pascalCase() {
+    this.#value = main_default.pascalCase(this.#value);
+    return this;
+  }
+  /**
+   * Applies camelcase case transformation
+   */
+  camelCase() {
+    this.#value = main_default.camelCase(this.#value);
+    return this;
+  }
+  /**
+   * Applies capital case transformation
+   */
+  capitalCase() {
+    this.#value = main_default.capitalCase(this.#value);
+    return this;
+  }
+  /**
+   * Applies title case transformation
+   */
+  titleCase() {
+    this.#value = main_default.titleCase(this.#value);
+    return this;
+  }
+  /**
+   * Applies sentence case transformation
+   */
+  sentenceCase() {
+    this.#value = main_default.sentenceCase(this.#value);
+    return this;
+  }
+  /**
+   * Removes all sorts of casing from the string
+   */
+  noCase() {
+    this.#value = main_default.noCase(this.#value);
+    return this;
+  }
+  /**
+   * Converts value to its plural form
+   */
+  plural() {
+    this.#value = main_default.pluralize(this.#value);
+    return this;
+  }
+  /**
+   * Converts value to its singular form
+   */
+  singular() {
+    this.#value = main_default.singular(this.#value);
+    return this;
+  }
+  /**
+   * Converts value to a URL friendly slug
+   */
+  slugify() {
+    this.#value = main_default.slug(this.#value);
+    return this;
+  }
+  /**
+   * Removes a given suffix from the string
+   */
+  removeSuffix(suffix) {
+    this.#value = this.#value.replace(new RegExp(`[-_]?${suffix}$`, "i"), "");
+    return this;
+  }
+  /**
+   * Adds suffix to the string
+   */
+  suffix(suffix) {
+    this.removeSuffix(suffix);
+    this.#value = `${this.#value}${suffix}`;
+    return this;
+  }
+  /**
+   * Removes a given prefix from the string
+   */
+  removePrefix(prefix) {
+    this.#value = this.#value.replace(new RegExp(`^${prefix}[-_]?`, "i"), "");
+    return this;
+  }
+  /**
+   * Adds prefix to the string
+   */
+  prefix(prefix) {
+    this.removePrefix(prefix);
+    this.#value = `${prefix}${this.#value}`;
+    return this;
+  }
+  /**
+   * Removes extension from the value
+   */
+  removeExtension() {
+    this.#value = this.#value.replace(new RegExp(`${extname(this.#value)}$`), "");
+    return this;
+  }
+  /**
+   * Adds extension to the value
+   */
+  ext(extension) {
+    this.removeExtension();
+    this.#value = `${this.#value}.${extension.replace(/^\./, "")}`;
+    return this;
+  }
+  toString() {
+    return this.#value;
+  }
+};
+export {
+  StringBuilder as default
+};

package/build/src/types.d.ts

@@ -1,22 +1,32 @@
 type PickKeysByValue<T, V> = {
     [K in keyof T]: T[K] extends V ? K : never;
 }[keyof T];
-export type OmitProperties<T, P> = Omit<T, PickKeysByValue<T, P>>;
+type OmitProperties<T, P> = Omit<T, PickKeysByValue<T, P>>;
 type ScanFsBaseOptions = {
     ignoreMissingRoot?: boolean;
     filter?: (filePath: string, index: number) => boolean;
     sort?: (current: string, next: string) => number;
 };
-export type ImportAllFilesOptions = ScanFsBaseOptions & {
+type ImportAllFilesOptions = ScanFsBaseOptions & {
+    /**
+     * A custom method to transform collection keys
+     */
     transformKeys?: (keys: string[]) => string[];
 };
-export type ReadAllFilesOptions = ScanFsBaseOptions & {
+type ReadAllFilesOptions = ScanFsBaseOptions & {
     pathType?: 'relative' | 'unixRelative' | 'absolute' | 'unixAbsolute' | 'url';
 };
-export type JSONReplacer = (this: any, key: string, value: any) => any;
-export type JSONReviver = (this: any, key: string, value: any) => any;
-export type Constructor = new (...args: any[]) => any;
-export type NormalizeConstructor<T extends Constructor> = {
+type JSONReplacer = (this: any, key: string, value: any) => any;
+type JSONReviver = (this: any, key: string, value: any) => any;
+type Constructor = new (...args: any[]) => any;
+/**
+ * Normalizes constructor to work with mixins. There is an open bug for mixins
+ * to allow constructors other than `...args: any[]`
+ *
+ * https://github.com/microsoft/TypeScript/issues/37142
+ */
+type NormalizeConstructor<T extends Constructor> = {
     new (...args: any[]): InstanceType<T>;
 } & Omit<T, 'constructor'>;
-export {};
+
+export { Constructor, ImportAllFilesOptions, JSONReplacer, JSONReviver, NormalizeConstructor, OmitProperties, ReadAllFilesOptions };

package/build/src/types.js

@@ -1 +0,0 @@
-export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poppinss/utils",
-  "version": "6.5.0-3",
+  "version": "6.5.0-4",
   "description": "Handy utilities for repetitive work",
   "main": "build/index.js",
   "type": "module",
@@ -32,11 +32,11 @@
     "quick:test": "node --loader=ts-node/esm bin/test.ts",
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
-    "compile": "npm run lint && npm run clean && tsc",
+    "compile": "npm run lint && npm run clean && tsup-node",
     "build": "npm run compile && npm run build:lodash",
     "release": "np",
     "version": "npm run build",
-    "prepublishOnly": "npm run build && cd build && node bin/test.js",
+    "prepublishOnly": "npm run build",
     "lint": "eslint . --ext=.ts",
     "format": "prettier --write .",
     "sync-labels": "github-label-sync --labels .github/labels.json poppinss/utils"
@@ -61,7 +61,7 @@
     "@types/node": "^20.3.2",
     "c8": "^8.0.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.43.0",
+    "eslint": "^8.45.0",
     "fs-extra": "^11.1.1",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
@@ -69,14 +69,15 @@
     "lodash-cli": "^4.17.5",
     "move-file-cli": "^3.0.0",
     "np": "^8.0.4",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.0",
     "ts-node": "^10.9.1",
+    "tsup": "^7.1.0",
     "typescript": "^5.1.6"
   },
   "dependencies": {
     "@lukeed/ms": "^2.0.1",
     "@types/bytes": "^3.1.1",
-    "@types/pluralize": "^0.0.29",
+    "@types/pluralize": "0.0.30",
     "bytes": "^3.1.2",
     "case-anything": "^2.1.13",
     "flattie": "^1.1.0",
@@ -124,5 +125,19 @@
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
   },
-  "prettier": "@adonisjs/prettier-config"
+  "prettier": "@adonisjs/prettier-config",
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./src/string/main.ts",
+      "./src/string_builder.ts",
+      "./src/json/main.ts",
+      "./src/types.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": true,
+    "target": "esnext"
+  }
 }

package/build/src/base64.d.ts

@@ -1,17 +0,0 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-declare class Base64 {
-    encode(arrayBuffer: ArrayBuffer | SharedArrayBuffer): string;
-    encode(data: string, encoding?: BufferEncoding): string;
-    decode(encode: string, encoding: BufferEncoding, strict: true): string;
-    decode(encode: string, encoding: undefined, strict: true): string;
-    decode(encode: string, encoding?: BufferEncoding, strict?: false): string | null;
-    decode(encode: Buffer, encoding?: BufferEncoding): string;
-    urlEncode(arrayBuffer: ArrayBuffer | SharedArrayBuffer): string;
-    urlEncode(data: string, encoding?: BufferEncoding): string;
-    urlDecode(encode: string, encoding: BufferEncoding, strict: true): string;
-    urlDecode(encode: string, encoding: undefined, strict: true): string;
-    urlDecode(encode: string, encoding?: BufferEncoding, strict?: false): string | null;
-    urlDecode(encode: Buffer, encoding?: BufferEncoding): string;
-}
-export declare const base64: Base64;
-export {};

package/build/src/base64.js

@@ -1,35 +0,0 @@
-class Base64 {
-    encode(data, encoding) {
-        if (typeof data === 'string') {
-            return Buffer.from(data, encoding).toString('base64');
-        }
-        return Buffer.from(data).toString('base64');
-    }
-    decode(encoded, encoding = 'utf-8', strict = false) {
-        if (Buffer.isBuffer(encoded)) {
-            return encoded.toString(encoding);
-        }
-        const decoded = Buffer.from(encoded, 'base64').toString(encoding);
-        const isInvalid = this.encode(decoded, encoding) !== encoded;
-        if (strict && isInvalid) {
-            throw new Error('Cannot decode malformed value');
-        }
-        return isInvalid ? null : decoded;
-    }
-    urlEncode(data, encoding) {
-        const encoded = typeof data === 'string' ? this.encode(data, encoding) : this.encode(data);
-        return encoded.replace(/\+/g, '-').replace(/\//g, '_').replace(/\=/g, '');
-    }
-    urlDecode(encoded, encoding = 'utf-8', strict = false) {
-        if (Buffer.isBuffer(encoded)) {
-            return encoded.toString(encoding);
-        }
-        const decoded = Buffer.from(encoded, 'base64').toString(encoding);
-        const isInvalid = this.urlEncode(decoded, encoding) !== encoded;
-        if (strict && isInvalid) {
-            throw new Error('Cannot urlDecode malformed value');
-        }
-        return isInvalid ? null : decoded;
-    }
-}
-export const base64 = new Base64();

package/build/src/compose.d.ts

@@ -1,14 +0,0 @@
-import type { Constructor } from './types.js';
-interface UnaryFunction<T, R> {
-    (source: T): R;
-}
-export declare function compose<T extends Constructor, A>(superclass: T, mixin: UnaryFunction<T, A>): A;
-export declare function compose<T extends Constructor, A, B>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>): B;
-export declare function compose<T extends Constructor, A, B, C>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>, mixinC: UnaryFunction<B, C>): C;
-export declare function compose<T extends Constructor, A, B, C, D>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>, mixinC: UnaryFunction<B, C>, mixinD: UnaryFunction<C, D>): D;
-export declare function compose<T extends Constructor, A, B, C, D, E>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>, mixinC: UnaryFunction<B, C>, mixinD: UnaryFunction<C, D>, mixinE: UnaryFunction<D, E>): E;
-export declare function compose<T extends Constructor, A, B, C, D, E, F>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>, mixinC: UnaryFunction<B, C>, mixinD: UnaryFunction<C, D>, mixinF: UnaryFunction<E, F>): F;
-export declare function compose<T extends Constructor, A, B, C, D, E, F, G>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>, mixinC: UnaryFunction<B, C>, mixinD: UnaryFunction<C, D>, mixinF: UnaryFunction<E, F>, mixinG: UnaryFunction<F, G>): G;
-export declare function compose<T extends Constructor, A, B, C, D, E, F, G, H>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>, mixinC: UnaryFunction<B, C>, mixinD: UnaryFunction<C, D>, mixinF: UnaryFunction<E, F>, mixinG: UnaryFunction<F, G>, mixinH: UnaryFunction<G, H>): H;
-export declare function compose<T extends Constructor, A, B, C, D, E, F, G, H, I>(superclass: T, mixin: UnaryFunction<T, A>, mixinB: UnaryFunction<A, B>, mixinC: UnaryFunction<B, C>, mixinD: UnaryFunction<C, D>, mixinF: UnaryFunction<E, F>, mixinG: UnaryFunction<F, G>, mixinH: UnaryFunction<G, H>, mixinI: UnaryFunction<H, I>): I;
-export {};

package/build/src/compose.js

@@ -1,3 +0,0 @@
-export function compose(superclass, ...mixins) {
-    return mixins.reduce((c, mixin) => mixin(c), superclass);
-}

package/build/src/define_static_property.d.ts

@@ -1,7 +0,0 @@
-type Constructor = new (...args: any[]) => any;
-type AbstractConstructor = abstract new (...args: any[]) => any;
-export declare function defineStaticProperty<T extends Constructor | AbstractConstructor, Prop extends keyof T>(self: T, propertyName: Prop, { initialValue, strategy, }: {
-    initialValue: T[Prop];
-    strategy: 'inherit' | 'define' | ((value: T[Prop]) => T[Prop]);
-}): void;
-export {};

package/build/src/define_static_property.js

@@ -1,21 +0,0 @@
-import lodash from '@poppinss/utils/lodash';
-export function defineStaticProperty(self, propertyName, { initialValue, strategy, }) {
-    if (!self.hasOwnProperty(propertyName)) {
-        const value = self[propertyName];
-        if (strategy === 'define' || value === undefined) {
-            Object.defineProperty(self, propertyName, {
-                value: initialValue,
-                configurable: true,
-                enumerable: true,
-                writable: true,
-            });
-            return;
-        }
-        Object.defineProperty(self, propertyName, {
-            value: typeof strategy === 'function' ? strategy(value) : lodash.cloneDeep(value),
-            configurable: true,
-            enumerable: true,
-            writable: true,
-        });
-    }
-}

package/build/src/exception.d.ts

@@ -1,21 +0,0 @@
-export declare class Exception extends Error {
-    static help?: string;
-    static code?: string;
-    static status?: number;
-    static message?: string;
-    name: string;
-    help?: string;
-    code?: string;
-    status: number;
-    constructor(message?: string, options?: ErrorOptions & {
-        code?: string;
-        status?: number;
-    });
-    get [Symbol.toStringTag](): string;
-    toString(): string;
-}
-export declare function createError<T extends any[] = never>(message: string, code: string, status?: number): typeof Exception & T extends never ? {
-    new (args?: any, options?: ErrorOptions): Exception;
-} : {
-    new (args: T, options?: ErrorOptions): Exception;
-};

package/build/src/exception.js

@@ -1,40 +0,0 @@
-import { format } from 'node:util';
-export class Exception extends Error {
-    name;
-    status;
-    constructor(message, options) {
-        super(message, options);
-        const ErrorConstructor = this.constructor;
-        this.name = ErrorConstructor.name;
-        this.message = message || ErrorConstructor.message || '';
-        this.status = options?.status || ErrorConstructor.status || 500;
-        const code = options?.code || ErrorConstructor.code;
-        if (code !== undefined) {
-            this.code = code;
-        }
-        const help = ErrorConstructor.help;
-        if (help !== undefined) {
-            this.help = help;
-        }
-        Error.captureStackTrace(this, ErrorConstructor);
-    }
-    get [Symbol.toStringTag]() {
-        return this.constructor.name;
-    }
-    toString() {
-        if (this.code) {
-            return `${this.name} [${this.code}]: ${this.message}`;
-        }
-        return `${this.name}: ${this.message}`;
-    }
-}
-export function createError(message, code, status) {
-    return class extends Exception {
-        static message = message;
-        static code = code;
-        static status = status;
-        constructor(args, options) {
-            super(format(message, ...(args || [])), options);
-        }
-    };
-}

package/build/src/exceptions/invalid_arguments_exception.d.ts

@@ -1,5 +0,0 @@
-import { Exception } from '../exception.js';
-export declare class InvalidArgumentsException extends Exception {
-    static code: string;
-    static status: number;
-}

package/build/src/exceptions/invalid_arguments_exception.js

@@ -1,5 +0,0 @@
-import { Exception } from '../exception.js';
-export class InvalidArgumentsException extends Exception {
-    static code = 'E_INVALID_ARGUMENTS_EXCEPTION';
-    static status = 500;
-}

package/build/src/exceptions/runtime_exception.d.ts

@@ -1,5 +0,0 @@
-import { Exception } from '../exception.js';
-export declare class RuntimeException extends Exception {
-    static code: string;
-    static status: number;
-}

package/build/src/exceptions/runtime_exception.js

@@ -1,5 +0,0 @@
-import { Exception } from '../exception.js';
-export class RuntimeException extends Exception {
-    static code = 'E_RUNTIME_EXCEPTION';
-    static status = 500;
-}

package/build/src/flatten.d.ts

@@ -1 +0,0 @@
-export declare function flatten<X = Record<string, any>, Y = unknown>(input: Y, glue?: string, keepNullish?: boolean): X;

package/build/src/flatten.js

@@ -1,4 +0,0 @@
-import { flattie } from 'flattie';
-export function flatten(input, glue, keepNullish) {
-    return flattie(input, glue, keepNullish);
-}

package/build/src/fs_import_all.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="@types/node" resolution-mode="require"/>
-import { ImportAllFilesOptions } from './types.js';
-export declare function fsImportAll(location: string | URL, options?: ImportAllFilesOptions): Promise<any>;