@iqai/adk 0.0.1 → 0.0.2
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/CHANGELOG.md +7 -0
- package/package.json +10 -2
- package/.changeset/README.md +0 -8
- package/.changeset/config.json +0 -11
- package/.cursor/rules/aim.mdc +0 -31
- package/.cursor/rules/naming-conventions.mdc +0 -42
- package/.cursor/rules/no-comments.mdc +0 -39
- package/.cursor/rules/paths.mdc +0 -6
- package/biome.json +0 -47
- package/tsup.config.ts +0 -11
- package/typedoc.json +0 -26
package/CHANGELOG.md
ADDED
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@iqai/adk",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "Agent Development Kit for TypeScript with multi-provider LLM support",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
|
-
"types": "dist/index.d.
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
9
|
"url": "https://github.com/IQAIcom/adk-ts.git"
|
|
@@ -53,6 +53,14 @@
|
|
|
53
53
|
"engines": {
|
|
54
54
|
"node": ">=22.0"
|
|
55
55
|
},
|
|
56
|
+
"files": [
|
|
57
|
+
"dist",
|
|
58
|
+
"!**/*.test.*",
|
|
59
|
+
"!**/*.json",
|
|
60
|
+
"CHANGELOG.md",
|
|
61
|
+
"LICENSE",
|
|
62
|
+
"README.md"
|
|
63
|
+
],
|
|
56
64
|
"lint-staged": {
|
|
57
65
|
"*.{js,ts,cjs,mjs,d.cts,d.mts,jsx,tsx,json,jsonc}": [
|
|
58
66
|
"biome check --write --organize-imports-enabled=false --no-errors-on-unmatched"
|
package/.changeset/README.md
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
# Changesets
|
|
2
|
-
|
|
3
|
-
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
|
|
4
|
-
with multi-package repos, or single-package repos to help you version and publish your code. You can
|
|
5
|
-
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
|
|
6
|
-
|
|
7
|
-
We have a quick list of common questions to get you started engaging with this project in
|
|
8
|
-
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|
package/.changeset/config.json
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
|
|
3
|
-
"changelog": "@changesets/cli/changelog",
|
|
4
|
-
"commit": false,
|
|
5
|
-
"fixed": [],
|
|
6
|
-
"linked": [],
|
|
7
|
-
"access": "restricted",
|
|
8
|
-
"baseBranch": "main",
|
|
9
|
-
"updateInternalDependencies": "patch",
|
|
10
|
-
"ignore": []
|
|
11
|
-
}
|
package/.cursor/rules/aim.mdc
DELETED
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description:
|
|
3
|
-
globs:
|
|
4
|
-
alwaysApply: true
|
|
5
|
-
---
|
|
6
|
-
# Project Aim
|
|
7
|
-
|
|
8
|
-
## Python to TypeScript Port
|
|
9
|
-
|
|
10
|
-
The aim of this project is to port the adk-python implementation to TypeScript (adk-ts). When porting code:
|
|
11
|
-
|
|
12
|
-
- Refer to the original implementation of the Python files
|
|
13
|
-
- Replicate their logic faithfully in TypeScript
|
|
14
|
-
- Ensure the core functionality remains identical
|
|
15
|
-
- Maintain the same logical structure and components
|
|
16
|
-
|
|
17
|
-
## Requirements
|
|
18
|
-
|
|
19
|
-
1. **Logic Preservation**: The TypeScript implementation MUST maintain the same logical flow and behavior as the Python version.
|
|
20
|
-
|
|
21
|
-
2. **Component Naming**: Core components should maintain conceptual naming parity with the Python version.
|
|
22
|
-
|
|
23
|
-
3. **Architecture**: Follow the same architectural patterns and separation of concerns as the Python implementation.
|
|
24
|
-
|
|
25
|
-
4. **File Organization**: Mirror the Python project's organizational structure where appropriate, adapting to TypeScript conventions.
|
|
26
|
-
|
|
27
|
-
## Implementation Notes
|
|
28
|
-
|
|
29
|
-
- Use TypeScript's type system to enhance the original Python implementation
|
|
30
|
-
- Apply language-specific best practices for TypeScript while preserving the original logic
|
|
31
|
-
- Adapt Python-specific patterns to TypeScript equivalents where direct ports aren't possible
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description:
|
|
3
|
-
globs:
|
|
4
|
-
alwaysApply: true
|
|
5
|
-
---
|
|
6
|
-
# File Naming Conventions
|
|
7
|
-
|
|
8
|
-
## Kebab Case for File Names
|
|
9
|
-
|
|
10
|
-
All files in this project should use kebab-case for naming. This means:
|
|
11
|
-
|
|
12
|
-
- All lowercase letters
|
|
13
|
-
- Words separated by hyphens
|
|
14
|
-
- No spaces or underscores
|
|
15
|
-
- No PascalCase or camelCase
|
|
16
|
-
|
|
17
|
-
### Examples:
|
|
18
|
-
|
|
19
|
-
✅ Good:
|
|
20
|
-
- `base-tool.ts`
|
|
21
|
-
- `google-search-tool.ts`
|
|
22
|
-
- `exit-loop-tool.ts`
|
|
23
|
-
- `llm-agent.ts`
|
|
24
|
-
- `memory-service.ts`
|
|
25
|
-
|
|
26
|
-
❌ Bad:
|
|
27
|
-
- `BaseTool.ts`
|
|
28
|
-
- `GoogleSearchTool.ts`
|
|
29
|
-
- `exit_loop_tool.ts`
|
|
30
|
-
- `LlmAgent.ts`
|
|
31
|
-
- `memoryService.ts`
|
|
32
|
-
|
|
33
|
-
## Class and Interface Naming
|
|
34
|
-
|
|
35
|
-
While files use kebab-case, TypeScript classes and interfaces should still follow standard conventions:
|
|
36
|
-
|
|
37
|
-
- Classes and Interfaces: PascalCase (e.g., `class BaseTool`, `interface ToolConfig`)
|
|
38
|
-
- Methods and Properties: camelCase (e.g., `runAsync()`, `getDeclaration()`)
|
|
39
|
-
|
|
40
|
-
## Implementation Note
|
|
41
|
-
|
|
42
|
-
This standardization helps maintain consistency across the codebase and aligns with common TypeScript ecosystem practices.
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description:
|
|
3
|
-
globs:
|
|
4
|
-
alwaysApply: true
|
|
5
|
-
---
|
|
6
|
-
# Code Documentation Guidelines
|
|
7
|
-
|
|
8
|
-
## Commenting Philosophy
|
|
9
|
-
|
|
10
|
-
This project follows a minimalist approach to code comments, focusing on clarity through well-structured, self-documenting code.
|
|
11
|
-
|
|
12
|
-
## Comment Guidelines
|
|
13
|
-
|
|
14
|
-
1. **Documentation Comments Only**: Add comments only when they provide documentation value. The code itself should be clear enough to understand without excessive comments.
|
|
15
|
-
|
|
16
|
-
2. **No Line-by-Line Comments**: Avoid explaining each line of code with a comment. This creates maintenance overhead and often becomes outdated.
|
|
17
|
-
|
|
18
|
-
3. **Method-Level Documentation**: Place concise documentation comments above methods/functions to explain:
|
|
19
|
-
- Purpose of the method
|
|
20
|
-
- Complex logic that may not be immediately obvious
|
|
21
|
-
- Any important side effects
|
|
22
|
-
|
|
23
|
-
4. **Class-Level Documentation**: Document classes with a brief description of their purpose and responsibility.
|
|
24
|
-
|
|
25
|
-
5. **Interface Documentation**: Document interfaces with clear descriptions of their intent and contract.
|
|
26
|
-
|
|
27
|
-
## When to Use Comments
|
|
28
|
-
|
|
29
|
-
✅ **Good Use of Comments**:
|
|
30
|
-
- Explaining "why" something is done a certain way
|
|
31
|
-
- Documenting complex algorithms
|
|
32
|
-
- Flagging future enhancements (TODO comments)
|
|
33
|
-
- Documenting API interfaces
|
|
34
|
-
|
|
35
|
-
❌ **Avoid Comments For**:
|
|
36
|
-
- Explaining obvious code
|
|
37
|
-
- Duplicating what the code already clearly states
|
|
38
|
-
- Commenting out unused code (delete it instead)
|
|
39
|
-
- Line-by-line explanations
|
package/.cursor/rules/paths.mdc
DELETED
package/biome.json
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
|
|
3
|
-
"vcs": {
|
|
4
|
-
"enabled": false,
|
|
5
|
-
"clientKind": "git",
|
|
6
|
-
"useIgnoreFile": false
|
|
7
|
-
},
|
|
8
|
-
"files": {
|
|
9
|
-
"ignoreUnknown": false,
|
|
10
|
-
"ignore": [
|
|
11
|
-
"node_modules/**",
|
|
12
|
-
"coverage/**",
|
|
13
|
-
"dist/**",
|
|
14
|
-
"*.lock",
|
|
15
|
-
"*.log",
|
|
16
|
-
"docs/**"
|
|
17
|
-
]
|
|
18
|
-
},
|
|
19
|
-
"formatter": {
|
|
20
|
-
"enabled": true,
|
|
21
|
-
"indentStyle": "tab"
|
|
22
|
-
},
|
|
23
|
-
"organizeImports": {
|
|
24
|
-
"enabled": true
|
|
25
|
-
},
|
|
26
|
-
"linter": {
|
|
27
|
-
"enabled": true,
|
|
28
|
-
"rules": {
|
|
29
|
-
"recommended": true,
|
|
30
|
-
"suspicious": {
|
|
31
|
-
"noExplicitAny": "off"
|
|
32
|
-
},
|
|
33
|
-
"complexity": {
|
|
34
|
-
"noForEach": "off",
|
|
35
|
-
"noStaticOnlyClass": "off"
|
|
36
|
-
},
|
|
37
|
-
"style": {
|
|
38
|
-
"noNonNullAssertion": "off"
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
},
|
|
42
|
-
"javascript": {
|
|
43
|
-
"formatter": {
|
|
44
|
-
"quoteStyle": "double"
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
}
|
package/tsup.config.ts
DELETED
package/typedoc.json
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"entryPoints": ["src/index.ts"],
|
|
3
|
-
"out": "docs",
|
|
4
|
-
"excludePrivate": true,
|
|
5
|
-
"excludeProtected": false,
|
|
6
|
-
"excludeExternals": true,
|
|
7
|
-
"excludeInternal": true,
|
|
8
|
-
"readme": "README.md",
|
|
9
|
-
"theme": "default",
|
|
10
|
-
"name": "ADK TypeScript Documentation",
|
|
11
|
-
"includeVersion": true,
|
|
12
|
-
"categorizeByGroup": true,
|
|
13
|
-
"categoryOrder": ["Core", "Agents", "LLM", "Tools", "Models", "Memory", "*"],
|
|
14
|
-
"githubPages": true,
|
|
15
|
-
"searchInComments": true,
|
|
16
|
-
"visibilityFilters": {
|
|
17
|
-
"protected": true,
|
|
18
|
-
"private": false,
|
|
19
|
-
"inherited": true,
|
|
20
|
-
"external": false
|
|
21
|
-
},
|
|
22
|
-
"navigationLinks": {
|
|
23
|
-
"GitHub": "https://github.com/IQAIcom/adk-ts",
|
|
24
|
-
"NPM": "https://www.npmjs.com/package/@iqai/adk"
|
|
25
|
-
}
|
|
26
|
-
}
|