@eeplatform/core 1.8.6 → 1.8.8

package/.github/workflows/publish.yml

@@ -15,26 +15,24 @@ jobs:
   publish:
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
-    environment: production
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - uses: actions/setup-node@v4
         with:
           node-version: 20.x
-          cache: "yarn" # Use yarn for caching
-          cache-dependency-path: yarn.lock # Cache Yarn lockfile
-
-      - run: yarn install --immutable # Install dependencies with immutable lockfile
+          cache: "yarn"
+          cache-dependency-path: yarn.lock
 
-      - name: Create .npmrc for publishing
-        run: |
-          echo '//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}' > ~/.npmrc
+      - run: yarn install --immutable
 
       - name: Create Release Pull Request or Publish
         id: changesets
         uses: changesets/action@v1
         with:
-          publish: yarn release # Use yarn for publishing
+          publish: yarn release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eeplatform/core
 
+## 1.8.8
+
+### Patch Changes
+
+- 6a72a1c: Update dependencies
+
+## 1.8.7
+
+### Patch Changes
+
+- 7bef39f: Add psgc index
+
 ## 1.8.6
 
 ### Patch Changes

package/CLAUDE.md

@@ -0,0 +1,106 @@
+# server-core-module (`@goweekdays/core`)
+
+Shared server module exported as a package consumed by all app servers.
+Built with Express + MongoDB (Atlas) + TypeScript.
+
+## Resource Layer Pattern
+
+Each resource lives under `src/resources/<resource-name>/` and follows this structure:
+
+```
+resource-name/
+  resource.model.ts       # Types and validation schema
+  resource.repository.ts  # Direct database interaction
+  resource.service.ts     # Business logic (optional — see below)
+  resource.controller.ts  # API request handler
+  index.ts                # Barrel export
+```
+
+### `.model.ts`
+
+Defines the TypeScript type and Joi validation schema for the resource. This is the source of truth for the shape of the data.
+
+### `.repository.ts`
+
+Contains all functions that directly interact with the database (MongoDB). No business logic here — only reads and writes.
+
+### `.service.ts`
+
+Builds business logic by composing repository functions and third-party integrations (e.g. hashing, email, S3, transactions). Never accesses the database directly — all DB interaction goes through the repository. **This layer is optional** — if a resource only needs basic CRUD with no business logic, a service file is not required.
+
+### `.controller.ts`
+
+Handles incoming API requests. Validates the request input, then delegates to the service layer if business logic exists, or calls the repository directly if the resource has no service.
+
+### `index.ts`
+
+Re-exports all layers so consumers can import from the resource folder directly.
+
+```typescript
+export * from "./user.model";
+export * from "./user.repository";
+export * from "./user.service";
+export * from "./user.controller";
+```
+
+---
+
+## Naming Conventions
+
+| Layer      | Pattern                     | Example                                              |
+| ---------- | --------------------------- | ---------------------------------------------------- |
+| File       | `<resource>.<layer>.ts`     | `user.model.ts`, `finance.journal.config.service.ts` |
+| Type       | `T<Resource>`               | `TUser`, `TJobPost`                                  |
+| Schema     | `schema<Resource>`          | `schemaUser`, `schemaJobPost`                        |
+| Model fn   | `model<Resource>()`         | `modelUser()`, `modelJobPost()`                      |
+| Repository | `use<Resource>Repo()`       | `useUserRepo()`, `useOrgRepo()`                      |
+| Service    | `use<Resource>Service()`    | `useUserService()`, `useOrgService()`                |
+| Controller | `use<Resource>Controller()` | `useUserController()`                                |
+
+Multi-word resource names use dot notation in file names: `finance.journal.config.model.ts`, `job.post.repository.ts`.
+
+---
+
+## Error Handling
+
+Always use the typed error classes from `@eeplatform/nodejs-utils` — never throw a generic `new Error()`.
+
+- `BadRequestError` — invalid input or a violated business rule
+- `NotFoundError` — resource does not exist
+- `InternalServerError` — unexpected DB or system failure
+- `AppError` — base class; use `instanceof AppError` in catch blocks to re-throw typed errors as-is
+
+---
+
+## Controller Input Extraction
+
+Validate the entire `req.body` against a Joi schema to ensure no unexpected keys are passed. Extract only the fields you need after validation.
+
+1. Define a Joi schema that describes exactly the expected shape
+2. Validate `req.body` (or `req.params` / `req.query`) against it — reject if invalid
+3. Destructure only the needed fields from the validated result
+4. Delegate to the service or repository
+
+This prevents unexpected or extra fields from leaking into the database.
+
+---
+
+## Transactions
+
+Use a MongoDB session whenever a service function writes to more than one collection. The pattern is always:
+
+1. Start session and transaction
+2. Pass `session` down to every repo call
+3. Commit on success, abort on error, and always end the session in `finally`
+
+Transactions belong in the service layer only — never in a controller or repository.
+
+---
+
+## What Not To Do
+
+- **No business logic in controllers** — controllers only handle HTTP input/output and delegate
+- **No direct DB access in controllers or services** — all DB interaction belongs in the repository only
+- **No generic `Error` throws** — use the typed error classes above
+- **No Zod** — validation is done with Joi throughout this module
+- **No extra fields into the DB** — always validate the full request body before using any of it

