@eeplatform/basic-edu 1.0.0

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.github/workflows/main.yml

@@ -0,0 +1,17 @@
+name: CI
+on:
+  push:
+    branches:
+      - "**"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: "yarn"
+      - run: yarn install --frozen-lockfile
+      - run: yarn lint && yarn build

package/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish
+on:
+  workflow_run:
+    workflows: [CI]
+    branches: [main]
+    types: [completed]
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - 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
+
+      - name: Create .npmrc for publishing
+        run: |
+          echo '//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}' > ~/.npmrc
+
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: yarn release # Use yarn for publishing
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @eeplatform/basic-edu
+
+## 1.0.0
+
+### Major Changes
+
+- 7383921: Initial release

package/dist/index.d.ts

@@ -0,0 +1,134 @@
+import Joi from 'joi';
+import { ObjectId, ClientSession } from 'mongodb';
+import { Request, Response, NextFunction } from 'express';
+
+type TRegion = {
+    _id?: ObjectId;
+    name?: string;
+    director?: ObjectId;
+    directorName?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+};
+declare const schemaRegion: Joi.ObjectSchema<any>;
+declare function modelRegion(value: TRegion): TRegion;
+
+declare function useRegionRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TRegion, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<TRegion>;
+    updateFieldById: ({ _id, field, value }?: {
+        _id: string | ObjectId;
+        field: string;
+        value: string;
+    }, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    getByName: (name: string) => Promise<TRegion>;
+};
+
+declare function useRegionController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByName: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateField: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TDivision = {
+    _id?: ObjectId;
+    name?: string;
+    region?: ObjectId;
+    regionName?: string;
+    superintendent?: ObjectId;
+    superintendentName?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+};
+declare const schemaDivision: Joi.ObjectSchema<any>;
+declare function modelDivision(value: TDivision): TDivision;
+
+declare function useDivisionRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TDivision, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<TDivision>;
+    updateFieldById: ({ _id, field, value }?: {
+        _id: string | ObjectId;
+        field: string;
+        value: string;
+    }, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    getByName: (name: string) => Promise<TDivision>;
+};
+
+declare function useDivisionController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByName: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateField: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TSchool = {
+    _id?: ObjectId;
+    name?: string;
+    region?: ObjectId;
+    regionName?: string;
+    division?: ObjectId;
+    divisionName?: string;
+    principal?: ObjectId;
+    principalName?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
+};
+declare const schemaSchool: Joi.ObjectSchema<any>;
+declare function modelSchool(value: TSchool): TSchool;
+
+declare function useSchoolRepo(): {
+    createIndexes: () => Promise<void>;
+    add: (value: TSchool, session?: ClientSession) => Promise<ObjectId>;
+    getAll: ({ search, page, limit, sort, status, }?: {
+        search?: string | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
+        sort?: {} | undefined;
+        status?: string | undefined;
+    }) => Promise<Record<string, any>>;
+    getById: (_id: string | ObjectId) => Promise<TSchool>;
+    updateFieldById: ({ _id, field, value }?: {
+        _id: string | ObjectId;
+        field: string;
+        value: string;
+    }, session?: ClientSession) => Promise<string>;
+    deleteById: (_id: string | ObjectId) => Promise<string>;
+    getByName: (name: string) => Promise<TSchool>;
+};
+
+declare function useSchoolController(): {
+    add: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getByName: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateField: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+export { TDivision, TRegion, TSchool, modelDivision, modelRegion, modelSchool, schemaDivision, schemaRegion, schemaSchool, useDivisionController, useDivisionRepo, useRegionController, useRegionRepo, useSchoolController, useSchoolRepo };