@artinet/cruiser 0.1.1 → 0.1.3

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.
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * @module @artinet/cruiser/strands
5
5
  * @description
6
- * This adapter "parks" {@link StrandsAgent | Strands Agents} (from `@strands-agents/sdk`) into the
6
+ * This adapter "docks" {@link StrandsAgent | Strands Agents} (from `@strands-agents/sdk`) into the
7
7
  * artinet, enabling them to participate in multi-agent workflows.
8
8
  * Strands is AWS's open-source agent framework with native Bedrock integration.
9
9
  *
@@ -25,7 +25,7 @@
25
25
  *
26
26
  * ```typescript
27
27
  * import { Agent } from "@strands-agents/sdk";
28
- * import { park } from "@artinet/cruiser/strands";
28
+ * import { dock } from "@artinet/cruiser/strands";
29
29
  * import { serve } from "@artinet/sdk";
30
30
  *
31
31
  * const strandsAgent = new Agent({
@@ -33,7 +33,7 @@
33
33
  * systemPrompt: "You are a helpful assistant",
34
34
  * });
35
35
  *
36
- * const artinetAgent = await park(strandsAgent, { name: "Strands Bot" });
36
+ * const artinetAgent = await dock(strandsAgent, { name: "Strands Bot" });
37
37
  * serve({agent: artinetAgent, port: 3000 });
38
38
  * ```
39
39
  *
@@ -42,19 +42,19 @@
42
42
  import * as sdk from "@artinet/sdk";
43
43
  import { getAgentCard, createStrandsMessage } from "./utils.js";
44
44
  /**
45
- * Parks a {@link StrandsAgent} into artinet.
45
+ * Docks a {@link StrandsAgent} into artinet.
46
46
  *
47
47
  * Transforms a Strands Agent instance into an {@link sdk.Agent | A2A-compatible agent}
48
48
  * that can be deployed on artinet.
49
49
  *
50
- * @param agent - The {@link StrandsAgent} to park
50
+ * @param agent - The {@link StrandsAgent} to dock
51
51
  * @param card - Optional {@link sdk.A2A.AgentCardParams} configuration to customize identity and capabilities
52
52
  *
53
53
  * @returns A Promise resolving to an {@link sdk.Agent} ready for deployment
54
54
  *
55
55
  * @example Basic Usage
56
56
  * ```typescript
57
- * import { park } from "@artinet/cruiser/strands";
57
+ * import { dock } from "@artinet/cruiser/strands";
58
58
  * import { Agent } from "@strands-agents/sdk";
59
59
  *
60
60
  * const agent = new Agent({
@@ -62,12 +62,12 @@ import { getAgentCard, createStrandsMessage } from "./utils.js";
62
62
  * systemPrompt: "Be helpful and concise",
63
63
  * });
64
64
  *
65
- * const artinetAgent = await park(agent, { name: "Quick Helper" });
65
+ * const artinetAgent = await dock(agent, { name: "Quick Helper" });
66
66
  * ```
67
67
  *
68
68
  * @example With Custom Tools
69
69
  * ```typescript
70
- * import { park } from "@artinet/cruiser/strands";
70
+ * import { dock } from "@artinet/cruiser/strands";
71
71
  * import { Agent, tool } from "@strands-agents/sdk";
72
72
  *
73
73
  * const agent = new Agent({
@@ -76,7 +76,7 @@ import { getAgentCard, createStrandsMessage } from "./utils.js";
76
76
  * tools: [calculatorTool, converterTool],
77
77
  * });
78
78
  *
79
- * const artinetAgent = await park(agent, {
79
+ * const artinetAgent = await dock(agent, {
80
80
  * name: "Math Helper",
81
81
  * description: "Calculator and unit conversion assistant",
82
82
  * });
@@ -84,7 +84,7 @@ import { getAgentCard, createStrandsMessage } from "./utils.js";
84
84
  *
85
85
  * @example With AWS Bedrock Configuration
86
86
  * ```typescript
87
- * import { park } from "@artinet/cruiser/strands";
87
+ * import { dock } from "@artinet/cruiser/strands";
88
88
  * import { Agent } from "@strands-agents/sdk";
89
89
  *
90
90
  * const agent = new Agent({
@@ -93,10 +93,10 @@ import { getAgentCard, createStrandsMessage } from "./utils.js";
93
93
  * region: "us-west-2",
94
94
  * });
95
95
  *
96
- * const artinetAgent = await park(agent, { name: "Enterprise Bot" });
96
+ * const artinetAgent = await dock(agent, { name: "Enterprise Bot" });
97
97
  * ```
98
98
  */
99
- export const park = async (agent, card) => {
99
+ export const dock = async (agent, card) => {
100
100
  const agentCard = await getAgentCard({ agent, card });
101
101
  sdk.logger.debug(`Strands[${agentCard.name}]:[card:${JSON.stringify(agentCard)}]`);
102
102
  return sdk.cr8(agentCard).from(async function* (context) {
@@ -139,3 +139,7 @@ export const park = async (agent, card) => {
139
139
  yield completedUpdate;
140
140
  });
141
141
  };
142
+ /**
143
+ * @deprecated Use {@link dock} instead.
144
+ */
145
+ export const park = dock;
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * @module @artinet/cruiser/volt
5
5
  * @description
6
- * This adapter "parks" Volt agents onto the Artinet A2A protocol.
6
+ * This adapter "docks" Volt agents onto the Artinet A2A protocol.
7
7
  *
8
8
  * ## Status
9
9
  *
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * @module @artinet/cruiser/volt
5
5
  * @description
6
- * This adapter "parks" Volt agents onto the Artinet A2A protocol.
6
+ * This adapter "docks" Volt agents onto the Artinet A2A protocol.
7
7
  *
8
8
  * ## Status
9
9
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artinet/cruiser",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "A library for building A2A enabled runtime Agents.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -50,7 +50,7 @@
50
50
  "clean": "rimraf dist",
51
51
  "rebuild": "rimraf dist node_modules/ package-lock.json && npm i && npm run build",
52
52
  "lint": "eslint src --ext .ts",
53
- "package-test": "npm run build && npm pack && sync && sleep 1 && docker build --no-cache -f ./deployment/test.dockerfile -t cruiser-test . && docker run --env-file .env --rm cruiser-test && rm artinet-cruiser-*.tgz",
53
+ "package-test": "npm run build && npm pack && sync && sleep 1 && docker build -f ./deployment/test.dockerfile -t cruiser-test . && docker run --env-file .env --rm cruiser-test && rm artinet-cruiser-*.tgz",
54
54
  "prepublishOnly": "npm run package-test && rimraf dist && npm run build && npm run lint && npm test",
55
55
  "test": "NODE_OPTIONS=--experimental-vm-modules jest",
56
56
  "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch",
@@ -80,7 +80,7 @@
80
80
  },
81
81
  "homepage": "https://artinet.io",
82
82
  "dependencies": {
83
- "@artinet/sdk": "^0.6.2",
83
+ "@artinet/sdk": "^0.6.4",
84
84
  "@artinet/types": "^0.0.9",
85
85
  "uuid": "^13.0.0"
86
86
  },