@gooddaydev/common 1.0.1

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@gooddaydev/common",
+  "version": "1.0.1",
+  "description": "Common utilities for TypeScript projects with CI/CD",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
+  "scripts": {
+    "build": "rollup --config ./rollup.config.mjs"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goodday-repo/common"
+  },
+  "keywords": [
+    "typescript",
+    "common",
+    "ci",
+    "cd"
+  ],
+  "author": "Edward Leong",
+  "license": "MIT",
+  "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.4",
+    "@types/jest": "^29.5.14",
+    "@types/mongoose-delete": "^1.0.6",
+    "@types/node": "^22.10.2",
+    "eslint": "^9.16.0",
+    "jest": "^29.7.0",
+    "rollup": "^4.28.1",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "mongoose": "^8.12.1",
+    "mongoose-delete": "^1.0.2"
+  }
+}

package/rollup.config.mjs

@@ -0,0 +1,75 @@
+// @ts-check
+
+import { readFile } from 'node:fs/promises';
+import terser from '@rollup/plugin-terser';
+import typescript2 from 'rollup-plugin-typescript2';
+
+const packageJSON = JSON.parse(await readFile('./package.json', 'utf-8'));
+
+/**
+ * Comment with library information to be appended in the generated bundles.
+ */
+const banner = `/*!
+ * ${packageJSON.name} v${packageJSON.version}
+ * (c) ${packageJSON.author.name}
+ * Released under the ${packageJSON.license} License.
+ */
+`;
+
+/**
+ * Creates an output options object for Rollup.js.
+ * @param {import('rollup').OutputOptions} options
+ * @returns {import('rollup').OutputOptions}
+ */
+function createOutputOptions(options) {
+  return {
+    banner,
+    name: '[libraryCamelCaseName]',
+    exports: 'named',
+    sourcemap: true,
+    ...options,
+  };
+}
+
+/**
+ * @type {import('rollup').RollupOptions}
+ */
+const options = {
+  input: './src/index.ts',
+  output: [
+    createOutputOptions({
+      file: './dist/index.js',
+      format: 'commonjs',
+    }),
+    createOutputOptions({
+      file: './dist/index.cjs',
+      format: 'commonjs',
+    }),
+    createOutputOptions({
+      file: './dist/index.mjs',
+      format: 'esm',
+    }),
+    createOutputOptions({
+      file: './dist/index.esm.js',
+      format: 'esm',
+    }),
+    createOutputOptions({
+      file: './dist/index.umd.js',
+      format: 'umd',
+    }),
+    createOutputOptions({
+      file: './dist/index.umd.min.js',
+      format: 'umd',
+      plugins: [terser()],
+    }),
+  ],
+  plugins: [
+    typescript2({
+      clean: true,
+      useTsconfigDeclarationDir: true,
+      tsconfig: './tsconfig.bundle.json',
+    }),
+  ],
+};
+
+export default options;

package/src/base/base.service.ts

@@ -0,0 +1,100 @@
+import {
+  Document,
+  ObjectId,
+  ProjectionType,
+  QueryOptions,
+  QueryWithHelpers,
+  UpdateQuery,
+} from 'mongoose';
+import { SoftDeleteModel } from 'mongoose-delete';
+
+export interface IQueryOptions {
+  page: number;
+  limit: number;
+  sorter: any;
+  filter: any;
+  lean: boolean;
+}
+
+interface PaginateModel<T> {
+  paginate(
+    filter: any,
+    options: {
+      page: number;
+      limit: number;
+      sort: any;
+      lean: boolean;
+    },
+  ): Promise<T>;
+}
+
+export class BaseService<T extends Document, CreateDto> {
+  constructor(private readonly model: SoftDeleteModel<T> & PaginateModel<T>) {
+    this.model = model;
+  }
+
+  async index(query: IQueryOptions) {
+    const sort = { [query.sorter.column]: query.sorter.state };
+
+    return await this.model.paginate(query.filter, {
+      page: query.page,
+      limit: query.limit,
+      sort: sort,
+      lean: query.lean,
+    });
+  }
+
+  async create(data: CreateDto | CreateDto[]): Promise<T> {
+    return await this.model.create(data);
+  }
+
+  async find(
+    filter: any,
+    projection?: ProjectionType<T>,
+    options?: QueryOptions<T>,
+  ): Promise<QueryWithHelpers<T[], T>> {
+    return await this.model.find(filter, projection, options);
+  }
+
+  async findOne(
+    filter: any,
+    projection?: ProjectionType<T>,
+    options?: QueryOptions<T>,
+  ): Promise<QueryWithHelpers<T | null, T>> {
+    return await this.model.findOne(filter, projection, options);
+  }
+
+  async findById(
+    id: string | ObjectId,
+    projection?: ProjectionType<T>,
+    options?: QueryOptions<T>,
+  ): Promise<QueryWithHelpers<T | null, T>> {
+    return await this.model.findById(id, projection, options);
+  }
+
+  async updateOne(
+    args: any,
+    set: UpdateQuery<T>,
+    options?: QueryOptions<T>,
+  ): Promise<boolean> {
+    return (await this.model.updateOne(args, set, options as UpdateQuery<T>))
+      .acknowledged;
+  }
+
+  async updateMany(
+    args: any,
+    set: UpdateQuery<T>,
+    options?: QueryOptions<T>,
+  ): Promise<number> {
+    return (await this.model.updateMany(args, set, options as UpdateQuery<T>))
+      .modifiedCount;
+  }
+
+  async deleteOne(args: any): Promise<boolean> {
+    return (await this.model.deleteOne(args)).acknowledged;
+  }
+
+  async deleteMany(args: any): Promise<number> {
+    return (await this.model.deleteMany(args)).deletedCount;
+  }
+}

