@adonisjs/core 6.1.5-2 → 6.1.5-3

package/modules/ace/shell.ts

@@ -0,0 +1,49 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+const DEFAULT_NODE_ARGS = [
+  // Use ts-node/esm loader. The project must install it
+  '--loader=ts-node/esm',
+  // Disable annonying warnings
+  '--no-warnings',
+  // Enable expiremental meta resolve for cases where someone uses magic import string
+  '--experimental-import-meta-resolve',
+]
+
+/**
+ * Ace shell is used to run the ace commands inside a TypeScript project
+ * without pre-compiling TypeScript source files.
+ *
+ * Under the hood a child process is used to execute the "bin/console.ts" file. This
+ * is required because we have to use "ts-node/esm" loader in order to run TypeScript
+ * files.
+ */
+export function aceShell(cwd: URL) {
+  return {
+    async handle(argv: string[]) {
+      const { execaNode } = await import('execa')
+      const childProcess = execaNode('bin/console.js', argv, {
+        nodeOptions: DEFAULT_NODE_ARGS,
+        preferLocal: true,
+        windowsHide: false,
+        localDir: cwd,
+        cwd,
+        buffer: false,
+        stdio: 'inherit',
+      })
+
+      try {
+        const result = await childProcess
+        process.exitCode = result.exitCode
+      } catch (error) {
+        process.exitCode = 1
+      }
+    },
+  }
+}

package/modules/app.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/application'

package/modules/bodyparser/bodyparser_middleware.ts

@@ -0,0 +1,16 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { BodyParserMiddleware } from '@adonisjs/bodyparser/bodyparser_middleware'
+
+/**
+ * Default export allows lazy importing middleware with
+ * destructuring the named exports
+ */
+export default BodyParserMiddleware

package/modules/bodyparser/main.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/bodyparser'

package/modules/config.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/config'

package/modules/container.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/fold'

package/modules/encryption.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/encryption'

package/modules/env.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/env'

package/modules/events.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/events'

package/modules/hash/define_config.ts

@@ -0,0 +1,64 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { InvalidArgumentsException } from '@poppinss/utils'
+
+import driversCollection from './drivers_collection.js'
+import type { HashDriversList } from '../../src/types.js'
+import type { ManagerDriverFactory } from '../../types/hash.js'
+
+/**
+ * Define config for the hash service.
+ */
+export function defineConfig<
+  KnownHashers extends Record<
+    string,
+    {
+      [K in keyof HashDriversList]: { driver: K } & Parameters<HashDriversList[K]>[0]
+    }[keyof HashDriversList]
+  >
+>(config: {
+  default?: keyof KnownHashers
+  list: KnownHashers
+}): {
+  default?: keyof KnownHashers
+  list: { [K in keyof KnownHashers]: ManagerDriverFactory }
+} {
+  /**
+   * Hashers list should always be provided
+   */
+  if (!config.list) {
+    throw new InvalidArgumentsException('Missing "list" property in hash config')
+  }
+
+  /**
+   * The default hasher should be mentioned in the list
+   */
+  if (config.default && !config.list[config.default]) {
+    throw new InvalidArgumentsException(
+      `Missing "list.${String(
+        config.default
+      )}" in hash config. It is referenced by the "default" property`
+    )
+  }
+
+  /**
+   * Converting list config to a collection that hash manager can use
+   */
+  const managerHashers = Object.keys(config.list).reduce((result, disk: keyof KnownHashers) => {
+    const hasherConfig = config.list[disk]
+    result[disk] = () => driversCollection.create(hasherConfig.driver, hasherConfig)
+    return result
+  }, {} as { [K in keyof KnownHashers]: ManagerDriverFactory })
+
+  return {
+    default: config.default,
+    list: managerHashers,
+  }
+}

package/modules/hash/drivers_collection.ts

