@venizia/ignis-docs 0.0.6-2 → 0.0.7-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 (120) hide show
  1. package/README.md +125 -388
  2. package/dist/mcp-server/common/config.d.ts +0 -21
  3. package/dist/mcp-server/common/config.d.ts.map +1 -1
  4. package/dist/mcp-server/common/config.js +1 -36
  5. package/dist/mcp-server/common/config.js.map +1 -1
  6. package/dist/mcp-server/helpers/docs.helper.d.ts +0 -24
  7. package/dist/mcp-server/helpers/docs.helper.d.ts.map +1 -1
  8. package/dist/mcp-server/helpers/docs.helper.js +0 -25
  9. package/dist/mcp-server/helpers/docs.helper.js.map +1 -1
  10. package/dist/mcp-server/helpers/github.helper.d.ts +0 -13
  11. package/dist/mcp-server/helpers/github.helper.d.ts.map +1 -1
  12. package/dist/mcp-server/helpers/github.helper.js +3 -20
  13. package/dist/mcp-server/helpers/github.helper.js.map +1 -1
  14. package/dist/mcp-server/index.js +1 -20
  15. package/dist/mcp-server/index.js.map +1 -1
  16. package/dist/mcp-server/tools/base.tool.d.ts +4 -85
  17. package/dist/mcp-server/tools/base.tool.d.ts.map +1 -1
  18. package/dist/mcp-server/tools/base.tool.js +1 -38
  19. package/dist/mcp-server/tools/base.tool.js.map +1 -1
  20. package/dist/mcp-server/tools/docs/get-document-content.tool.d.ts +8 -2
  21. package/dist/mcp-server/tools/docs/get-document-content.tool.d.ts.map +1 -1
  22. package/dist/mcp-server/tools/docs/get-document-content.tool.js +1 -10
  23. package/dist/mcp-server/tools/docs/get-document-content.tool.js.map +1 -1
  24. package/dist/mcp-server/tools/docs/get-document-metadata.tool.d.ts +13 -2
  25. package/dist/mcp-server/tools/docs/get-document-metadata.tool.d.ts.map +1 -1
  26. package/dist/mcp-server/tools/docs/get-document-metadata.tool.js +1 -10
  27. package/dist/mcp-server/tools/docs/get-document-metadata.tool.js.map +1 -1
  28. package/dist/mcp-server/tools/docs/get-package-overview.tool.d.ts +16 -8
  29. package/dist/mcp-server/tools/docs/get-package-overview.tool.d.ts.map +1 -1
  30. package/dist/mcp-server/tools/docs/get-package-overview.tool.js +2 -25
  31. package/dist/mcp-server/tools/docs/get-package-overview.tool.js.map +1 -1
  32. package/dist/mcp-server/tools/docs/list-categories.tool.d.ts +5 -2
  33. package/dist/mcp-server/tools/docs/list-categories.tool.d.ts.map +1 -1
  34. package/dist/mcp-server/tools/docs/list-categories.tool.js +1 -10
  35. package/dist/mcp-server/tools/docs/list-categories.tool.js.map +1 -1
  36. package/dist/mcp-server/tools/docs/list-documents.tool.d.ts +11 -2
  37. package/dist/mcp-server/tools/docs/list-documents.tool.d.ts.map +1 -1
  38. package/dist/mcp-server/tools/docs/list-documents.tool.js +1 -10
  39. package/dist/mcp-server/tools/docs/list-documents.tool.js.map +1 -1
  40. package/dist/mcp-server/tools/docs/search-documents.tool.d.ts +13 -2
  41. package/dist/mcp-server/tools/docs/search-documents.tool.d.ts.map +1 -1
  42. package/dist/mcp-server/tools/docs/search-documents.tool.js +1 -10
  43. package/dist/mcp-server/tools/docs/search-documents.tool.js.map +1 -1
  44. package/dist/mcp-server/tools/github/list-project-files.tool.d.ts +9 -2
  45. package/dist/mcp-server/tools/github/list-project-files.tool.d.ts.map +1 -1
  46. package/dist/mcp-server/tools/github/list-project-files.tool.js +1 -10
  47. package/dist/mcp-server/tools/github/list-project-files.tool.js.map +1 -1
  48. package/dist/mcp-server/tools/github/search-code.tool.d.ts +16 -2
  49. package/dist/mcp-server/tools/github/search-code.tool.d.ts.map +1 -1
  50. package/dist/mcp-server/tools/github/search-code.tool.js +2 -14
  51. package/dist/mcp-server/tools/github/search-code.tool.js.map +1 -1
  52. package/dist/mcp-server/tools/github/verify-dependencies.tool.d.ts +19 -6
  53. package/dist/mcp-server/tools/github/verify-dependencies.tool.d.ts.map +1 -1
  54. package/dist/mcp-server/tools/github/verify-dependencies.tool.js +2 -19
  55. package/dist/mcp-server/tools/github/verify-dependencies.tool.js.map +1 -1
  56. package/dist/mcp-server/tools/github/view-source-file.tool.d.ts +8 -2
  57. package/dist/mcp-server/tools/github/view-source-file.tool.d.ts.map +1 -1
  58. package/dist/mcp-server/tools/github/view-source-file.tool.js +1 -10
  59. package/dist/mcp-server/tools/github/view-source-file.tool.js.map +1 -1
  60. package/dist/mcp-server/tools/index.d.ts.map +1 -1
  61. package/dist/mcp-server/tools/index.js +0 -2
  62. package/dist/mcp-server/tools/index.js.map +1 -1
  63. package/package.json +68 -54
  64. package/wiki/best-practices/api-usage-examples.md +7 -5
  65. package/wiki/best-practices/code-style-standards/advanced-patterns.md +1 -1
  66. package/wiki/best-practices/code-style-standards/constants-configuration.md +1 -1
  67. package/wiki/best-practices/code-style-standards/control-flow.md +1 -1
  68. package/wiki/best-practices/code-style-standards/function-patterns.md +1 -1
  69. package/wiki/best-practices/common-pitfalls.md +1 -1
  70. package/wiki/best-practices/data-modeling.md +33 -1
  71. package/wiki/best-practices/error-handling.md +7 -4
  72. package/wiki/best-practices/performance-optimization.md +1 -1
  73. package/wiki/best-practices/security-guidelines.md +5 -4
  74. package/wiki/guides/core-concepts/components-guide.md +1 -1
  75. package/wiki/guides/core-concepts/controllers.md +14 -8
  76. package/wiki/guides/core-concepts/persistent/models.md +32 -0
  77. package/wiki/guides/core-concepts/services.md +2 -1
  78. package/wiki/guides/get-started/5-minute-quickstart.md +1 -1
  79. package/wiki/guides/reference/mcp-docs-server.md +0 -134
  80. package/wiki/guides/tutorials/building-a-crud-api.md +2 -1
  81. package/wiki/guides/tutorials/complete-installation.md +2 -2
  82. package/wiki/guides/tutorials/ecommerce-api.md +3 -3
  83. package/wiki/guides/tutorials/realtime-chat.md +7 -6
  84. package/wiki/index.md +2 -1
  85. package/wiki/references/base/components.md +2 -1
  86. package/wiki/references/base/controllers.md +19 -12
  87. package/wiki/references/base/middlewares.md +2 -1
  88. package/wiki/references/base/models.md +11 -2
  89. package/wiki/references/base/services.md +2 -1
  90. package/wiki/references/components/authentication/api.md +525 -205
  91. package/wiki/references/components/authentication/errors.md +502 -105
  92. package/wiki/references/components/authentication/index.md +388 -75
  93. package/wiki/references/components/authentication/usage.md +428 -266
  94. package/wiki/references/components/authorization/api.md +1213 -0
  95. package/wiki/references/components/authorization/errors.md +387 -0
  96. package/wiki/references/components/authorization/index.md +712 -0
  97. package/wiki/references/components/authorization/usage.md +758 -0
  98. package/wiki/references/components/health-check.md +2 -1
  99. package/wiki/references/components/index.md +2 -0
  100. package/wiki/references/components/socket-io/index.md +9 -4
  101. package/wiki/references/components/socket-io/usage.md +1 -1
  102. package/wiki/references/components/static-asset/index.md +3 -5
  103. package/wiki/references/components/swagger.md +2 -1
  104. package/wiki/references/configuration/environment-variables.md +2 -1
  105. package/wiki/references/configuration/index.md +2 -1
  106. package/wiki/references/helpers/error/index.md +1 -1
  107. package/wiki/references/helpers/index.md +1 -0
  108. package/wiki/references/helpers/inversion/index.md +1 -1
  109. package/wiki/references/helpers/kafka/index.md +305 -0
  110. package/wiki/references/helpers/redis/index.md +2 -9
  111. package/wiki/references/quick-reference.md +3 -5
  112. package/wiki/references/utilities/crypto.md +2 -2
  113. package/wiki/references/utilities/date.md +5 -5
  114. package/wiki/references/utilities/index.md +3 -11
  115. package/wiki/references/utilities/jsx.md +4 -2
  116. package/wiki/references/utilities/module.md +1 -1
  117. package/wiki/references/utilities/parse.md +4 -4
  118. package/wiki/references/utilities/performance.md +2 -2
  119. package/wiki/references/utilities/promise.md +4 -4
  120. package/wiki/references/utilities/request.md +2 -2
