gymmonk-schema 0.1.2 → 0.1.3

package/README.md

@@ -1,93 +1,642 @@
-# Gym Schema
+# 🏋️ gymmonk-schema
+
+> Central Zod v4 schema library for the GymMonk / Gym SaaS ecosystem.
+
+[![npm version](https://img.shields.io/npm/v/gymmonk-schema.svg)](https://www.npmjs.com/package/gymmonk-schema)
+[![License](https://img.shields.io/npm/l/gymmonk-schema.svg)](https://github.com/yourorg/gymmonk-schema/blob/main/LICENSE)
+
+---
+
+## 📋 Table of Contents
+
+- [Overview](#overview)
+- [Installation](#installation)
+- [Core Concepts](#core-concepts)
+  - [Schemas vs Types](#schemas-vs-types)
+  - [Naming Conventions](#naming-conventions)
+- [Library Structure](#library-structure)
+  - [Common](#common)
+  - [Auth](#auth)
+  - [Gym](#gym)
+  - [Workout](#workout)
+  - [Nutrition](#nutrition)
+  - [Subscription](#subscription)
+  - [Marketing](#marketing)
+  - [Notification](#notification)
+  - [Community](#community)
+  - [Feedback](#feedback)
+  - [Support](#support)
+  - [Landing](#landing)
+  - [Audit](#audit)
+- [How to Import](#how-to-import)
+- [Usage Examples](#usage-examples)
+  - [Backend (Express)](#backend-express)
+  - [Frontend (Next.js)](#frontend-nextjs)
+  - [Forms (React Hook Form + Zod)](#forms-react-hook-form--zod)
+  - [API-doc / OpenAPI](#api-doc--openapi)
+- [Development & Publishing](#development--publishing)
+- [Versioning](#versioning)
+
+---
+
+## 🎯 Overview
+
+This package is the **single source of truth** for:
+
+- ✅ Domain models (`User`, `Organisation`, `Center`, `Membership`, `Workout`, etc.)
+- ✅ API DTOs (create/update payloads)
+- ✅ Public view models (safe objects to send to frontend)
+- ✅ Shared primitives (`ObjectId`, dates, pagination, etc.)
+
+### 🚀 Designed for Multi-Platform Use
+
+It is designed to be used by:
+
+- **Backend** (Node.js / Express)
+- **Web frontend** (Next.js)
+- **Mobile app** (React Native)
+- **API-doc project** (OpenAPI/Swagger via zod-to-openapi)
+
+So all layers share the same contracts.
+
+---
+
+## 📦 Installation
+
+In any consumer project (backend, web, app, api-doc):
+
+```bash
+npm install gymmonk-schema
+# or
+yarn add gymmonk-schema
+# or
+pnpm add gymmonk-schema
+```
+
+---
+
+## 💡 Core Concepts
+
+### Schemas vs Types
+
+Each entity is represented by a **Zod schema** and a corresponding **TypeScript type**:
+
+```typescript
+import { z } from "zod";
+
+export const RoleSchema = z.object({
+  name: z.string().min(1),
+  description: z.string().trim().optional(),
+  permissions: z.array(z.string()).default([]),
+});
+
+export type Role = z.infer<typeof RoleSchema>;
+```
+
+#### Two Different Layers
+
+| Layer                     | Description                                                                                                        |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| **Schema** (`RoleSchema`) | • Real runtime object<br>• Validates and parses data<br>• Used in controllers, services, forms, API-doc generation |
+| **Type** (`Role`)         | • Compile-time only (erased at runtime)<br>• Used by TypeScript for static checking and autocomplete               |
 
+You will see this pattern throughout the library.
 
+### Naming Conventions
 
-## Getting started
+Inside each domain:
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+- **Schemas** are named: `XxxSchema`
+- **Types** are named: `Xxx` (via `z.infer<typeof XxxSchema>`)
+- **DTOs** (request/response payloads) are named: `XxxCreateDtoSchema`, `XxxUpdateDtoSchema`, etc.
+- **Public view models** (safe to send to frontend): `PublicXxxSchema`, `type PublicXxx`
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+---
 
-## Add your files
+## 🏗️ Library Structure
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+At the top level, the package exposes namespaced domains:
 
+```typescript
+import {
+  Common,
+  Auth,
+  Gym,
+  Workout,
+  Nutrition,
+  Subscription,
+  Marketing,
+  Notification,
+  Community,
+  Feedback,
+  Support,
+  Landing,
+  Audit,
+} from "gymmonk-schema";
 ```
-cd existing_repo
-git remote add origin https://gitlab.com/transcybernetics-group/inhouse/gym-saas/gym-schema.git
-git branch -M main
-git push -uf origin main
+
+Each domain has its own folder + barrel file and follows the same structure: schemas + types grouped by feature.
+
+Below is an overview of what each domain represents.
+
+---
+
+### 🔧 Common
+
+Building blocks used everywhere.
+
+#### Includes:
+
+**Primitives**
+
+- `ObjectIdSchema`
+- `IsoDateStringSchema`
+- `IsoDateTimeStringSchema`
+- `NonEmptyStringSchema`, `OptionalStringSchema`, etc.
+
+**Value Objects**
+
+- `EmailSchema`
+- `PhoneSchema`
+- `AddressSchema`
+- `NutritionalValuesSchema`
+- `PlanVariantSchema` (for flexible pricing options)
+- `MfaSchema`, `SocialLoginSchema`, etc.
+
+**Enums**
+
+- Gender enum
+- EntityStatus enum
+- NotificationType enum
+
+**Pagination**
+
+- `PaginationSchema` (common page, limit, etc.)
+
+#### Usage Example
+
+```typescript
+const id = Common.Primitives.ObjectIdSchema.parse(someString);
+const pagination = Common.Pagination.PaginationSchema.parse(req.query);
 ```
 
-## Integrate with your tools
+> ℹ️ _Exact nested names may vary slightly; check `src/common/index.ts` for the authoritative exports._
+
+---
+
+### 🔐 Auth
+
+Authentication & authorization related models.
+
+#### Includes (names representative):
+
+- `UserSchema`, `PublicUserSchema`, `UserRegisterDtoSchema` etc.
+- `RoleSchema` (RBAC roles)
+- `PermissionSchema` (fine-grained permissions)
+- `ResourceSchema` (RBAC resources)
+- `TokenSchema` (access/refresh tokens, device tokens)
+- `OtpSchema` (one-time passwords)
+- `DeviceSchema`
+- `PasswordHistorySchema`
+- `UserActivitySchema` (login, logout, etc.)
+
+#### Common Usage:
+
+- **Backend**: validate incoming auth requests (register, login, password reset)
+- **Frontend**: type-safe forms for login/register, and PublicUser types for UI
+
+---
+
+### 🏢 Gym
+
+All gym/organisation/center management models.
+
+#### Includes:
+
+**Organisation / Centers**
+
+- `OrganisationSchema`
+- `CenterSchema`
+- `CenterFacilitySchema`
+- `CenterServiceSchema`
+
+**Catalogs**
+
+- `EquipmentCatalogSchema`
+- `FacilityCatalogSchema`
+- `ServiceCatalogSchema`
+
+**Operational Models**
+
+- `AttendanceSchema`
+- `ClassScheduleSchema`
+- `EquipmentInventorySchema`
+- `GymLayoutSchema`
+- `SessionBookingSchema`
+- `GoalSchema`
+- `AchievementBadgeSchema`
+
+#### Used to Define and Validate:
+
+- How the gym, centers, facilities, services are modeled
+- Attendance tracking
+- Booking / layout / goals / badges
+
+---
+
+### 💪 Workout
+
+Exercise and workout planning & tracking.
+
+#### Includes:
+
+- `ExerciseSchema` (name, muscle groups, media, equipment)
+- `WorkoutPlanSchema` (list of exercises with sets/reps/duration)
+- `WorkoutTrackingEntrySchema` (what a member actually did, per set, per day)
+
+#### Used By:
+
+- **Backend**: workout CRUD, tracking endpoints
+- **Frontend/App**: typed workout UI, tracking screens
+
+---
+
+### 🥗 Nutrition
+
+Ingredient, recipes, diet plans, hydration.
+
+#### Includes:
+
+- `IngredientSchema`
+- `RecipeSchema`, `RecipeIngredientSchema`
+- `DietPlanSchema`, `DietPlanMealSchema`, `DietPlanItemSchema`
+- `DietTrackingEntrySchema`
+- `HydrationTrackingSchema`
+
+#### Use This For:
+
+- Building diet plans and logging diets
+- Aggregating nutrition
+- Hydration tracking
+
+---
+
+### 💳 Subscription
+
+Subscription, membership, coupons, payments.
+
+#### Includes:
+
+- `SubscriptionPlanSchema`
+- `SubscriptionSchema`
+- `MembershipPlanSchema`
+- `MembershipSchema`
+- `CouponSchema`
+- `PaymentTransactionSchema`
+
+#### Used For:
+
+- Defining product plans and membership plans
+- Linking members to plans (Membership, Subscription)
+- Applying coupons and tracking payments
+
+---
+
+### 📢 Marketing
+
+Branding, ads, campaigns, referrals.
+
+#### Includes:
+
+- `BrandSchema`
+- `AdvertisementSchema`
+- `MarketingCampaignSchema`
+- `ReferralSchema`
+
+#### Used For:
+
+- Dashboard banners, campaigns, referral systems
+- Representing marketing data in a unified way
+
+---
+
+### 🔔 Notification
+
+Notifications and templates.
+
+#### Includes:
+
+- `NotificationSchema` (delivered notification entries)
+- `NotificationTemplateSchema` (reusable templates per channel)
+
+**Supports channels like**: `in_app`, `push`, `email`, `sms`.
+
+---
+
+### 👥 Community
+
+Internal community / communication layer.
+
+#### Includes:
+
+- `ConversationSchema`
+- `MessageSchema`
+- `PostSchema`
+
+#### Used For:
+
+- Chats
+- Group conversations
+- Community posts
 
-- [ ] [Set up project integrations](https://gitlab.com/transcybernetics-group/inhouse/gym-saas/gym-schema/-/settings/integrations)
+---
 
-## Collaborate with your team
+### 💬 Feedback
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+User feedback, bug reports, ratings.
 
-## Test and Deploy
+#### Includes:
 
-Use the built-in continuous integration in GitLab.
+- `FeedbackSchema` (type, message, metadata, rating)
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+---
 
-***
+### 🎫 Support
 
-# Editing this README
+Support tickets.
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+#### Includes:
 
-## Suggestions for a good README
+- `SupportTicketSchema` (priority, status, category, assignments, metadata)
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+---
 
-## Name
-Choose a self-explaining name for your project.
+### 🌐 Landing
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+Contact requests from marketing/landing pages.
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+#### Includes:
+
+- `ContactRequestSchema` (name, email/phone, subject, message, metadata)
+
+---
+
+### 📝 Audit
+
+Audit logs.
+
+#### Includes:
+
+- `AuditLogSchema` (who, what, when, before/after, metadata)
+
+---
+
+## 📥 How to Import
+
+### Top-Level Domains (Recommended)
+
+Prefer importing from the root in most cases:
+
+```typescript
+import {
+  Auth,
+  Gym,
+  Subscription,
+  Workout,
+  Nutrition,
+  Common,
+} from "gymmonk-schema";
+
+// Auth
+const dto = Auth.UserRegisterDtoSchema.parse(body);
+
+// Gym
+const center = Gym.CenterSchema.parse(payload);
+
+// Subscription
+type Plan = Subscription.SubscriptionPlan;
+const planSchema = Subscription.SubscriptionPlanSchema;
+```
+
+> 💡 If you want very fine-grained imports, you can also import directly from subpaths as long as your build/exports are configured for it (check your `package.json` "exports" if you add that later).
+
+---
+
+## 🎨 Usage Examples
+
+### Backend (Express)
+
+#### Validate Request Body (DTO)
+
+```typescript
+import { Auth } from "gymmonk-schema";
+import type { Request, Response } from "express";
+
+export async function registerHandler(req: Request, res: Response) {
+  try {
+    const dto = Auth.UserRegisterDtoSchema.parse(req.body);
+
+    // dto is fully validated and typed
+    const user = await createUser(dto);
+
+    const publicUser = Auth.PublicUserSchema.parse(user);
+    return res.status(201).json(publicUser);
+  } catch (err: any) {
+    return res.status(400).json({
+      message: "Invalid request",
+      errors: err.errors ?? err,
+    });
+  }
+}
+```
+
+#### Validate Query Params
+
+```typescript
+import { Common } from "gymmonk-schema";
+
+app.get("/centers", (req, res) => {
+  const pagination = Common.Pagination.PaginationSchema.parse(req.query);
+  // use pagination.page / pagination.limit
+});
+```
+
+---
+
+### Frontend (Next.js)
+
+#### Validate Data Before Sending to Backend
+
+```typescript
+"use client";
+
+import { Auth } from "gymmonk-schema";
+
+async function submit(formData: any) {
+  const dto = Auth.UserRegisterDtoSchema.parse(formData);
+
+  const res = await fetch("/api/auth/register", {
+    method: "POST",
+    body: JSON.stringify(dto),
+    headers: { "Content-Type": "application/json" },
+  });
+
+  return res.json();
+}
+```
+
+#### Strongly Typed UI Components
+
+```typescript
+import { Gym } from "gymmonk-schema";
+
+type Center = Gym.Center;
+
+function CenterCard({ center }: { center: Center }) {
+  return (
+    <div>
+      <h2>{center.name}</h2>
+      <p>{center.address?.city}</p>
+    </div>
+  );
+}
+```
+
+---
+
+### Forms (React Hook Form + Zod)
+
+```typescript
+import { useForm } from "react-hook-form";
+import { zodResolver } from "@hookform/resolvers/zod";
+import { Subscription } from "gymmonk-schema";
+
+const schema = Subscription.SubscriptionPlanSchema;
+type PlanForm = Subscription.SubscriptionPlan;
+
+export function PlanFormComponent() {
+  const form = useForm<PlanForm>({
+    resolver: zodResolver(schema),
+  });
+
+  // form.register, form.handleSubmit, etc.
+}
+```
+
+---
+
+### API-doc / OpenAPI
+
+In your API-doc project (contract-first design), you can introspect schemas and generate OpenAPI:
+
+```typescript
+import {
+  OpenAPIRegistry,
+  generateOpenApiDocument,
+} from "@asteasolutions/zod-to-openapi";
+import { Auth, Gym } from "gymmonk-schema";
+
+const registry = new OpenAPIRegistry();
+
+// Register schemas
+registry.register("User", Auth.PublicUserSchema);
+registry.register("Center", Gym.CenterSchema);
+
+// Register routes and use the schemas in request/response definitions…
+
+const openapi = generateOpenApiDocument(registry.definitions, {
+  openapi: "3.0.0",
+  info: {
+    title: "GymMonk API",
+    version: "1.0.0",
+  },
+});
+
+// Then write openapi.json and serve via swagger-ui-express
+```
+
+This way API docs are always in sync with your code and frontend types.
+
+---
+
+## 🛠️ Development & Publishing
+
+In the `gymmonk-schema` repo:
+
+### Build
+
+```bash
+npm run build
+```
+
+**Typical script:**
+
+```json
+"build": "tsc"
+```
+
+This compiles `src/**/*.ts` → `dist/**/*.js` + `.d.ts`.
+
+### Lint + Format
+
+Using Biome:
+
+```bash
+npm run check      # type-check + lint + format (depending on your script)
+npm run lint       # if you have a separate lint script
+npm run format     # if you have a separate format script
+```
+
+### Version Bump
+
+Use semantic versioning:
+
+```bash
+npm version patch   # 0.1.0 -> 0.1.1
+npm version minor   # 0.1.0 -> 0.2.0
+npm version major   # 0.1.0 -> 1.0.0
+```
+
+This updates `package.json` and creates a git commit + tag (if configured).
+
+### Publish
+
+```bash
+npm login
+npm run build
+npm publish --access public
+```
+
+Then consumers can install:
+
+```bash
+npm install gymmonk-schema
+```
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+---
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+## 📌 Versioning
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+Follow standard **SemVer**:
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+| Version Type | Pattern | Description                                                      |
+| ------------ | ------- | ---------------------------------------------------------------- |
+| **PATCH**    | `x.y.Z` | Internal fixes, no breaking changes                              |
+| **MINOR**    | `x.Y.z` | New schemas/fields added in a backwards-compatible way           |
+| **MAJOR**    | `X.y.z` | Breaking changes (removed fields, renamed, incompatible changes) |
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+### Guidelines:
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+- ✅ **Adding optional fields**: minor
+- ⚠️ **Making a field required or changing its type**: major
+- ⚠️ **Removing schemas or renaming them**: major
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+> 📝 Keep a simple `CHANGELOG.md` to track what changed between versions, especially when schemas or DTOs change in ways that affect consumers.
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+---
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+<div align="center">
 
-## License
-For open source projects, say how it is licensed.
+**Built with ❤️ for the GymMonk ecosystem**
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+</div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gymmonk-schema",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Shared Zod domain schemas for Gym SaaS (frontend + backend).",
   "type": "module",
   "main": "./dist/index.js",