@joktec/skills 0.1.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 (129) hide show
  1. package/AGENTS.md +89 -0
  2. package/LICENSE +21 -0
  3. package/README.md +502 -0
  4. package/adapters/README.md +12 -0
  5. package/adapters/copilot/README.md +5 -0
  6. package/adapters/cursor/README.md +5 -0
  7. package/adapters/gemini/README.md +5 -0
  8. package/adapters/windsurf/README.md +5 -0
  9. package/bin/joktec-skills.mjs +553 -0
  10. package/dist/claude/skills/joktec-adapter-skill/SKILL.md +26 -0
  11. package/dist/claude/skills/joktec-adapter-skill/agents/openai.yaml +4 -0
  12. package/dist/claude/skills/joktec-adapter-skill/references/adapters.md +12 -0
  13. package/dist/claude/skills/joktec-broker-skill/SKILL.md +26 -0
  14. package/dist/claude/skills/joktec-broker-skill/agents/openai.yaml +4 -0
  15. package/dist/claude/skills/joktec-broker-skill/references/brokers.md +12 -0
  16. package/dist/claude/skills/joktec-common-skill/SKILL.md +28 -0
  17. package/dist/claude/skills/joktec-common-skill/agents/openai.yaml +4 -0
  18. package/dist/claude/skills/joktec-common-skill/references/core.md +19 -0
  19. package/dist/claude/skills/joktec-common-skill/references/utils-cron.md +17 -0
  20. package/dist/claude/skills/joktec-database-extended-skill/SKILL.md +25 -0
  21. package/dist/claude/skills/joktec-database-extended-skill/agents/openai.yaml +4 -0
  22. package/dist/claude/skills/joktec-database-extended-skill/references/extended-databases.md +11 -0
  23. package/dist/claude/skills/joktec-framework-skill/SKILL.md +31 -0
  24. package/dist/claude/skills/joktec-framework-skill/agents/openai.yaml +4 -0
  25. package/dist/claude/skills/joktec-framework-skill/references/framework-map.md +25 -0
  26. package/dist/claude/skills/joktec-integration-skill/SKILL.md +24 -0
  27. package/dist/claude/skills/joktec-integration-skill/agents/openai.yaml +4 -0
  28. package/dist/claude/skills/joktec-integration-skill/references/integrations.md +9 -0
  29. package/dist/claude/skills/joktec-mongo-skill/SKILL.md +22 -0
  30. package/dist/claude/skills/joktec-mongo-skill/agents/openai.yaml +4 -0
  31. package/dist/claude/skills/joktec-mongo-skill/references/repository.md +20 -0
  32. package/dist/claude/skills/joktec-mongo-skill/references/schema-and-plugins.md +17 -0
  33. package/dist/claude/skills/joktec-mysql-skill/SKILL.md +22 -0
  34. package/dist/claude/skills/joktec-mysql-skill/agents/openai.yaml +4 -0
  35. package/dist/claude/skills/joktec-mysql-skill/references/entities.md +15 -0
  36. package/dist/claude/skills/joktec-mysql-skill/references/repository.md +23 -0
  37. package/dist/claude/skills/joktec-tool-skill/SKILL.md +25 -0
  38. package/dist/claude/skills/joktec-tool-skill/agents/openai.yaml +4 -0
  39. package/dist/claude/skills/joktec-tool-skill/references/tools.md +13 -0
  40. package/dist/codex/skills/joktec-adapter-skill/SKILL.md +26 -0
  41. package/dist/codex/skills/joktec-adapter-skill/agents/openai.yaml +4 -0
  42. package/dist/codex/skills/joktec-adapter-skill/references/adapters.md +12 -0
  43. package/dist/codex/skills/joktec-broker-skill/SKILL.md +26 -0
  44. package/dist/codex/skills/joktec-broker-skill/agents/openai.yaml +4 -0
  45. package/dist/codex/skills/joktec-broker-skill/references/brokers.md +12 -0
  46. package/dist/codex/skills/joktec-common-skill/SKILL.md +28 -0
  47. package/dist/codex/skills/joktec-common-skill/agents/openai.yaml +4 -0
  48. package/dist/codex/skills/joktec-common-skill/references/core.md +19 -0
  49. package/dist/codex/skills/joktec-common-skill/references/utils-cron.md +17 -0
  50. package/dist/codex/skills/joktec-database-extended-skill/SKILL.md +25 -0
  51. package/dist/codex/skills/joktec-database-extended-skill/agents/openai.yaml +4 -0
  52. package/dist/codex/skills/joktec-database-extended-skill/references/extended-databases.md +11 -0
  53. package/dist/codex/skills/joktec-framework-skill/SKILL.md +31 -0
  54. package/dist/codex/skills/joktec-framework-skill/agents/openai.yaml +4 -0
  55. package/dist/codex/skills/joktec-framework-skill/references/framework-map.md +25 -0
  56. package/dist/codex/skills/joktec-integration-skill/SKILL.md +24 -0
  57. package/dist/codex/skills/joktec-integration-skill/agents/openai.yaml +4 -0
  58. package/dist/codex/skills/joktec-integration-skill/references/integrations.md +9 -0
  59. package/dist/codex/skills/joktec-mongo-skill/SKILL.md +22 -0
  60. package/dist/codex/skills/joktec-mongo-skill/agents/openai.yaml +4 -0
  61. package/dist/codex/skills/joktec-mongo-skill/references/repository.md +20 -0
  62. package/dist/codex/skills/joktec-mongo-skill/references/schema-and-plugins.md +17 -0
  63. package/dist/codex/skills/joktec-mysql-skill/SKILL.md +22 -0
  64. package/dist/codex/skills/joktec-mysql-skill/agents/openai.yaml +4 -0
  65. package/dist/codex/skills/joktec-mysql-skill/references/entities.md +15 -0
  66. package/dist/codex/skills/joktec-mysql-skill/references/repository.md +23 -0
  67. package/dist/codex/skills/joktec-tool-skill/SKILL.md +25 -0
  68. package/dist/codex/skills/joktec-tool-skill/agents/openai.yaml +4 -0
  69. package/dist/codex/skills/joktec-tool-skill/references/tools.md +13 -0
  70. package/dist/copilot/.github/copilot-instructions.md +459 -0
  71. package/dist/cursor/.cursor/rules/joktec-adapter-skill.mdc +44 -0
  72. package/dist/cursor/.cursor/rules/joktec-broker-skill.mdc +44 -0
  73. package/dist/cursor/.cursor/rules/joktec-common-skill.mdc +73 -0
  74. package/dist/cursor/.cursor/rules/joktec-database-extended-skill.mdc +42 -0
  75. package/dist/cursor/.cursor/rules/joktec-framework-skill.mdc +62 -0
  76. package/dist/cursor/.cursor/rules/joktec-integration-skill.mdc +39 -0
  77. package/dist/cursor/.cursor/rules/joktec-mongo-skill.mdc +68 -0
  78. package/dist/cursor/.cursor/rules/joktec-mysql-skill.mdc +69 -0
  79. package/dist/cursor/.cursor/rules/joktec-tool-skill.mdc +44 -0
  80. package/dist/gemini/GEMINI.md +477 -0
  81. package/dist/windsurf/.windsurf/rules/joktec-adapter-skill.md +40 -0
  82. package/dist/windsurf/.windsurf/rules/joktec-broker-skill.md +40 -0
  83. package/dist/windsurf/.windsurf/rules/joktec-common-skill.md +69 -0
  84. package/dist/windsurf/.windsurf/rules/joktec-database-extended-skill.md +38 -0
  85. package/dist/windsurf/.windsurf/rules/joktec-framework-skill.md +58 -0
  86. package/dist/windsurf/.windsurf/rules/joktec-integration-skill.md +35 -0
  87. package/dist/windsurf/.windsurf/rules/joktec-mongo-skill.md +64 -0
  88. package/dist/windsurf/.windsurf/rules/joktec-mysql-skill.md +65 -0
  89. package/dist/windsurf/.windsurf/rules/joktec-tool-skill.md +40 -0
  90. package/package.json +69 -0
  91. package/scripts/build-copilot-instructions.mjs +22 -0
  92. package/scripts/build-cursor-rules.mjs +23 -0
  93. package/scripts/build-gemini-md.mjs +22 -0
  94. package/scripts/build-skill-folders.mjs +16 -0
  95. package/scripts/build-windsurf-rules.mjs +18 -0
  96. package/scripts/lib.mjs +110 -0
  97. package/scripts/sync-from-joktec-framework.mjs +53 -0
  98. package/scripts/validate-skills.mjs +78 -0
  99. package/skill-pack.json +146 -0
  100. package/skills/joktec-adapter-skill/SKILL.md +26 -0
  101. package/skills/joktec-adapter-skill/agents/openai.yaml +4 -0
  102. package/skills/joktec-adapter-skill/references/adapters.md +12 -0
  103. package/skills/joktec-broker-skill/SKILL.md +26 -0
  104. package/skills/joktec-broker-skill/agents/openai.yaml +4 -0
  105. package/skills/joktec-broker-skill/references/brokers.md +12 -0
  106. package/skills/joktec-common-skill/SKILL.md +28 -0
  107. package/skills/joktec-common-skill/agents/openai.yaml +4 -0
  108. package/skills/joktec-common-skill/references/core.md +19 -0
  109. package/skills/joktec-common-skill/references/utils-cron.md +17 -0
  110. package/skills/joktec-database-extended-skill/SKILL.md +25 -0
  111. package/skills/joktec-database-extended-skill/agents/openai.yaml +4 -0
  112. package/skills/joktec-database-extended-skill/references/extended-databases.md +11 -0
  113. package/skills/joktec-framework-skill/SKILL.md +31 -0
  114. package/skills/joktec-framework-skill/agents/openai.yaml +4 -0
  115. package/skills/joktec-framework-skill/references/framework-map.md +25 -0
  116. package/skills/joktec-integration-skill/SKILL.md +24 -0
  117. package/skills/joktec-integration-skill/agents/openai.yaml +4 -0
  118. package/skills/joktec-integration-skill/references/integrations.md +9 -0
  119. package/skills/joktec-mongo-skill/SKILL.md +22 -0
  120. package/skills/joktec-mongo-skill/agents/openai.yaml +4 -0
  121. package/skills/joktec-mongo-skill/references/repository.md +20 -0
  122. package/skills/joktec-mongo-skill/references/schema-and-plugins.md +17 -0
  123. package/skills/joktec-mysql-skill/SKILL.md +22 -0
  124. package/skills/joktec-mysql-skill/agents/openai.yaml +4 -0
  125. package/skills/joktec-mysql-skill/references/entities.md +15 -0
  126. package/skills/joktec-mysql-skill/references/repository.md +23 -0
  127. package/skills/joktec-tool-skill/SKILL.md +25 -0
  128. package/skills/joktec-tool-skill/agents/openai.yaml +4 -0
  129. package/skills/joktec-tool-skill/references/tools.md +13 -0
