@venizia/ignis-docs 0.2.0 → 0.2.1-1
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/README.md +14 -14
- package/content/best-practices/api-usage-examples.md +39 -19
- package/content/best-practices/architectural-patterns.md +24 -13
- package/content/best-practices/architecture-decisions.md +29 -16
- package/content/best-practices/code-style-standards/advanced-patterns.md +43 -31
- package/content/best-practices/code-style-standards/constants-configuration.md +19 -4
- package/content/best-practices/code-style-standards/control-flow.md +33 -1
- package/content/best-practices/code-style-standards/documentation.md +28 -8
- package/content/best-practices/code-style-standards/function-patterns.md +15 -4
- package/content/best-practices/code-style-standards/index.md +7 -2
- package/content/best-practices/code-style-standards/naming-conventions.md +27 -3
- package/content/best-practices/code-style-standards/route-definitions.md +9 -5
- package/content/best-practices/code-style-standards/tooling.md +14 -1
- package/content/best-practices/code-style-standards/type-safety.md +39 -6
- package/content/best-practices/common-pitfalls.md +59 -35
- package/content/best-practices/contribution-workflow.md +8 -4
- package/content/best-practices/data-modeling.md +78 -62
- package/content/best-practices/deployment-strategies.md +56 -19
- package/content/best-practices/error-handling.md +247 -153
- package/content/best-practices/index.md +6 -0
- package/content/best-practices/performance-optimization.md +26 -13
- package/content/best-practices/security-guidelines.md +35 -9
- package/content/best-practices/testing-strategies.md +7 -2
- package/content/best-practices/troubleshooting-tips.md +27 -17
- package/content/extensions/components/api-reference.md +109 -323
- package/content/extensions/components/authentication/api.md +489 -602
- package/content/extensions/components/authentication/errors.md +135 -498
- package/content/extensions/components/authentication/index.md +89 -801
- package/content/extensions/components/authentication/usage.md +231 -955
- package/content/extensions/components/authorization/api.md +991 -644
- package/content/extensions/components/authorization/errors.md +204 -208
- package/content/extensions/components/authorization/getting-started.md +227 -0
- package/content/extensions/components/authorization/index.md +88 -795
- package/content/extensions/components/authorization/usage.md +219 -528
- package/content/extensions/components/health-check.md +77 -243
- package/content/extensions/components/index.md +24 -90
- package/content/extensions/components/mail/api.md +553 -285
- package/content/extensions/components/mail/errors.md +76 -62
- package/content/extensions/components/mail/index.md +111 -463
- package/content/extensions/components/mail/usage.md +139 -173
- package/content/extensions/components/request-tracker.md +70 -173
- package/content/extensions/components/socket-io/api.md +462 -785
- package/content/extensions/components/socket-io/errors.md +49 -51
- package/content/extensions/components/socket-io/index.md +69 -372
- package/content/extensions/components/socket-io/usage.md +212 -105
- package/content/extensions/components/static-asset/api.md +461 -141
- package/content/extensions/components/static-asset/errors.md +121 -53
- package/content/extensions/components/static-asset/index.md +84 -606
- package/content/extensions/components/static-asset/usage.md +184 -299
- package/content/extensions/components/template/index.md +3 -3
- package/content/extensions/components/websocket/api.md +311 -404
- package/content/extensions/components/websocket/errors.md +47 -56
- package/content/extensions/components/websocket/index.md +75 -407
- package/content/extensions/components/websocket/usage.md +120 -338
- package/content/extensions/helpers/cron/index.md +52 -160
- package/content/extensions/helpers/crypto/index.md +67 -480
- package/content/extensions/helpers/crypto/reference.md +528 -0
- package/content/extensions/helpers/env/index.md +64 -178
- package/content/extensions/helpers/error/index.md +286 -196
- package/content/extensions/helpers/index.md +61 -47
- package/content/extensions/helpers/inversion/index.md +76 -550
- package/content/extensions/helpers/inversion/reference.md +530 -0
- package/content/extensions/helpers/kafka/admin.md +23 -3
- package/content/extensions/helpers/kafka/compile-binary.md +83 -52
- package/content/extensions/helpers/kafka/consumer.md +65 -28
- package/content/extensions/helpers/kafka/examples.md +46 -253
- package/content/extensions/helpers/kafka/index.md +55 -617
- package/content/extensions/helpers/kafka/producer.md +156 -22
- package/content/extensions/helpers/kafka/schema-registry.md +59 -79
- package/content/extensions/helpers/logger/hf-logger.md +220 -0
- package/content/extensions/helpers/logger/index.md +78 -552
- package/content/extensions/helpers/logger/pino.md +105 -0
- package/content/extensions/helpers/logger/reference.md +937 -0
- package/content/extensions/helpers/network/api.md +276 -195
- package/content/extensions/helpers/network/index.md +87 -524
- package/content/extensions/helpers/queue/index.md +80 -897
- package/content/extensions/helpers/queue/reference.md +494 -0
- package/content/extensions/helpers/redis/index.md +86 -640
- package/content/extensions/helpers/redis/reference.md +784 -0
- package/content/extensions/helpers/secrets/index.md +136 -0
- package/content/extensions/helpers/socket-io/api.md +325 -204
- package/content/extensions/helpers/socket-io/index.md +79 -429
- package/content/extensions/helpers/storage/api.md +584 -464
- package/content/extensions/helpers/storage/index.md +80 -573
- package/content/extensions/helpers/types/index.md +75 -495
- package/content/extensions/helpers/types/reference.md +689 -0
- package/content/extensions/helpers/uid/index.md +176 -189
- package/content/extensions/helpers/websocket/api.md +366 -214
- package/content/extensions/helpers/websocket/index.md +68 -503
- package/content/extensions/helpers/worker-thread/index.md +62 -396
- package/content/extensions/helpers/worker-thread/reference.md +428 -0
- package/content/extensions/index.md +38 -39
- package/content/extensions/src-details/mcp-server.md +96 -548
- package/content/guides/core-concepts/persistent/datasources.md +2 -2
- package/content/guides/core-concepts/persistent/index.md +5 -1
- package/content/guides/core-concepts/persistent/models.md +1 -1
- package/content/guides/core-concepts/persistent/pglite.md +218 -0
- package/content/guides/core-concepts/persistent/postgres-drivers.md +21 -15
- package/content/guides/core-concepts/persistent/search-meilisearch.md +22 -12
- package/content/guides/core-concepts/persistent/search-typesense.md +28 -16
- package/content/guides/core-concepts/persistent/sqlite.md +296 -0
- package/content/guides/core-concepts/persistent/transactions.md +12 -11
- package/content/guides/core-concepts/secrets-vault.md +177 -0
- package/content/guides/core-concepts/services.md +1 -1
- package/content/guides/get-started/5-minute-quickstart.md +59 -206
- package/content/guides/get-started/philosophy.md +135 -670
- package/content/guides/get-started/setup.md +53 -74
- package/content/guides/migrations/redis-helpers-migration.md +5 -4
- package/content/guides/migrations/scoped-rbac-migration.md +5 -5
- package/content/guides/migrations/unified-connectors-migration.md +8 -7
- package/content/guides/tutorials/ecommerce-api.md +3 -8
- package/content/guides/tutorials/realtime-chat.md +1 -1
- package/content/references/base/application.md +64 -22
- package/content/references/base/components.md +3 -3
- package/content/references/base/connectors.md +79 -136
- package/content/references/base/controllers.md +12 -12
- package/content/references/base/datasources-reference.md +600 -0
- package/content/references/base/datasources.md +84 -444
- package/content/references/base/dependency-injection.md +25 -46
- package/content/references/base/filter-system/application-usage.md +95 -123
- package/content/references/base/filter-system/array-operators.md +33 -43
- package/content/references/base/filter-system/comparison-operators.md +55 -63
- package/content/references/base/filter-system/default-filter.md +144 -350
- package/content/references/base/filter-system/fields-order-pagination.md +116 -148
- package/content/references/base/filter-system/index.md +114 -253
- package/content/references/base/filter-system/json-filtering.md +52 -181
- package/content/references/base/filter-system/list-operators.md +28 -44
- package/content/references/base/filter-system/logical-operators.md +69 -114
- package/content/references/base/filter-system/null-operators.md +41 -98
- package/content/references/base/filter-system/pattern-matching.md +48 -51
- package/content/references/base/filter-system/quick-reference.md +93 -196
- package/content/references/base/filter-system/range-operators.md +22 -38
- package/content/references/base/filter-system/tips.md +70 -133
- package/content/references/base/filter-system/use-cases.md +173 -232
- package/content/references/base/grpc-controllers.md +53 -17
- package/content/references/base/index.md +5 -3
- package/content/references/base/middlewares.md +43 -28
- package/content/references/base/models-reference.md +886 -0
- package/content/references/base/models.md +81 -1452
- package/content/references/base/providers.md +8 -8
- package/content/references/base/repositories/advanced.md +281 -419
- package/content/references/base/repositories/index.md +84 -644
- package/content/references/base/repositories/mixins.md +25 -21
- package/content/references/base/repositories/relations.md +194 -375
- package/content/references/base/repositories/soft-deletable.md +67 -55
- package/content/references/base/secrets.md +267 -0
- package/content/references/base/services.md +8 -6
- package/content/references/configuration/environment-variables.md +73 -21
- package/content/references/configuration/index.md +51 -31
- package/content/references/index.md +1 -1
- package/content/references/quick-reference.md +3 -16
- package/content/references/utilities/crypto.md +35 -76
- package/content/references/utilities/date.md +33 -73
- package/content/references/utilities/duration.md +85 -0
- package/content/references/utilities/index.md +6 -2
- package/content/references/utilities/jsx-reference.md +298 -0
- package/content/references/utilities/jsx.md +82 -525
- package/content/references/utilities/module.md +81 -61
- package/content/references/utilities/parse.md +34 -64
- package/content/references/utilities/performance.md +33 -58
- package/content/references/utilities/promise.md +28 -62
- package/content/references/utilities/request.md +58 -218
- package/content/references/utilities/retry.md +139 -0
- package/content/references/utilities/schema.md +43 -137
- package/content/references/utilities/statuses-reference.md +361 -0
- package/content/references/utilities/statuses.md +63 -667
- package/dist/mcp-server/index.js +0 -0
- package/dist/mcp-server/tools/github/list-project-files.tool.d.ts +1 -1
- package/dist/mcp-server/tools/github/list-project-files.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/github/list-project-files.tool.js +3 -3
- package/dist/mcp-server/tools/github/search-code.tool.js +1 -1
- package/dist/mcp-server/tools/github/verify-dependencies.tool.js +1 -1
- package/dist/mcp-server/tools/github/view-source-file.tool.js +1 -1
- package/package.json +24 -23
package/dist/mcp-server/index.js
CHANGED
|
File without changes
|
|
@@ -11,7 +11,7 @@ declare const OutputSchema: z.ZodObject<{
|
|
|
11
11
|
}, z.core.$strip>;
|
|
12
12
|
export declare class ListProjectFilesTool extends BaseTool<typeof InputSchema, typeof OutputSchema> {
|
|
13
13
|
readonly id = "listProjectFiles";
|
|
14
|
-
readonly description = "\nLists files and directories within the Ignis GitHub repository.\n\nPURPOSE:\nExplore the project structure, discover source code files, and navigate the monorepo.\nPrimary tool for understanding codebase layout before reading specific files.\n\nWHEN TO USE:\n- To understand overall project structure\n- To find location of specific modules (e.g., \"where are the controllers?\")\n- To get list of files in a directory before using viewSourceFile\n- To find configuration files, examples, or documentation\n\nWHEN NOT TO USE:\n- When searching for specific code patterns or keywords (use searchCode instead)\n- When you need to read a file's content (use viewSourceFile instead)\n- For documentation content (use searchDocs, listDocs, getDocContent instead)\n\nWORKFLOW:\n1. Start at root: listProjectFiles()\n2. Explore a package: listProjectFiles({ directoryPath: \"packages/core/src\" })\n3. Identify a file of interest\n4. Read the file: viewSourceFile({ filePath: \"packages/core/src/application.ts\" })\n";
|
|
14
|
+
readonly description = "\nLists files and directories within the Ignis GitHub repository.\n\nPURPOSE:\nExplore the project structure, discover source code files, and navigate the monorepo.\nPrimary tool for understanding codebase layout before reading specific files.\n\nWHEN TO USE:\n- To understand overall project structure\n- To find location of specific modules (e.g., \"where are the controllers?\")\n- To get list of files in a directory before using viewSourceFile\n- To find configuration files, examples, or documentation\n\nWHEN NOT TO USE:\n- When searching for specific code patterns or keywords (use searchCode instead)\n- When you need to read a file's content (use viewSourceFile instead)\n- For documentation content (use searchDocs, listDocs, getDocContent instead)\n\nWORKFLOW:\n1. Start at root: listProjectFiles()\n2. Explore a package: listProjectFiles({ directoryPath: \"packages/core-server/src\" })\n3. Identify a file of interest\n4. Read the file: viewSourceFile({ filePath: \"packages/core-server/src/application.ts\" })\n";
|
|
15
15
|
readonly inputSchema: z.ZodObject<{
|
|
16
16
|
directoryPath: z.ZodDefault<z.ZodString>;
|
|
17
17
|
}, z.core.$strip>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"list-project-files.tool.d.ts","sourceRoot":"","sources":["../../../../mcp-server/tools/github/list-project-files.tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAsCxC,QAAA,MAAM,WAAW;;iBAEf,CAAC;AAEH,QAAA,MAAM,YAAY;;;;;iBAOhB,CAAC;AAEH,qBAAa,oBAAqB,SAAQ,QAAQ,CAAC,OAAO,WAAW,EAAE,OAAO,YAAY,CAAC;IACzF,QAAQ,CAAC,EAAE,sBAAsB;IACjC,QAAQ,CAAC,WAAW,
|
|
1
|
+
{"version":3,"file":"list-project-files.tool.d.ts","sourceRoot":"","sources":["../../../../mcp-server/tools/github/list-project-files.tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAsCxC,QAAA,MAAM,WAAW;;iBAEf,CAAC;AAEH,QAAA,MAAM,YAAY;;;;;iBAOhB,CAAC;AAEH,qBAAa,oBAAqB,SAAQ,QAAQ,CAAC,OAAO,WAAW,EAAE,OAAO,YAAY,CAAC;IACzF,QAAQ,CAAC,EAAE,sBAAsB;IACjC,QAAQ,CAAC,WAAW,wgCAAoB;IACxC,QAAQ,CAAC,WAAW;;sBAAe;IACnC,QAAQ,CAAC,YAAY;;;;;sBAAgB;IAE/B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;IAuBvF,OAAO;;;;;;;;CASR"}
|
|
@@ -25,9 +25,9 @@ WHEN NOT TO USE:
|
|
|
25
25
|
|
|
26
26
|
WORKFLOW:
|
|
27
27
|
1. Start at root: listProjectFiles()
|
|
28
|
-
2. Explore a package: listProjectFiles({ directoryPath: "packages/core/src" })
|
|
28
|
+
2. Explore a package: listProjectFiles({ directoryPath: "packages/core-server/src" })
|
|
29
29
|
3. Identify a file of interest
|
|
30
|
-
4. Read the file: viewSourceFile({ filePath: "packages/core/src/application.ts" })
|
|
30
|
+
4. Read the file: viewSourceFile({ filePath: "packages/core-server/src/application.ts" })
|
|
31
31
|
`;
|
|
32
32
|
const DIRECTORY_PATH_DESCRIPTION = `
|
|
33
33
|
The path to the directory you want to list, relative to the project root.
|
|
@@ -36,7 +36,7 @@ If omitted, it defaults to the root of the repository.
|
|
|
36
36
|
EXAMPLES:
|
|
37
37
|
- "." (or omitted) -> lists the root directory
|
|
38
38
|
- "packages" -> lists the contents of the 'packages' directory
|
|
39
|
-
- "packages/core/src" -> lists the source files of the core package
|
|
39
|
+
- "packages/core-server/src" -> lists the source files of the core package
|
|
40
40
|
`;
|
|
41
41
|
const InputSchema = zod_1.z.object({
|
|
42
42
|
directoryPath: zod_1.z.string().default('.').describe(DIRECTORY_PATH_DESCRIPTION),
|
|
@@ -43,7 +43,7 @@ QUERY SYNTAX:
|
|
|
43
43
|
- Multiple terms: "inject service" - files containing both terms
|
|
44
44
|
- Exact phrase: "\\"dependency injection\\"" - exact phrase match
|
|
45
45
|
- File extension: "extension:ts middleware" - only TypeScript files
|
|
46
|
-
- Path filter: "path:packages/core createTool" - search in specific path
|
|
46
|
+
- Path filter: "path:packages/core-server createTool" - search in specific path
|
|
47
47
|
|
|
48
48
|
EXAMPLES:
|
|
49
49
|
- "class Application" - find Application class definition
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@venizia/ignis-docs",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1-1",
|
|
4
4
|
"description": "Interactive documentation site and MCP (Model Context Protocol) server for the Ignis Framework. Includes a VitePress-powered documentation site with guides, API references, and best practices. Ships an MCP server (CLI: ignis-docs-mcp) with 11 tools for AI assistants to search docs, browse source code, verify dependencies, and access real-time framework knowledge. Built with Mastra MCP SDK and Fuse.js fuzzy search.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"wiki",
|
|
44
44
|
"windsurf"
|
|
45
45
|
],
|
|
46
|
-
"homepage": "https://venizia
|
|
46
|
+
"homepage": "https://ignis.venizia.ai",
|
|
47
47
|
"repository": {
|
|
48
48
|
"type": "git",
|
|
49
49
|
"url": "git+https://github.com/VENIZIA-AI/ignis.git",
|
|
@@ -96,47 +96,48 @@
|
|
|
96
96
|
"access": "public"
|
|
97
97
|
},
|
|
98
98
|
"scripts": {
|
|
99
|
-
"
|
|
99
|
+
"docs:build": "sh ./scripts/docs-build.sh",
|
|
100
|
+
"docs:check-sidebar": "bun scripts/check-sidebar.ts",
|
|
101
|
+
"docs:clean": "sh ./scripts/docs-clean.sh",
|
|
102
|
+
"docs:dev": "vitepress dev site",
|
|
103
|
+
"docs:preview": "vitepress preview site",
|
|
100
104
|
"eslint": "eslint --report-unused-disable-directives .",
|
|
105
|
+
"force-update": "sh ./scripts/force-update.sh",
|
|
101
106
|
"lint": "bun run eslint && bun run prettier:cli",
|
|
102
107
|
"lint:fix": "bun run eslint --fix && bun run prettier:fix",
|
|
103
|
-
"prettier:cli": "prettier \"**/*.{js,ts}\" -l",
|
|
104
|
-
"prettier:fix": "bun run prettier:cli --write",
|
|
105
|
-
"docs:dev": "vitepress dev site",
|
|
106
|
-
"docs:clean": "sh ./scripts/docs-clean.sh",
|
|
107
|
-
"docs:build": "sh ./scripts/docs-build.sh",
|
|
108
|
-
"docs:preview": "vitepress preview site",
|
|
109
|
-
"rebuild": "sh ./scripts/mcp-rebuild.sh no-version",
|
|
110
|
-
"mcp:rebuild": "bun run rebuild",
|
|
111
108
|
"mcp:build": "sh ./scripts/mcp-build.sh",
|
|
112
109
|
"mcp:clean": "sh ./scripts/mcp-clean.sh",
|
|
113
|
-
"mcp:start": "bun run mcp-server/index.ts",
|
|
114
110
|
"mcp:dev": "bun --watch mcp-server/index.ts",
|
|
115
|
-
"
|
|
111
|
+
"mcp:rebuild": "bun run rebuild",
|
|
112
|
+
"mcp:start": "bun run mcp-server/index.ts",
|
|
113
|
+
"prepublishOnly": "bun run mcp:rebuild",
|
|
114
|
+
"prettier:cli": "prettier \"**/*.{js,ts}\" -l",
|
|
115
|
+
"prettier:fix": "bun run prettier:cli --write",
|
|
116
|
+
"rebuild": "sh ./scripts/mcp-rebuild.sh no-version"
|
|
116
117
|
},
|
|
117
118
|
"dependencies": {
|
|
118
|
-
"@mastra/core": "1.
|
|
119
|
-
"@mastra/mcp": "1.
|
|
120
|
-
"cytoscape": "^3.
|
|
119
|
+
"@mastra/core": "^1.51.0",
|
|
120
|
+
"@mastra/mcp": "^1.14.0",
|
|
121
|
+
"cytoscape": "^3.34.0",
|
|
121
122
|
"cytoscape-cose-bilkent": "^4.1.0",
|
|
122
|
-
"dayjs": "^1.11.
|
|
123
|
+
"dayjs": "^1.11.21",
|
|
123
124
|
"debug": "^4.4.3",
|
|
124
125
|
"fast-glob": "^3.3.3",
|
|
125
|
-
"fuse.js": "^7.
|
|
126
|
+
"fuse.js": "^7.5.0",
|
|
126
127
|
"gray-matter": "^4.0.3",
|
|
127
|
-
"zod": "^4.3
|
|
128
|
+
"zod": "^4.4.3"
|
|
128
129
|
},
|
|
129
130
|
"devDependencies": {
|
|
130
131
|
"@braintree/sanitize-url": "^7.1.2",
|
|
131
132
|
"@types/bun": "^1.3.14",
|
|
132
|
-
"@venizia/dev-configs": "^0.
|
|
133
|
+
"@venizia/dev-configs": "^0.2.0-1",
|
|
133
134
|
"eslint": "^10.7.0",
|
|
134
135
|
"prettier": "^3.9.5",
|
|
135
|
-
"tsc-alias": "^1.9.
|
|
136
|
-
"tsx": "^4.23.
|
|
136
|
+
"tsc-alias": "^1.9.1",
|
|
137
|
+
"tsx": "^4.23.1",
|
|
137
138
|
"typescript": "^6.0.3",
|
|
138
139
|
"vitepress": "^1.6.4",
|
|
139
140
|
"vitepress-plugin-mermaid": "^2.0.17",
|
|
140
|
-
"vue": "^3.5.
|
|
141
|
+
"vue": "^3.5.40"
|
|
141
142
|
}
|
|
142
143
|
}
|