@krutai/auth 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # @krutai/auth
 
-Authentication package for KrutAI powered by [Better Auth](https://www.better-auth.com/).
+Authentication package for KrutAI powered by [Krut AI](https://www.krut.ai/).
 
 ## Features
 
@@ -16,6 +16,8 @@ Authentication package for KrutAI powered by [Better Auth](https://www.better-au
 npm install @krutai/auth
 ```
 
+> **Note:** Installing `@krutai/auth` automatically installs the parent `krutai` package, which provides centralized API key validation for all KrutAI packages.
+
 ## Quick Start
 
 ### Basic Usage
@@ -127,9 +129,35 @@ const apiKey = auth.getApiKey();
 
 **Returns:** `string`
 
+## Architecture
+
+### Dependency on Parent Package
+
+`@krutai/auth` depends on the parent `krutai` package for API key validation:
+
+```
+@krutai/auth
+└── krutai (parent)
+    └── Provides: validateApiKeyFormat, validateApiKeyWithService, etc.
+```
+
+**Benefits:**
+- ✅ All `@krutai/*` packages use the same validation logic from `krutai`
+- ✅ No code duplication across packages
+- ✅ Consistent API key handling
+- ✅ Centralized validation updates benefit all packages
+
+You can also use the validation utilities directly:
+
+```typescript
+import { validateApiKeyFormat, ApiKeyValidationError } from '@krutai/auth';
+// or
+import { validateApiKeyFormat, ApiKeyValidationError } from 'krutai';
+```
+
 ## Error Handling
 
-The package throws `ApiKeyValidationError` when:
+The package throws `ApiKeyValidationError` (from parent `krutai` package) when:
 
 - API key is not provided
 - API key is empty or invalid format

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as better_auth from 'better-auth';
 import { BetterAuthOptions, betterAuth } from 'better-auth';
-export { BetterAuthOptions } from 'better-auth';
+export { BetterAuthOptions, betterAuth } from 'better-auth';
 
 /**
  * Configuration options for KrutAuth
@@ -122,7 +122,13 @@ declare class KrutAuth {
 }
 
 /**
- * Custom error class for API key validation failures
+ * API Key Validation Module
+ *
+ * Centralized API key validation for @krutai/auth.
+ * This is bundled directly into @krutai/auth so no separate `krutai` package install is needed.
+ */
+/**
+ * Custom error for API key validation failures
  */
 declare class ApiKeyValidationError extends Error {
     constructor(message: string);
@@ -130,26 +136,57 @@ declare class ApiKeyValidationError extends Error {
 /**
  * Validates the format of an API key
  * @param apiKey - The API key to validate
- * @throws {ApiKeyValidationError} If the API key is invalid
+ * @throws {ApiKeyValidationError} If the API key format is invalid
  */
-declare function validateApiKeyFormat(apiKey: string | undefined): void;
+declare function validateApiKeyFormat(apiKey: string): void;
 /**
- * Validates an API key against a backend service (optional)
- * This is a placeholder for actual API validation logic
- * @param _apiKey - The API key to validate (currently unused in mock implementation)
- * @returns Promise that resolves if valid, rejects if invalid
+ * Validates an API key with the KrutAI service
+ * @param apiKey - The API key to validate
+ * @returns Promise that resolves to true if valid, false otherwise
  */
-declare function validateApiKeyWithService(_apiKey: string): Promise<boolean>;
+declare function validateApiKeyWithService(apiKey: string): Promise<boolean>;
+/**
+ * Creates a validated API key checker function
+ * @param apiKey - The API key to validate
+ * @returns A function that checks if the API key is valid
+ */
+declare function createApiKeyChecker(apiKey: string): {
+    /**
+     * Validates the API key (cached after first call)
+     */
+    validate(): Promise<boolean>;
+    /**
+     * Resets the validation cache
+     */
+    reset(): void;
+};
 
 /**
  * @krutai/auth - Authentication package for KrutAI
  *
- * This package provides authentication functionality powered by Better Auth
- * with API key validation to ensure secure access.
+ * Everything is bundled — no need to separately install `krutai` or `better-auth`.
+ *
+ * @example Server-side (Next.js API route / server component)
+ * ```typescript
+ * import { betterAuth } from "@krutai/auth";
+ *
+ * export const auth = betterAuth({ ... });
+ * ```
+ *
+ * @example Client-side (React / Next.js client component)
+ * ```typescript
+ * import { createAuthClient } from "@krutai/auth/react";
+ *
+ * export const authClient = createAuthClient({
+ *   baseURL: process.env.NEXT_PUBLIC_APP_URL ?? "http://localhost:3000",
+ * });
+ *
+ * export const { signIn, signUp, signOut, useSession } = authClient;
+ * ```
  *
  * @packageDocumentation
  */
 
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.1.2";
 
-export { ApiKeyValidationError, type AuthSession, KrutAuth, type KrutAuthConfig, VERSION, validateApiKeyFormat, validateApiKeyWithService };
+export { ApiKeyValidationError, type AuthSession, KrutAuth, type KrutAuthConfig, VERSION, createApiKeyChecker, validateApiKeyFormat, validateApiKeyWithService };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as better_auth from 'better-auth';
 import { BetterAuthOptions, betterAuth } from 'better-auth';
-export { BetterAuthOptions } from 'better-auth';
+export { BetterAuthOptions, betterAuth } from 'better-auth';
 
 /**
  * Configuration options for KrutAuth
@@ -122,7 +122,13 @@ declare class KrutAuth {
 }
 
 /**
- * Custom error class for API key validation failures
+ * API Key Validation Module
+ *
+ * Centralized API key validation for @krutai/auth.
+ * This is bundled directly into @krutai/auth so no separate `krutai` package install is needed.
+ */
+/**
+ * Custom error for API key validation failures
  */
 declare class ApiKeyValidationError extends Error {
     constructor(message: string);
@@ -130,26 +136,57 @@ declare class ApiKeyValidationError extends Error {
 /**
  * Validates the format of an API key
  * @param apiKey - The API key to validate
- * @throws {ApiKeyValidationError} If the API key is invalid
+ * @throws {ApiKeyValidationError} If the API key format is invalid
  */
-declare function validateApiKeyFormat(apiKey: string | undefined): void;
+declare function validateApiKeyFormat(apiKey: string): void;
 /**
- * Validates an API key against a backend service (optional)
- * This is a placeholder for actual API validation logic
- * @param _apiKey - The API key to validate (currently unused in mock implementation)
- * @returns Promise that resolves if valid, rejects if invalid
+ * Validates an API key with the KrutAI service
+ * @param apiKey - The API key to validate
+ * @returns Promise that resolves to true if valid, false otherwise
  */
-declare function validateApiKeyWithService(_apiKey: string): Promise<boolean>;
+declare function validateApiKeyWithService(apiKey: string): Promise<boolean>;
+/**
+ * Creates a validated API key checker function
+ * @param apiKey - The API key to validate
+ * @returns A function that checks if the API key is valid
+ */
+declare function createApiKeyChecker(apiKey: string): {
+    /**
+     * Validates the API key (cached after first call)
+     */
+    validate(): Promise<boolean>;
+    /**
+     * Resets the validation cache
+     */
+    reset(): void;
+};
 
 /**
  * @krutai/auth - Authentication package for KrutAI
  *
- * This package provides authentication functionality powered by Better Auth
- * with API key validation to ensure secure access.
+ * Everything is bundled — no need to separately install `krutai` or `better-auth`.
+ *
+ * @example Server-side (Next.js API route / server component)
+ * ```typescript
+ * import { betterAuth } from "@krutai/auth";
+ *
+ * export const auth = betterAuth({ ... });
+ * ```
+ *
+ * @example Client-side (React / Next.js client component)
+ * ```typescript
+ * import { createAuthClient } from "@krutai/auth/react";
+ *
+ * export const authClient = createAuthClient({
+ *   baseURL: process.env.NEXT_PUBLIC_APP_URL ?? "http://localhost:3000",
+ * });
+ *
+ * export const { signIn, signUp, signOut, useSession } = authClient;
+ * ```
  *
  * @packageDocumentation
  */
 
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.1.2";
 
-export { ApiKeyValidationError, type AuthSession, KrutAuth, type KrutAuthConfig, VERSION, validateApiKeyFormat, validateApiKeyWithService };
+export { ApiKeyValidationError, type AuthSession, KrutAuth, type KrutAuthConfig, VERSION, createApiKeyChecker, validateApiKeyFormat, validateApiKeyWithService };