typedapi-client-helpers 0.2.1 → 0.3.0

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 (124) hide show
  1. package/CHANGELOG.md +68 -0
  2. package/README.md +221 -220
  3. package/dist/cjs/httpClient.js +258 -0
  4. package/dist/cjs/httpClient.js.map +1 -0
  5. package/dist/cjs/index.js +32 -0
  6. package/dist/cjs/index.js.map +1 -0
  7. package/dist/cjs/interfaces/ApiResult.js +3 -0
  8. package/dist/cjs/interfaces/ApiResult.js.map +1 -0
  9. package/dist/cjs/interfaces/Filter.js +3 -0
  10. package/dist/cjs/interfaces/Filter.js.map +1 -0
  11. package/dist/cjs/interfaces/SortType.js +3 -0
  12. package/dist/cjs/interfaces/SortType.js.map +1 -0
  13. package/dist/cjs/package.json +3 -0
  14. package/dist/cjs/types/ApiCallOptions.js +3 -0
  15. package/dist/cjs/types/ApiCallOptions.js.map +1 -0
  16. package/dist/cjs/types/ApiMethodArguments.js +3 -0
  17. package/dist/cjs/types/ApiMethodArguments.js.map +1 -0
  18. package/dist/cjs/types/ApiMethodOptions.js +3 -0
  19. package/dist/cjs/types/ApiMethodOptions.js.map +1 -0
  20. package/dist/cjs/types/ApiMethodTypes.js +3 -0
  21. package/dist/cjs/types/ApiMethodTypes.js.map +1 -0
  22. package/dist/cjs/types/HttpResponse.js +3 -0
  23. package/dist/cjs/types/HttpResponse.js.map +1 -0
  24. package/dist/cjs/types/httpClientTypes.js +3 -0
  25. package/dist/cjs/types/httpClientTypes.js.map +1 -0
  26. package/dist/cjs/utils/SortTypeFromSortDirection.js +43 -0
  27. package/dist/cjs/utils/SortTypeFromSortDirection.js.map +1 -0
  28. package/dist/cjs/utils/buildQuery.js +96 -0
  29. package/dist/cjs/utils/buildQuery.js.map +1 -0
  30. package/dist/cjs/utils/extractArgsCallbacksAndParams.js +51 -0
  31. package/dist/cjs/utils/extractArgsCallbacksAndParams.js.map +1 -0
  32. package/dist/cjs/utils/extractArgsToastsAndParams.js +49 -0
  33. package/dist/cjs/utils/extractArgsToastsAndParams.js.map +1 -0
  34. package/dist/cjs/utils/handleApiResponse.js +124 -0
  35. package/dist/cjs/utils/handleApiResponse.js.map +1 -0
  36. package/dist/cjs/utils/toFormData.js +58 -0
  37. package/dist/cjs/utils/toFormData.js.map +1 -0
  38. package/dist/cjs/utils/wireMapping.js +123 -0
  39. package/dist/cjs/utils/wireMapping.js.map +1 -0
  40. package/dist/esm/httpClient.js +251 -0
  41. package/dist/esm/httpClient.js.map +1 -0
  42. package/dist/esm/index.js +16 -0
  43. package/dist/esm/index.js.map +1 -0
  44. package/dist/esm/interfaces/ApiResult.js +2 -0
  45. package/dist/esm/interfaces/ApiResult.js.map +1 -0
  46. package/dist/esm/interfaces/Filter.js +2 -0
  47. package/dist/esm/interfaces/Filter.js.map +1 -0
  48. package/dist/esm/interfaces/SortType.js +2 -0
  49. package/dist/esm/interfaces/SortType.js.map +1 -0
  50. package/dist/esm/types/ApiCallOptions.js +2 -0
  51. package/dist/esm/types/ApiCallOptions.js.map +1 -0
  52. package/dist/esm/types/ApiMethodArguments.js +2 -0
  53. package/dist/esm/types/ApiMethodArguments.js.map +1 -0
  54. package/dist/esm/types/ApiMethodOptions.js +2 -0
  55. package/dist/esm/types/ApiMethodOptions.js.map +1 -0
  56. package/dist/esm/types/ApiMethodTypes.js +2 -0
  57. package/dist/esm/types/ApiMethodTypes.js.map +1 -0
  58. package/dist/esm/types/HttpResponse.js +2 -0
  59. package/dist/esm/types/HttpResponse.js.map +1 -0
  60. package/dist/esm/types/httpClientTypes.js +2 -0
  61. package/dist/esm/types/httpClientTypes.js.map +1 -0
  62. package/dist/esm/utils/SortTypeFromSortDirection.js +38 -0
  63. package/dist/esm/utils/SortTypeFromSortDirection.js.map +1 -0
  64. package/dist/esm/utils/buildQuery.js +93 -0
  65. package/dist/esm/utils/buildQuery.js.map +1 -0
  66. package/dist/esm/utils/extractArgsCallbacksAndParams.js +48 -0
  67. package/dist/esm/utils/extractArgsCallbacksAndParams.js.map +1 -0
  68. package/dist/esm/utils/extractArgsToastsAndParams.js +46 -0
  69. package/dist/esm/utils/extractArgsToastsAndParams.js.map +1 -0
  70. package/dist/esm/utils/handleApiResponse.js +121 -0
  71. package/dist/esm/utils/handleApiResponse.js.map +1 -0
  72. package/dist/esm/utils/toFormData.js +55 -0
  73. package/dist/esm/utils/toFormData.js.map +1 -0
  74. package/dist/esm/utils/wireMapping.js +119 -0
  75. package/dist/esm/utils/wireMapping.js.map +1 -0
  76. package/dist/types/httpClient.d.ts +63 -0
  77. package/dist/types/httpClient.d.ts.map +1 -0
  78. package/dist/types/index.d.ts +16 -0
  79. package/dist/types/index.d.ts.map +1 -0
  80. package/dist/types/interfaces/ApiResult.d.ts +32 -0
  81. package/dist/types/interfaces/ApiResult.d.ts.map +1 -0
  82. package/dist/types/interfaces/Filter.d.ts +31 -0
  83. package/dist/types/interfaces/Filter.d.ts.map +1 -0
  84. package/dist/types/interfaces/SortType.d.ts +7 -0
  85. package/dist/types/interfaces/SortType.d.ts.map +1 -0
  86. package/dist/types/types/ApiCallOptions.d.ts +26 -0
  87. package/dist/types/types/ApiCallOptions.d.ts.map +1 -0
  88. package/dist/types/types/ApiMethodArguments.d.ts +6 -0
  89. package/dist/types/types/ApiMethodArguments.d.ts.map +1 -0
  90. package/dist/types/types/ApiMethodOptions.d.ts +8 -0
  91. package/dist/types/types/ApiMethodOptions.d.ts.map +1 -0
  92. package/dist/types/types/ApiMethodTypes.d.ts +47 -0
  93. package/dist/types/types/ApiMethodTypes.d.ts.map +1 -0
  94. package/dist/types/types/HttpResponse.d.ts +2 -0
  95. package/dist/types/types/HttpResponse.d.ts.map +1 -0
  96. package/dist/types/types/httpClientTypes.d.ts +2 -0
  97. package/dist/types/types/httpClientTypes.d.ts.map +1 -0
  98. package/dist/types/utils/SortTypeFromSortDirection.d.ts +13 -0
  99. package/dist/types/utils/SortTypeFromSortDirection.d.ts.map +1 -0
  100. package/dist/types/utils/buildQuery.d.ts +16 -0
  101. package/dist/types/utils/buildQuery.d.ts.map +1 -0
  102. package/dist/types/utils/extractArgsCallbacksAndParams.d.ts +22 -0
  103. package/dist/types/utils/extractArgsCallbacksAndParams.d.ts.map +1 -0
  104. package/dist/types/utils/extractArgsToastsAndParams.d.ts +20 -0
  105. package/dist/types/utils/extractArgsToastsAndParams.d.ts.map +1 -0
  106. package/dist/types/utils/handleApiResponse.d.ts +11 -0
  107. package/dist/types/utils/handleApiResponse.d.ts.map +1 -0
  108. package/dist/types/utils/toFormData.d.ts +10 -0
  109. package/dist/types/utils/toFormData.d.ts.map +1 -0
  110. package/dist/types/utils/wireMapping.d.ts +30 -0
  111. package/dist/types/utils/wireMapping.d.ts.map +1 -0
  112. package/package.json +90 -84
  113. package/scripts/build.mjs +74 -0
  114. package/scripts/generate-api-minimal.mjs +568 -476
  115. package/scripts/openapi-generator/controller-template.mjs +1 -1
  116. package/scripts/openapi-generator/index.mjs +357 -113
  117. package/scripts/openapi-generator/method-template.mjs +201 -244
  118. package/scripts/openapi-generator/names.mjs +37 -86
  119. package/scripts/openapi-generator/openapi-utils.mjs +411 -147
  120. package/scripts/openapi-generator/schema.mjs +518 -238
  121. package/dist/index.cjs +0 -536
  122. package/dist/index.d.cts +0 -285
  123. package/dist/index.d.ts +0 -285
  124. package/dist/index.js +0 -495