@@ -15,7 +15,7 @@ The Parse utility provides a collection of functions for data type checking, con
15
15
  - **`toStringDecimal(input, digit = 2)`**: Formats a number to a string with a specified number of decimal places, using locale-specific formatting.
16
16
 
17
17
  ```typescript
18
- import { int, float, toBoolean } from '@venizia/ignis';
18
+ import { int, float, toBoolean } from '@venizia/ignis-helpers';
19
19
 
20
20
  const myInt = int('1,000'); // => 1000
21
21
  const myFloat = float('1,234.567', 2); // => 1234.57
@@ -28,7 +28,7 @@ const myBool = toBoolean('true'); // => true
28
28
  - **`keysToCamel(object)`**: Recursively converts all keys in an object (and nested objects) to camelCase.
29
29
 
30
30
  ```typescript
31
- import { toCamel, keysToCamel } from '@venizia/ignis';
31
+ import { toCamel, keysToCamel } from '@venizia/ignis-helpers';
32
32
 
33
33
  const camelString = toCamel('my-snake_case-string');
34
34
  // => 'mySnakeCaseString'
@@ -43,7 +43,7 @@ const camelObject = keysToCamel({ 'first-name': 'John', 'last_name': 'Doe' });
43
43
  - **`parseArrayToMapWithKey(arr, keyMap)`**: Transforms an array of objects into a `Map`, using a specified property of the objects as keys. This is useful for efficient lookups.
