@salespark/route-utils 1.0.2 β†’ 1.0.4

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 (4) hide show
  1. package/README.md +19 -4
  2. package/dist/index.d.ts +24 -24
  3. package/dist/index.d.ts.map +1 -1
  4. package/package.json +5 -4
package/README.md CHANGED
@@ -196,17 +196,32 @@ const { wrapRoute } = makeRouteUtils({
196
196
 
197
197
  ---
198
198
 
199
- ## πŸ“¦ NPM Package
200
-
201
- This module is published as:
202
- πŸ‘‰ [`@salespark/route-utils`](https://www.npmjs.com/package/@salespark/route-utils)
199
+ ## πŸ“¦ Installation
203
200
 
204
201
  ```bash
202
+ yarn add @salespark/route-utils
203
+ # or
205
204
  npm install @salespark/route-utils
206
205
  ```
207
206
 
208
207
  ---
209
208
 
209
+ ## πŸ› οΈ Support
210
+
211
+ Got stuck? Don’t panic β€” we’ve got you covered.
212
+
213
+ ### πŸ€– AI Assistant
214
+
215
+ We built a custom **AI Assistant** trained _only_ on `@salespark/route-utils`.
216
+ It answers implementation and troubleshooting questions in real time:
217
+
218
+ πŸ‘‰ Ask the Route Utils GPT:
219
+ https://chatgpt.com/g/g-68a9b742f240819197057ba3333230be-salespark-route-utils-v1
220
+
221
+ _(Free to use with a ChatGPT account)_
222
+
223
+ ---
224
+
210
225
  ### πŸ”’ Internal Usage Notice
211
226
 
212
227
  This package is primarily designed and maintained for internal use within the SalesPark ecosystem.
package/dist/index.d.ts CHANGED
@@ -58,16 +58,16 @@ export interface ApiResponse<T = unknown, M = unknown> {
58
58
  * 16-08-2025: Created
59
59
  ****************************************************************************************************************/
60
60
  export declare const makeRouteUtils: ({ logger, tagPrefix, }?: {
61
- logger?: LoggerFn | undefined;
62
- tagPrefix?: string | undefined;
61
+ logger?: LoggerFn;
62
+ tagPrefix?: string;
63
63
  }) => {
64
64
  wrapRoute: (handler: (req: any, res: ResLike) => Promise<ApiResponse> | ApiResponse, options?: {
65
- tag?: string | undefined;
66
- logger?: LoggerFn | undefined;
65
+ tag?: string;
66
+ logger?: LoggerFn;
67
67
  }) => (req: any, res: ResLike, _next?: any) => Promise<void>;
68
68
  createResponder: (res: ResLike, options?: {
69
- tag?: string | undefined;
70
- logger?: LoggerFn | undefined;
69
+ tag?: string;
70
+ logger?: LoggerFn;
71
71
  }) => (workFn: () => Promise<ApiResponse> | ApiResponse) => Promise<boolean>;
72
72
  resolveRouteResponse: (res: ResLike, response: any) => boolean;
73
73
  };
@@ -91,37 +91,37 @@ export declare const makeRouteUtils: ({ logger, tagPrefix, }?: {
91
91
  ****************************************************************************************************************/
92
92
  export declare const resolveRouteResponse: (res: ResLike, response: any) => boolean;
93
93
  export declare const wrapRoute: (handler: (req: any, res: ResLike) => Promise<ApiResponse> | ApiResponse, options?: {
94
- tag?: string | undefined;
95
- logger?: LoggerFn | undefined;
94
+ tag?: string;
95
+ logger?: LoggerFn;
96
96
  }) => (req: any, res: ResLike, _next?: any) => Promise<void>;
97
97
  export declare const createResponder: (res: ResLike, options?: {
98
- tag?: string | undefined;
99
- logger?: LoggerFn | undefined;
98
+ tag?: string;
99
+ logger?: LoggerFn;
100
100
  }) => (workFn: () => Promise<ApiResponse> | ApiResponse) => Promise<boolean>;
101
101
  /** Default export bundle (optional convenience) */
102
102
  declare const _default: {
103
103
  makeRouteUtils: ({ logger, tagPrefix, }?: {
104
- logger?: LoggerFn | undefined;
105
- tagPrefix?: string | undefined;
104
+ logger?: LoggerFn;
105
+ tagPrefix?: string;
106
106
  }) => {
107
- wrapRoute: (handler: (req: any, res: ResLike) => ApiResponse<unknown, unknown> | Promise<ApiResponse<unknown, unknown>>, options?: {
108
- tag?: string | undefined;
109
- logger?: LoggerFn | undefined;
107
+ wrapRoute: (handler: (req: any, res: ResLike) => Promise<ApiResponse> | ApiResponse, options?: {
108
+ tag?: string;
109
+ logger?: LoggerFn;
110
110
  }) => (req: any, res: ResLike, _next?: any) => Promise<void>;
111
111
  createResponder: (res: ResLike, options?: {
112
- tag?: string | undefined;
113
- logger?: LoggerFn | undefined;
114
- }) => (workFn: () => ApiResponse<unknown, unknown> | Promise<ApiResponse<unknown, unknown>>) => Promise<boolean>;
112
+ tag?: string;
113
+ logger?: LoggerFn;
114
+ }) => (workFn: () => Promise<ApiResponse> | ApiResponse) => Promise<boolean>;
115
115
  resolveRouteResponse: (res: ResLike, response: any) => boolean;
116
116
  };
117
- wrapRoute: (handler: (req: any, res: ResLike) => ApiResponse<unknown, unknown> | Promise<ApiResponse<unknown, unknown>>, options?: {
118
- tag?: string | undefined;
119
- logger?: LoggerFn | undefined;
117
+ wrapRoute: (handler: (req: any, res: ResLike) => Promise<ApiResponse> | ApiResponse, options?: {
118
+ tag?: string;
119
+ logger?: LoggerFn;
120
120
  }) => (req: any, res: ResLike, _next?: any) => Promise<void>;
121
121
  createResponder: (res: ResLike, options?: {
122
- tag?: string | undefined;
123
- logger?: LoggerFn | undefined;
124
- }) => (workFn: () => ApiResponse<unknown, unknown> | Promise<ApiResponse<unknown, unknown>>) => Promise<boolean>;
122
+ tag?: string;
123
+ logger?: LoggerFn;
124
+ }) => (workFn: () => Promise<ApiResponse> | ApiResponse) => Promise<boolean>;
125
125
  resolveRouteResponse: (res: ResLike, response: any) => boolean;
126
126
  };
127
127
  export default _default;
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;kHAmBkH;AAElH,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IAClC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC;IAClC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO;IACnD,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAKD;;;;;;;;;;;;kHAYkH;AAClH,eAAO,MAAM,cAAc;;;;+BAoBS,GAAG,OAAO,OAAO,KAAK,QAAQ,WAAW,CAAC,GAAG,WAAW;;;gBAGrE,GAAG,OAAO,OAAO,UAAU,GAAG;2BAuCrB,OAAO;;;mBAIb,MAAM,QAAQ,WAAW,CAAC,GAAG,WAAW;gCA6CxB,OAAO,YAAY,GAAG,KAAG,OAAO;CApBzE,CAAC;AAEF;;;;;;;;;;;;;;;;;kHAiBkH;AAClH,eAAO,MAAM,oBAAoB,QAAS,OAAO,YAAY,GAAG,KAAG,OA8ElE,CAAC;AAOF,eAAO,MAAM,SAAS,kBAhLc,GAAG,OAAO,OAAO,KAAK,QAAQ,WAAW,CAAC,GAAG,WAAW;;;YAGrE,GAAG,OAAO,OAAO,UAAU,GAAG,kBA6KZ,CAAC;AAC1C,eAAO,MAAM,eAAe,QAvII,OAAO;;;eAIb,MAAM,QAAQ,WAAW,CAAC,GAAG,WAAW,qBAmIb,CAAC;AAEtD,mDAAmD;;;;;;;;;;;;;;;;;;;;;;;;;;AACnD,wBAKE"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;kHAmBkH;AAElH,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IAClC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC;IAClC,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO;IACnD,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,CAAC,CAAC;CACV;AAKD;;;;;;;;;;;;kHAYkH;AAClH,eAAO,MAAM,cAAc,GAAI,yBAG5B;IACD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACf;yBAcwB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,YAAW;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;KAAE,MAGxH,KAAK,GAAG,EAAE,KAAK,OAAO,EAAE,QAAQ,GAAG;2BAuCrB,OAAO,YAAW;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;KAAE,MAInE,QAAQ,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW;gCA6CxB,OAAO,YAAY,GAAG,KAAG,OAAO;CApBzE,CAAC;AAEF;;;;;;;;;;;;;;;;;kHAiBkH;AAClH,eAAO,MAAM,oBAAoB,GAAI,KAAK,OAAO,EAAE,UAAU,GAAG,KAAG,OA8ElE,CAAC;AAOF,eAAO,MAAM,SAAS,YAhLQ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,YAAW;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;CAAE,MAGxH,KAAK,GAAG,EAAE,KAAK,OAAO,EAAE,QAAQ,GAAG,kBA6KZ,CAAC;AAC1C,eAAO,MAAM,eAAe,QAvII,OAAO,YAAW;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;CAAE,MAInE,QAAQ,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,qBAmIb,CAAC;AAEtD,mDAAmD;;8CApMhD;QACD,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;6BAc6B,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,YAAW;YAAE,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;SAAE,MAGxH,KAAK,GAAG,EAAE,KAAK,OAAO,EAAE,QAAQ,GAAG;+BAuCrB,OAAO,YAAW;YAAE,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;SAAE,MAInE,QAAQ,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW;oCA6CxB,OAAO,YAAY,GAAG,KAAG,OAAO;;yBA3F5C,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,YAAW;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;KAAE,MAGxH,KAAK,GAAG,EAAE,KAAK,OAAO,EAAE,QAAQ,GAAG;2BAuCrB,OAAO,YAAW;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,QAAQ,CAAA;KAAE,MAInE,QAAQ,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW;gCA6CxB,OAAO,YAAY,GAAG,KAAG,OAAO;;AAyF1E,wBAKE"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salespark/route-utils",
3
- "version": "1.0.2",
3
+ "version": "1.0.4",
4
4
  "description": "Vendor-agnostic helpers for Express route handlers with normalized responses and optional logging.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -9,7 +9,7 @@
9
9
  ],
10
10
  "scripts": {
11
11
  "build": "tsc -p tsconfig.build.json",
12
- "clean": "rm -rf dist",
12
+ "clean": "rimraf dist",
13
13
  "prepublishOnly": "yarn run clean && yarn run build"
14
14
  },
15
15
  "keywords": [
@@ -32,8 +32,9 @@
32
32
  "access": "public"
33
33
  },
34
34
  "devDependencies": {
35
- "typescript": "^5.4.0",
36
- "@types/express": "^4.17.21"
35
+ "@types/express": "^4.17.21",
36
+ "rimraf": "^6.0.1",
37
+ "typescript": "^5.4.0"
37
38
  },
38
39
  "peerDependencies": {
39
40
  "express": ">=4"