@atlanai/sdk 0.1.1 → 0.2.2

package/dist/tracing/spans.js

@@ -66,7 +66,6 @@ const COST_ATTRIBUTES = {
  * target it (SPEC §9.4). Set by client.startAsCurrentSpan.
  */
 exports.ROOT_SPAN_CONTEXT_KEY = (0, api_1.createContextKey)("atlan.root_span");
-const SCORE_EVENT_NAME = "atlan.score";
 function resolveSpanType(asType) {
     const resolved = sc.SPAN_TYPE_ALIASES[asType] ?? asType;
     if (!sc.SPAN_TYPES.includes(resolved)) {
@@ -93,10 +92,12 @@ class AtlanSpan {
     otel;
     config;
     mask;
-    constructor(otelSpan, config, mask) {
+    tracer;
+    constructor(otelSpan, config, mask, tracer) {
         this.otel = otelSpan;
         this.config = config;
         this.mask = mask;
+        this.tracer = tracer;
     }
     get otelSpan() {
         return this.otel;
@@ -213,9 +214,12 @@ class AtlanSpan {
         }
         return this;
     }
+    /** Braintrust-compatible spelling for incrementally adding span fields. */
+    log(fields) {
+        return this.update(fields);
+    }
     /**
-     * Attach a score to this span (SPEC §9.4): an `atlan.score` event plus a
-     * rollup attribute `atlan.score.{name}`.
+     * Emit a dedicated score child span (SPEC §9.4).
      *
      * NUMERIC requires a numeric value; CATEGORICAL requires stringValue
      * (numeric value defaults to 0.0); BOOLEAN encodes value as 0/1.
@@ -223,7 +227,7 @@ class AtlanSpan {
      */
     score(name, value, options = {}) {
         const span = this.otel;
-        if (!span.isRecording())
+        if (!span.isRecording() || this.tracer === undefined)
             return;
         if (!name || typeof name !== "string") {
             logger_js_1.logger.warn(`dropping score with invalid name ${JSON.stringify(name)}`);
@@ -234,6 +238,16 @@ class AtlanSpan {
             logger_js_1.logger.warn(`dropping score ${name} with unknown dataType ${String(dataType)}`);
             return;
         }
+        if (typeof options.scorerId !== "string" || !options.scorerId.startsWith("scorer_")) {
+            logger_js_1.logger.warn(`dropping score ${name} without a valid scorerId`);
+            return;
+        }
+        if (typeof options.scorerVersion !== "number" ||
+            !Number.isInteger(options.scorerVersion) ||
+            options.scorerVersion < 1) {
+            logger_js_1.logger.warn(`dropping score ${name} without a valid scorerVersion`);
+            return;
+        }
         let numeric;
         if (dataType === "NUMERIC") {
             const coerced = asFloat(value);
@@ -258,19 +272,24 @@ class AtlanSpan {
             }
             numeric = value ? 1.0 : 0.0;
         }
-        const eventAttributes = {
-            [`${sc.ATLAN_SCORE_PREFIX}name`]: name,
-            [`${sc.ATLAN_SCORE_PREFIX}value`]: numeric,
-            [`${sc.ATLAN_SCORE_PREFIX}data_type`]: dataType,
+        const attributes = {
+            [sc.ATLAN_SPAN_TYPE]: "score",
+            [sc.ATLAN_SCORE_NAME]: name,
+            [sc.ATLAN_SCORE_VALUE]: numeric,
+            [sc.ATLAN_SCORE_DATA_TYPE]: dataType,
+            [sc.ATLAN_SCORE_SCORER_ID]: options.scorerId,
+            [sc.ATLAN_SCORE_SCORER_VERSION]: options.scorerVersion,
         };
         if (options.stringValue !== undefined) {
-            eventAttributes[`${sc.ATLAN_SCORE_PREFIX}string_value`] = options.stringValue;
+            attributes[sc.ATLAN_SCORE_STRING_VALUE] = options.stringValue;
         }
         if (options.comment !== undefined) {
-            eventAttributes[`${sc.ATLAN_SCORE_PREFIX}comment`] = options.comment;
+            attributes[sc.ATLAN_SCORE_COMMENT] = options.comment;
         }
-        span.addEvent(SCORE_EVENT_NAME, eventAttributes);
-        span.setAttribute(`${sc.ATLAN_SCORE_PREFIX}${name}`, numeric);
+        const parent = api_1.trace.setSpan(api_1.context.active(), span);
+        const scoreSpan = this.tracer.startSpan(`score.${name}`, {}, parent);
+        scoreSpan.setAttributes(attributes);
+        scoreSpan.end();
     }
     /**
      * Attach a score to the current trace's root span when resolvable
@@ -299,6 +318,10 @@ class AtlanSpan {
     end(endTime) {
         this.otel.end(endTime);
     }
+    /** Braintrust-compatible spelling for ending a manually managed span. */
+    close(endTime) {
+        this.end(endTime);
+    }
 }
 exports.AtlanSpan = AtlanSpan;
 function noopSpan(config) {

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.1";
+export declare const SDK_VERSION = "0.2.2";

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.1";
+exports.SDK_VERSION = "0.2.2";

package/package.json

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

package/dist/raw/registry/apis/ActionsApi.d.ts

@@ -1,68 +0,0 @@
-/**
- * Atlan Agent Gateway — registry
- * The platform core: identity, tenancy, the artifact plane, discovery and the policy plane.
- *
- * The version of the OpenAPI document: 0.1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import * as runtime from '../runtime';
-import { type ActionRunDto } from '../models/ActionRunDto';
-import { type ActionRunJobsPage } from '../models/ActionRunJobsPage';
-import { type ActionRunsPage } from '../models/ActionRunsPage';
-export interface RegistryGetActionRunRequest {
-    runId: string;
-}
-export interface RegistryListActionRunJobsRequest {
-    runId: string;
-}
-/**
- *
- */
-export declare class ActionsApi extends runtime.BaseAPI {
-    /**
-     * Creates request options for registryGetActionRun without sending the request
-     */
-    registryGetActionRunRequestOpts(requestParameters: RegistryGetActionRunRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Use this operation to get an action run.
-     * Get an action run
-     */
-    registryGetActionRunRaw(requestParameters: RegistryGetActionRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActionRunDto>>;
-    /**
-     * Use this operation to get an action run.
-     * Get an action run
-     */
-    registryGetActionRun(requestParameters: RegistryGetActionRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActionRunDto>;
-    /**
-     * Creates request options for registryListActionRunJobs without sending the request
-     */
-    registryListActionRunJobsRequestOpts(requestParameters: RegistryListActionRunJobsRequest): Promise<runtime.RequestOpts>;
-    /**
-     * One row per DAG node: its status, its findings\' `max_severity`, and what it depended on. The run\'s own status is the roll-up; this is where a `failed` run says which node failed.
-     * List a run\'s job results
-     */
-    registryListActionRunJobsRaw(requestParameters: RegistryListActionRunJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActionRunJobsPage>>;
-    /**
-     * One row per DAG node: its status, its findings\' `max_severity`, and what it depended on. The run\'s own status is the roll-up; this is where a `failed` run says which node failed.
-     * List a run\'s job results
-     */
-    registryListActionRunJobs(requestParameters: RegistryListActionRunJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActionRunJobsPage>;
-    /**
-     * Creates request options for registryListActionRuns without sending the request
-     */
-    registryListActionRunsRequestOpts(): Promise<runtime.RequestOpts>;
-    /**
-     * Newest first, by `started_at` — a run is appended and then finished, never edited, so there is no `updated_at` to order by.  `run_status` is one of `pending`, `running`, `passed`, `failed`, `error`, `cancelled`, and the last three are three different facts. `failed` is a verdict — a scan found something. `error` is a malfunction — the scanner fell over; a broken extension must not read as a policy hit. `cancelled` is neither: the run was abandoned because its target artifact was archived, so there was nothing left to run it against. A `cancelled` run carries a `finished_at` and no `gate_outcome`, because it gated nothing.
-     * List action runs
-     */
-    registryListActionRunsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ActionRunsPage>>;
-    /**
-     * Newest first, by `started_at` — a run is appended and then finished, never edited, so there is no `updated_at` to order by.  `run_status` is one of `pending`, `running`, `passed`, `failed`, `error`, `cancelled`, and the last three are three different facts. `failed` is a verdict — a scan found something. `error` is a malfunction — the scanner fell over; a broken extension must not read as a policy hit. `cancelled` is neither: the run was abandoned because its target artifact was archived, so there was nothing left to run it against. A `cancelled` run carries a `finished_at` and no `gate_outcome`, because it gated nothing.
-     * List action runs
-     */
-    registryListActionRuns(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ActionRunsPage>;
-}

package/dist/raw/registry/apis/ActionsApi.js

@@ -1,181 +0,0 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Atlan Agent Gateway — registry
- * The platform core: identity, tenancy, the artifact plane, discovery and the policy plane.
- *
- * The version of the OpenAPI document: 0.1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionsApi = void 0;
-const runtime = __importStar(require("../runtime"));
-const ActionRunDto_1 = require("../models/ActionRunDto");
-const ActionRunJobsPage_1 = require("../models/ActionRunJobsPage");
-const ActionRunsPage_1 = require("../models/ActionRunsPage");
-/**
- *
- */
-class ActionsApi extends runtime.BaseAPI {
-    /**
-     * Creates request options for registryGetActionRun without sending the request
-     */
-    async registryGetActionRunRequestOpts(requestParameters) {
-        if (requestParameters['runId'] == null) {
-            throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling registryGetActionRun().');
-        }
-        const queryParameters = {};
-        const headerParameters = {};
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("bearer", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        let urlPath = `/action-runs/{run_id}`;
-        urlPath = urlPath.replace('{run_id}', encodeURIComponent(String(requestParameters['runId'])));
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-    /**
-     * Use this operation to get an action run.
-     * Get an action run
-     */
-    async registryGetActionRunRaw(requestParameters, initOverrides) {
-        const requestOptions = await this.registryGetActionRunRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, ActionRunDto_1.ActionRunDtoFromJSON)(jsonValue));
-    }
-    /**
-     * Use this operation to get an action run.
-     * Get an action run
-     */
-    async registryGetActionRun(requestParameters, initOverrides) {
-        const response = await this.registryGetActionRunRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Creates request options for registryListActionRunJobs without sending the request
-     */
-    async registryListActionRunJobsRequestOpts(requestParameters) {
-        if (requestParameters['runId'] == null) {
-            throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling registryListActionRunJobs().');
-        }
-        const queryParameters = {};
-        const headerParameters = {};
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("bearer", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        let urlPath = `/action-runs/{run_id}/jobs`;
-        urlPath = urlPath.replace('{run_id}', encodeURIComponent(String(requestParameters['runId'])));
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-    /**
-     * One row per DAG node: its status, its findings\' `max_severity`, and what it depended on. The run\'s own status is the roll-up; this is where a `failed` run says which node failed.
-     * List a run\'s job results
-     */
-    async registryListActionRunJobsRaw(requestParameters, initOverrides) {
-        const requestOptions = await this.registryListActionRunJobsRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, ActionRunJobsPage_1.ActionRunJobsPageFromJSON)(jsonValue));
-    }
-    /**
-     * One row per DAG node: its status, its findings\' `max_severity`, and what it depended on. The run\'s own status is the roll-up; this is where a `failed` run says which node failed.
-     * List a run\'s job results
-     */
-    async registryListActionRunJobs(requestParameters, initOverrides) {
-        const response = await this.registryListActionRunJobsRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-    /**
-     * Creates request options for registryListActionRuns without sending the request
-     */
-    async registryListActionRunsRequestOpts() {
-        const queryParameters = {};
-        const headerParameters = {};
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("bearer", []);
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-        let urlPath = `/action-runs`;
-        return {
-            path: urlPath,
-            method: 'GET',
-            headers: headerParameters,
-            query: queryParameters,
-        };
-    }
-    /**
-     * Newest first, by `started_at` — a run is appended and then finished, never edited, so there is no `updated_at` to order by.  `run_status` is one of `pending`, `running`, `passed`, `failed`, `error`, `cancelled`, and the last three are three different facts. `failed` is a verdict — a scan found something. `error` is a malfunction — the scanner fell over; a broken extension must not read as a policy hit. `cancelled` is neither: the run was abandoned because its target artifact was archived, so there was nothing left to run it against. A `cancelled` run carries a `finished_at` and no `gate_outcome`, because it gated nothing.
-     * List action runs
-     */
-    async registryListActionRunsRaw(initOverrides) {
-        const requestOptions = await this.registryListActionRunsRequestOpts();
-        const response = await this.request(requestOptions, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, ActionRunsPage_1.ActionRunsPageFromJSON)(jsonValue));
-    }
-    /**
-     * Newest first, by `started_at` — a run is appended and then finished, never edited, so there is no `updated_at` to order by.  `run_status` is one of `pending`, `running`, `passed`, `failed`, `error`, `cancelled`, and the last three are three different facts. `failed` is a verdict — a scan found something. `error` is a malfunction — the scanner fell over; a broken extension must not read as a policy hit. `cancelled` is neither: the run was abandoned because its target artifact was archived, so there was nothing left to run it against. A `cancelled` run carries a `finished_at` and no `gate_outcome`, because it gated nothing.
-     * List action runs
-     */
-    async registryListActionRuns(initOverrides) {
-        const response = await this.registryListActionRunsRaw(initOverrides);
-        return await response.value();
-    }
-}
-exports.ActionsApi = ActionsApi;

package/dist/raw/registry/apis/CatalogApi.d.ts

@@ -1,98 +0,0 @@
-/**
- * Atlan Agent Gateway — registry
- * The platform core: identity, tenancy, the artifact plane, discovery and the policy plane.
- *
- * The version of the OpenAPI document: 0.1.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import * as runtime from '../runtime';
-import { type AvailableExtensionDto } from '../models/AvailableExtensionDto';
-import { type AvailableExtensionsPage } from '../models/AvailableExtensionsPage';
-import { type ExtensionJobsPage } from '../models/ExtensionJobsPage';
-import { type PublisherDto } from '../models/PublisherDto';
-import { type PublishersPage } from '../models/PublishersPage';
-export interface RegistryGetAvailableExtensionRequest {
-    extension: string;
-}
-export interface RegistryGetPublisherRequest {
-    publisherId: string;
-}
-/**
- *
- */
-export declare class CatalogApi extends runtime.BaseAPI {
-    /**
-     * Creates request options for registryGetAvailableExtension without sending the request
-     */
-    registryGetAvailableExtensionRequestOpts(requestParameters: RegistryGetAvailableExtensionRequest): Promise<runtime.RequestOpts>;
-    /**
-     * Use this operation to get an available extension.
-     * Get an available extension
-     */
-    registryGetAvailableExtensionRaw(requestParameters: RegistryGetAvailableExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AvailableExtensionDto>>;
-    /**
-     * Use this operation to get an available extension.
-     * Get an available extension
-     */
-    registryGetAvailableExtension(requestParameters: RegistryGetAvailableExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AvailableExtensionDto>;
-    /**
-     * Creates request options for registryGetPublisher without sending the request
-     */
-    registryGetPublisherRequestOpts(requestParameters: RegistryGetPublisherRequest): Promise<runtime.RequestOpts>;
-    /**
-     * The id is a slug (`atlan`), not a minted handle — these rows predate the handle convention and the slug appears in the extension listing.
-     * Get a publisher
-     */
-    registryGetPublisherRaw(requestParameters: RegistryGetPublisherRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublisherDto>>;
-    /**
-     * The id is a slug (`atlan`), not a minted handle — these rows predate the handle convention and the slug appears in the extension listing.
-     * Get a publisher
-     */
-    registryGetPublisher(requestParameters: RegistryGetPublisherRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublisherDto>;
-    /**
-     * Creates request options for registryListAvailableExtensions without sending the request
-     */
-    registryListAvailableExtensionsRequestOpts(): Promise<runtime.RequestOpts>;
-    /**
-     * The catalogue: what *can* be installed. `GET /extensions` is the other half — what this account *has* installed — and the two are deliberately different paths, because one is deployment-global and the other is per-account.
-     * List available extensions
-     */
-    registryListAvailableExtensionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AvailableExtensionsPage>>;
-    /**
-     * The catalogue: what *can* be installed. `GET /extensions` is the other half — what this account *has* installed — and the two are deliberately different paths, because one is deployment-global and the other is per-account.
-     * List available extensions
-     */
-    registryListAvailableExtensions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AvailableExtensionsPage>;
-    /**
-     * Creates request options for registryListExtensionJobs without sending the request
-     */
-    registryListExtensionJobsRequestOpts(): Promise<runtime.RequestOpts>;
-    /**
-     * The durable work extensions declare they can run, which is what an action\'s DAG nodes name. `user_authorable` is the field that matters when authoring one: a job is internal until it is deliberately exposed.
-     * List extension jobs
-     */
-    registryListExtensionJobsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExtensionJobsPage>>;
-    /**
-     * The durable work extensions declare they can run, which is what an action\'s DAG nodes name. `user_authorable` is the field that matters when authoring one: a job is internal until it is deliberately exposed.
-     * List extension jobs
-     */
-    registryListExtensionJobs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExtensionJobsPage>;
-    /**
-     * Creates request options for registryListPublishers without sending the request
-     */
-    registryListPublishersRequestOpts(): Promise<runtime.RequestOpts>;
-    /**
-     * Who ships the extensions in this deployment\'s marketplace. Deployment-global: every account sees the same list, because a publisher is a fact about the marketplace rather than about a tenant. Supports the shared query grammar over `publisher_id`, `display_name`, `publisher_kind`, `publisher_status` and `created_at`.
-     * List publishers
-     */
-    registryListPublishersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PublishersPage>>;
-    /**
-     * Who ships the extensions in this deployment\'s marketplace. Deployment-global: every account sees the same list, because a publisher is a fact about the marketplace rather than about a tenant. Supports the shared query grammar over `publisher_id`, `display_name`, `publisher_kind`, `publisher_status` and `created_at`.
-     * List publishers
-     */
-    registryListPublishers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PublishersPage>;
-}