@@ -0,0 +1,61 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * This class exists in the core, because it maintains a list of
+ * globally available drivers applicable to the hash manager
+ * instance registered with the container.
+ *
+ * In other words, these drivers are not needed by the hash module
+ * regular usage and specific to AdonisJS container flow.
+ */
+
+import { RuntimeException } from '@poppinss/utils'
+import type { HashDriversList } from '../../src/types.js'
+
+/**
+ * A global collection of Hash drivers
+ */
+class HashDriversCollection {
+  /**
+   * List of registered drivers
+   */
+  list: Partial<HashDriversList> = {}
+
+  /**
+   * Extend drivers collection and add a custom
+   * driver to it.
+   */
+  extend<Name extends keyof HashDriversList>(
+    driverName: Name,
+    factoryCallback: HashDriversList[Name]
+  ): this {
+    this.list[driverName] = factoryCallback
+    return this
+  }
+
+  /**
+   * Creates the driver instance with config
+   */
+  create<Name extends keyof HashDriversList>(
+    name: Name,
+    config: Parameters<HashDriversList[Name]>[0]
+  ) {
+    const driverFactory = this.list[name]
+    if (!driverFactory) {
+      throw new RuntimeException(
+        `Unknown hash driver "${String(name)}". Make sure the driver is registered`
+      )
+    }
+
+    return driverFactory(config as any)
+  }
+}
+
+export default new HashDriversCollection()

package/modules/hash/main.ts

@@ -0,0 +1,12 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/hash'
+export { defineConfig } from './define_config.js'
+export { default as driversList } from './drivers_collection.js'

package/modules/http.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/http-server'

package/modules/logger.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/logger'

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "@adonisjs/core",
-  "version": "6.1.5-2",
+  "version": "6.1.5-3",
   "description": "Core of AdonisJS",
   "main": "build/index.js",
   "type": "module",
   "files": [
+    "modules",
+    "commands",
+    "legacy",
+    "providers",
+    "services",
+    "factories",
+    "types",
+    "src",
+    "index.ts",
     "build/modules",
     "build/commands",
     "build/legacy",
@@ -16,6 +25,7 @@
     "build/src",
     "build/stubs",
     "build/index.d.ts",
+    "build/index.d.ts.map",
     "build/index.js"
   ],
   "bin": {
@@ -61,7 +71,6 @@
     "./helpers/is": "./build/src/helpers/is.js",
     "./helpers/types": "./build/src/helpers/types.js",
     "./helpers/string": "./build/src/helpers/string.js",
-    "./helpers/string_builder": "./build/src/helpers/string_builder.js",
     "./ace/shell": "./build/modules/ace/shell.js",
     "./ace": "./build/modules/ace/main.js",
     "./bodyparser": "./build/modules/bodyparser/main.js",
@@ -79,7 +88,7 @@
   },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "cross-env NODE_DEBUG=adonisjs:core c8 npm run vscode:test",
+    "test": "cross-env NODE_DEBUG=adonisjs:core c8 npm run quick:test",
     "clean": "del-cli build",
     "copy:templates": "copyfiles \"stubs/**/**/*.stub\" build",
     "precompile": "npm run lint",
@@ -92,7 +101,7 @@
     "lint": "eslint . --ext=.ts",
     "format": "prettier --write .",
     "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/core",
