@atlanai/sdk 0.1.0 → 0.1.1

package/README.md

@@ -1,45 +1,81 @@
 # @atlanai/sdk
 
-TypeScript management client for the public Atlan Agent Gateway API. Use
-`AtlanClient` for stable service namespaces. Generated clients are available
-below `client.raw` and package subpaths under `@atlanai/sdk/raw/*`.
+TypeScript/JavaScript SDK for the Atlan Agent Gateway: manage agents, skills,
+sessions, and workspaces, and optionally trace what your agents do.
 
-Tracing is an authored follow-on and is not included in the current TypeScript
-package. It will not be generated from the management OpenAPI contract.
+## Install
 
-## Local install
+```bash
+npm install @atlanai/sdk
+```
 
-Build the package from the repository root:
+## Quickstart
 
-```bash
-npm --prefix typescript ci --ignore-scripts
-npm --prefix typescript run build
+```typescript
+import { AtlanClient } from "@atlanai/sdk";
+
+const client = new AtlanClient({
+  gatewayOrigin: "https://<your-gateway-host>",
+  bearerToken: "<your-api-token>",
+});
+
+const agent = await client.agents.create({
+  name: "support-triage",
+  workspaceId: "workspace_01example",
+});
+
+const page = await client.agents.list({ limit: 10 });
+console.log(`${page.items.length} agents`);
 ```
 
-Install the built checkout into a local project:
+Methods read as `client.<resource>.<action>` — `client.agents.get(agentId)`,
+`client.sessions.messages.create(sessionId, {...})`, and so on. Every public
+Agent Gateway operation is reachable this way; nothing requires reaching into
+a generated client directly.
 
-```bash
-npm install /absolute/path/to/sdk/typescript --ignore-scripts
+Pass a default workspace once instead of repeating it on every call:
+
+```typescript
+const client = new AtlanClient({ gatewayOrigin, bearerToken, workspace: "workspace_01example" });
 ```
 
-Pass the Gateway origin and bearer explicitly:
+## Tracing
 
 ```typescript
-import { AtlanClient, rawAgent } from "@atlanai/sdk";
+import * as atlan from "@atlanai/sdk/tracing";
 
-declare const process: { env: Record<string, string | undefined> };
+const tracer = atlan.init({ apiKey: "<your-tracing-key>", workspaceId: "workspace_01example" });
 
-const client = new AtlanClient({
-  gatewayOrigin: process.env.ATLANAI_GATEWAY_URL!,
-  bearerToken: process.env.ATLANAI_TOKEN!,
+await tracer.startAsCurrentSpan("handle-request", { asType: "task" }, async (span) => {
+  span.update({ model: "claude-sonnet-5", usage: { inputTokens: 120, outputTokens: 40 } });
 });
+```
+
+Tracing has its own API key and lifecycle — it does not reuse the management
+client's bearer token or transport. It ships as a separate subpath
+(`@atlanai/sdk/tracing`) so importing it doesn't pull OpenTelemetry into a
+management-only bundle.
 
-const agentsApi = client.agents.apis.agents as rawAgent.AgentsApi;
-const page = await agentsApi.agentListAgents({ limit: 10 });
-console.log(page.items.length);
+## Errors
+
+Every non-2xx response rejects with `AtlanAPIError`, with `.status`, `.code`,
+and (where the gateway includes one) `.traceId`:
+
+```typescript
+import { AtlanAPIError } from "@atlanai/sdk";
+
+try {
+  await client.agents.get("agent_does_not_exist");
+} catch (error) {
+  if (error instanceof AtlanAPIError) {
+    console.log(error.status, error.code);
+  }
+}
 ```
 
-See [the complete local setup guide](../docs/getting-started.md) for direct
-Registry configuration and the current typed-namespace follow-up. The
-[generated TypeScript reference](../docs/reference/README.md) covers every raw
-operation and model.
+## Runtimes
+
+Node ≥20. The tracing subpath is written to also run in non-Node runtimes
+like Cloudflare Workers — pass configuration to `init()` explicitly there
+rather than relying on environment variables, since Workers has no ambient
+environment.

package/dist/tracing/version.d.ts

@@ -1,4 +1,4 @@
 /** SDK identity (SPEC §2.2, §5.1). Kept in sync with package.json — the
  * version test fails the build on drift. */
 export declare const SDK_LANGUAGE = "typescript";
-export declare const SDK_VERSION = "0.1.0";
+export declare const SDK_VERSION = "0.1.1";

package/dist/tracing/version.js

@@ -4,4 +4,4 @@ exports.SDK_VERSION = exports.SDK_LANGUAGE = void 0;
 /** SDK identity (SPEC §2.2, §5.1). Kept in sync with package.json — the
  * version test fails the build on drift. */
 exports.SDK_LANGUAGE = "typescript";
-exports.SDK_VERSION = "0.1.0";
+exports.SDK_VERSION = "0.1.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlanai/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Atlan Agent Gateway management SDK",
   "type": "commonjs",
   "main": "./dist/index.js",