package/package.json CHANGED
@@ -1,84 +1,90 @@
1
- {
2
- "name": "typedapi-client-helpers",
3
- "version": "0.2.1",
4
- "description": "Reusable typed OpenAPI client helpers.",
5
- "license": "MIT",
6
- "keywords": [
7
- "typescript",
8
- "openapi",
9
- "swagger",
10
- "api-client",
11
- "typed-api",
12
- "typescript-api-client",
13
- "openapi-client",
14
- "swagger-client",
15
- "client-generator",
16
- "api-generator",
17
- "codegen",
18
- "type-safe",
19
- "type-safe-api",
20
- "fetch",
21
- "frontend",
22
- "api-wrapper",
23
- "generated-client",
24
- "form-data",
25
- "multipart",
26
- "pagination",
27
- "filters",
28
- "sorting"
29
- ],
30
- "type": "module",
31
- "main": "./dist/index.cjs",
32
- "module": "./dist/index.js",
33
- "types": "./dist/index.d.ts",
34
- "exports": {
35
- ".": {
36
- "types": "./dist/index.d.ts",
37
- "import": "./dist/index.js",
38
- "require": "./dist/index.cjs"
39
- },
40
- "./package.json": "./package.json"
41
- },
42
- "files": [
43
- "dist",
44
- "scripts",
45
- "README.md",
46
- "LICENSE"
47
- ],
48
- "bin": {
49
- "typedapi-generate": "./scripts/generate-api-minimal.mjs"
50
- },
51
- "engines": {
52
- "node": ">=18"
53
- },
54
- "repository": {
55
- "type": "git",
56
- "url": "git+https://github.com/Stef-Buurman/TypedApi.git",
57
- "directory": "npm/typed-api-client"
58
- },
59
- "homepage": "https://github.com/Stef-Buurman/TypedApi/tree/main/npm/typed-api-client#readme",
60
- "config": {
61
- "apiOutput": "src/api",
62
- "typedApiCleanOutput": true,
63
- "typedApiModuleNameFirstTag": true,
64
- "typedApiUseTypeOnlyImports": true,
65
- "typedApiDefaultFunctionsPath": "src/defaultApiFunctions",
66
- "typedApiDefaultSuccessHandler": "handleGoodResult",
67
- "typedApiDefaultErrorHandler": "handleErrors",
68
- "typedApiDefaultResponseAsSuccess": false,
69
- "typedApiGenerateUnionEnums": false,
70
- "typedApiEnumNamesAsValues": false,
71
- "typedApiSwaggerBackupFile": "swagger/swagger.backup.json"
72
- },
73
- "scripts": {
74
- "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
75
- "typecheck": "tsc --noEmit",
76
- "build": "npm run clean && tsup src/index.ts --format esm,cjs --dts",
77
- "prepack": "npm run typecheck && npm run build",
78
- "generate:api": "node ./scripts/generate-api-minimal.mjs"
79
- },
80
- "devDependencies": {
81
- "tsup": "^8.5.1",
82
- "typescript": "5.8.3"
83
- }
84
- }
1
+ {
2
+ "name": "typedapi-client-helpers",
3
+ "version": "0.3.0",
4
+ "description": "Reusable typed OpenAPI client helpers.",
5
+ "license": "MIT",
6
+ "keywords": [
7
+ "typescript",
8
+ "openapi",
9
+ "swagger",
10
+ "api-client",
11
+ "typed-api",
12
+ "typescript-api-client",
13
+ "openapi-client",
14
+ "swagger-client",
15
+ "client-generator",
16
+ "api-generator",
17
+ "codegen",
18
+ "type-safe",
19
+ "type-safe-api",
20
+ "fetch",
21
+ "frontend",
22
+ "api-wrapper",
23
+ "generated-client",
24
+ "form-data",
25
+ "multipart",
26
+ "pagination",
27
+ "filters",
28
+ "sorting"
29
+ ],
30
+ "type": "module",
31
+ "main": "./dist/cjs/index.js",
32
+ "module": "./dist/esm/index.js",
33
+ "types": "./dist/types/index.d.ts",
34
+ "exports": {
35
+ ".": {
36
+ "types": "./dist/types/index.d.ts",
37
+ "import": "./dist/esm/index.js",
38
+ "require": "./dist/cjs/index.js"
39
+ },
40
+ "./package.json": "./package.json"
41
+ },
42
+ "files": [
43
+ "dist",
44
+ "scripts",
45
+ "README.md",
46
+ "LICENSE",
47
+ "CHANGELOG.md"
48
+ ],
49
+ "bin": {
50
+ "typedapi-generate": "./scripts/generate-api-minimal.mjs"
51
+ },
52
+ "engines": {
53
+ "node": ">=18"
54
+ },
55
+ "repository": {
56
+ "type": "git",
57
+ "url": "git+https://github.com/Stef-Buurman/TypedApi.git",
58
+ "directory": "npm/typed-api-client"
59
+ },
60
+ "homepage": "https://github.com/Stef-Buurman/TypedApi/tree/main/npm/typed-api-client#readme",
61
+ "config": {
62
+ "apiOutput": "src/api",
63
+ "typedApiCleanOutput": true,
64
+ "typedApiModuleNameFirstTag": true,
65
+ "typedApiUseTypeOnlyImports": true,
66
+ "typedApiDefaultFunctionsPath": "src/defaultApiFunctions",
67
+ "typedApiDefaultSuccessHandler": "handleGoodResult",
68
+ "typedApiDefaultErrorHandler": "handleErrors",
69
+ "typedApiDefaultResponseAsSuccess": false,
70
+ "typedApiGenerateUnionEnums": false,
71
+ "typedApiEnumNamesAsValues": false,
72
+ "typedApiSwaggerBackupFile": "swagger/swagger.backup.json",
73
+ "typedApiDownloadTimeoutMs": 15000,
74
+ "typedApiGenerateMissingOperationIds": false,
75
+ "typedApiMethodNameStyle": "operationId",
76
+ "typedApiPrefixMethodNamesWithController": false
77
+ },
78
+ "scripts": {
79
+ "clean": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\"",
80
+ "typecheck": "node ./node_modules/typescript/bin/tsc --noEmit",
81
+ "build": "node ./scripts/build.mjs",
82
+ "prepack": "npm run typecheck && npm run build",
83
+ "generate:api": "node ./scripts/generate-api-minimal.mjs",
84
+ "test": "npm run build && node --test test/*.test.mjs",
85
+ "verify": "npm run typecheck && npm test"
86
+ },
87
+ "devDependencies": {
88
+ "typescript": "5.8.3"
89
+ }
90
+ }
@@ -0,0 +1,74 @@
1
+ #!/usr/bin/env node
2
+ import { spawnSync } from "node:child_process";
3
+ import fs from "node:fs";
4
+ import path from "node:path";
5
+ import { fileURLToPath } from "node:url";
6
+
7
+ const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
8
+ const tsc = path.join(root, "node_modules", "typescript", "bin", "tsc");
9
+ const dist = path.join(root, "dist");
10
+
11
+ fs.rmSync(dist, { recursive: true, force: true });
12
+
13
+ run([
14
+ "--project", "tsconfig.json",
15
+ "--outDir", "dist/esm",
16
+ "--module", "ESNext",
17
+ "--moduleResolution", "Bundler",
18
+ "--declaration", "false",
19
+ "--declarationMap", "false",
20
+ ]);
21
+
22
+ addJavaScriptExtensions(path.join(dist, "esm"));
23
+
24
+ run([
25
+ "--project", "tsconfig.json",
26
+ "--outDir", "dist/cjs",
27
+ "--module", "CommonJS",
28
+ "--moduleResolution", "Node",
29
+ "--declaration", "false",
30
+ "--declarationMap", "false",
31
+ ]);
32
+
33
+ run([
34
+ "--project", "tsconfig.json",
35
+ "--outDir", "dist/types",
36
+ "--emitDeclarationOnly",
37
+ "--declaration", "true",
38
+ "--declarationMap", "true",
39
+ ]);
40
+
41
+ fs.writeFileSync(
42
+ path.join(dist, "cjs", "package.json"),
43
+ `${JSON.stringify({ type: "commonjs" }, null, 2)}\n`,
44
+ );
45
+
46
+ function addJavaScriptExtensions(directory) {
47
+ for (const entry of fs.readdirSync(directory, { withFileTypes: true })) {
48
+ const entryPath = path.join(directory, entry.name);
49
+ if (entry.isDirectory()) {
50
+ addJavaScriptExtensions(entryPath);
51
+ continue;
52
+ }
53
+ if (!entry.isFile() || !entry.name.endsWith(".js")) continue;
54
+
55
+ const source = fs.readFileSync(entryPath, "utf8");
56
+ const updated = source.replace(
57
+ /(from\s+|import\s*\(\s*)(["'])(\.{1,2}\/[^"']+)(["'])/g,
58
+ (match, prefix, quote, specifier, closingQuote) => {
59
+ if (/\.(?:[cm]?js|json)$/.test(specifier)) return match;
60
+ return `${prefix}${quote}${specifier}.js${closingQuote}`;
61
+ },
62
+ );
63
+ fs.writeFileSync(entryPath, updated);
64
+ }
65
+ }
66
+
67
+ function run(args) {
68
+ const result = spawnSync(process.execPath, [tsc, ...args], {
69
+ cwd: root,
70
+ encoding: "utf8",
71
+ stdio: "inherit",
72
+ });
73
+ if (result.status !== 0) process.exit(result.status ?? 1);
74
+ }