@hivehub/rulebook 1.2.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.
- package/LICENSE +191 -0
- package/README.md +539 -0
- package/dist/agents/claude-code.d.ts +69 -0
- package/dist/agents/claude-code.d.ts.map +1 -0
- package/dist/agents/claude-code.js +180 -0
- package/dist/agents/claude-code.js.map +1 -0
- package/dist/agents/cursor-agent.d.ts +184 -0
- package/dist/agents/cursor-agent.d.ts.map +1 -0
- package/dist/agents/cursor-agent.js +299 -0
- package/dist/agents/cursor-agent.js.map +1 -0
- package/dist/agents/gemini-cli.d.ts +69 -0
- package/dist/agents/gemini-cli.d.ts.map +1 -0
- package/dist/agents/gemini-cli.js +180 -0
- package/dist/agents/gemini-cli.js.map +1 -0
- package/dist/cli/commands.d.ts +57 -0
- package/dist/cli/commands.d.ts.map +1 -0
- package/dist/cli/commands.js +1370 -0
- package/dist/cli/commands.js.map +1 -0
- package/dist/cli/docs-prompts.d.ts +3 -0
- package/dist/cli/docs-prompts.d.ts.map +1 -0
- package/dist/cli/docs-prompts.js +45 -0
- package/dist/cli/docs-prompts.js.map +1 -0
- package/dist/cli/prompts.d.ts +6 -0
- package/dist/cli/prompts.d.ts.map +1 -0
- package/dist/cli/prompts.js +376 -0
- package/dist/cli/prompts.js.map +1 -0
- package/dist/core/agent-manager.d.ts +89 -0
- package/dist/core/agent-manager.d.ts.map +1 -0
- package/dist/core/agent-manager.js +546 -0
- package/dist/core/agent-manager.js.map +1 -0
- package/dist/core/auto-fixer.d.ts +14 -0
- package/dist/core/auto-fixer.d.ts.map +1 -0
- package/dist/core/auto-fixer.js +207 -0
- package/dist/core/auto-fixer.js.map +1 -0
- package/dist/core/changelog-generator.d.ts +44 -0
- package/dist/core/changelog-generator.d.ts.map +1 -0
- package/dist/core/changelog-generator.js +222 -0
- package/dist/core/changelog-generator.js.map +1 -0
- package/dist/core/cli-bridge.d.ts +113 -0
- package/dist/core/cli-bridge.d.ts.map +1 -0
- package/dist/core/cli-bridge.js +1094 -0
- package/dist/core/cli-bridge.js.map +1 -0
- package/dist/core/config-manager.d.ts +65 -0
- package/dist/core/config-manager.d.ts.map +1 -0
- package/dist/core/config-manager.js +266 -0
- package/dist/core/config-manager.js.map +1 -0
- package/dist/core/coverage-checker.d.ts +14 -0
- package/dist/core/coverage-checker.d.ts.map +1 -0
- package/dist/core/coverage-checker.js +176 -0
- package/dist/core/coverage-checker.js.map +1 -0
- package/dist/core/custom-templates.d.ts +27 -0
- package/dist/core/custom-templates.d.ts.map +1 -0
- package/dist/core/custom-templates.js +122 -0
- package/dist/core/custom-templates.js.map +1 -0
- package/dist/core/dependency-checker.d.ts +21 -0
- package/dist/core/dependency-checker.d.ts.map +1 -0
- package/dist/core/dependency-checker.js +247 -0
- package/dist/core/dependency-checker.js.map +1 -0
- package/dist/core/detector.d.ts +3 -0
- package/dist/core/detector.d.ts.map +1 -0
- package/dist/core/detector.js +1443 -0
- package/dist/core/detector.js.map +1 -0
- package/dist/core/docs-generator.d.ts +9 -0
- package/dist/core/docs-generator.d.ts.map +1 -0
- package/dist/core/docs-generator.js +531 -0
- package/dist/core/docs-generator.js.map +1 -0
- package/dist/core/generator.d.ts +16 -0
- package/dist/core/generator.d.ts.map +1 -0
- package/dist/core/generator.js +561 -0
- package/dist/core/generator.js.map +1 -0
- package/dist/core/gitignore-generator.d.ts +13 -0
- package/dist/core/gitignore-generator.d.ts.map +1 -0
- package/dist/core/gitignore-generator.js +307 -0
- package/dist/core/gitignore-generator.js.map +1 -0
- package/dist/core/health-scorer.d.ts +22 -0
- package/dist/core/health-scorer.d.ts.map +1 -0
- package/dist/core/health-scorer.js +395 -0
- package/dist/core/health-scorer.js.map +1 -0
- package/dist/core/logger.d.ts +116 -0
- package/dist/core/logger.d.ts.map +1 -0
- package/dist/core/logger.js +289 -0
- package/dist/core/logger.js.map +1 -0
- package/dist/core/merger.d.ts +6 -0
- package/dist/core/merger.d.ts.map +1 -0
- package/dist/core/merger.js +131 -0
- package/dist/core/merger.js.map +1 -0
- package/dist/core/migrator.d.ts +19 -0
- package/dist/core/migrator.d.ts.map +1 -0
- package/dist/core/migrator.js +102 -0
- package/dist/core/migrator.js.map +1 -0
- package/dist/core/minimal-scaffolder.d.ts +8 -0
- package/dist/core/minimal-scaffolder.d.ts.map +1 -0
- package/dist/core/minimal-scaffolder.js +51 -0
- package/dist/core/minimal-scaffolder.js.map +1 -0
- package/dist/core/modern-console-new.d.ts +81 -0
- package/dist/core/modern-console-new.d.ts.map +1 -0
- package/dist/core/modern-console-new.js +340 -0
- package/dist/core/modern-console-new.js.map +1 -0
- package/dist/core/modern-console.d.ts +99 -0
- package/dist/core/modern-console.d.ts.map +1 -0
- package/dist/core/modern-console.js +568 -0
- package/dist/core/modern-console.js.map +1 -0
- package/dist/core/openspec-manager.d.ts +133 -0
- package/dist/core/openspec-manager.d.ts.map +1 -0
- package/dist/core/openspec-manager.js +605 -0
- package/dist/core/openspec-manager.js.map +1 -0
- package/dist/core/openspec-migrator.d.ts +27 -0
- package/dist/core/openspec-migrator.d.ts.map +1 -0
- package/dist/core/openspec-migrator.js +255 -0
- package/dist/core/openspec-migrator.js.map +1 -0
- package/dist/core/task-manager.d.ts +65 -0
- package/dist/core/task-manager.d.ts.map +1 -0
- package/dist/core/task-manager.js +318 -0
- package/dist/core/task-manager.js.map +1 -0
- package/dist/core/test-task-manager.d.ts +49 -0
- package/dist/core/test-task-manager.d.ts.map +1 -0
- package/dist/core/test-task-manager.js +121 -0
- package/dist/core/test-task-manager.js.map +1 -0
- package/dist/core/validator.d.ts +21 -0
- package/dist/core/validator.d.ts.map +1 -0
- package/dist/core/validator.js +177 -0
- package/dist/core/validator.js.map +1 -0
- package/dist/core/version-bumper.d.ts +19 -0
- package/dist/core/version-bumper.d.ts.map +1 -0
- package/dist/core/version-bumper.js +180 -0
- package/dist/core/version-bumper.js.map +1 -0
- package/dist/core/watcher.d.ts +9 -0
- package/dist/core/watcher.d.ts.map +1 -0
- package/dist/core/watcher.js +22 -0
- package/dist/core/watcher.js.map +1 -0
- package/dist/core/workflow-generator.d.ts +10 -0
- package/dist/core/workflow-generator.d.ts.map +1 -0
- package/dist/core/workflow-generator.js +279 -0
- package/dist/core/workflow-generator.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +159 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp/handlers/archive-task.d.ts +17 -0
- package/dist/mcp/handlers/archive-task.d.ts.map +1 -0
- package/dist/mcp/handlers/archive-task.js +36 -0
- package/dist/mcp/handlers/archive-task.js.map +1 -0
- package/dist/mcp/handlers/create-task.d.ts +17 -0
- package/dist/mcp/handlers/create-task.d.ts.map +1 -0
- package/dist/mcp/handlers/create-task.js +56 -0
- package/dist/mcp/handlers/create-task.js.map +1 -0
- package/dist/mcp/handlers/list-tasks.d.ts +22 -0
- package/dist/mcp/handlers/list-tasks.d.ts.map +1 -0
- package/dist/mcp/handlers/list-tasks.js +42 -0
- package/dist/mcp/handlers/list-tasks.js.map +1 -0
- package/dist/mcp/handlers/show-task.d.ts +25 -0
- package/dist/mcp/handlers/show-task.d.ts.map +1 -0
- package/dist/mcp/handlers/show-task.js +43 -0
- package/dist/mcp/handlers/show-task.js.map +1 -0
- package/dist/mcp/handlers/update-task.d.ts +17 -0
- package/dist/mcp/handlers/update-task.d.ts.map +1 -0
- package/dist/mcp/handlers/update-task.js +35 -0
- package/dist/mcp/handlers/update-task.js.map +1 -0
- package/dist/mcp/handlers/validate-task.d.ts +15 -0
- package/dist/mcp/handlers/validate-task.d.ts.map +1 -0
- package/dist/mcp/handlers/validate-task.js +27 -0
- package/dist/mcp/handlers/validate-task.js.map +1 -0
- package/dist/mcp/rulebook-config.d.ts +22 -0
- package/dist/mcp/rulebook-config.d.ts.map +1 -0
- package/dist/mcp/rulebook-config.js +65 -0
- package/dist/mcp/rulebook-config.js.map +1 -0
- package/dist/mcp/rulebook-server.d.ts +4 -0
- package/dist/mcp/rulebook-server.d.ts.map +1 -0
- package/dist/mcp/rulebook-server.js +246 -0
- package/dist/mcp/rulebook-server.js.map +1 -0
- package/dist/types.d.ts +190 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/dist/utils/file-system.d.ts +9 -0
- package/dist/utils/file-system.d.ts.map +1 -0
- package/dist/utils/file-system.js +51 -0
- package/dist/utils/file-system.js.map +1 -0
- package/dist/utils/git-hooks.d.ts +8 -0
- package/dist/utils/git-hooks.d.ts.map +1 -0
- package/dist/utils/git-hooks.js +440 -0
- package/dist/utils/git-hooks.js.map +1 -0
- package/dist/utils/rulesignore.d.ts +9 -0
- package/dist/utils/rulesignore.d.ts.map +1 -0
- package/dist/utils/rulesignore.js +42 -0
- package/dist/utils/rulesignore.js.map +1 -0
- package/package.json +106 -0
- package/templates/cli/AIDER.md +49 -0
- package/templates/cli/AMAZON_Q.md +25 -0
- package/templates/cli/AUGGIE.md +32 -0
- package/templates/cli/CLAUDE.md +32 -0
- package/templates/cli/CLAUDE_CODE.md +35 -0
- package/templates/cli/CLINE.md +32 -0
- package/templates/cli/CODEBUDDY.md +20 -0
- package/templates/cli/CODEIUM.md +20 -0
- package/templates/cli/CODEX.md +21 -0
- package/templates/cli/CONTINUE.md +34 -0
- package/templates/cli/CURSOR_CLI.md +28 -0
- package/templates/cli/FACTORY.md +18 -0
- package/templates/cli/GEMINI.md +35 -0
- package/templates/cli/KILOCODE.md +18 -0
- package/templates/cli/OPENCODE.md +18 -0
- package/templates/cli/_GENERIC_TEMPLATE.md +29 -0
- package/templates/commands/rulebook-task-apply.md +67 -0
- package/templates/commands/rulebook-task-archive.md +70 -0
- package/templates/commands/rulebook-task-create.md +93 -0
- package/templates/commands/rulebook-task-list.md +42 -0
- package/templates/commands/rulebook-task-show.md +52 -0
- package/templates/commands/rulebook-task-validate.md +53 -0
- package/templates/core/AGENT_AUTOMATION.md +184 -0
- package/templates/core/DAG.md +304 -0
- package/templates/core/DOCUMENTATION_RULES.md +37 -0
- package/templates/core/QUALITY_ENFORCEMENT.md +68 -0
- package/templates/core/RULEBOOK.md +1874 -0
- package/templates/frameworks/ANGULAR.md +36 -0
- package/templates/frameworks/DJANGO.md +83 -0
- package/templates/frameworks/ELECTRON.md +147 -0
- package/templates/frameworks/FLASK.md +38 -0
- package/templates/frameworks/FLUTTER.md +55 -0
- package/templates/frameworks/JQUERY.md +32 -0
- package/templates/frameworks/LARAVEL.md +38 -0
- package/templates/frameworks/NESTJS.md +43 -0
- package/templates/frameworks/NEXTJS.md +127 -0
- package/templates/frameworks/NUXT.md +40 -0
- package/templates/frameworks/RAILS.md +66 -0
- package/templates/frameworks/REACT.md +38 -0
- package/templates/frameworks/REACT_NATIVE.md +47 -0
- package/templates/frameworks/SPRING.md +39 -0
- package/templates/frameworks/SYMFONY.md +36 -0
- package/templates/frameworks/VUE.md +36 -0
- package/templates/frameworks/ZEND.md +35 -0
- package/templates/git/CI_CD_PATTERNS.md +661 -0
- package/templates/git/GITHUB_ACTIONS.md +728 -0
- package/templates/git/GITLAB_CI.md +730 -0
- package/templates/git/GIT_WORKFLOW.md +1157 -0
- package/templates/git/SECRETS_MANAGEMENT.md +585 -0
- package/templates/hooks/COMMIT_MSG.md +530 -0
- package/templates/hooks/POST_CHECKOUT.md +546 -0
- package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -0
- package/templates/hooks/PRE_COMMIT.md +414 -0
- package/templates/hooks/PRE_PUSH.md +601 -0
- package/templates/hooks/csharp-pre-commit.sh +23 -0
- package/templates/hooks/csharp-pre-push.sh +23 -0
- package/templates/hooks/dart-pre-commit.sh +30 -0
- package/templates/hooks/dart-pre-push.sh +25 -0
- package/templates/hooks/elixir-pre-commit.sh +32 -0
- package/templates/hooks/elixir-pre-push.sh +31 -0
- package/templates/hooks/erlang-pre-commit.sh +30 -0
- package/templates/hooks/erlang-pre-push.sh +37 -0
- package/templates/hooks/go-pre-commit.sh +40 -0
- package/templates/hooks/go-pre-push.sh +31 -0
- package/templates/hooks/haskell-pre-commit.sh +41 -0
- package/templates/hooks/haskell-pre-push.sh +37 -0
- package/templates/hooks/java-pre-commit.sh +34 -0
- package/templates/hooks/java-pre-push.sh +24 -0
- package/templates/hooks/kotlin-pre-commit.sh +32 -0
- package/templates/hooks/kotlin-pre-push.sh +16 -0
- package/templates/hooks/php-pre-commit.sh +36 -0
- package/templates/hooks/php-pre-push.sh +26 -0
- package/templates/hooks/python-pre-commit.sh +51 -0
- package/templates/hooks/python-pre-push.sh +25 -0
- package/templates/hooks/ruby-pre-commit.sh +33 -0
- package/templates/hooks/ruby-pre-push.sh +32 -0
- package/templates/hooks/rust-pre-commit.sh +30 -0
- package/templates/hooks/rust-pre-push.sh +30 -0
- package/templates/hooks/scala-pre-commit.sh +32 -0
- package/templates/hooks/scala-pre-push.sh +24 -0
- package/templates/hooks/swift-pre-commit.sh +25 -0
- package/templates/hooks/swift-pre-push.sh +23 -0
- package/templates/hooks/typescript-pre-commit.sh +37 -0
- package/templates/hooks/typescript-pre-push.sh +36 -0
- package/templates/ides/COPILOT.md +37 -0
- package/templates/ides/CURSOR.md +43 -0
- package/templates/ides/JETBRAINS_AI.md +35 -0
- package/templates/ides/REPLIT.md +36 -0
- package/templates/ides/TABNINE.md +29 -0
- package/templates/ides/VSCODE.md +40 -0
- package/templates/ides/WINDSURF.md +36 -0
- package/templates/ides/ZED.md +32 -0
- package/templates/languages/ADA.md +58 -0
- package/templates/languages/C.md +333 -0
- package/templates/languages/CPP.md +743 -0
- package/templates/languages/CSHARP.md +417 -0
- package/templates/languages/DART.md +332 -0
- package/templates/languages/ELIXIR.md +454 -0
- package/templates/languages/ERLANG.md +361 -0
- package/templates/languages/GO.md +645 -0
- package/templates/languages/HASKELL.md +177 -0
- package/templates/languages/JAVA.md +607 -0
- package/templates/languages/JAVASCRIPT.md +631 -0
- package/templates/languages/JULIA.md +97 -0
- package/templates/languages/KOTLIN.md +511 -0
- package/templates/languages/LISP.md +100 -0
- package/templates/languages/LUA.md +74 -0
- package/templates/languages/OBJECTIVEC.md +90 -0
- package/templates/languages/PHP.md +416 -0
- package/templates/languages/PYTHON.md +682 -0
- package/templates/languages/R.md +350 -0
- package/templates/languages/RUBY.md +421 -0
- package/templates/languages/RUST.md +477 -0
- package/templates/languages/SAS.md +73 -0
- package/templates/languages/SCALA.md +348 -0
- package/templates/languages/SOLIDITY.md +580 -0
- package/templates/languages/SQL.md +137 -0
- package/templates/languages/SWIFT.md +466 -0
- package/templates/languages/TYPESCRIPT.md +591 -0
- package/templates/languages/ZIG.md +265 -0
- package/templates/modules/ATLASSIAN.md +255 -0
- package/templates/modules/CONTEXT7.md +54 -0
- package/templates/modules/FIGMA.md +267 -0
- package/templates/modules/GITHUB_MCP.md +64 -0
- package/templates/modules/GRAFANA.md +328 -0
- package/templates/modules/NOTION.md +247 -0
- package/templates/modules/PLAYWRIGHT.md +90 -0
- package/templates/modules/RULEBOOK_MCP.md +156 -0
- package/templates/modules/SERENA.md +337 -0
- package/templates/modules/SUPABASE.md +223 -0
- package/templates/modules/SYNAP.md +69 -0
- package/templates/modules/VECTORIZER.md +63 -0
- package/templates/services/AZURE_BLOB.md +184 -0
- package/templates/services/CASSANDRA.md +239 -0
- package/templates/services/DYNAMODB.md +308 -0
- package/templates/services/ELASTICSEARCH.md +347 -0
- package/templates/services/GCS.md +178 -0
- package/templates/services/INFLUXDB.md +265 -0
- package/templates/services/KAFKA.md +341 -0
- package/templates/services/MARIADB.md +183 -0
- package/templates/services/MEMCACHED.md +242 -0
- package/templates/services/MINIO.md +201 -0
- package/templates/services/MONGODB.md +268 -0
- package/templates/services/MYSQL.md +358 -0
- package/templates/services/NEO4J.md +247 -0
- package/templates/services/ORACLE.md +290 -0
- package/templates/services/POSTGRESQL.md +326 -0
- package/templates/services/RABBITMQ.md +286 -0
- package/templates/services/REDIS.md +292 -0
- package/templates/services/S3.md +298 -0
- package/templates/services/SQLITE.md +294 -0
- package/templates/services/SQLSERVER.md +294 -0
- package/templates/workflows/codespell.yml +31 -0
- package/templates/workflows/cpp-lint.yml +47 -0
- package/templates/workflows/cpp-publish.yml +119 -0
- package/templates/workflows/cpp-test.yml +77 -0
- package/templates/workflows/dotnet-lint.yml +29 -0
- package/templates/workflows/dotnet-publish.yml +40 -0
- package/templates/workflows/dotnet-test.yml +41 -0
- package/templates/workflows/elixir-lint.yml +45 -0
- package/templates/workflows/elixir-publish.yml +49 -0
- package/templates/workflows/elixir-test.yml +54 -0
- package/templates/workflows/erlang-lint.yml +47 -0
- package/templates/workflows/erlang-test.yml +62 -0
- package/templates/workflows/go-lint.yml +39 -0
- package/templates/workflows/go-publish.yml +95 -0
- package/templates/workflows/go-test.yml +59 -0
- package/templates/workflows/java-lint.yml +60 -0
- package/templates/workflows/java-publish.yml +120 -0
- package/templates/workflows/java-test.yml +85 -0
- package/templates/workflows/kotlin-lint.yml +34 -0
- package/templates/workflows/kotlin-publish.yml +56 -0
- package/templates/workflows/kotlin-test.yml +48 -0
- package/templates/workflows/php-lint.yml +39 -0
- package/templates/workflows/php-publish.yml +50 -0
- package/templates/workflows/php-test.yml +54 -0
- package/templates/workflows/python-lint.yml +47 -0
- package/templates/workflows/python-publish.yml +91 -0
- package/templates/workflows/python-test.yml +59 -0
- package/templates/workflows/rust-lint.yml +54 -0
- package/templates/workflows/rust-publish.yml +66 -0
- package/templates/workflows/rust-test.yml +75 -0
- package/templates/workflows/solidity-lint.yml +41 -0
- package/templates/workflows/solidity-test.yml +47 -0
- package/templates/workflows/swift-lint.yml +32 -0
- package/templates/workflows/swift-publish.yml +58 -0
- package/templates/workflows/swift-test.yml +44 -0
- package/templates/workflows/typescript-lint.yml +61 -0
- package/templates/workflows/typescript-publish.yml +60 -0
- package/templates/workflows/typescript-test.yml +73 -0
- package/templates/workflows/zig-lint.yml +27 -0
- package/templates/workflows/zig-test.yml +40 -0
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
<!-- NEO4J:START -->
|
|
2
|
+
# Neo4j Graph Database Instructions
|
|
3
|
+
|
|
4
|
+
**CRITICAL**: Use Neo4j for graph data modeling, relationship traversal, and complex connected data queries.
|
|
5
|
+
|
|
6
|
+
## Core Features
|
|
7
|
+
|
|
8
|
+
### Connection
|
|
9
|
+
```typescript
|
|
10
|
+
// Using neo4j-driver
|
|
11
|
+
import neo4j from 'neo4j-driver'
|
|
12
|
+
|
|
13
|
+
const driver = neo4j.driver(
|
|
14
|
+
process.env.NEO4J_URI || 'bolt://localhost:7687',
|
|
15
|
+
neo4j.auth.basic(
|
|
16
|
+
process.env.NEO4J_USER || 'neo4j',
|
|
17
|
+
process.env.NEO4J_PASSWORD || 'password'
|
|
18
|
+
),
|
|
19
|
+
{
|
|
20
|
+
maxConnectionLifetime: 3 * 60 * 60 * 1000, // 3 hours
|
|
21
|
+
maxConnectionPoolSize: 50,
|
|
22
|
+
connectionAcquisitionTimeout: 2 * 60 * 1000, // 2 minutes
|
|
23
|
+
}
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
const session = driver.session()
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Basic Operations
|
|
30
|
+
```typescript
|
|
31
|
+
// Create node
|
|
32
|
+
const result = await session.run(
|
|
33
|
+
'CREATE (u:User {id: $id, name: $name, email: $email}) RETURN u',
|
|
34
|
+
{ id: '1', name: 'John Doe', email: 'john@example.com' }
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
// Create relationship
|
|
38
|
+
await session.run(
|
|
39
|
+
'MATCH (u:User {id: $userId}), (p:Post {id: $postId}) CREATE (u)-[:CREATED]->(p)',
|
|
40
|
+
{ userId: '1', postId: '1' }
|
|
41
|
+
)
|
|
42
|
+
|
|
43
|
+
// Find nodes
|
|
44
|
+
const result = await session.run(
|
|
45
|
+
'MATCH (u:User {email: $email}) RETURN u',
|
|
46
|
+
{ email: 'john@example.com' }
|
|
47
|
+
)
|
|
48
|
+
const user = result.records[0]?.get('u')
|
|
49
|
+
|
|
50
|
+
// Update node
|
|
51
|
+
await session.run(
|
|
52
|
+
'MATCH (u:User {id: $id}) SET u.name = $name, u.updatedAt = $updatedAt',
|
|
53
|
+
{ id: '1', name: 'Jane Doe', updatedAt: new Date().toISOString() }
|
|
54
|
+
)
|
|
55
|
+
|
|
56
|
+
// Delete node and relationships
|
|
57
|
+
await session.run(
|
|
58
|
+
'MATCH (u:User {id: $id}) DETACH DELETE u',
|
|
59
|
+
{ id: '1' }
|
|
60
|
+
)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Advanced Queries
|
|
64
|
+
```typescript
|
|
65
|
+
// Find relationships
|
|
66
|
+
const result = await session.run(`
|
|
67
|
+
MATCH (u:User)-[r:FOLLOWS]->(f:User)
|
|
68
|
+
WHERE u.id = $userId
|
|
69
|
+
RETURN f, r.createdAt
|
|
70
|
+
ORDER BY r.createdAt DESC
|
|
71
|
+
LIMIT 10
|
|
72
|
+
`, { userId: '1' })
|
|
73
|
+
|
|
74
|
+
// Shortest path
|
|
75
|
+
const result = await session.run(`
|
|
76
|
+
MATCH path = shortestPath(
|
|
77
|
+
(start:User {id: $startId})-[*]-(end:User {id: $endId})
|
|
78
|
+
)
|
|
79
|
+
RETURN path, length(path) as distance
|
|
80
|
+
`, { startId: '1', endId: '2' })
|
|
81
|
+
|
|
82
|
+
// Pattern matching
|
|
83
|
+
const result = await session.run(`
|
|
84
|
+
MATCH (u:User)-[:CREATED]->(p:Post)-[:TAGGED_WITH]->(t:Tag)
|
|
85
|
+
WHERE t.name = $tagName
|
|
86
|
+
RETURN u, count(p) as postCount
|
|
87
|
+
ORDER BY postCount DESC
|
|
88
|
+
`, { tagName: 'javascript' })
|
|
89
|
+
|
|
90
|
+
// Aggregations
|
|
91
|
+
const result = await session.run(`
|
|
92
|
+
MATCH (u:User)-[:FOLLOWS]->(f:User)
|
|
93
|
+
RETURN u.id, count(f) as followerCount
|
|
94
|
+
ORDER BY followerCount DESC
|
|
95
|
+
LIMIT 10
|
|
96
|
+
`)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Common Patterns
|
|
100
|
+
|
|
101
|
+
### User Recommendations
|
|
102
|
+
```typescript
|
|
103
|
+
async function getRecommendedUsers(userId: string) {
|
|
104
|
+
const result = await session.run(`
|
|
105
|
+
MATCH (u:User {id: $userId})-[:FOLLOWS]->(f:User)-[:FOLLOWS]->(recommended:User)
|
|
106
|
+
WHERE NOT (u)-[:FOLLOWS]->(recommended) AND u <> recommended
|
|
107
|
+
RETURN recommended, count(recommended) as mutualFollowers
|
|
108
|
+
ORDER BY mutualFollowers DESC
|
|
109
|
+
LIMIT 10
|
|
110
|
+
`, { userId })
|
|
111
|
+
|
|
112
|
+
return result.records.map(record => ({
|
|
113
|
+
user: record.get('recommended').properties,
|
|
114
|
+
score: record.get('mutualFollowers').toNumber(),
|
|
115
|
+
}))
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Graph Traversal
|
|
120
|
+
```typescript
|
|
121
|
+
async function findConnections(userId: string, depth: number) {
|
|
122
|
+
const result = await session.run(`
|
|
123
|
+
MATCH path = (start:User {id: $userId})-[*1..${depth}]-(connected:User)
|
|
124
|
+
RETURN connected, length(path) as distance
|
|
125
|
+
ORDER BY distance
|
|
126
|
+
`, { userId })
|
|
127
|
+
|
|
128
|
+
return result.records.map(record => ({
|
|
129
|
+
user: record.get('connected').properties,
|
|
130
|
+
distance: record.get('distance').toNumber(),
|
|
131
|
+
}))
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Transaction
|
|
136
|
+
```typescript
|
|
137
|
+
const session = driver.session()
|
|
138
|
+
const tx = session.beginTransaction()
|
|
139
|
+
|
|
140
|
+
try {
|
|
141
|
+
await tx.run('CREATE (u:User {id: $id, name: $name})', { id: '1', name: 'John' })
|
|
142
|
+
await tx.run('CREATE (p:Post {id: $id, title: $title})', { id: '1', title: 'Post 1' })
|
|
143
|
+
await tx.run(
|
|
144
|
+
'MATCH (u:User {id: $userId}), (p:Post {id: $postId}) CREATE (u)-[:CREATED]->(p)',
|
|
145
|
+
{ userId: '1', postId: '1' }
|
|
146
|
+
)
|
|
147
|
+
await tx.commit()
|
|
148
|
+
} catch (error) {
|
|
149
|
+
await tx.rollback()
|
|
150
|
+
throw error
|
|
151
|
+
} finally {
|
|
152
|
+
await session.close()
|
|
153
|
+
}
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Best Practices
|
|
157
|
+
|
|
158
|
+
✅ **DO:**
|
|
159
|
+
- Use parameterized queries ($param)
|
|
160
|
+
- Create indexes on frequently queried properties
|
|
161
|
+
- Use appropriate relationship types
|
|
162
|
+
- Batch operations when possible
|
|
163
|
+
- Close sessions after use
|
|
164
|
+
- Use transactions for multi-step operations
|
|
165
|
+
- Monitor query performance
|
|
166
|
+
- Use appropriate data types
|
|
167
|
+
- Implement connection pooling
|
|
168
|
+
- Use labels effectively
|
|
169
|
+
|
|
170
|
+
❌ **DON'T:**
|
|
171
|
+
- Use string concatenation for queries (injection risk)
|
|
172
|
+
- Create too many relationships per node
|
|
173
|
+
- Skip error handling
|
|
174
|
+
- Ignore query performance
|
|
175
|
+
- Hardcode connection strings
|
|
176
|
+
- Store large properties (use external storage)
|
|
177
|
+
- Skip indexes on lookup properties
|
|
178
|
+
- Ignore transaction boundaries
|
|
179
|
+
- Use synchronous operations
|
|
180
|
+
- Store sensitive data without encryption
|
|
181
|
+
|
|
182
|
+
## Configuration
|
|
183
|
+
|
|
184
|
+
### Environment Variables
|
|
185
|
+
```bash
|
|
186
|
+
NEO4J_URI=bolt://localhost:7687
|
|
187
|
+
NEO4J_URI=neo4j+s://cluster.example.com:7687 # SSL
|
|
188
|
+
NEO4J_USER=neo4j
|
|
189
|
+
NEO4J_PASSWORD=securepassword
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Docker Compose
|
|
193
|
+
```yaml
|
|
194
|
+
services:
|
|
195
|
+
neo4j:
|
|
196
|
+
image: neo4j:5
|
|
197
|
+
ports:
|
|
198
|
+
- "7474:7474" # HTTP
|
|
199
|
+
- "7687:7687" # Bolt
|
|
200
|
+
environment:
|
|
201
|
+
NEO4J_AUTH: neo4j/securepassword
|
|
202
|
+
NEO4J_PLUGINS: '["apoc"]'
|
|
203
|
+
volumes:
|
|
204
|
+
- neo4j_data:/data
|
|
205
|
+
- neo4j_logs:/logs
|
|
206
|
+
healthcheck:
|
|
207
|
+
test: ["CMD", "cypher-shell", "-u", "neo4j", "-p", "securepassword", "RETURN 1"]
|
|
208
|
+
interval: 10s
|
|
209
|
+
timeout: 5s
|
|
210
|
+
retries: 5
|
|
211
|
+
|
|
212
|
+
volumes:
|
|
213
|
+
neo4j_data:
|
|
214
|
+
neo4j_logs:
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## Integration with Development
|
|
218
|
+
|
|
219
|
+
### Testing
|
|
220
|
+
```typescript
|
|
221
|
+
// Use test database
|
|
222
|
+
const testDriver = neo4j.driver('bolt://localhost:7688', neo4j.auth.basic('neo4j', 'test'))
|
|
223
|
+
|
|
224
|
+
// Clean up after tests
|
|
225
|
+
afterEach(async () => {
|
|
226
|
+
const session = testDriver.session()
|
|
227
|
+
await session.run('MATCH (n) DETACH DELETE n')
|
|
228
|
+
await session.close()
|
|
229
|
+
})
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Health Checks
|
|
233
|
+
```typescript
|
|
234
|
+
async function checkNeo4jHealth(): Promise<boolean> {
|
|
235
|
+
try {
|
|
236
|
+
const session = driver.session()
|
|
237
|
+
const result = await session.run('RETURN 1 as health')
|
|
238
|
+
await session.close()
|
|
239
|
+
return result.records.length > 0
|
|
240
|
+
} catch {
|
|
241
|
+
return false
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
<!-- NEO4J:END -->
|
|
247
|
+
|
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
<!-- ORACLE:START -->
|
|
2
|
+
# Oracle Database Instructions
|
|
3
|
+
|
|
4
|
+
**CRITICAL**: Use Oracle Database for enterprise relational data storage with advanced features, high availability, and comprehensive tooling.
|
|
5
|
+
|
|
6
|
+
## Core Features
|
|
7
|
+
|
|
8
|
+
### Connection
|
|
9
|
+
```typescript
|
|
10
|
+
// Using oracledb
|
|
11
|
+
import oracledb from 'oracledb'
|
|
12
|
+
|
|
13
|
+
oracledb.outFormat = oracledb.OUT_FORMAT_OBJECT
|
|
14
|
+
oracledb.autoCommit = false
|
|
15
|
+
|
|
16
|
+
const connection = await oracledb.getConnection({
|
|
17
|
+
user: process.env.DB_USER || 'system',
|
|
18
|
+
password: process.env.DB_PASSWORD,
|
|
19
|
+
connectString: `${process.env.DB_HOST || 'localhost'}:${process.env.DB_PORT || '1521'}/${process.env.DB_SERVICE || 'XE'}`,
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
// Connection pool
|
|
23
|
+
const pool = await oracledb.createPool({
|
|
24
|
+
user: process.env.DB_USER,
|
|
25
|
+
password: process.env.DB_PASSWORD,
|
|
26
|
+
connectString: `${process.env.DB_HOST}:${process.env.DB_PORT}/${process.env.DB_SERVICE}`,
|
|
27
|
+
poolMin: 2,
|
|
28
|
+
poolMax: 10,
|
|
29
|
+
poolIncrement: 1,
|
|
30
|
+
poolTimeout: 60,
|
|
31
|
+
})
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Basic Queries
|
|
35
|
+
```typescript
|
|
36
|
+
// SELECT
|
|
37
|
+
const result = await connection.execute(
|
|
38
|
+
'SELECT * FROM Users WHERE Id = :id',
|
|
39
|
+
{ id: userId }
|
|
40
|
+
)
|
|
41
|
+
const users = result.rows
|
|
42
|
+
|
|
43
|
+
// INSERT with RETURNING
|
|
44
|
+
const result = await connection.execute(
|
|
45
|
+
`INSERT INTO Users (Name, Email)
|
|
46
|
+
VALUES (:name, :email)
|
|
47
|
+
RETURNING Id INTO :id`,
|
|
48
|
+
{
|
|
49
|
+
name: 'John Doe',
|
|
50
|
+
email: 'john@example.com',
|
|
51
|
+
id: { type: oracledb.NUMBER, dir: oracledb.BIND_OUT },
|
|
52
|
+
}
|
|
53
|
+
)
|
|
54
|
+
const newId = result.outBinds.id[0]
|
|
55
|
+
|
|
56
|
+
// UPDATE
|
|
57
|
+
const result = await connection.execute(
|
|
58
|
+
'UPDATE Users SET Name = :name WHERE Id = :id',
|
|
59
|
+
{
|
|
60
|
+
name: 'Jane Doe',
|
|
61
|
+
id: userId,
|
|
62
|
+
}
|
|
63
|
+
)
|
|
64
|
+
|
|
65
|
+
// DELETE
|
|
66
|
+
await connection.execute(
|
|
67
|
+
'DELETE FROM Users WHERE Id = :id',
|
|
68
|
+
{ id: userId }
|
|
69
|
+
)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Transactions
|
|
73
|
+
```typescript
|
|
74
|
+
const connection = await pool.getConnection()
|
|
75
|
+
|
|
76
|
+
try {
|
|
77
|
+
await connection.execute(
|
|
78
|
+
'INSERT INTO Accounts (UserId, Balance) VALUES (:userId, :balance)',
|
|
79
|
+
{ userId, balance: 1000 }
|
|
80
|
+
)
|
|
81
|
+
|
|
82
|
+
await connection.execute(
|
|
83
|
+
'INSERT INTO Transactions (AccountId, Amount) VALUES (:accountId, :amount)',
|
|
84
|
+
{ accountId, amount: 1000 }
|
|
85
|
+
)
|
|
86
|
+
|
|
87
|
+
await connection.commit()
|
|
88
|
+
} catch (error) {
|
|
89
|
+
await connection.rollback()
|
|
90
|
+
throw error
|
|
91
|
+
} finally {
|
|
92
|
+
await connection.close()
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Advanced Features
|
|
97
|
+
```typescript
|
|
98
|
+
// PL/SQL procedures
|
|
99
|
+
const result = await connection.execute(
|
|
100
|
+
`BEGIN
|
|
101
|
+
sp_GetUserDetails(:userId, :userData);
|
|
102
|
+
END;`,
|
|
103
|
+
{
|
|
104
|
+
userId,
|
|
105
|
+
userData: { type: oracledb.CURSOR, dir: oracledb.BIND_OUT },
|
|
106
|
+
}
|
|
107
|
+
)
|
|
108
|
+
|
|
109
|
+
// JSON operations (Oracle 12c+)
|
|
110
|
+
const result = await connection.execute(
|
|
111
|
+
`SELECT
|
|
112
|
+
Id,
|
|
113
|
+
Name,
|
|
114
|
+
JSON_VALUE(Metadata, '$.category') AS Category
|
|
115
|
+
FROM Products
|
|
116
|
+
WHERE JSON_VALUE(Metadata, '$.category') = :category`,
|
|
117
|
+
{ category: 'electronics' }
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
// Full-text search (Oracle Text)
|
|
121
|
+
const result = await connection.execute(
|
|
122
|
+
`SELECT * FROM Articles
|
|
123
|
+
WHERE CONTAINS(Content, :searchTerm, 1) > 0`,
|
|
124
|
+
{ searchTerm: 'search term' }
|
|
125
|
+
)
|
|
126
|
+
|
|
127
|
+
// Window functions
|
|
128
|
+
const result = await connection.execute(
|
|
129
|
+
`SELECT
|
|
130
|
+
Name,
|
|
131
|
+
Salary,
|
|
132
|
+
ROW_NUMBER() OVER (PARTITION BY DepartmentId ORDER BY Salary DESC) AS Rank
|
|
133
|
+
FROM Employees`
|
|
134
|
+
)
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Common Patterns
|
|
138
|
+
|
|
139
|
+
### Connection Pooling
|
|
140
|
+
```typescript
|
|
141
|
+
let pool: oracledb.Pool | null = null
|
|
142
|
+
|
|
143
|
+
export async function getPool(): Promise<oracledb.Pool> {
|
|
144
|
+
if (!pool) {
|
|
145
|
+
pool = await oracledb.createPool({
|
|
146
|
+
// ... config
|
|
147
|
+
})
|
|
148
|
+
}
|
|
149
|
+
return pool
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
// Graceful shutdown
|
|
153
|
+
process.on('SIGINT', async () => {
|
|
154
|
+
if (pool) {
|
|
155
|
+
await pool.close()
|
|
156
|
+
}
|
|
157
|
+
process.exit(0)
|
|
158
|
+
})
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Parameterized Queries
|
|
162
|
+
```typescript
|
|
163
|
+
// Always use bind variables (:param) to prevent SQL injection
|
|
164
|
+
// ❌ WRONG
|
|
165
|
+
await connection.execute(`SELECT * FROM Users WHERE Email = '${email}'`)
|
|
166
|
+
|
|
167
|
+
// ✅ CORRECT
|
|
168
|
+
await connection.execute(
|
|
169
|
+
'SELECT * FROM Users WHERE Email = :email',
|
|
170
|
+
{ email }
|
|
171
|
+
)
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Error Handling
|
|
175
|
+
```typescript
|
|
176
|
+
try {
|
|
177
|
+
const result = await connection.execute(
|
|
178
|
+
'SELECT * FROM Users WHERE Id = :id',
|
|
179
|
+
{ id: userId }
|
|
180
|
+
)
|
|
181
|
+
|
|
182
|
+
if (result.rows.length === 0) {
|
|
183
|
+
throw new Error('User not found')
|
|
184
|
+
}
|
|
185
|
+
return result.rows[0]
|
|
186
|
+
} catch (error: any) {
|
|
187
|
+
if (error.errorNum === 1) { // Unique constraint violation
|
|
188
|
+
throw new Error('Duplicate entry')
|
|
189
|
+
}
|
|
190
|
+
if (error.errorNum === 2291) { // Foreign key constraint violation
|
|
191
|
+
throw new Error('Referenced record does not exist')
|
|
192
|
+
}
|
|
193
|
+
throw error
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## Best Practices
|
|
198
|
+
|
|
199
|
+
✅ **DO:**
|
|
200
|
+
- Use connection pooling (2-10 connections typically)
|
|
201
|
+
- Always use bind variables (:param)
|
|
202
|
+
- Use transactions for multi-step operations
|
|
203
|
+
- Create indexes on frequently queried columns
|
|
204
|
+
- Use appropriate data types
|
|
205
|
+
- Enable connection retry logic
|
|
206
|
+
- Use PL/SQL for complex operations
|
|
207
|
+
- Monitor connection pool usage
|
|
208
|
+
- Use appropriate fetch array sizes
|
|
209
|
+
- Implement proper error handling
|
|
210
|
+
|
|
211
|
+
❌ **DON'T:**
|
|
212
|
+
- Use string concatenation for queries (SQL injection risk)
|
|
213
|
+
- Create too many connections
|
|
214
|
+
- Skip error handling
|
|
215
|
+
- Ignore connection pool limits
|
|
216
|
+
- Use SELECT * in production
|
|
217
|
+
- Skip indexes on foreign keys
|
|
218
|
+
- Hardcode connection strings
|
|
219
|
+
- Skip transaction management
|
|
220
|
+
- Ignore query performance
|
|
221
|
+
- Use synchronous operations
|
|
222
|
+
|
|
223
|
+
## Configuration
|
|
224
|
+
|
|
225
|
+
### Environment Variables
|
|
226
|
+
```bash
|
|
227
|
+
DB_HOST=localhost
|
|
228
|
+
DB_PORT=1521
|
|
229
|
+
DB_SERVICE=XE
|
|
230
|
+
DB_USER=system
|
|
231
|
+
DB_PASSWORD=securepassword
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Docker Compose
|
|
235
|
+
```yaml
|
|
236
|
+
services:
|
|
237
|
+
oracle:
|
|
238
|
+
image: container-registry.oracle.com/database/express:21.3.0-xe
|
|
239
|
+
ports:
|
|
240
|
+
- "1521:1521"
|
|
241
|
+
- "5500:5500" # Enterprise Manager
|
|
242
|
+
environment:
|
|
243
|
+
ORACLE_PWD: securepassword
|
|
244
|
+
volumes:
|
|
245
|
+
- oracle_data:/opt/oracle/oradata
|
|
246
|
+
healthcheck:
|
|
247
|
+
test: ["CMD-SHELL", "sqlplus -S system/securepassword@localhost:1521/XE <<< 'SELECT 1 FROM DUAL;' || exit 1"]
|
|
248
|
+
interval: 30s
|
|
249
|
+
timeout: 10s
|
|
250
|
+
retries: 5
|
|
251
|
+
|
|
252
|
+
volumes:
|
|
253
|
+
oracle_data:
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
## Integration with Development
|
|
257
|
+
|
|
258
|
+
### Testing
|
|
259
|
+
```typescript
|
|
260
|
+
// Use test database
|
|
261
|
+
const testPool = await oracledb.createPool({
|
|
262
|
+
connectString: 'localhost:1521/TEST',
|
|
263
|
+
// ... config
|
|
264
|
+
})
|
|
265
|
+
|
|
266
|
+
// Clean up after tests
|
|
267
|
+
afterEach(async () => {
|
|
268
|
+
const connection = await testPool.getConnection()
|
|
269
|
+
await connection.execute('DELETE FROM Users')
|
|
270
|
+
await connection.execute('DELETE FROM Posts')
|
|
271
|
+
await connection.close()
|
|
272
|
+
})
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### Health Checks
|
|
276
|
+
```typescript
|
|
277
|
+
async function checkDatabaseHealth(): Promise<boolean> {
|
|
278
|
+
try {
|
|
279
|
+
const connection = await pool.getConnection()
|
|
280
|
+
const result = await connection.execute('SELECT 1 FROM DUAL')
|
|
281
|
+
await connection.close()
|
|
282
|
+
return result.rows.length > 0
|
|
283
|
+
} catch {
|
|
284
|
+
return false
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
<!-- ORACLE:END -->
|
|
290
|
+
|