@@ -0,0 +1,477 @@
1
+ # @joktec/skills
2
+
3
+ Use these instructions when working in a project that consumes JokTec packages.
4
+
5
+ ## JokTec Framework Skill
6
+
7
+ Packages: @joktec/*
8
+
9
+ Start here when a task mentions JokTec generally, multiple `@joktec/*` packages, or a consumer app that needs framework wiring.
10
+
11
+ ## Select The Focused Skill
12
+
13
+ - For `@joktec/core`, `@joktec/utils`, or `@joktec/cron`, use `joktec-common-skill`.
14
+ - For `@joktec/mongo`, use `joktec-mongo-skill`.
15
+ - For `@joktec/mysql`, use `joktec-mysql-skill`.
16
+ - For Kafka, RabbitMQ, SQS, or Redcast, use `joktec-broker-skill`.
17
+ - For cache, mail, notification, or storage adapters, use `joktec-adapter-skill`.
18
+ - For Elastic, Arango, or BigQuery, use `joktec-database-extended-skill`.
19
+ - For Firebase or GPT integrations, use `joktec-integration-skill`.
20
+ - For HTTP, file, or alert utilities, use `joktec-tool-skill`.
21
+
22
+ ## Core Rules
23
+
24
+ - Treat `joktec-framework` code, package README files, and agent docs as source-of-truth.
25
+ - Keep consumer app business logic in the app; do not move it into `@joktec/*` packages.
26
+ - Prefer config-driven module setup and `conId` when a package supports multiple clients.
27
+ - Preserve NestJS module boundaries, dependency injection, lifecycle hooks, and exported package APIs.
28
+ - Do not invent behavior for unfinished or missing packages.
29
+
30
+ ## Reference
31
+
32
+ Read `references/framework-map.md` when the task needs package selection, dependency flow, or a quick map from requirement to package.
33
+
34
+ ## Bundled References
35
+
36
+ ### references/framework-map.md
37
+
38
+ # JokTec Framework Map
39
+
40
+ ## Package Families
41
+
42
+ - `@joktec/core`: bootstrap, config, logger, metrics, guards, base abstractions, transports, pagination, Bull.
43
+ - `@joktec/utils`: low-level helpers, validators, conversion utilities.
44
+ - `@joktec/cron`: cron decorators, schedulers, job workers.
45
+ - `@joktec/mongo`: Mongoose/Typegoose database adapter and repository.
46
+ - `@joktec/mysql`: TypeORM relational adapter and repository.
47
+ - `@joktec/kafka`, `@joktec/rabbit`, `@joktec/sqs`, `@joktec/redcast`: broker clients and decorators.
48
+ - `@joktec/cacher`, `@joktec/mailer`, `@joktec/notifier`, `@joktec/storage`: external capability adapters.
49
+ - `@joktec/elastic`, `@joktec/arango`, `@joktec/bigquery`: extended database clients.
50
+ - `@joktec/firebase`, `@joktec/gpt`: third-party integrations.
51
+ - `@joktec/http`, `@joktec/file`, `@joktec/alert`: reusable tools.
52
+
53
+ ## Dependency Direction
54
+
55
+ Consumer apps depend on concrete `@joktec/*` packages. Concrete packages usually depend on `@joktec/core` and `@joktec/utils`. Keep app-specific schemas, handlers, and business semantics outside reusable packages.
56
+
57
+ ## Common Consumer App Pattern
58
+
59
+ 1. Register package modules in the app module or repository module.
60
+ 2. Keep app schemas/entities and app repositories in the consumer app.
61
+ 3. Extend the package repository base class when the package provides one.
62
+ 4. Use `BaseService`, `BaseController`, or transport helpers from `@joktec/core` when the app follows standard CRUD or message patterns.
63
+
64
+ ---
65
+
66
+ ## JokTec Common Skill
67
+
68
+ Packages: @joktec/core, @joktec/utils, @joktec/cron, @joktec/types
69
+
70
+ Use this skill for shared framework primitives, low-level helpers, cron utilities, and config schema type support.
71
+
72
+ ## Packages
73
+
74
+ - `@joktec/core`: NestJS bootstrap, modules, config, logger, metrics, base abstractions, transports, pagination, Bull.
75
+ - `@joktec/utils`: conversion helpers, UUID/OTP/hash generators, validators, common constants.
76
+ - `@joktec/cron`: cron decorators, schedulers, workers, and job contracts.
77
+ - `@joktec/types`: generated config schema/type support for the JokTec package set.
78
+
79
+ ## Rules
80
+
81
+ - Keep `@joktec/core` app-neutral; do not import adapters, brokers, databases, integrations, or consumer app code into core concepts.
82
+ - Use `BaseController` and `BaseService` for standard CRUD flows before hand-writing repetitive controllers.
83
+ - Use page, offset, or cursor pagination contracts from core; let database packages execute storage-specific pagination.
84
+ - Use `AbstractClientService` patterns for client packages that need config, lifecycle, retry, and `conId`.
85
+ - Use `@joktec/utils` for shared helpers instead of duplicating conversion, validation, hashing, or UUID logic.
86
+
87
+ ## References
88
+
89
+ - Read `references/core.md` for bootstrap, CRUD, pagination, and client lifecycle.
90
+ - Read `references/utils-cron.md` for utility helpers and cron usage.
91
+
92
+ ## Bundled References
93
+
94
+ ### references/core.md
95
+
96
+ # Common Core Usage
97
+
98
+ ## Runtime Bootstrap
99
+
100
+ Use the application bootstrap helpers from `@joktec/core` for gateway and microservice runtimes. Keep runtime behavior config-driven.
101
+
102
+ ## CRUD Abstractions
103
+
104
+ - `BaseController` creates standard REST CRUD endpoints for DTO-backed resources.
105
+ - `BaseService` delegates repository operations through the shared repository contract.
106
+ - `ClientController` and `ClientService` provide generated microservice CRUD patterns.
107
+
108
+ ## Pagination
109
+
110
+ Request priority is cursor, then offset, then page. `BaseController.paginationMode` affects Swagger response shape; runtime selection remains request-driven unless the app service narrows it.
111
+
112
+ ## Client Lifecycle
113
+
114
+ Use `ClientConfig`, `AbstractClientService`, and `conId` when building or consuming packages that support multiple client connections.
115
+
116
+ ### references/utils-cron.md
117
+
118
+ # Utils And Cron Usage
119
+
120
+ ## Utils
121
+
122
+ Use `@joktec/utils` for common generators, validators, converters, hashing helpers, constants, and class-validator/class-transformer exports.
123
+
124
+ Prefer package helpers over app-local reimplementation when behavior should stay consistent across services.
125
+
126
+ ## Cron
127
+
128
+ Use `@joktec/cron` when a consumer app needs scheduled jobs, job worker contracts, or decorator-driven cron registration.
129
+
130
+ Keep job business logic in the consumer app. The package provides scheduling abstractions, not domain behavior.
131
+
132
+ ## Types
133
+
134
+ Use `@joktec/types` when a consumer workflow needs generated JokTec package config schema/type artifacts. Treat the framework repository as source-of-truth for the generated schema shape.
135
+
136
+ ---
137
+
138
+ ## JokTec Mongo Skill
139
+
140
+ Packages: @joktec/mongo
141
+
142
+ Use this skill for MongoDB-backed resources that rely on JokTec's Mongoose/Typegoose wrapper.
143
+
144
+ ## Rules
145
+
146
+ - Register app schema classes through `MongoModule.forRoot(...)`.
147
+ - Keep schema classes, app repositories, and app-specific queries in the consumer app.
148
+ - Extend `MongoRepo<T, ID>` for app repositories.
149
+ - Preserve `conId` when the app has multiple Mongo connections.
150
+ - Use schema-first decorators when a schema class should be reused as a DTO source.
151
+ - Treat ObjectId casting and regex behavior as safety-sensitive.
152
+
153
+ ## References
154
+
155
+ - Read `references/repository.md` for `MongoService`, `MongoRepo`, query parsing, and cursor pagination.
156
+ - Read `references/schema-and-plugins.md` for decorators, paranoid soft delete, strict references, transform behavior, and debug output.
157
+
158
+ ## Bundled References
159
+
160
+ ### references/repository.md
161
+
162
+ # Mongo Repository Usage
163
+
164
+ ## Module Setup
165
+
166
+ Register schemas with `MongoModule.forRoot({ conId, models: [...] })`. Use the same `conId` in app repositories when using non-default connections.
167
+
168
+ ## Repository Pattern
169
+
170
+ Extend `MongoRepo` and pass the schema class to the base constructor. Services can then use `BaseService` from `@joktec/core`.
171
+
172
+ ## Query Safety
173
+
174
+ - Root `id` can act as an API alias for `_id` in query conditions.
175
+ - ObjectId casting should be schema-aware and limited to `_id`, ObjectId paths, or explicitly configured paths.
176
+ - `$like`, `$begin`, and `$end` escape regex input by default.
177
+ - Do not rely on broad conversion when storing raw snapshots, maps, or nested subdocuments.
178
+
179
+ ## Pagination
180
+
181
+ `MongoRepo.paginate` supports page, offset, and cursor responses. Cursor mode defaults to `_id`; custom `cursorKey` appends `_id` as a tie-breaker.
182
+
183
+ ### references/schema-and-plugins.md
184
+
185
+ # Mongo Schema And Plugins
186
+
187
+ ## Schema Decorators
188
+
189
+ Use `@Schema` and `@Prop` wrappers from `@joktec/mongo` for Typegoose schema metadata plus validation, transform, and Swagger metadata.
190
+
191
+ Avoid mutating shared option objects across multiple properties.
192
+
193
+ ## Plugins
194
+
195
+ - Paranoid plugin handles soft delete filtering and must respect aggregate first-stage constraints such as `$geoNear`.
196
+ - Strict reference plugin validates referenced documents and must resolve models through the active connection.
197
+ - Transform plugin centralizes common document transformation and should not break Mongo update operators.
198
+
199
+ ## Debug Output
200
+
201
+ Use `mongoDebug(collection, method, ...args)` when a Mongoose debug callback should be rendered as a Mongo shell-friendly command.
202
+
203
+ ---
204
+
205
+ ## JokTec MySQL Skill
206
+
207
+ Packages: @joktec/mysql
208
+
209
+ Use this skill for relational resources backed by JokTec's TypeORM wrapper.
210
+
211
+ ## Rules
212
+
213
+ - Register app entities through `MysqlModule.forRoot(...)`.
214
+ - Keep entities, app repositories, and app-specific SQL in the consumer app.
215
+ - Extend `MysqlRepo<T, ID>` for app repositories.
216
+ - Treat `mysql`, `mariadb`, and `postgres` as the first-class dialects.
217
+ - Keep `sync` explicit and normally enabled only by an owner process or development bootstrap.
218
+ - Do not add new behavior to deprecated `MysqlFinder`; use `MysqlRepo.qb()` and `MysqlHelper` paths.
219
+
220
+ ## References
221
+
222
+ - Read `references/repository.md` for connection lifecycle, repository usage, query safety, transaction, and cursor behavior.
223
+ - Read `references/entities.md` for `@Tables`, `@Column`, `@PrimaryColumn`, uuidv7, and dialect guidance.
224
+
225
+ ## Bundled References
226
+
227
+ ### references/entities.md
228
+
229
+ # MySQL Entity Decorators
230
+
231
+ ## Schema-First Entity Pattern
232
+
233
+ Use `@Tables`, `@Column`, and `@PrimaryColumn` from `@joktec/mysql` when an entity should also act as the source class for mapped DTOs.
234
+
235
+ ## Primary Keys
236
+
237
+ - Prefer numeric auto-increment keys for write-heavy MySQL tables.
238
+ - Use UUIDs when the app needs globally unique or public identifiers.
239
+ - Prefer `uuidv7` over random UUIDs when the id participates in ordered indexes or cursor-like access.
240
+
241
+ ## Dialects
242
+
243
+ The stable dialects are MySQL, MariaDB, and Postgres. Dialect capabilities own differences such as `LIKE` vs `ILIKE`, array support, fulltext support, and generated map reliability.
244
+
245
+ ### references/repository.md
246
+
247
+ # MySQL Repository Usage
248
+
249
+ ## Module Setup
250
+
251
+ Register entities with `MysqlModule.forRoot({ conId, models: [...] })`. Use `conId` for multiple DataSources.
252
+
253
+ ## Repository Pattern
254
+
255
+ Extend `MysqlRepo` and pass the entity class to the base constructor. Services can use `BaseService` when CRUD behavior follows the shared contract.
256
+
257
+ ## Query Safety
258
+
259
+ - Validate field paths against TypeORM metadata before interpolating SQL identifiers.
260
+ - Use parameter binding for values.
261
+ - Keep logical operators such as `$and` and `$or` grouped through QueryBuilder behavior.
262
+
263
+ ## Pagination
264
+
265
+ `MysqlRepo.paginate` supports page, offset, and cursor responses. Cursor mode defaults to `createdAt` plus primary key columns. Custom cursor keys must be mapped columns.
266
+
267
+ ## Transactions
268
+
269
+ When using transaction-scoped operations, pass the manager or query runner through repository options so pre-read and write operations use the same context.
270
+
271
+ ---
272
+
273
+ ## JokTec Broker Skill
274
+
275
+ Packages: @joktec/kafka, @joktec/rabbit, @joktec/sqs, @joktec/redcast
276
+
277
+ Use this skill for message broker packages.
278
+
279
+ ## Packages
280
+
281
+ - `@joktec/kafka`: Kafka client, decorators, loaders, metrics.
282
+ - `@joktec/rabbit`: RabbitMQ client, decorators, auto-binding, metrics.
283
+ - `@joktec/sqs`: AWS SQS/SNS queue and topic wrapper.
284
+ - `@joktec/redcast`: Redis-backed broker behavior.
285
+
286
+ ## Rules
287
+
288
+ - Keep message business semantics in the consumer app.
289
+ - Use broker decorators for transport wiring, not for domain policy.
290
+ - Preserve config-driven client selection and `conId` when available.
291
+ - Keep topic, queue, and routing names explicit in app configuration or decorators.
292
+
293
+ ## Reference
294
+
295
+ Read `references/brokers.md` for setup and package-specific notes.
296
+
297
+ ## Bundled References
298
+
299
+ ### references/brokers.md
300
+
301
+ # Broker Usage
302
+
303
+ ## Runtime Pattern
304
+
305
+ Broker services follow `AbstractClientService` lifecycle. Loader classes discover decorator metadata after module initialization. Apps define producers, consumers, and message semantics.
306
+
307
+ ## Package Notes
308
+
309
+ - Kafka: check topic existence and broker advertised listeners in local development.
310
+ - RabbitMQ: use module options and decorators for exchanges, queues, and bindings.
311
+ - SQS: local ElasticMQ-style environments may require queues to exist before consumers start.
312
+ - Redcast: use Redis-backed list, stream, or pub/sub behavior when a lightweight broker is enough.
313
+
314
+ ---
315
+
316
+ ## JokTec Adapter Skill
317
+
318
+ Packages: @joktec/cacher, @joktec/mailer, @joktec/notifier, @joktec/storage
319
+
320
+ Use this skill for pluggable external capability adapters.
321
+
322
+ ## Packages
323
+
324
+ - `@joktec/cacher`: cache stores.
325
+ - `@joktec/mailer`: mail delivery.
326
+ - `@joktec/notifier`: push notifications.
327
+ - `@joktec/storage`: object storage and file metadata helpers.
328
+
329
+ ## Rules
330
+
331
+ - Keep adapter services app-neutral.
332
+ - Use validated config and `conId` where supported.
333
+ - Keep secrets and credentials in app config or runtime environment, never in code.
334
+ - Prefer adapter services over direct SDK usage in app services.
335
+
336
+ ## Reference
337
+
338
+ Read `references/adapters.md` for setup and package-specific notes.
339
+
340
+ ## Bundled References
341
+
342
+ ### references/adapters.md
343
+
344
+ # Adapter Usage
345
+
346
+ ## Runtime Pattern
347
+
348
+ Adapters are global Nest modules. Services own native client creation and expose package-specific operations.
349
+
350
+ ## Package Notes
351
+
352
+ - Cacher: choose local, Redis, or Memcached stores based on runtime config.
353
+ - Mailer: centralize mail transport configuration in the service that owns outbound email.
354
+ - Notifier: keep push provider configuration outside app business logic.
355
+ - Storage: keep storage metadata and object operations behind the adapter service.
356
+
357
+ ---
358
+
359
+ ## JokTec Extended Database Skill
360
+
361
+ Packages: @joktec/elastic, @joktec/arango, @joktec/bigquery
362
+
363
+ Use this skill for database clients that are not Mongo or MySQL.
364
+
365
+ ## Packages
366
+
367
+ - `@joktec/elastic`
368
+ - `@joktec/arango`
369
+ - `@joktec/bigquery`
370
+
371
+ ## Rules
372
+
373
+ - Keep app-specific query semantics in the consumer app.
374
+ - Use package services for client lifecycle and connection config.
375
+ - Do not claim parity with Mongo/MySQL repository behavior unless the package implements it.
376
+ - Use package README and source as final truth before adding advanced behavior.
377
+
378
+ ## Reference
379
+
380
+ Read `references/extended-databases.md` for package boundaries and usage notes.
381
+
382
+ ## Bundled References
383
+
384
+ ### references/extended-databases.md
385
+
386
+ # Extended Database Usage
387
+
388
+ ## Package Boundaries
389
+
390
+ Extended database packages expose reusable clients and helpers for specific data systems. They should not contain consumer app schemas or business-specific query policy.
391
+
392
+ ## Notes
393
+
394
+ - Elastic may depend on `@joktec/http` for HTTP-backed behavior.
395
+ - Arango and BigQuery are separate client packages; verify the README/source before assuming repository-like CRUD support.
396
+ - Use local package tests or consumer harnesses only when the target service stack is available.
397
+
398
+ ---
399
+
400
+ ## JokTec Integration Skill
401
+
402
+ Packages: @joktec/firebase, @joktec/gpt
403
+
404
+ Use this skill for third-party integration packages.
405
+
406
+ ## Packages
407
+
408
+ - `@joktec/firebase`: Firebase Admin SDK integration.
409
+ - `@joktec/gpt`: GPT/OpenAI-style client integration.
410
+
411
+ ## Rules
412
+
413
+ - Keep credentials config-driven and never commit real credentials.
414
+ - Use package services instead of direct SDK initialization in app code.
415
+ - Preserve app-neutral service behavior; consumer apps own domain workflows.
416
+ - Verify current package README/source before relying on advanced provider features.
417
+
418
+ ## Reference
419
+
420
+ Read `references/integrations.md` for provider-specific notes.
421
+
422
+ ## Bundled References
423
+
424
+ ### references/integrations.md
425
+
426
+ # Integration Usage
427
+
428
+ ## Firebase
429
+
430
+ Use the integration module and service to initialize Firebase Admin clients from validated config. Keep credential files local or environment-provided.
431
+
432
+ ## GPT
433
+
434
+ Use the integration package for reusable GPT client setup. Keep prompt/business policy in the consumer app, not in the generic package.
435
+
436
+ ---
437
+
438
+ ## JokTec Tool Skill
439
+
440
+ Packages: @joktec/http, @joktec/file, @joktec/alert
441
+
442
+ Use this skill for reusable utility services.
443
+
444
+ ## Packages
445
+
446
+ - `@joktec/http`: Axios-backed HTTP client wrapper.
447
+ - `@joktec/file`: file classification and local file helpers.
448
+ - `@joktec/alert`: alert delivery through Slack-compatible webhooks.
449
+
450
+ ## Rules
451
+
452
+ - Keep tools app-neutral and reusable.
453
+ - Use config-driven clients instead of direct ad hoc setup in app code.
454
+ - Preserve retry, metrics, proxy, and upload behavior where the package exposes it.
455
+ - Keep alert tokens and webhook URLs in runtime config only.
456
+
457
+ ## Reference
458
+
459
+ Read `references/tools.md` for package-specific usage notes.
460
+
461
+ ## Bundled References
462
+
463
+ ### references/tools.md
464
+
465
+ # Tool Usage
466
+
467
+ ## HTTP
468
+
469
+ Use `@joktec/http` for Axios-backed requests, uploads, proxy agent support, retry config, and metrics where exposed.
470
+
471
+ ## File
472
+
473
+ Use `@joktec/file` for shared file helpers and classification behavior instead of duplicating local utility code.
474
+
475
+ ## Alert
476
+
477
+ Use `@joktec/alert` for Slack-compatible webhook alerts. Keep webhook URLs and credentials out of source control.
@@ -0,0 +1,40 @@
1
+ # JokTec Adapter Skill
2
+
3
+ Use when wiring or using JokTec adapter packages @joktec/cacher, @joktec/mailer, @joktec/notifier, or @joktec/storage for cache, mail delivery, push notifications, object storage, config-driven clients, and app-neutral adapter services.
4
+
5
+ Use this skill for pluggable external capability adapters.
6
+
7
+ ## Packages
8
+
9
+ - `@joktec/cacher`: cache stores.
10
+ - `@joktec/mailer`: mail delivery.
11
+ - `@joktec/notifier`: push notifications.
12
+ - `@joktec/storage`: object storage and file metadata helpers.
13
+
14
+ ## Rules
15
+
16
+ - Keep adapter services app-neutral.
17
+ - Use validated config and `conId` where supported.
18
+ - Keep secrets and credentials in app config or runtime environment, never in code.
19
+ - Prefer adapter services over direct SDK usage in app services.
20
+
21
+ ## Reference
22
+
23
+ Read `references/adapters.md` for setup and package-specific notes.
24
+
25
+ ## Bundled References
26
+
27
+ ### references/adapters.md
28
+
29
+ # Adapter Usage
30
+
31
+ ## Runtime Pattern
32
+
33
+ Adapters are global Nest modules. Services own native client creation and expose package-specific operations.
34
+
35
+ ## Package Notes
36
+
37
+ - Cacher: choose local, Redis, or Memcached stores based on runtime config.
38
+ - Mailer: centralize mail transport configuration in the service that owns outbound email.
39
+ - Notifier: keep push provider configuration outside app business logic.
40
+ - Storage: keep storage metadata and object operations behind the adapter service.
@@ -0,0 +1,40 @@
1
+ # JokTec Broker Skill
2
+
3
+ Use when wiring or using JokTec broker packages @joktec/kafka, @joktec/rabbit, @joktec/sqs, or @joktec/redcast, including client config, producer decorators, consumer loaders, message handlers, auto-binding, and app-level broker flows.
4
+
5
+ Use this skill for message broker packages.
6
+
7
+ ## Packages
8
+
9
+ - `@joktec/kafka`: Kafka client, decorators, loaders, metrics.
10
+ - `@joktec/rabbit`: RabbitMQ client, decorators, auto-binding, metrics.
11
+ - `@joktec/sqs`: AWS SQS/SNS queue and topic wrapper.
12
+ - `@joktec/redcast`: Redis-backed broker behavior.
13
+
14
+ ## Rules
15
+
16
+ - Keep message business semantics in the consumer app.
17
+ - Use broker decorators for transport wiring, not for domain policy.
18
+ - Preserve config-driven client selection and `conId` when available.
19
+ - Keep topic, queue, and routing names explicit in app configuration or decorators.
20
+
21
+ ## Reference
22
+
23
+ Read `references/brokers.md` for setup and package-specific notes.
24
+
25
+ ## Bundled References
26
+
27
+ ### references/brokers.md
28
+
29
+ # Broker Usage
30
+
31
+ ## Runtime Pattern
32
+
33
+ Broker services follow `AbstractClientService` lifecycle. Loader classes discover decorator metadata after module initialization. Apps define producers, consumers, and message semantics.
34
+
35
+ ## Package Notes
36
+
37
+ - Kafka: check topic existence and broker advertised listeners in local development.
38
+ - RabbitMQ: use module options and decorators for exchanges, queues, and bindings.
39
+ - SQS: local ElasticMQ-style environments may require queues to exist before consumers start.
40
+ - Redcast: use Redis-backed list, stream, or pub/sub behavior when a lightweight broker is enough.
@@ -0,0 +1,69 @@
1
+ # JokTec Common Skill
2
+
3
+ Use when implementing or wiring @joktec/core, @joktec/utils, or @joktec/cron in a consumer app, especially BaseController, BaseService, pagination, config, client lifecycle, bootstrap, cron decorators, or utility helpers.
4
+
5
+ Use this skill for shared framework primitives, low-level helpers, cron utilities, and config schema type support.
6
+
7
+ ## Packages
8
+
9
+ - `@joktec/core`: NestJS bootstrap, modules, config, logger, metrics, base abstractions, transports, pagination, Bull.
10
+ - `@joktec/utils`: conversion helpers, UUID/OTP/hash generators, validators, common constants.
11
+ - `@joktec/cron`: cron decorators, schedulers, workers, and job contracts.
12
+ - `@joktec/types`: generated config schema/type support for the JokTec package set.
13
+
14
+ ## Rules
15
+
16
+ - Keep `@joktec/core` app-neutral; do not import adapters, brokers, databases, integrations, or consumer app code into core concepts.
17
+ - Use `BaseController` and `BaseService` for standard CRUD flows before hand-writing repetitive controllers.
18
+ - Use page, offset, or cursor pagination contracts from core; let database packages execute storage-specific pagination.
19
+ - Use `AbstractClientService` patterns for client packages that need config, lifecycle, retry, and `conId`.
20
+ - Use `@joktec/utils` for shared helpers instead of duplicating conversion, validation, hashing, or UUID logic.
21
+
22
+ ## References
23
+
24
+ - Read `references/core.md` for bootstrap, CRUD, pagination, and client lifecycle.
25
+ - Read `references/utils-cron.md` for utility helpers and cron usage.
26
+
27
+ ## Bundled References
28
+
29
+ ### references/core.md
30
+
31
+ # Common Core Usage
32
+
33
+ ## Runtime Bootstrap
34
+
35
+ Use the application bootstrap helpers from `@joktec/core` for gateway and microservice runtimes. Keep runtime behavior config-driven.
36
+
37
+ ## CRUD Abstractions
38
+
39
+ - `BaseController` creates standard REST CRUD endpoints for DTO-backed resources.
40
+ - `BaseService` delegates repository operations through the shared repository contract.
41
+ - `ClientController` and `ClientService` provide generated microservice CRUD patterns.
42
+
43
+ ## Pagination
44
+
45
+ Request priority is cursor, then offset, then page. `BaseController.paginationMode` affects Swagger response shape; runtime selection remains request-driven unless the app service narrows it.
46
+
47
+ ## Client Lifecycle
48
+
49
+ Use `ClientConfig`, `AbstractClientService`, and `conId` when building or consuming packages that support multiple client connections.
50
+
51
+ ### references/utils-cron.md
52
+
53
+ # Utils And Cron Usage
54
+
55
+ ## Utils
56
+
57
+ Use `@joktec/utils` for common generators, validators, converters, hashing helpers, constants, and class-validator/class-transformer exports.
58
+
59
+ Prefer package helpers over app-local reimplementation when behavior should stay consistent across services.
60
+
61
+ ## Cron
62
+
63
+ Use `@joktec/cron` when a consumer app needs scheduled jobs, job worker contracts, or decorator-driven cron registration.
64
+
65
+ Keep job business logic in the consumer app. The package provides scheduling abstractions, not domain behavior.
66
+
67
+ ## Types
68
+
69
+ Use `@joktec/types` when a consumer workflow needs generated JokTec package config schema/type artifacts. Treat the framework repository as source-of-truth for the generated schema shape.
@@ -0,0 +1,38 @@
1
+ # JokTec Extended Database Skill
2
+
3
+ Use when working with extended JokTec database packages @joktec/elastic, @joktec/arango, or @joktec/bigquery in a consumer app, including app-neutral client setup, config-driven lifecycle, and package-specific query/service usage.
4
+
5
+ Use this skill for database clients that are not Mongo or MySQL.
6
+
7
+ ## Packages
8
+
9
+ - `@joktec/elastic`
10
+ - `@joktec/arango`
11
+ - `@joktec/bigquery`
12
+
13
+ ## Rules
14
+
15
+ - Keep app-specific query semantics in the consumer app.
16
+ - Use package services for client lifecycle and connection config.
17
+ - Do not claim parity with Mongo/MySQL repository behavior unless the package implements it.
18
+ - Use package README and source as final truth before adding advanced behavior.
19
+
20
+ ## Reference
21
+
22
+ Read `references/extended-databases.md` for package boundaries and usage notes.
23
+
24
+ ## Bundled References
25
+
26
+ ### references/extended-databases.md
27
+
28
+ # Extended Database Usage
29
+
30
+ ## Package Boundaries
31
+
32
+ Extended database packages expose reusable clients and helpers for specific data systems. They should not contain consumer app schemas or business-specific query policy.
33
+
34
+ ## Notes
35
+
36
+ - Elastic may depend on `@joktec/http` for HTTP-backed behavior.
37
+ - Arango and BigQuery are separate client packages; verify the README/source before assuming repository-like CRUD support.
38
+ - Use local package tests or consumer harnesses only when the target service stack is available.