@arkstack/auth 0.13.2 → 0.14.0

package/dist/index.js

@@ -1,4 +1,4 @@
-import { Encryption, Exception, Hash, env, getModel } from "@arkstack/common";
+import { Encryption, Exception, Hash, appKey, env, getModel } from "@arkstack/common";
 import { SignJWT, jwtVerify } from "jose";
 import { Request, Response, Session } from "@arkstack/http";
 import { UAParser } from "ua-parser-js";
@@ -543,7 +543,7 @@ var Auth = class Auth extends AuthContract {
 		}
 	}
 	getSecret() {
-		return this.configuredSecret ?? env("JWT_SECRET", "default_secret");
+		return this.configuredSecret ?? appKey("JWT_SECRET") ?? "default_secret";
 	}
 	setAuthenticated(user, token) {
 		this.#user = user;

package/dist/setup.d.ts

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

package/dist/setup.js

@@ -0,0 +1,25 @@
+import { Publisher } from "@arkstack/common";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+//#region src/setup.ts
+const root = join(dirname(fileURLToPath(import.meta.url)), "..");
+/**
+* Register the artifacts `@arkstack/auth` publishes into the application.
+*
+* Run `ark publish --tag two-factor` (or `--package @arkstack/auth`) to copy the
+* `UserTwoFactor` model and the migration that creates the `user_two_factors`
+* table into the app.
+*/
+Publisher.publishes({
+	package: "@arkstack/auth",
+	tag: "two-factor",
+	entries: [{
+		from: join(root, "stubs/models/UserTwoFactor.ts.stub"),
+		to: "src/app/models/UserTwoFactor.ts"
+	}, {
+		from: join(root, "stubs/migrations/20260505110000_create_user_two_factors_table.ts.stub"),
+		to: "src/database/migrations/20260505110000_create_user_two_factors_table.ts"
+	}]
+});
+//#endregion
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/auth",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "type": "module",
   "description": "Authentication module for Arkstack, providing core authentication and identity features.",
   "homepage": "https://arkstack.toneflix.net/guide/auth",
@@ -25,25 +25,27 @@
     "arkstack"
   ],
   "files": [
-    "dist"
+    "dist",
+    "stubs"
   ],
   "publishConfig": {
     "access": "public"
   },
   "exports": {
     ".": "./dist/index.js",
+    "./setup": "./dist/setup.js",
     "./package.json": "./package.json"
   },
   "dependencies": {
     "jose": "^6.2.3",
     "otpauth": "^9.5.1",
     "ua-parser-js": "^2.0.9",
-    "@arkstack/common": "^0.13.2",
-    "@arkstack/http": "^0.13.2"
+    "@arkstack/common": "^0.14.0",
+    "@arkstack/http": "^0.14.0"
   },
   "peerDependencies": {
     "@h3ravel/support": "^2.1.3",
-    "@arkstack/database": "^0.13.2"
+    "@arkstack/database": "^0.14.0"
   },
   "scripts": {
     "build": "tsdown --config-loader unrun",

package/stubs/migrations/20260505110000_create_user_two_factors_table.ts.stub

@@ -0,0 +1,24 @@
+import { Migration, SchemaBuilder } from 'arkormx'
+
+export default class CreateUserTwoFactorsTableMigration extends Migration {
+    public async up (schema: SchemaBuilder): Promise<void> {
+        schema.createTable('user_two_factors', (table) => {
+            table.id('id', 'uuid').primary()
+            table.uuid('userId').map('user_id')
+                .foreign().references('users', 'id').onDelete('cascade').as('user').inverseAlias('twoFactor')
+            table.enum('method', ['authenticator', 'sms']).nullable().enumName('TwoFactorMethod')
+            table.string('secretCiphertext').nullable().map('secret_ciphertext')
+            table.string('smsCodeHash').nullable().map('sms_code_hash')
+            table.date('smsCodeExpiresAt').nullable().map('sms_code_expires_at')
+            table.string('smsCodePurpose').nullable().map('sms_code_purpose')
+            table.date('enabledAt').nullable().map('enabled_at')
+            table.json('recoveryCodeHashes').nullable().map('recovery_code_hashes')
+            table.timestamps()
+            table.index(['userId'])
+        })
+    }
+
+    public async down (schema: SchemaBuilder): Promise<void> {
+        schema.dropTable('user_two_factors')
+    }
+}

package/stubs/models/UserTwoFactor.ts.stub

@@ -0,0 +1,20 @@
+import { UserTwoFactor as BaseUserTwoFactor } from '@arkstack/auth'
+import { User } from '@app/models/User'
+
+export class UserTwoFactor extends BaseUserTwoFactor {
+    protected static columns = {
+        userId: 'user_id',
+        secretCiphertext: 'secret_ciphertext',
+        smsCodeHash: 'sms_code_hash',
+        smsCodeExpiresAt: 'sms_code_expires_at',
+        smsCodePurpose: 'sms_code_purpose',
+        enabledAt: 'enabled_at',
+        recoveryCodeHashes: 'recovery_code_hashes',
+        createdAt: 'created_at',
+        updatedAt: 'updated_at',
+    }
+
+    user() {
+        return this.belongsTo(User, 'userId', 'id')
+    }
+}