-    "vscode:test": "node --loader=ts-node/esm --experimental-import-meta-resolve bin/test.ts",
+    "quick:test": "node --loader=ts-node/esm --experimental-import-meta-resolve bin/test.ts",
     "index:commands": "node --loader=ts-node/esm toolkit/main.js index build/commands"
   },
   "keywords": [
@@ -103,17 +112,17 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/assembler": "^6.1.3-3",
-    "@commitlint/cli": "^17.4.4",
-    "@commitlint/config-conventional": "^17.4.4",
+    "@adonisjs/assembler": "^6.1.3-6",
+    "@commitlint/cli": "^17.6.1",
+    "@commitlint/config-conventional": "^17.6.1",
     "@japa/assert": "^1.4.1",
     "@japa/expect-type": "^1.0.3",
     "@japa/file-system": "^1.0.1",
     "@japa/run-failed-tests": "^1.1.1",
     "@japa/runner": "^2.5.1",
     "@japa/spec-reporter": "^1.3.3",
-    "@swc/core": "^1.3.40",
-    "@types/node": "^18.15.3",
+    "@swc/core": "^1.3.51",
+    "@types/node": "^18.15.11",
     "@types/pretty-hrtime": "^1.0.1",
     "@types/sinon": "^10.0.13",
     "@types/supertest": "^2.0.12",
@@ -122,37 +131,37 @@
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.7.0",
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-adonis": "^3.0.3",
     "eslint-plugin-prettier": "^4.2.1",
     "get-port": "^6.1.2",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
-    "np": "^7.6.3",
-    "prettier": "^2.8.4",
-    "sinon": "^15.0.2",
+    "np": "^7.7.0",
+    "prettier": "^2.8.7",
+    "sinon": "^15.0.3",
     "supertest": "^6.3.3",
     "test-console": "^2.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@adonisjs/ace": "^12.3.1-3",
-    "@adonisjs/application": "^7.1.2-2",
-    "@adonisjs/bodyparser": "^9.3.2-2",
-    "@adonisjs/config": "^4.2.1-0",
-    "@adonisjs/encryption": "^5.1.2-0",
-    "@adonisjs/env": "^4.2.0-1",
-    "@adonisjs/events": "^8.4.9-1",
-    "@adonisjs/fold": "^9.9.3-3",
-    "@adonisjs/hash": "^8.3.1-1",
-    "@adonisjs/http-server": "^6.8.2-4",
-    "@adonisjs/logger": "^5.4.2-0",
-    "@adonisjs/validator": "^13.0.2-0",
+    "@adonisjs/ace": "^12.3.1-5",
+    "@adonisjs/application": "^7.1.2-3",
+    "@adonisjs/bodyparser": "^9.3.2-5",
+    "@adonisjs/config": "^4.2.1-1",
+    "@adonisjs/encryption": "^5.1.2-1",
+    "@adonisjs/env": "^4.2.0-2",
+    "@adonisjs/events": "^8.4.9-2",
+    "@adonisjs/fold": "^9.9.3-4",
+    "@adonisjs/hash": "^8.3.1-2",
+    "@adonisjs/http-server": "^6.8.2-6",
+    "@adonisjs/logger": "^5.4.2-1",
+    "@adonisjs/validator": "^13.0.2-2",
     "@paralleldrive/cuid2": "^2.2.0",
-    "@poppinss/macroable": "^1.0.0-3",
-    "@poppinss/utils": "^6.5.0-1",
+    "@poppinss/macroable": "^1.0.0-6",
+    "@poppinss/utils": "^6.5.0-2",
     "@sindresorhus/is": "^5.3.0",
     "@types/he": "^1.2.0",
     "execa": "^7.1.1",
@@ -164,7 +173,7 @@
     "youch-terminal": "^2.2.0"
   },
   "peerDependencies": {
-    "@adonisjs/assembler": "^6.1.3-2",
+    "@adonisjs/assembler": "^6.1.3-4",
     "argon2": "^0.30.3",
     "bcrypt": "^5.0.1"
   },

package/providers/app_provider.ts

