@s-hirano-ist/s-database 1.2.0 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@s-hirano-ist/s-database",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Prisma database schema and client for s-private project",
   "type": "module",
   "main": "./src/index.ts",

package/src/index.ts

@@ -1,4 +1,52 @@
-// Re-export all Prisma client types and client
+/**
+ * @packageDocumentation
+ *
+ * Database package providing Prisma client and types for the content management system.
+ *
+ * @remarks
+ * This package wraps the Prisma ORM client and provides:
+ * - Type-safe database access via PrismaClient
+ * - Generated TypeScript types for all database models
+ * - PostgreSQL database connectivity
+ *
+ * ## Database Models
+ *
+ * - **Category** - Hierarchical organization for articles
+ * - **Article** - News/link management with OG metadata
+ * - **Note** - Markdown-based content storage
+ * - **Image** - File metadata with MinIO path storage
+ * - **Book** - ISBN-based book tracking with Google Books integration
+ *
+ * ## Status Lifecycle
+ *
+ * All content models follow a common status workflow:
+ * - `UNEXPORTED` - Initial state, content not yet published
+ * - `LAST_UPDATED` - Content has been modified since last export
+ * - `EXPORTED` - Content has been published/exported
+ *
+ * ## Multi-tenant Design
+ *
+ * All models include `userId` for data isolation between users.
+ * Unique constraints are scoped per user (e.g., `@@unique([url, userId])`).
+ *
+ * @example
+ * ```typescript
+ * import { PrismaClient } from "@s-hirano-ist/s-database";
+ *
+ * const prisma = new PrismaClient();
+ *
+ * // Fetch all unexported articles for a user
+ * const articles = await prisma.article.findMany({
+ *   where: {
+ *     userId: "user-123",
+ *     status: "UNEXPORTED",
+ *   },
+ *   include: { Category: true },
+ * });
+ * ```
+ *
+ * @see {@link https://www.prisma.io/docs | Prisma Documentation}
+ */
 
 export * from "./generated/prisma/client";
 export { Prisma, PrismaClient } from "./generated/prisma/client";