Skip to content

Commit edf9b58

Browse files
authored
Remove deprecated files and update project structure for improved clarity (#21)
- Deleted `llms.txt`, `examples/code-deployment.js`, `examples/code-deployment.ts`, and other related deployment utilities to streamline the SDK. - Updated `package.json` to reflect changes in type definitions and removed references to deprecated modules. - Refactored `README.md` to remove outdated documentation and clarify breaking changes in version 0.5.8. - Adjusted TypeScript configuration and logging utilities for better performance and maintainability. - Enhanced error handling in various services and methods to improve robustness.
1 parent 04571e5 commit edf9b58

34 files changed

+51
-1558
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ This SDK leverages a service-oriented architecture for building AI agents allowi
1818
- [Features](#features)
1919
- [Installation](#installation)
2020
- [Requirements](#requirements)
21-
- [Documentation](#documentation)
2221
- [Example](#example)
2322
- [Running Tests](#running-tests)
2423
- [Usage](#usage)
@@ -38,6 +37,15 @@ This SDK leverages a service-oriented architecture for building AI agents allowi
3837
- [License](#license)
3938
- [Acknowledgements](#acknowledgements)
4039

40+
**Breaking Changes in v0.5.8**
41+
- Pino has been removed and replaced with console for better portability and is set to silent by default.
42+
- The default handler for streamMessage no longer automatically emits an initial `submitted` and `working` event.
43+
- Agent Registration, Bundling and Deployment utils have been removed (email us: humans@artinet.io for support).
44+
- `@artinet/metadata-validator` has been removed due to build issues.
45+
- getTask now correctly takes TaskQueryParams as an argument vs TaskIdParams in accordance with the A2A spec.
46+
- AgentBuilder now returns a unique messageId for each status update instead of the original user provided messageId.
47+
- In a future release the following packages will be set as peer dependancies to reduce the size of the build: `@modelcontextprotocol/sdk`, `@trpc/server`, `cors`, `express`
48+
4149
## Features
4250

4351
- **Modular Design:** Everything you need to get started building collaborative agents + its flexible enough for advanced configuration.
@@ -53,10 +61,10 @@ npm install @artinet/sdk
5361
## Requirements
5462

5563
- Node.js (v22.0.0 or higher recommended)
56-
64+
<!--
5765
## Documentation
5866
59-
For more detailed documentation visit our documentation site [here](https://the-artinet-project.github.io/artinet-documentation/).
67+
For more detailed documentation visit our documentation site [here](https://the-artinet-project.github.io/artinet-documentation/). -->
6068

6169
## Example
6270

examples/README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -69,23 +69,6 @@ And after restarting the server, test persistence with:
6969
node examples/file-storage-client-continued.js
7070
```
7171

72-
### Code Deployment Examples
73-
74-
These examples demonstrate how to prepare your agent code for deployment, including bundling and using the task handling proxies.
75-
76-
- `examples/code-deployment.js`: Shows a JavaScript agent structured for deployment.
77-
- `examples/code-deployment.ts`: Shows a TypeScript agent structured for deployment, which will be bundled by the deployment process.
78-
79-
These examples utilize `taskHandlerProxy` and `fetchResponseProxy` (from `examples/task-wrapper.js`, which is a simplified version of `src/utils/deployment/task-wrapper.ts`) to interact with a simulated deployment environment.
80-
81-
## Test Deployment Feature
82-
83-
The Artinet SDK now includes a **Test Deployment** feature. This allows you to bundle your agent code (as demonstrated in the Code Deployment Examples) and test its execution against a sandboxed deployment environment provided by Artinet. This is a crucial step for verifying your agent\'s behavior before a full deployment.
84-
85-
You can see this in action in our internal tests (`tests/deployment.test.ts`), which use the `bundle` utility and the `testDeployment` function.
86-
87-
**Coming Soon: Full Agent Deployment!** Beta users will get access to full serverless agent deployment capabilities in the coming days. This will allow you to host your agents directly on the Artinet platform, making them accessible to other agents and users. Stay tuned for more details!
88-
8972
## Known Issues
9073

9174
- The file storage server does not properly maintain conversation history between restarts - it treats each message as if it were the first message in a conversation

examples/code-deployment.js

Lines changed: 0 additions & 64 deletions
This file was deleted.

examples/code-deployment.ts

Lines changed: 0 additions & 90 deletions
This file was deleted.

examples/nested-deployment.ts

Lines changed: 0 additions & 169 deletions
This file was deleted.

0 commit comments

Comments
 (0)