Skip to content

Commit

Permalink
refactor: export Lucid mixins from its own subpath with descriptive name
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Apr 2, 2024
1 parent c61ccb1 commit 15d3761
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 58 deletions.
6 changes: 3 additions & 3 deletions index.ts
Expand Up @@ -14,7 +14,7 @@ export { AuthManager } from './src/auth_manager.js'
export { defineConfig } from './src/define_config.js'
export { Authenticator } from './src/authenticator.js'
export { AuthenticatorClient } from './src/authenticator_client.js'
import type { withAuthFinder as withAuthFinderType } from './src/mixins/with_auth_finder.js'
import type { withAuthFinder as withAuthFinderType } from './src/mixins/lucid.js'

function isModuleInstalled(moduleName: string) {
try {
Expand All @@ -26,12 +26,12 @@ function isModuleInstalled(moduleName: string) {
}

/**
* @deprecated Import `withAuthFinder` from `@adonisjs/auth/mixins` instead
* @deprecated Import `withAuthFinder` from `@adonisjs/auth/mixins/lucid` instead
*/
let withAuthFinder: typeof withAuthFinderType

if (isModuleInstalled('@adonisjs/lucid')) {
const { withAuthFinder: withAuthFinderFn } = await import('./src/mixins/with_auth_finder.js')
const { withAuthFinder: withAuthFinderFn } = await import('./src/mixins/lucid.js')
withAuthFinder = withAuthFinderFn
}

Expand Down
10 changes: 0 additions & 10 deletions mixins.ts

This file was deleted.

84 changes: 42 additions & 42 deletions package.json
Expand Up @@ -15,9 +15,9 @@
},
"exports": {
".": "./build/index.js",
"./mixins": "./build/mixins.js",
"./types": "./build/src/types.js",
"./auth_provider": "./build/providers/auth_provider.js",
"./mixins/lucid": "./build/src/mixins/lucid.js",
"./plugins/api_client": "./build/src/plugins/japa/api_client.js",
"./plugins/browser_client": "./build/src/plugins/japa/browser_client.js",
"./services/main": "./build/services/auth.js",
Expand Down Expand Up @@ -67,54 +67,54 @@
"url": "https://github.com/adonisjs/auth/issues"
},
"devDependencies": {
"@adonisjs/assembler": "^7.1.1",
"@adonisjs/core": "^6.2.1",
"@adonisjs/eslint-config": "^1.2.1",
"@adonisjs/i18n": "^2.0.0",
"@adonisjs/lucid": "^20.1.0",
"@adonisjs/prettier-config": "^1.2.1",
"@adonisjs/session": "^7.1.1",
"@adonisjs/tsconfig": "^1.2.1",
"@commitlint/cli": "^18.5.0",
"@commitlint/config-conventional": "^18.5.0",
"@japa/api-client": "^2.0.2",
"@japa/assert": "^2.1.0",
"@japa/browser-client": "^2.0.2",
"@japa/expect-type": "^2.0.1",
"@japa/file-system": "^2.2.0",
"@japa/plugin-adonisjs": "^3.0.0",
"@japa/runner": "^3.1.1",
"@japa/snapshot": "^2.0.4",
"@swc/core": "^1.3.105",
"@types/basic-auth": "^1.1.7",
"@adonisjs/assembler": "^7.4.0",
"@adonisjs/core": "^6.5.0",
"@adonisjs/eslint-config": "^1.3.0",
"@adonisjs/i18n": "^2.0.1",
"@adonisjs/lucid": "^20.5.1",
"@adonisjs/prettier-config": "^1.3.0",
"@adonisjs/session": "^7.3.0",
"@adonisjs/tsconfig": "^1.3.0",
"@commitlint/cli": "^19.2.1",
"@commitlint/config-conventional": "^19.1.0",
"@japa/api-client": "^2.0.3",
"@japa/assert": "^3.0.0",
"@japa/browser-client": "^2.0.3",
"@japa/expect-type": "^2.0.2",
"@japa/file-system": "^2.3.0",
"@japa/plugin-adonisjs": "^3.0.1",
"@japa/runner": "^3.1.2",
"@japa/snapshot": "^2.0.5",
"@swc/core": "^1.4.11",
"@types/basic-auth": "^1.1.8",
"@types/luxon": "^3.4.2",
"@types/node": "^20.11.6",
"@types/node": "^20.12.2",
"@types/set-cookie-parser": "^2.4.7",
"@types/sinon": "^17.0.3",
"c8": "^9.0.0",
"convert-hrtime": "^5.0.0",
"copyfiles": "^2.4.1",
"cross-env": "^7.0.3",
"del-cli": "^5.1.0",
"dotenv": "^16.4.1",
"eslint": "^8.56.0",
"dotenv": "^16.4.5",
"eslint": "^8.57.0",
"github-label-sync": "^2.3.1",
"husky": "^9.0.7",
"husky": "^9.0.11",
"luxon": "^3.4.4",
"mysql2": "^3.9.1",
"nock": "^13.5.0",
"np": "^9.2.0",
"pg": "^8.11.3",
"playwright": "^1.41.1",
"prettier": "^3.1.1",
"mysql2": "^3.9.3",
"nock": "^13.5.4",
"np": "^10.0.2",
"pg": "^8.11.4",
"playwright": "^1.42.1",
"prettier": "^3.2.5",
"set-cookie-parser": "^2.6.0",
"sinon": "^17.0.1",
"sqlite3": "^5.1.7",
"tedious": "^16.6.1",
"tedious": "^18.1.0",
"timekeeper": "^2.3.1",
"ts-node": "^10.9.2",
"tsup": "^8.0.1",
"typescript": "^5.3.3"
"tsup": "^8.0.2",
"typescript": "^5.4.3"
},
"prettier": "@adonisjs/prettier-config",
"eslintConfig": {
Expand Down Expand Up @@ -147,16 +147,16 @@
]
},
"dependencies": {
"@adonisjs/presets": "^2.2.3",
"@adonisjs/presets": "^2.4.0",
"basic-auth": "^2.0.1"
},
"peerDependencies": {
"@adonisjs/core": "^6.2.1",
"@adonisjs/lucid": "^20.1.0",
"@adonisjs/session": "^7.1.1",
"@japa/api-client": "^2.0.2",
"@japa/browser-client": "^2.0.2",
"@japa/plugin-adonisjs": "^3.0.0"
"@adonisjs/core": "^6.5.0",
"@adonisjs/lucid": "^20.5.1",
"@adonisjs/session": "^7.3.0",
"@japa/api-client": "^2.0.3",
"@japa/browser-client": "^2.0.3",
"@japa/plugin-adonisjs": "^3.0.1"
},
"peerDependenciesMeta": {
"@adonisjs/lucid": {
Expand All @@ -178,12 +178,12 @@
"tsup": {
"entry": [
"./index.ts",
"./mixins.ts",
"./src/types.ts",
"./providers/auth_provider.ts",
"./src/plugins/japa/api_client.ts",
"./src/plugins/japa/browser_client.ts",
"./services/auth.ts",
"./src/mixins/lucid.ts",
"./src/middleware/initialize_auth_middleware.ts",
"./modules/access_tokens_guard/main.ts",
"./modules/access_tokens_guard/types.ts",
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion tests/auth/mixins/with_auth_finder.spec.ts
Expand Up @@ -13,7 +13,7 @@ import { compose } from '@adonisjs/core/helpers'
import { BaseModel, column } from '@adonisjs/lucid/orm'

import { createDatabase, createTables, getHasher } from '../../helpers.js'
import { withAuthFinder } from '../../../src/mixins/with_auth_finder.js'
import { withAuthFinder } from '../../../src/mixins/lucid.js'

test.group('withAuthFinder | findForAuth', () => {
test('find user for authentication using the mixin', async ({ assert, expectTypeOf }) => {
Expand Down
2 changes: 1 addition & 1 deletion tests/basic_auth/define_config.spec.ts
Expand Up @@ -15,7 +15,7 @@ import { AppFactory } from '@adonisjs/core/factories/app'
import type { ApplicationService } from '@adonisjs/core/types'
import { HttpContextFactory } from '@adonisjs/core/factories/http'

import { withAuthFinder } from '../../src/mixins/with_auth_finder.js'
import { withAuthFinder } from '../../src/mixins/lucid.js'
import { createEmitter, getHasher } from '../helpers.js'
import {
basicAuthGuard,
Expand Down
2 changes: 1 addition & 1 deletion tests/basic_auth/user_providers/lucid.spec.ts
Expand Up @@ -11,7 +11,7 @@ import { test } from '@japa/runner'
import { compose } from '@adonisjs/core/helpers'
import { BaseModel, column } from '@adonisjs/lucid/orm'

import { withAuthFinder } from '../../../src/mixins/with_auth_finder.js'
import { withAuthFinder } from '../../../src/mixins/lucid.js'
import { createDatabase, createTables, getHasher } from '../../helpers.js'
import { BasicAuthGuardUser } from '../../../modules/basic_auth_guard/types.js'
import { BasicAuthLucidUserProvider } from '../../../modules/basic_auth_guard/user_providers/lucid.js'
Expand Down

0 comments on commit 15d3761

Please sign in to comment.