package/dist/index.d.ts

@@ -762,6 +762,7 @@ declare function usePSGCRepo(): {
         prefix?: string;
         type?: string;
     }) => Promise<TPSGC | null>;
+    setRegionProvinceName: () => Promise<"Successfully set region name as province name for cities." | undefined>;
 };
 
 declare function usePSGCController(): {

package/dist/index.js

@@ -1878,7 +1878,7 @@ function useVerificationService() {
           to: email,
           subject: "Member Invite",
           html: emailContent2,
-          from: "EEPlatform"
+          from: `"EEPlatform" <support@goweekdays.com>`
         }).catch((error) => {
           import_nodejs_utils9.logger.log({
             level: "error",
@@ -1900,7 +1900,7 @@ function useVerificationService() {
         to: email,
         subject: "User Invite",
         html: emailContent,
-        from: "EEPlatform"
+        from: `"EEPlatform" <support@goweekdays.com>`
       }).catch((error) => {
         import_nodejs_utils9.logger.log({
           level: "error",
@@ -1934,7 +1934,7 @@ function useVerificationService() {
       mailer.sendMail({
         to: email,
         subject: "Forget Password",
-        from: "EEPlatform",
+        from: `"EEPlatform" <support@goweekdays.com>`,
         html: emailContent
       }).catch((error) => {
         import_nodejs_utils9.logger.log({
@@ -2129,7 +2129,7 @@ function useVerificationService() {
         to: email,
         subject: "Sign Up Verification",
         html: emailContent,
-        from: "EEPlatform"
+        from: `"EEPlatform" <support@goweekdays.com>`
       }).catch((error) => {
         import_nodejs_utils9.logger.log({
           level: "error",
@@ -6250,6 +6250,40 @@ function usePSGCRepo() {
       throw new import_nodejs_utils33.InternalServerError("Failed to delete PSGC.");
     }
   }
+  async function setRegionProvinceName() {
+    try {
+      const cities = await collection.find({ type: { $in: ["City", "Mun"] } }).toArray();
+      for (let index = 0; index < cities.length; index++) {
+        const city = cities[index];
+        if (city.region) {
+          continue;
+        }
+        const province = await collection.findOne({
+          type: "Prov",
+          code: { $regex: `^${city.code.substring(0, 5)}` }
+        });
+        if (province) {
+          await collection.updateOne(
+            { _id: city._id },
+            { $set: { province: province.name } }
+          );
+        }
+        const region = await collection.findOne({
+          type: "Reg",
+          code: { $regex: `^${city.code.substring(0, 2)}` }
+        });
+        if (region) {
+          await collection.updateOne(
+            { _id: city._id },
+            { $set: { region: region.name } }
+          );
+        }
+      }
+      return "Successfully set region name as province name for cities.";
+    } catch (error) {
+      console.log(error);
+    }
+  }
   return {
     createIndexes,
     add,
@@ -6257,7 +6291,8 @@ function usePSGCRepo() {
     getById,
     updateFieldById,
     deleteById,
-    getByName
+    getByName,
+    setRegionProvinceName
   };
 }