44
44
 
45
45
  ```typescript
46
- import { parseArrayToMapWithKey } from '@venizia/ignis';
46
+ import { parseArrayToMapWithKey } from '@venizia/ignis-helpers';
47
47
 
48
48
  const users = [
49
49
  { id: 1, name: 'Alice' },
@@ -62,7 +62,7 @@ const user = usersMap.get(1);
62
62
  - **`getUID()`**: Generates a simple, short unique ID string.
63
63
 
64
64
  ```typescript
65
- import { getUID } from '@venizia/ignis';
65
+ import { getUID } from '@venizia/ignis-helpers';
66
66
 
67
67
  const uniqueId = getUID(); // => e.g., 'A1B2C3D4'
68
68
  ```
@@ -20,7 +20,7 @@ The `BaseApplication` uses this utility to measure the time taken to register co
20
20
 
21
21
  ```typescript
22
22
  // Inside BaseApplication class
23
- import { executeWithPerformanceMeasure } from '@venizia/ignis';
23
+ import { executeWithPerformanceMeasure } from '@venizia/ignis-helpers';
24
24
 
25
25
  // ...
26
26
 
@@ -53,7 +53,7 @@ For more granular measurements, you can use the lower-level functions:
53
53
  ### Example
54
54
 
55
55
  ```typescript
56
- import { getPerformanceCheckpoint, getExecutedPerformance } from '@venizia/ignis';
56
+ import { getPerformanceCheckpoint, getExecutedPerformance } from '@venizia/ignis-helpers';
57
57
 
58
58
  const start = getPerformanceCheckpoint();
59
59
 
@@ -16,7 +16,7 @@ This function executes an array of asynchronous tasks concurrently, but with a s
16
16
  ### Example
17
17
 
18
18
  ```typescript
19
- import { executePromiseWithLimit, sleep } from '@venizia/ignis';
19
+ import { executePromiseWithLimit, sleep } from '@venizia/ignis-helpers';
20
20
 
21
21
  const tasks = [
22
22
  () => sleep(1000).then(() => 'Task 1 done'),
@@ -43,7 +43,7 @@ console.log('All tasks finished:', results);
43
43
  A type guard function to check if a given value is a Promise-like object (i.e., it has a `then` method).
44
44
 
45
45
  ```typescript
46
- import { isPromiseLike } from '@venizia/ignis';
46
+ import { isPromiseLike } from '@venizia/ignis-helpers';
47
47
 
48
48
  const a = Promise.resolve(1);
49
49
  const b = 2;
@@ -62,7 +62,7 @@ if (isPromiseLike(b)) {
62
62
  This function applies a transformation function to a value that might be a direct value or a Promise.
63
63
 
64
64
  ```typescript
65
- import { transformValueOrPromise, isPromiseLike } from '@venizia/ignis';
65
+ import { transformValueOrPromise, isPromiseLike } from '@venizia/ignis-helpers';
66
66
 
67
67
  const double = (n: number) => n * 2;
68
68
 
@@ -75,7 +75,7 @@ const result2 = await transformValueOrPromise(Promise.resolve(5), double); // =>
75
75
  Safely retrieves a deeply nested property from an object using a dot-separated path string. It throws an error if any part of the path is null or undefined.
76
76
 
77
77
  ```typescript
78
- import { getDeepProperty } from '@venizia/ignis';
78
+ import { getDeepProperty } from '@venizia/ignis-helpers';
79
79
 
80
80
  const obj = { a: { b: { c: 'hello' } } };
81
81
 
@@ -31,8 +31,8 @@ The function returns a `Promise` that resolves to an array of `IParsedFile` obje
31
31
  Here is an example of how to use `parseMultipartBody` in a controller to handle a file upload.
32
32
 
33
33
  ```typescript
34
- import { BaseController, controller, HTTP } from '@venizia/ignis';
35
- import { parseMultipartBody } from '@venizia/ignis';
34
+ import { BaseController, controller } from '@venizia/ignis';
35
+ import { parseMultipartBody, HTTP } from '@venizia/ignis-helpers';
36
36
 
37
37
  @controller({ path: '/files' })
38
38
  export class FileController extends BaseController {