@pextran/db 0.0.3 → 0.0.5

package/README.md

@@ -0,0 +1,55 @@
+# `@pextran/db`
+
+Database-facing helpers for Pextran: Prisma client typing, auth claims resolution, and repository-style APIs for **approvals** and **media**. Built on `@pextran/core` for DTOs, responses, and shared types.
+
+## Install
+
+In a workspace that already uses the peer stack (Next.js, NextAuth v5, React 18, Zustand 4):
+
+```bash
+pnpm add @pextran/db
+```
+
+**Peers:** `next` ^14, `next-auth` 5.0.0-beta.4, `react` / `react-dom` ^18, `zustand` ^4.
+
+**Runtime deps:** `@pextran/core`, `jsonwebtoken`, `pdf-lib`.
+
+## How it works
+
+The package does **not** create its own Prisma client. It exports an [`IPrisma`](./src/prisma.ts) interface describing the client surface area these modules need (`employee`, `tenant`, `organization`, `role`, `department`, `media`, `approval`, `resourceApproval`, …). Your app’s generated `PrismaClient` satisfies this when passed into the functions.
+
+## Public API (barrel: `src/index.ts`)
+
+| Area | Exports | Role |
+|------|---------|------|
+| **Prisma typing** | `IPrisma` | Structural type for injectable Prisma used by all helpers below. |
+| **Employees / auth** | `getEmployeeClaims` | Load employee, department, tenant, org, roles; build `AuthClaims` for session/JWT (optionally via org logo from `getOrgLogo`). |
+| **Approvals** | `findApprovalById`, `findApprovalByResourceType`, `getApprovalsForTenant`, `getResourceApprovalsForResource` | Read approval configs and resource-approval rows; return `NexiResponse<…>` from `@pextran/core`. |
+| **Media** | `upsertMedia`, `upsertMedias`, `getOrgLogo`, `moveAndDeleteMedia`, `findMediasForResourceId`, `findMediasForTypeAndResourceId`, `findMediasForTypeAndResourceIdAndCategory`, `findMediaById`, `getMediasForQuery`, `deleteMedia`, `getDeletedMedias`, `hardDeleteMedia` | CRUD/soft-delete and queries for media rows keyed by tenant and resource. |
+
+## Usage sketch
+
+```ts
+import { PrismaClient } from '@prisma/client'
+import { getEmployeeClaims, getOrgLogo, upsertMedia } from '@pextran/db'
+
+const prisma = new PrismaClient()
+
+// Pass prisma as IPrisma; wrap getOrgLogo for claims:
+const claims = await getEmployeeClaims(
+  prisma,
+  tenantId,
+  email,
+  activeRole,
+  (orgId) => getOrgLogo(prisma, orgId)
+)
+```
+
+## Scripts
+
+- `pnpm run build` — Typecheck (`tsc --noEmit`).
+- `pnpm run patch` — Version bump, publish, and tag (maintainer workflow; see `package.json`).
+
+## License
+
+MIT.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pextran/db",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "pextran DB Utilities",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -41,7 +41,7 @@
     "access": "restricted"
   },
   "dependencies": {
-    "@pextran/core": "^0.0.5",
+    "@pextran/core": "^0.0.15",
     "jsonwebtoken": "^9.0.2",
     "pdf-lib": "^1.17.1"
   }

package/src/README.md

@@ -1 +1 @@
-# Arcisol DB Package
+# Pextran DB Package