@eeplatform/basic-edu 1.10.38 → 1.10.40

package/.github/workflows/publish.yml

@@ -17,23 +17,22 @@ jobs:
     runs-on: ubuntu-latest
     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/basic-edu
 
+## 1.10.40
+
+### Patch Changes
+
+- ef02db4: Update dependencies
+
+## 1.10.39
+
+### Patch Changes
+
+- 338451c: Make LRN optional and use quoted search
+
 ## 1.10.38
 
 ### 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

@@ -1074,7 +1074,7 @@ declare function useSectionController(): {
 
 type TSectionStudent = {
     _id?: ObjectId;
-    lrn: string;
+    lrn?: string;
     school: ObjectId | string;
     schoolName?: string;
     section: ObjectId | string;

package/dist/index.js

@@ -6521,7 +6521,7 @@ function useSchoolRepo() {
       cacheKeyOptions.prefix = prefix;
     }
     if (search) {
-      query.$text = { $search: search };
+      query.$text = { $search: `"${search}"` };
       cacheKeyOptions.search = search;
     }
     const cacheKey = (0, import_nodejs_utils24.makeCacheKey)(namespace_collection, cacheKeyOptions);
@@ -39975,7 +39975,7 @@ var allowedSectionStudentStatuses = [
 ];
 var schemaSectionStudent = import_joi33.default.object({
   _id: import_joi33.default.string().hex().optional().allow(null, ""),
-  lrn: import_joi33.default.string().required(),
+  lrn: import_joi33.default.string().optional().allow(null, ""),
   school: import_joi33.default.string().hex().required(),
   schoolName: import_joi33.default.string().optional().allow(null, ""),
   section: import_joi33.default.string().hex().required(),
@@ -42380,9 +42380,6 @@ function useSectionService() {
           if (!student._id) {
             throw new import_nodejs_utils66.BadRequestError("Learner ID is missing.");
           }
-          if (!student.learnerInfo.lrn) {
-            throw new import_nodejs_utils66.BadRequestError("Learner LRN is missing.");
-          }
           const existingStudent = await getStudent({
             student: student._id.toString(),
             schoolYear: value.schoolYear,