package/src/enum/user-type.enum.ts

@@ -0,0 +1,5 @@
+export enum UserType {
+  ADMIN = 'admin',
+  USER = 'user',
+}
+

package/src/index.ts

@@ -0,0 +1,5 @@
+// base
+export * from './base/base.service';
+
+// enum
+export * from './enum/user-type.enum';

package/tsconfig.bundle.json

@@ -0,0 +1,19 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    // Transpilation settings.
+    "module": "ES2020",
+    "target": "ES5",
+    // Output settings.
+    "newLine": "LF",
+    "sourceMap": true,
+    // Type declaration settings.
+    "declaration": true,
+    "declarationDir": "types/",
+    "declarationMap": true
+  },
+  "exclude": [
+    "./src/**/*.test.ts",
+    "./src/**/*.test.tsx"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    // React.js JSX settings.
+    "jsx": "react",
+    "jsxFactory": "React.createElement",
+    "jsxFragmentFactory": "React.Fragment",
+
+    // Module settings.
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+
+    // Strictness and quality settings.
+    "alwaysStrict": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strict": true,
+
+    // Type-checking settings.
+    "lib": ["ES2020", "dom"],
+    "skipDefaultLibCheck": true,
+    "skipLibCheck": true,
+    "types": ["jest"]
+  },
+  "include": ["./src/**/*.ts", "./src/**/*.tsx"]
+}

package/types/base/base.service.d.ts

@@ -0,0 +1,32 @@
+import { Document, ObjectId, ProjectionType, QueryOptions, QueryWithHelpers, UpdateQuery } from 'mongoose';
+import { SoftDeleteModel } from 'mongoose-delete';
+export interface IQueryOptions {
+    page: number;
+    limit: number;
+    sorter: any;
+    filter: any;
+    lean: boolean;
+}
+interface PaginateModel<T> {
+    paginate(filter: any, options: {
+        page: number;
+        limit: number;
+        sort: any;
+        lean: boolean;
+    }): Promise<T>;
+}
+export declare class BaseService<T extends Document, CreateDto> {
+    private readonly model;
+    constructor(model: SoftDeleteModel<T> & PaginateModel<T>);
+    index(query: IQueryOptions): Promise<T>;
+    create(data: CreateDto | CreateDto[]): Promise<T>;
+    find(filter: any, projection?: ProjectionType<T>, options?: QueryOptions<T>): Promise<QueryWithHelpers<T[], T>>;
+    findOne(filter: any, projection?: ProjectionType<T>, options?: QueryOptions<T>): Promise<QueryWithHelpers<T | null, T>>;
+    findById(id: string | ObjectId, projection?: ProjectionType<T>, options?: QueryOptions<T>): Promise<QueryWithHelpers<T | null, T>>;
+    updateOne(args: any, set: UpdateQuery<T>, options?: QueryOptions<T>): Promise<boolean>;
+    updateMany(args: any, set: UpdateQuery<T>, options?: QueryOptions<T>): Promise<number>;
+    deleteOne(args: any): Promise<boolean>;
+    deleteMany(args: any): Promise<number>;
+}
+export {};
+//# sourceMappingURL=base.service.d.ts.map

package/types/base/base.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.service.d.ts","sourceRoot":"","sources":["../../src/base/base.service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,WAAW,EACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,GAAG,CAAC;IACZ,IAAI,EAAE,OAAO,CAAC;CACf;AAED,UAAU,aAAa,CAAC,CAAC;IACvB,QAAQ,CACN,MAAM,EAAE,GAAG,EACX,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,GAAG,CAAC;QACV,IAAI,EAAE,OAAO,CAAC;KACf,GACA,OAAO,CAAC,CAAC,CAAC,CAAC;CACf;AAED,qBAAa,WAAW,CAAC,CAAC,SAAS,QAAQ,EAAE,SAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;IAInE,KAAK,CAAC,KAAK,EAAE,aAAa;IAW1B,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAIjD,IAAI,CACR,MAAM,EAAE,GAAG,EACX,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAC9B,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAI9B,OAAO,CACX,MAAM,EAAE,GAAG,EACX,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAC9B,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;IAInC,QAAQ,CACZ,EAAE,EAAE,MAAM,GAAG,QAAQ,EACrB,UAAU,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,EAC9B,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,gBAAgB,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;IAInC,SAAS,CACb,IAAI,EAAE,GAAG,EACT,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,EACnB,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,OAAO,CAAC;IAKb,UAAU,CACd,IAAI,EAAE,GAAG,EACT,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,EACnB,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC,MAAM,CAAC;IAKZ,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAItC,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;CAG7C"}

package/types/enum/user-type.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum UserType {
+    ADMIN = "admin",
+    USER = "user"
+}
+//# sourceMappingURL=user-type.enum.d.ts.map

package/types/enum/user-type.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-type.enum.d.ts","sourceRoot":"","sources":["../../src/enum/user-type.enum.ts"],"names":[],"mappings":"AAAA,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;CACd"}

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './base/base.service';
+export * from './enum/user-type.enum';
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,qBAAqB,CAAC;AAGpC,cAAc,uBAAuB,CAAC"}