@veloxts/orm 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Type definitions for @veloxts/orm
+ *
+ * Provides type-safe abstractions for Prisma client integration
+ * without requiring direct Prisma dependency.
+ *
+ * @module types
+ */
+/**
+ * Extend the VeloxErrorCodeRegistry to include ORM-specific error codes
+ *
+ * This enables type-safe error handling for database-related errors
+ */
+declare module '@veloxts/core' {
+    interface VeloxErrorCodeRegistry {
+        orm: 'DATABASE_CONNECTION_ERROR' | 'DATABASE_DISCONNECTION_ERROR' | 'DATABASE_NOT_CONNECTED' | 'DATABASE_ALREADY_CONNECTED' | 'DATABASE_CONNECTION_IN_PROGRESS' | 'DATABASE_DISCONNECTION_IN_PROGRESS';
+    }
+}
+/**
+ * Minimal interface that any Prisma client must satisfy
+ *
+ * This interface allows the ORM package to work with any Prisma client
+ * without requiring @prisma/client as a direct dependency.
+ *
+ * @example
+ * ```typescript
+ * import { PrismaClient } from '@prisma/client';
+ *
+ * // PrismaClient satisfies DatabaseClient
+ * const prisma: DatabaseClient = new PrismaClient();
+ * ```
+ */
+export interface DatabaseClient {
+    /**
+     * Establishes connection to the database
+     *
+     * Called automatically when using createDatabasePlugin,
+     * or can be called manually with createDatabase.
+     */
+    $connect: () => Promise<void>;
+    /**
+     * Disconnects from the database
+     *
+     * Called automatically during app shutdown when using createDatabasePlugin,
+     * or can be called manually with createDatabase.
+     */
+    $disconnect: () => Promise<void>;
+}
+/**
+ * Type guard to check if an object is a valid DatabaseClient
+ *
+ * Uses property checks to ensure the object has the required methods
+ * without using type assertions.
+ *
+ * @param value - Value to check
+ * @returns true if value satisfies DatabaseClient interface
+ *
+ * @example
+ * ```typescript
+ * if (isDatabaseClient(unknownValue)) {
+ *   await unknownValue.$connect();
+ * }
+ * ```
+ */
+export declare function isDatabaseClient(value: unknown): value is DatabaseClient;
+/**
+ * Configuration options for the database plugin
+ *
+ * @template TClient - Type of the Prisma client
+ */
+export interface OrmPluginConfig<TClient extends DatabaseClient> {
+    /**
+     * The Prisma client instance to use
+     *
+     * Must be an already-instantiated PrismaClient. Connection will be
+     * managed by the plugin (connect on start, disconnect on shutdown).
+     *
+     * @example
+     * ```typescript
+     * const prisma = new PrismaClient();
+     * const plugin = createDatabasePlugin({ client: prisma });
+     * ```
+     */
+    client: TClient;
+    /**
+     * Custom name for the plugin registration
+     *
+     * Defaults to '@veloxts/orm'. Useful when registering multiple database
+     * connections with different names.
+     *
+     * @default '@veloxts/orm'
+     */
+    name?: string;
+}
+/**
+ * Configuration options for the database wrapper
+ */
+export interface DatabaseWrapperConfig<TClient extends DatabaseClient> {
+    /**
+     * The Prisma client instance to wrap
+     */
+    client: TClient;
+}
+/**
+ * Possible states of a database connection
+ */
+export type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'disconnecting';
+/**
+ * Database connection status information
+ */
+export interface ConnectionStatus {
+    /**
+     * Current connection state
+     */
+    state: ConnectionState;
+    /**
+     * Whether the database is currently connected and ready for queries
+     */
+    isConnected: boolean;
+    /**
+     * Timestamp of last successful connection, if any
+     */
+    connectedAt?: Date;
+}
+/**
+ * Infer the client type from an OrmPluginConfig
+ *
+ * @template T - OrmPluginConfig type
+ *
+ * @example
+ * ```typescript
+ * const config = { client: new PrismaClient() };
+ * type Client = InferClientType<typeof config>;
+ * // Client = PrismaClient
+ * ```
+ */
+export type InferClientType<T> = T extends OrmPluginConfig<infer C> ? C : never;
+/**
+ * Infer the client type from a Database wrapper
+ *
+ * @template T - Database wrapper type
+ */
+export type InferDatabaseClient<T> = T extends {
+    client: infer C;
+} ? C : never;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH;;;;GAIG;AACH,OAAO,QAAQ,eAAe,CAAC;IAC7B,UAAU,sBAAsB;QAC9B,GAAG,EACC,2BAA2B,GAC3B,8BAA8B,GAC9B,wBAAwB,GACxB,4BAA4B,GAC5B,iCAAiC,GACjC,oCAAoC,CAAC;KAC1C;CACF;AAMD;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B;;;;;OAKG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAClC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAYxE;AAMD;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,OAAO,SAAS,cAAc;IAC7D;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,OAAO,SAAS,cAAc;IACnE;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAMD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,YAAY,GAAG,WAAW,GAAG,eAAe,CAAC;AAE5F;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IAEvB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAC;CACpB;AAMD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC"}

package/dist/types.js

@@ -0,0 +1,35 @@
+/**
+ * Type definitions for @veloxts/orm
+ *
+ * Provides type-safe abstractions for Prisma client integration
+ * without requiring direct Prisma dependency.
+ *
+ * @module types
+ */
+/**
+ * Type guard to check if an object is a valid DatabaseClient
+ *
+ * Uses property checks to ensure the object has the required methods
+ * without using type assertions.
+ *
+ * @param value - Value to check
+ * @returns true if value satisfies DatabaseClient interface
+ *
+ * @example
+ * ```typescript
+ * if (isDatabaseClient(unknownValue)) {
+ *   await unknownValue.$connect();
+ * }
+ * ```
+ */
+export function isDatabaseClient(value) {
+    if (typeof value !== 'object' || value === null) {
+        return false;
+    }
+    // Check for required methods
+    return ('$connect' in value &&
+        typeof value.$connect === 'function' &&
+        '$disconnect' in value &&
+        typeof value.$disconnect === 'function');
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AA2DH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6BAA6B;IAC7B,OAAO,CACL,UAAU,IAAI,KAAK;QACnB,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU;QACpC,aAAa,IAAI,KAAK;QACtB,OAAO,KAAK,CAAC,WAAW,KAAK,UAAU,CACxC,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@veloxts/orm",
+  "version": "0.1.0",
+  "description": "Prisma wrapper with enhanced DX for VeloxTS framework",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "fastify": "5.6.2",
+    "@veloxts/core": "0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "5.9.3",
+    "vitest": "4.0.15"
+  },
+  "peerDependencies": {
+    "@prisma/client": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@prisma/client": {
+      "optional": true
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "velox",
+    "orm",
+    "prisma",
+    "database",
+    "fullstack",
+    "typescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/veloxts/velox-ts-framework",
+    "directory": "packages/orm"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}