@@ -0,0 +1,125 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { Config } from '../modules/config.js'
+import { Logger } from '../modules/logger.js'
+import { validator } from '../legacy/validator.js'
+import { Encryption } from '../modules/encryption.js'
+import type { ApplicationService, LoggerService } from '../src/types.js'
+
+/**
+ * The Application Service provider registers all the baseline
+ * features required to run the framework.
+ */
+export default class AppServiceProvider {
+  constructor(protected app: ApplicationService) {}
+
+  /**
+   * Registers test utils with the container
+   */
+  protected registerTestUtils() {
+    this.app.container.singleton('testUtils', async () => {
+      const { TestUtils } = await import('../src/test_utils/main.js')
+      return new TestUtils(this.app)
+    })
+  }
+
+  /**
+   * Registers ace with the container
+   */
+  protected registerAce() {
+    this.app.container.singleton('ace', async () => {
+      const { createAceKernel } = await import('../modules/ace/create_kernel.js')
+      return createAceKernel(this.app)
+    })
+  }
+
+  /**
+   * Registers the application to the container
+   */
+  protected registerApp() {
+    this.app.container.singleton('app', () => this.app)
+  }
+
+  /**
+   * Registers the logger class to resolve the default logger
+   */
+  protected registerLogger() {
+    this.app.container.singleton(Logger, async (resolver) => {
+      const loggerManager = await resolver.make('logger')
+      return loggerManager.use()
+    })
+  }
+
+  /**
+   * Registers the logger manager to the container
+   */
+  protected registerLoggerManager() {
+    this.app.container.singleton('logger', async () => {
+      const { LoggerManager } = await import('../modules/logger.js')
+      const config = this.app.config.get<any>('logger')
+      return new LoggerManager(config) as LoggerService
+    })
+  }
+
+  /**
+   * Registers the config to the container
+   */
+  protected registerConfig() {
+    this.app.container.singleton(Config, () => this.app.config)
+    this.app.container.alias('config', Config)
+  }
+
+  /**
+   * Registers emitter service to the container
+   */
+  protected registerEmitter() {
+    this.app.container.singleton('emitter', async () => {
+      const { Emitter } = await import('../modules/events.js')
+      return new Emitter(this.app)
+    })
+  }
+
+  /**
+   * Register the encryption service to the container
+   */
+  protected registerEncryption() {
+    this.app.container.singleton(Encryption, () => {
+      const appKey = this.app.config.get<string>('app.appKey')
+      return new Encryption({ secret: appKey })
+    })
+    this.app.container.alias('encryption', Encryption)
+  }
+
+  /**
+   * Configure the validator
+   */
+  protected async configureValidator() {
+    const config = await this.app.container.make('config')
+    validator.configure(config.get('validator', {}))
+  }
+
+  /**
+   * Registers bindings
+   */
+  register() {
+    this.registerApp()
+    this.registerAce()
+    this.registerLoggerManager()
+    this.registerLogger()
+    this.registerConfig()
+    this.registerEmitter()
+    this.registerEncryption()
+    this.registerTestUtils()
+  }
+
+  async boot() {
+    await this.configureValidator()
+  }
+}

package/providers/hash_provider.ts

@@ -0,0 +1,58 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ApplicationService } from '../src/types.js'
+import { Argon, Bcrypt, Hash, Scrypt, driversList } from '../modules/hash/main.js'
+
+/**
+ * Registers the passwords hasher with the container
+ */
+export default class HashServiceProvider {
+  constructor(protected app: ApplicationService) {}
+
+  /**
+   * Registering bundled drivers with the driversList collection
+   */
+  protected registerHashDrivers() {
+    driversList.extend('bcrypt', (config) => new Bcrypt(config))
+    driversList.extend('scrypt', (config) => new Scrypt(config))
+    driversList.extend('argon2', (config) => new Argon(config))
+  }
+
+  /**
+   * Registering the hash class to resolve an instance with the
+   * default hasher.
+   */
+  protected registerHash() {
+    this.app.container.singleton(Hash, async (resolver) => {
+      const hashManager = await resolver.make('hash')
+      return hashManager.use()
+    })
+  }
+
+  /**
+   * Registers the hash manager with the container
+   */
+  protected registerHashManager() {
+    this.app.container.singleton('hash', async () => {
+      const { HashManager } = await import('../modules/hash/main.js')
+      const config = this.app.config.get<any>('hash')
+      return new HashManager(config)
+    })
+  }
+
+  /**
+   * Registers bindings
+   */
+  register() {
+    this.registerHashDrivers()
+    this.registerHashManager()
+    this.registerHash()
+  }
+}