@poppinss/utils 6.0.1-0 → 6.2.0-0

package/README.md

@@ -771,19 +771,18 @@ class ResourceNotFound extends Exception {
 throw new ResourceNotFound()
 ```
 
-Following is an example of creating a dynamic message with interpolation.
+#### 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.
 
-```ts
-import { Exception } from '@poppinss/utils'
-import string from '@poppinss/utils/string'
+The interpolation of error message is performed using the `util.format` message.
 
-class ResourceNotFound extends Exception {
-  static code = 'E_RESOURCE_NOT_FOUND'
-  static status = 404
-  static message = 'Unable to find resource with id {{ id }}'
-}
+```ts
+import { createError } from '@poppinss/utils'
+const E_RESOURCE_NOT_FOUND = createError('Unable to find resource with id %d', 'E_RESOURCE_NOT_FOUND')
 
-throw new ResourceNotFound(interpolate(ResourceNotFound.message, { id: 1 }))
+const id = 1
+throw new E_RESOURCE_NOT_FOUND([id])
 ```
 
 #### flatten

package/build/index.d.ts

@@ -2,7 +2,7 @@
 export { base64 } from './src/base64.js';
 export { compose } from './src/compose.js';
 export { defineStaticProperty } from './src/define_static_property.js';
-export { Exception } from './src/exception.js';
+export { Exception, createError } from './src/exception.js';
 export { flatten } from './src/flatten.js';
 export { fsImportAll } from './src/fs_import_all.js';
 export { fsReadAll } from './src/fs_read_all.js';
@@ -12,5 +12,6 @@ export { naturalSort } from './src/natural_sort.js';
 export { ObjectBuilder } from './src/object_builder.js';
 export { safeEqual } from './src/safe_equal.js';
 export { slash } from './src/slash.js';
+export { RuntimeException } from './src/exceptions/runtime_exception.js';
 export declare function getDirname(url: string | URL): string;
 export declare function getFilename(url: string | URL): string;

package/build/index.js

@@ -3,7 +3,7 @@ import { dirname as pathDirname } from 'node:path';
 export { base64 } from './src/base64.js';
 export { compose } from './src/compose.js';
 export { defineStaticProperty } from './src/define_static_property.js';
-export { Exception } from './src/exception.js';
+export { Exception, createError } from './src/exception.js';
 export { flatten } from './src/flatten.js';
 export { fsImportAll } from './src/fs_import_all.js';
 export { fsReadAll } from './src/fs_read_all.js';
@@ -13,6 +13,7 @@ export { naturalSort } from './src/natural_sort.js';
 export { ObjectBuilder } from './src/object_builder.js';
 export { safeEqual } from './src/safe_equal.js';
 export { slash } from './src/slash.js';
+export { RuntimeException } from './src/exceptions/runtime_exception.js';
 export function getDirname(url) {
     return pathDirname(getFilename(url));
 }

package/build/src/define_static_property.d.ts

@@ -1,5 +1,5 @@
-declare type Constructor = new (...args: any[]) => any;
-declare type AbstractConstructor = abstract new (...args: any[]) => any;
+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]);

package/build/src/exception.d.ts

@@ -14,3 +14,8 @@ export declare class Exception extends Error {
     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,3 +1,4 @@
+import { format } from 'node:util';
 export class Exception extends Error {
     name;
     status;
@@ -27,3 +28,13 @@ export class Exception extends Error {
         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/runtime_exception.d.ts

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

package/build/src/exceptions/runtime_exception.js

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

package/build/src/safe_equal.d.ts

@@ -1,4 +1,4 @@
-declare type BufferSafeValue = ArrayBuffer | SharedArrayBuffer | number[] | string | {
+type BufferSafeValue = ArrayBuffer | SharedArrayBuffer | number[] | string | {
     valueOf(): string | object;
 } | {
     [Symbol.toPrimitive](hint: 'string'): string;

package/build/src/types.d.ts

@@ -1,22 +1,22 @@
-declare type PickKeysByValue<T, V> = {
+type PickKeysByValue<T, V> = {
     [K in keyof T]: T[K] extends V ? K : never;
 }[keyof T];
-export declare type OmitProperties<T, P> = Omit<T, PickKeysByValue<T, P>>;
-declare type ScanFsBaseOptions = {
+export 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 declare type ImportAllFilesOptions = ScanFsBaseOptions & {
+export type ImportAllFilesOptions = ScanFsBaseOptions & {
     transformKeys?: (keys: string[]) => string[];
 };
-export declare type ReadAllFilesOptions = ScanFsBaseOptions & {
+export type ReadAllFilesOptions = ScanFsBaseOptions & {
     pathType?: 'relative' | 'unixRelative' | 'absolute' | 'unixAbsolute' | 'url';
 };
-export declare type JSONReplacer = (this: any, key: string, value: any) => any;
-export declare type JSONReviver = (this: any, key: string, value: any) => any;
-export declare type Constructor = new (...args: any[]) => any;
-export declare type NormalizeConstructor<T extends Constructor> = {
+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> = {
     new (...args: any[]): InstanceType<T>;
 } & Omit<T, 'constructor'>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@poppinss/utils",
-  "version": "6.0.1-0",
+  "version": "6.2.0-0",
   "description": "Handy utilities for repetitive work",
   "main": "build/index.js",
   "type": "module",
@@ -53,32 +53,32 @@
   "author": "virk,poppinss",
   "license": "MIT",
   "devDependencies": {
-    "@commitlint/cli": "^17.1.2",
-    "@commitlint/config-conventional": "^17.1.0",
+    "@commitlint/cli": "^17.3.0",
+    "@commitlint/config-conventional": "^17.3.0",
     "@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.11",
+    "@swc/core": "^1.3.23",
     "@types/fs-extra": "^9.0.13",
-    "@types/node": "^18.11.7",
+    "@types/node": "^18.11.15",
     "c8": "^7.12.0",
     "del-cli": "^5.0.0",
-    "eslint": "^8.26.0",
+    "eslint": "^8.29.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^3.0.3",
     "eslint-plugin-prettier": "^4.2.1",
-    "fs-extra": "^10.1.0",
+    "fs-extra": "^11.1.0",
     "github-label-sync": "^2.2.0",
     "husky": "^8.0.1",
     "lodash": "^4.17.21",
     "lodash-cli": "^4.17.5",
     "move-file-cli": "^3.0.0",
     "np": "^7.6.2",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.1",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.3"
+    "typescript": "^4.9.4"
   },
   "dependencies": {
     "@lukeed/ms": "^2.0.0",
@@ -89,7 +89,7 @@
     "flattie": "^1.1.0",
     "pluralize": "^8.0.0",
     "safe-stable-stringify": "^2.4.1",
-    "secure-json-parse": "^2.5.0",
+    "secure-json-parse": "^2.6.0",
     "slash": "^5.0.0",
     "slugify": "^1.6.5",
     "truncatise": "^0.0.8"