@aneuhold/core-ts-api-lib 2.2.1 → 2.2.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.
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## 🔖 [2.2.2] (2025-10-17)
|
|
9
|
+
|
|
10
|
+
### 🏗️ Changed
|
|
11
|
+
|
|
12
|
+
- Improved and expanded JSDoc comments and documentation for public types and methods throughout the package
|
|
13
|
+
|
|
8
14
|
## 🔖 [2.2.1] (2025-09-08)
|
|
9
15
|
|
|
10
16
|
### ✅ Added
|
|
@@ -63,6 +69,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
|
|
63
69
|
|
|
64
70
|
<!-- Link References -->
|
|
65
71
|
|
|
72
|
+
[2.2.2]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.1...core-ts-api-lib-v2.2.2
|
|
66
73
|
[2.2.1]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.0...core-ts-api-lib-v2.2.1
|
|
67
74
|
[2.2.0]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.1.25...core-ts-api-lib-v2.2.0
|
|
68
75
|
[2.1.25]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.1.24...core-ts-api-lib-v2.1.25
|
|
@@ -1,9 +1,17 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Generic for API responses
|
|
2
|
+
* Generic type for API responses in personal projects.
|
|
3
|
+
*
|
|
4
|
+
* Provides a consistent structure for all API responses with success status,
|
|
5
|
+
* error messages, and typed data payload.
|
|
6
|
+
*
|
|
7
|
+
* @template T - The type of data contained in the response.
|
|
3
8
|
*/
|
|
4
9
|
export type APIResponse<T> = {
|
|
10
|
+
/** Indicates whether the API call was successful */
|
|
5
11
|
success: boolean;
|
|
12
|
+
/** Array of error messages if the call failed */
|
|
6
13
|
errors: string[];
|
|
14
|
+
/** The typed data payload returned by the API */
|
|
7
15
|
data: T;
|
|
8
16
|
};
|
|
9
17
|
//# sourceMappingURL=APIResponse.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"APIResponse.d.ts","sourceRoot":"","sources":["../../src/types/APIResponse.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"APIResponse.d.ts","sourceRoot":"","sources":["../../src/types/APIResponse.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,oDAAoD;IACpD,OAAO,EAAE,OAAO,CAAC;IACjB,iDAAiD;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,iDAAiD;IACjD,IAAI,EAAE,CAAC,CAAC;CACT,CAAC"}
|
package/lib/types/APIResponse.ts
CHANGED
|
@@ -1,8 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Generic for API responses
|
|
2
|
+
* Generic type for API responses in personal projects.
|
|
3
|
+
*
|
|
4
|
+
* Provides a consistent structure for all API responses with success status,
|
|
5
|
+
* error messages, and typed data payload.
|
|
6
|
+
*
|
|
7
|
+
* @template T - The type of data contained in the response.
|
|
3
8
|
*/
|
|
4
9
|
export type APIResponse<T> = {
|
|
10
|
+
/** Indicates whether the API call was successful */
|
|
5
11
|
success: boolean;
|
|
12
|
+
/** Array of error messages if the call failed */
|
|
6
13
|
errors: string[];
|
|
14
|
+
/** The typed data payload returned by the API */
|
|
7
15
|
data: T;
|
|
8
16
|
};
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@aneuhold/core-ts-api-lib",
|
|
3
3
|
"author": "Anton G. Neuhold Jr.",
|
|
4
4
|
"license": "MIT",
|
|
5
|
-
"version": "2.2.
|
|
5
|
+
"version": "2.2.2",
|
|
6
6
|
"description": "A library for interacting with the backend and defining the backend API for personal projects.",
|
|
7
7
|
"packageManager": "pnpm@10.12.1",
|
|
8
8
|
"type": "module",
|