@ticatec/common-express-server 0.0.8 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +491 -0
  2. package/lib/AppConf.d.ts +31 -0
  3. package/lib/AppConf.js +57 -0
  4. package/lib/AppConf.js.map +1 -0
  5. package/lib/BaseServer.d.ts +72 -26
  6. package/lib/BaseServer.js +52 -24
  7. package/lib/BaseServer.js.map +1 -1
  8. package/lib/CommonRouterHelper.d.ts +45 -22
  9. package/lib/CommonRouterHelper.js +52 -22
  10. package/lib/CommonRouterHelper.js.map +1 -1
  11. package/lib/CommonRoutes.d.ts +21 -3
  12. package/lib/CommonRoutes.js +16 -1
  13. package/lib/CommonRoutes.js.map +1 -1
  14. package/lib/LoggedUser.d.ts +11 -15
  15. package/lib/common/AdminBaseController.d.ts +14 -10
  16. package/lib/common/AdminBaseController.js +11 -8
  17. package/lib/common/AdminBaseController.js.map +1 -1
  18. package/lib/common/AdminSearchController.d.ts +6 -1
  19. package/lib/common/AdminSearchController.js +7 -2
  20. package/lib/common/AdminSearchController.js.map +1 -1
  21. package/lib/common/BaseController.d.ts +18 -2
  22. package/lib/common/BaseController.js +18 -3
  23. package/lib/common/BaseController.js.map +1 -1
  24. package/lib/common/CommonController.d.ts +49 -25
  25. package/lib/common/CommonController.js +42 -23
  26. package/lib/common/CommonController.js.map +1 -1
  27. package/lib/common/TenantBaseController.d.ts +16 -11
  28. package/lib/common/TenantBaseController.js +14 -13
  29. package/lib/common/TenantBaseController.js.map +1 -1
  30. package/lib/common/TenantSearchController.d.ts +6 -1
  31. package/lib/common/TenantSearchController.js +7 -2
  32. package/lib/common/TenantSearchController.js.map +1 -1
  33. package/lib/index.d.ts +14 -0
  34. package/lib/index.js +30 -0
  35. package/lib/index.js.map +1 -0
  36. package/package.json +54 -14
  37. package/.idea/common-express-server.iml +0 -9
  38. package/.idea/inspectionProfiles/Project_Default.xml +0 -11
  39. package/.idea/misc.xml +0 -5
  40. package/.idea/modules.xml +0 -8
  41. package/.idea/vcs.xml +0 -6
  42. package/tsconfig.json +0 -13
@@ -6,13 +6,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const TenantBaseController_1 = __importDefault(require("./TenantBaseController"));
7
7
  const BaseController_1 = __importDefault(require("./BaseController"));
8
8
  /**
9
- * 供租户使用带查询的接口
9
+ * Interface with search capabilities for tenant use
10
+ * @template T The service type this controller depends on
10
11
  */
11
12
  class TenantSearchController extends TenantBaseController_1.default {
13
+ /**
14
+ * Search method for querying entities with tenant context
15
+ * @returns Function that handles tenant-specific search requests
16
+ */
12
17
  search() {
13
18
  return async (req) => {
14
19
  let query = req.query;
15
- BaseController_1.default.debugEnabled && this.logger.debug(`path: ${req.path}, query by criteria:`, query);
20
+ BaseController_1.default.debugEnabled && this.logger.debug(`Path: ${req.path}, query by criteria:`, query);
16
21
  this.checkInterface('search');
17
22
  return await this.invokeServiceInterface('search', [this.getLoggedUser(req), query]);
18
23
  };
@@ -1 +1 @@
1
- {"version":3,"file":"TenantSearchController.js","sourceRoot":"src/","sources":["common/TenantSearchController.ts"],"names":[],"mappings":";;;;;AACA,kFAA0D;AAC1D,sEAA8C;AAE9C;;GAEG;AACH,MAA8B,sBAA0B,SAAQ,8BAAuB;IAEnF,MAAM;QACF,OAAO,KAAK,EAAE,GAAW,EAAe,EAAE;YACtC,IAAI,KAAK,GAAO,GAAG,CAAC,KAAK,CAAC;YAC1B,wBAAc,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,IAAI,sBAAsB,EAAE,KAAK,CAAC,CAAC;YACjG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YAC9B,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACzF,CAAC,CAAA;IACL,CAAC;CAEJ;AAXD,yCAWC"}
1
+ {"version":3,"file":"TenantSearchController.js","sourceRoot":"src/","sources":["common/TenantSearchController.ts"],"names":[],"mappings":";;;;;AACA,kFAA0D;AAC1D,sEAA8C;AAE9C;;;GAGG;AACH,MAA8B,sBAA0B,SAAQ,8BAAuB;IAEnF;;;OAGG;IACH,MAAM;QACF,OAAO,KAAK,EAAE,GAAW,EAAe,EAAE;YACtC,IAAI,KAAK,GAAO,GAAG,CAAC,KAAK,CAAC;YAC1B,wBAAc,CAAC,YAAY,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,IAAI,sBAAsB,EAAE,KAAK,CAAC,CAAC;YACjG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YAC9B,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACzF,CAAC,CAAA;IACL,CAAC;CAEJ;AAfD,yCAeC"}
package/lib/index.d.ts ADDED
@@ -0,0 +1,14 @@
1
+ import BaseServer from './BaseServer';
2
+ export { default as CommonRouterHelper } from './CommonRouterHelper';
3
+ export { default as CommonRoutes } from './CommonRoutes';
4
+ export { default as AppConf } from './AppConf';
5
+ export { default as LoggedUser, CommonUser } from './LoggedUser';
6
+ export { default as BaseController } from './common/BaseController';
7
+ export { default as CommonController } from './common/CommonController';
8
+ export { default as AdminBaseController } from './common/AdminBaseController';
9
+ export { default as TenantBaseController } from './common/TenantBaseController';
10
+ export { default as AdminSearchController } from './common/AdminSearchController';
11
+ export { default as TenantSearchController } from './common/TenantSearchController';
12
+ export type { RestfulFunction, ControlFunction } from './CommonRouterHelper';
13
+ export type { moduleLoader } from './BaseServer';
14
+ export default BaseServer;
package/lib/index.js ADDED
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ // Main entry point for @ticatec/common-express-server
3
+ var __importDefault = (this && this.__importDefault) || function (mod) {
4
+ return (mod && mod.__esModule) ? mod : { "default": mod };
5
+ };
6
+ Object.defineProperty(exports, "__esModule", { value: true });
7
+ exports.TenantSearchController = exports.AdminSearchController = exports.TenantBaseController = exports.AdminBaseController = exports.CommonController = exports.BaseController = exports.AppConf = exports.CommonRoutes = exports.CommonRouterHelper = void 0;
8
+ // Core classes
9
+ const BaseServer_1 = __importDefault(require("./BaseServer"));
10
+ var CommonRouterHelper_1 = require("./CommonRouterHelper");
11
+ Object.defineProperty(exports, "CommonRouterHelper", { enumerable: true, get: function () { return __importDefault(CommonRouterHelper_1).default; } });
12
+ var CommonRoutes_1 = require("./CommonRoutes");
13
+ Object.defineProperty(exports, "CommonRoutes", { enumerable: true, get: function () { return __importDefault(CommonRoutes_1).default; } });
14
+ var AppConf_1 = require("./AppConf");
15
+ Object.defineProperty(exports, "AppConf", { enumerable: true, get: function () { return __importDefault(AppConf_1).default; } });
16
+ // Controllers
17
+ var BaseController_1 = require("./common/BaseController");
18
+ Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return __importDefault(BaseController_1).default; } });
19
+ var CommonController_1 = require("./common/CommonController");
20
+ Object.defineProperty(exports, "CommonController", { enumerable: true, get: function () { return __importDefault(CommonController_1).default; } });
21
+ var AdminBaseController_1 = require("./common/AdminBaseController");
22
+ Object.defineProperty(exports, "AdminBaseController", { enumerable: true, get: function () { return __importDefault(AdminBaseController_1).default; } });
23
+ var TenantBaseController_1 = require("./common/TenantBaseController");
24
+ Object.defineProperty(exports, "TenantBaseController", { enumerable: true, get: function () { return __importDefault(TenantBaseController_1).default; } });
25
+ var AdminSearchController_1 = require("./common/AdminSearchController");
26
+ Object.defineProperty(exports, "AdminSearchController", { enumerable: true, get: function () { return __importDefault(AdminSearchController_1).default; } });
27
+ var TenantSearchController_1 = require("./common/TenantSearchController");
28
+ Object.defineProperty(exports, "TenantSearchController", { enumerable: true, get: function () { return __importDefault(TenantSearchController_1).default; } });
29
+ exports.default = BaseServer_1.default;
30
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"src/","sources":["index.ts"],"names":[],"mappings":";AACA,sDAAsD;;;;;;AAEtD,eAAe;AACf,8DAAsC;AAEtC,2DAAmE;AAA3D,yIAAA,OAAO,OAAsB;AACrC,+CAAuD;AAA/C,6HAAA,OAAO,OAAgB;AAC/B,qCAA6C;AAArC,mHAAA,OAAO,OAAW;AAK1B,cAAc;AACd,0DAAoE;AAA3D,iIAAA,OAAO,OAAkB;AAClC,8DAAwE;AAA/D,qIAAA,OAAO,OAAoB;AACpC,oEAA8E;AAArE,2IAAA,OAAO,OAAuB;AACvC,sEAAgF;AAAvE,6IAAA,OAAO,OAAwB;AACxC,wEAAkF;AAAzE,+IAAA,OAAO,OAAyB;AACzC,0EAAoF;AAA3E,iJAAA,OAAO,OAA0B;AAM1C,kBAAe,oBAAU,CAAC"}
package/package.json CHANGED
@@ -1,41 +1,81 @@
1
1
  {
2
2
  "name": "@ticatec/common-express-server",
3
- "version": "0.0.8",
4
- "description": "A set of common classes for node express apps.",
3
+ "version": "0.1.2",
4
+ "description": "A comprehensive TypeScript library providing common classes, controllers, and middleware for building scalable Express.js applications with multi-tenant support.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
7
7
  "scripts": {
8
- "test": "echo \"Error: no test specified\" && exit 1",
9
8
  "build": "rm -rf ./lib && tsc",
10
- "publish-public": "npm publish --access public"
9
+ "build:watch": "tsc --watch",
10
+ "clean": "rm -rf ./lib",
11
+ "prepare": "npm run build",
12
+ "prepack": "npm run build",
13
+ "test": "echo \"Error: no test specified\" && exit 1",
14
+ "lint": "echo \"No linting configured\"",
15
+ "typecheck": "tsc --noEmit",
16
+ "dev": "tsc --watch",
17
+ "publish-public": "npm run build && npm publish --access public"
11
18
  },
12
19
  "keywords": [
20
+ "express",
21
+ "typescript",
22
+ "nodejs",
23
+ "rest-api",
24
+ "middleware",
25
+ "controller",
26
+ "multi-tenant",
27
+ "authentication",
28
+ "routing",
29
+ "server",
30
+ "framework",
13
31
  "ticatec",
14
32
  "common",
15
- "database",
16
33
  "utils"
17
34
  ],
18
35
  "repository": {
19
36
  "type": "git",
20
37
  "url": "https://github.com/ticatec/common-express-server.git"
21
38
  },
22
- "author": "Henry Feng",
39
+ "author": {
40
+ "name": "Henry Feng",
41
+ "email": "henry@ticatec.com"
42
+ },
23
43
  "license": "MIT",
24
44
  "bugs": {
25
45
  "url": "https://github.com/ticatec/common-express-server/issues"
26
46
  },
27
- "homepage": "https://github.com/ticatec/common-express-server",
47
+ "homepage": "https://github.com/ticatec/common-express-server#readme",
48
+ "files": [
49
+ "lib/**/*",
50
+ "README.md",
51
+ "LICENSE",
52
+ "package.json"
53
+ ],
54
+ "engines": {
55
+ "node": ">=18.0.0",
56
+ "npm": ">=8.0.0"
57
+ },
58
+ "publishConfig": {
59
+ "access": "public",
60
+ "registry": "https://registry.npmjs.org/"
61
+ },
62
+ "dependencies": {
63
+ "@ticatec/bean-validator": "^0.0.6",
64
+ "@ticatec/express-exception": "^1.1.3",
65
+ "@ticatec/node-common-library": "^2.2.0",
66
+ "log4js": "^6.7.0"
67
+ },
28
68
  "devDependencies": {
29
69
  "@types/express": "^5.0.1",
30
- "@types/node": "^22.8.6"
70
+ "@types/node": "^22.8.6",
71
+ "typescript": "^5.0.0"
31
72
  },
32
- "dependencies": {
33
- "@ticatec/bean-validator": "^0.0.1",
34
- "@ticatec/express-exception": "^1.1.1",
73
+ "peerDependencies": {
35
74
  "express": "^5.1.0"
36
75
  },
37
- "peerDependencies": {
38
- "express": "^5.1.0",
39
- "log4js": "^6.7.0"
76
+ "peerDependenciesMeta": {
77
+ "express": {
78
+ "optional": false
79
+ }
40
80
  }
41
81
  }
@@ -1,9 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <module type="JAVA_MODULE" version="4">
3
- <component name="NewModuleRootManager" inherit-compiler-output="true">
4
- <exclude-output />
5
- <content url="file://$MODULE_DIR$" />
6
- <orderEntry type="inheritedJdk" />
7
- <orderEntry type="sourceFolder" forTests="false" />
8
- </component>
9
- </module>
@@ -1,11 +0,0 @@
1
- <component name="InspectionProjectProfileManager">
2
- <profile version="1.0">
3
- <option name="myName" value="Project Default" />
4
- <inspection_tool class="ImplicitTypeConversion" enabled="true" level="WARNING" enabled_by_default="true">
5
- <option name="BITS" value="1720" />
6
- <option name="FLAG_EXPLICIT_CONVERSION" value="true" />
7
- <option name="IGNORE_NODESET_TO_BOOLEAN_VIA_STRING" value="true" />
8
- </inspection_tool>
9
- <inspection_tool class="UsePropertyAccessSyntax" enabled="true" level="WEAK WARNING" enabled_by_default="true" />
10
- </profile>
11
- </component>
package/.idea/misc.xml DELETED
@@ -1,5 +0,0 @@
1
- <project version="4">
2
- <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="jbr-17" project-jdk-type="JavaSDK">
3
- <output url="file://$PROJECT_DIR$/out" />
4
- </component>
5
- </project>
package/.idea/modules.xml DELETED
@@ -1,8 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <project version="4">
3
- <component name="ProjectModuleManager">
4
- <modules>
5
- <module fileurl="file://$PROJECT_DIR$/.idea/common-express-server.iml" filepath="$PROJECT_DIR$/.idea/common-express-server.iml" />
6
- </modules>
7
- </component>
8
- </project>
package/.idea/vcs.xml DELETED
@@ -1,6 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <project version="4">
3
- <component name="VcsDirectoryMappings">
4
- <mapping directory="" vcs="Git" />
5
- </component>
6
- </project>
package/tsconfig.json DELETED
@@ -1,13 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "module": "commonjs",
4
- "esModuleInterop": true,
5
- "target": "es2017",
6
- "moduleResolution": "node",
7
- "sourceMap": true,
8
- "declaration": true,
9
- "outDir": "lib",
10
- "sourceRoot": "src"
11
- },
12
- "lib": ["es2017"]
13
- }