@narrative.io/data-collaboration-sdk-ts 2.106.0 → 2.108.0

package/build/agents/types.d.ts

@@ -126,6 +126,33 @@ export interface RunError {
     title?: string;
     docs_url?: string;
 }
+/**
+ * A turn the agent loop has produced during an active run but has not yet
+ * committed to the conversation's message log. The loop appends one of these
+ * per produced turn (assistant `tool_use`, tool `tool_result`, ...) to
+ * `agent_run_live_messages`, ordered by `turn_index`. Surfaced on
+ * `RunResponse.live.messages` only while the run is non-terminal; finalize
+ * clears them and re-writes the same content as committed messages with
+ * gap-free `sequence_no`.
+ *
+ * Order by `turn_index` (run-local), not `sequence_no` — live turns do not
+ * carry `sequence_no` and never collide with the committed table.
+ */
+export interface LiveRunTurn {
+    turn_index: number;
+    role: AgentMessageRole;
+    content_blocks: ContentBlock[];
+    created_at: string;
+}
+/**
+ * In-flight progress for a non-terminal run. Empty (or omitted) once the run
+ * reaches a terminal state — at that point the same content is available on
+ * `GET /agents/conversations/{id}/messages?since={version}` as committed
+ * turns with `sequence_no`.
+ */
+export interface RunLiveProgress {
+    messages: LiveRunTurn[];
+}
 export interface RunResponse {
     id: RunId;
     conversation_id: ConversationId;
@@ -143,6 +170,13 @@ export interface RunResponse {
     error?: RunError | null;
     started_at: string;
     completed_at?: string | null;
+    /**
+     * In-flight tool-loop progress while the run is non-terminal. Empty
+     * (or absent) after finalize; consumers must then fall back to
+     * `listAgentConversationMessages({ since: version-at-run-start })` for
+     * the committed turns.
+     */
+    live?: RunLiveProgress | null;
 }
 export type AgentMessageRole = "user" | "assistant" | "tool";
 export interface TextContentBlock {

package/build/companies/index.d.ts

@@ -0,0 +1,20 @@
+import { BaseApi } from "../base-api";
+import type { ApiRecords } from "../types";
+import type { CompanyAdminResponse } from "./types";
+export * from "./types";
+/**
+ * @module CompaniesApi
+ * @description Admin Companies: list and inspect companies on the platform.
+ *   Requires the `admin:company_info` permission. Archived companies are
+ *   excluded server-side from the list.
+ *
+ * @extends BaseApi
+ */
+export declare class CompaniesApi extends BaseApi {
+    /**
+     * List all active and pending companies, newest filter applied server-side
+     * (archived excluded). Returns the `records` envelope only — no pagination
+     * metadata is provided by the backend for this endpoint.
+     */
+    getCompanies(): Promise<ApiRecords<CompanyAdminResponse>>;
+}

package/build/companies/index.js

@@ -0,0 +1,21 @@
+import { BaseApi } from "../base-api";
+export * from "./types";
+const resourceName = "admin/companies";
+/**
+ * @module CompaniesApi
+ * @description Admin Companies: list and inspect companies on the platform.
+ *   Requires the `admin:company_info` permission. Archived companies are
+ *   excluded server-side from the list.
+ *
+ * @extends BaseApi
+ */
+export class CompaniesApi extends BaseApi {
+    /**
+     * List all active and pending companies, newest filter applied server-side
+     * (archived excluded). Returns the `records` envelope only — no pagination
+     * metadata is provided by the backend for this endpoint.
+     */
+    async getCompanies() {
+        return await this.get(resourceName);
+    }
+}

package/build/companies/types.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Admin Companies API — types.
+ *
+ * Mirrors `/admin/companies` on the Narrative Data Collaboration Platform.
+ * Requires a bearer token with the `admin:company_info` permission.
+ */
+export type CompanyStatus = "active" | "pending" | "archived";
+export type CompanyVisibility = "visible" | "invisible" | "invisible-in-discover";
+export interface CompanyAdminResponse {
+    id: number;
+    company_type: string | null;
+    contact: string | null;
+    created_at: string;
+    description_long: string | null;
+    description_short: string | null;
+    image_url: string | null;
+    location: string | null;
+    name: string;
+    size: string | null;
+    status: CompanyStatus;
+    updated_at: string | null;
+    visibility: CompanyVisibility;
+    website: string | null;
+    credit_limit_usd: number;
+    check_datashops_credit_limit: boolean;
+    slug: string | null;
+}

package/build/companies/types.js

@@ -0,0 +1,7 @@
+/**
+ * Admin Companies API — types.
+ *
+ * Mirrors `/admin/companies` on the Narrative Data Collaboration Platform.
+ * Requires a bearer token with the `admin:company_info` permission.
+ */
+export {};

package/build/index.d.ts

@@ -7,6 +7,7 @@ export * from "./attributes";
 export * from "./authentication";
 export * from "./base-api";
 export * from "./collaboration-policy";
+export * from "./companies";
 export * from "./company-info";
 export * from "./compute-pools";
 export * from "./compute-pools/types";
@@ -61,6 +62,7 @@ import { AppsApi } from "./apps";
 import { AttributeApi, AttributeApiV2 } from "./attributes";
 import { AuthenticationApi } from "./authentication";
 import { BaseApi } from "./base-api";
+import { CompaniesApi } from "./companies";
 import { CompanyInfoApi } from "./company-info";
 import { ComputePoolsApi } from "./compute-pools";
 import { ConnectionsApi } from "./connections";
@@ -89,6 +91,6 @@ import { WhoAmIApi } from "./whoami";
 import { WorkflowsApi } from "./workflows";
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, ModelTrainingApi, ModelInferenceApi, EncryptionMaterialApi, WhoAmIApi, WorkflowsApi, ComputePoolsApi, AgentsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, ModelTrainingApi, ModelInferenceApi, EncryptionMaterialApi, WhoAmIApi, WorkflowsApi, ComputePoolsApi, AgentsApi, CompaniesApi {
 }
 export { NarrativeApi };

package/build/index.js

@@ -7,6 +7,7 @@ export * from "./attributes";
 export * from "./authentication";
 export * from "./base-api";
 export * from "./collaboration-policy";
+export * from "./companies";
 export * from "./company-info";
 export * from "./compute-pools";
 export * from "./compute-pools/types";
@@ -62,6 +63,7 @@ import { AttributeApi, AttributeApiV2 } from "./attributes";
 import { AuthenticationApi } from "./authentication";
 // Handle the NarrativeApi class with mixins
 import { BaseApi } from "./base-api";
+import { CompaniesApi } from "./companies";
 import { CompanyInfoApi } from "./company-info";
 import { ComputePoolsApi } from "./compute-pools";
 import { ConnectionsApi } from "./connections";
@@ -126,5 +128,6 @@ applyMixins(NarrativeApi, [
     WorkflowsApi,
     ComputePoolsApi,
     AgentsApi,
+    CompaniesApi,
 ]);
 export { NarrativeApi };

package/build/installations/index.d.ts

@@ -1,6 +1,6 @@
 import { BaseApi } from "../base-api";
 import type { ApiRecords, ApiRecordsV2 } from "../types";
-import type { AppCategory, CreateInstallationRequest, Installation, InstallationInfo, Profile } from "./types";
+import type { AppCategory, CreateInstallationRequest, Installation, InstallationAccessToken, InstallationInfo, Profile } from "./types";
 export interface ListInstallationsOptions {
     appCategory?: AppCategory | AppCategory[];
     page?: number;
@@ -33,5 +33,12 @@ declare class InstallationsApi extends BaseApi {
      */
     deleteInstallation(installationId: number): Promise<void>;
     getInstallationProfiles(installationId: number): Promise<ApiRecords<Profile>>;
+    /**
+     * Create an installation-scoped access token on behalf of the authenticated
+     * user. Requires a user-bound bearer token (app client-credentials tokens
+     * return 403). 404 if the installation does not exist or does not belong to
+     * the caller's company.
+     */
+    createInstallationToken(installationId: number): Promise<InstallationAccessToken>;
 }
-export { type AppCategory, type CreateInstallationRequest, type Installation, type InstallationInfo, InstallationsApi, type Profile, };
+export { type AppCategory, type CreateInstallationRequest, type Installation, type InstallationAccessToken, type InstallationInfo, InstallationsApi, type Profile, };

package/build/installations/index.js

@@ -45,5 +45,14 @@ class InstallationsApi extends BaseApi {
         const url = `${resourceName}/${installationId}/profiles`;
         return await this.get(url);
     }
+    /**
+     * Create an installation-scoped access token on behalf of the authenticated
+     * user. Requires a user-bound bearer token (app client-credentials tokens
+     * return 403). 404 if the installation does not exist or does not belong to
+     * the caller's company.
+     */
+    async createInstallationToken(installationId) {
+        return await this.post(`${resourceName}/${installationId}/token`);
+    }
 }
 export { InstallationsApi, };

package/build/installations/types.d.ts

@@ -26,3 +26,9 @@ export interface Profile {
     description: string;
     status: ProfileStatus;
 }
+export interface InstallationAccessToken {
+    access_token: string;
+    access_token_expires_in: number;
+    refresh_token: string;
+    refresh_token_expires_in: number;
+}

package/build/jobs/index.d.ts

@@ -1,14 +1,15 @@
 import { BaseApi } from "../base-api";
-import type { ApiRecords } from "../types";
+import type { ApiRecordsV2 } from "../types";
 import type { CalculateAffectedRowsInput, CalculateAffectedRowsJob, CollectAccessRulesBillingDataInput, CollectAccessRulesBillingDataJob, CollectAccessRulesBillingDataResult, ColumnDetails, ColumnStatDataType, CostsInput, CostsJob, CreateTableInput, DatasetsCalculateColumnStatsJob, DatasetsCreateTableJob, DatasetsDeleteTableJob, DatasetsDeliverDataJob, DatasetsEnforceRowTtlRetentionPolicyJob, DatasetsEnforceTableTtlRetentionPolicyJob, DatasetsExecuteDmlJob, DatasetsExecuteSelectJob, DatasetsSampleJob, DatasetsSuggestMappingsJob, DatasetsTruncateTableJob, DeleteInput, DeliverInput, EnabledColumnStatFlags, EnforceRowTtlRetentionPolicyInput, EnforceTableTtlRetentionPolicyInput, ExecuteDmlInput, ExecuteDmlResult, ExecuteSelectInput, ExecuteSelectResult, ExplainInput, ExplainJob, ExplainOutput, ForecastInput, ForecastInternalJob, ForecastJob, HealthCheckJob, Job, JobExecutionCluster, JobRequestSource, JobRequestSourceApiUser, JobRequestSourceProcess, JobType, KnownJob, MaterializedViewInput, MaterializedViewJob, MaterializedViewOutput, MaterializedViewRowStats, ModelInferenceRunInput, ModelInferenceRunJob, ModelInferenceRunJobResult, ModelsDeliverModelInput, ModelsDeliverModelJob, ModelsTrainClassifierJob, ModelTrainingRunInput, ModelTrainingRunJob, RefreshMaterializedViewResult, SampleInput, StatsInput, StatsInputV2, SuggestMappingsInput, SuggestMappingsResult, TruncateTableInput } from "./types";
 import { isKnownJob, KNOWN_JOB_TYPES } from "./types";
-interface GetJobsParameters extends Record<string, string | number | boolean | undefined> {
+type JobStateFilter = "cancelled" | "completed" | "failed" | "pending" | "pending_cancellation" | "running";
+interface GetJobsParameters extends Record<string, string | number | boolean | string[] | undefined> {
     dataset_id?: number;
     per_page?: number;
     offset?: number;
-    order_by?: "created_at_asc" | "created_at_desc";
-    state?: "cancelled" | "completed" | "failed" | "pending" | "pending_cancellation" | "running";
-    type?: string;
+    order_by?: "created_at_asc" | "created_at_desc" | "updated_at_asc" | "updated_at_desc";
+    state?: JobStateFilter | JobStateFilter[];
+    type?: string | string[];
 }
 /**
  * @module JobsApi
@@ -18,9 +19,10 @@ interface GetJobsParameters extends Record<string, string | number | boolean | u
 declare class JobsApi extends BaseApi {
     /**
      * Get all jobs for the current company
-     * @returns {Promise<ApiRecords<Job>>} - Promise resolving with the list of jobs.
+     * @returns {Promise<ApiRecordsV2<Job>>} - Promise resolving with a page of jobs plus pagination
+     *   metadata (current_page, total_pages, total_records, prev_page, next_page).
      */
-    getJobs(parameters?: GetJobsParameters): Promise<ApiRecords<Job>>;
+    getJobs(parameters?: GetJobsParameters): Promise<ApiRecordsV2<Job>>;
     /**
      * Get a specific job by id
      * @returns {Promise<Job>} - Promise resolving with the job.
@@ -32,4 +34,4 @@ declare class JobsApi extends BaseApi {
      */
     cancelJob(jobId: string): Promise<void>;
 }
-export { type CalculateAffectedRowsInput, type CalculateAffectedRowsJob, type CollectAccessRulesBillingDataInput, type CollectAccessRulesBillingDataJob, type CollectAccessRulesBillingDataResult, type ColumnDetails, type ColumnStatDataType, type CostsInput, type CostsJob, type CreateTableInput, type DatasetsCalculateColumnStatsJob, type DatasetsCreateTableJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsEnforceRowTtlRetentionPolicyJob, type DatasetsEnforceTableTtlRetentionPolicyJob, type DatasetsExecuteDmlJob, type DatasetsExecuteSelectJob, type DatasetsSampleJob, type DatasetsSuggestMappingsJob, type DatasetsTruncateTableJob, type DeleteInput, type DeliverInput, type EnabledColumnStatFlags, type EnforceRowTtlRetentionPolicyInput, type EnforceTableTtlRetentionPolicyInput, type ExecuteDmlInput, type ExecuteDmlResult, type ExecuteSelectInput, type ExecuteSelectResult, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastInternalJob, type ForecastJob, type GetJobsParameters, type HealthCheckJob, isKnownJob, type Job, type JobExecutionCluster, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, JobsApi, type JobType, KNOWN_JOB_TYPES, type KnownJob, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type MaterializedViewRowStats, type ModelInferenceRunInput, type ModelInferenceRunJob, type ModelInferenceRunJobResult, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type ModelsTrainClassifierJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type RefreshMaterializedViewResult, type SampleInput, type StatsInput, type StatsInputV2, type SuggestMappingsInput, type SuggestMappingsResult, type TruncateTableInput, };
+export { type CalculateAffectedRowsInput, type CalculateAffectedRowsJob, type CollectAccessRulesBillingDataInput, type CollectAccessRulesBillingDataJob, type CollectAccessRulesBillingDataResult, type ColumnDetails, type ColumnStatDataType, type CostsInput, type CostsJob, type CreateTableInput, type DatasetsCalculateColumnStatsJob, type DatasetsCreateTableJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsEnforceRowTtlRetentionPolicyJob, type DatasetsEnforceTableTtlRetentionPolicyJob, type DatasetsExecuteDmlJob, type DatasetsExecuteSelectJob, type DatasetsSampleJob, type DatasetsSuggestMappingsJob, type DatasetsTruncateTableJob, type DeleteInput, type DeliverInput, type EnabledColumnStatFlags, type EnforceRowTtlRetentionPolicyInput, type EnforceTableTtlRetentionPolicyInput, type ExecuteDmlInput, type ExecuteDmlResult, type ExecuteSelectInput, type ExecuteSelectResult, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastInternalJob, type ForecastJob, type GetJobsParameters, type HealthCheckJob, isKnownJob, type Job, type JobExecutionCluster, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, type JobStateFilter, JobsApi, type JobType, KNOWN_JOB_TYPES, type KnownJob, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type MaterializedViewRowStats, type ModelInferenceRunInput, type ModelInferenceRunJob, type ModelInferenceRunJobResult, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type ModelsTrainClassifierJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type RefreshMaterializedViewResult, type SampleInput, type StatsInput, type StatsInputV2, type SuggestMappingsInput, type SuggestMappingsResult, type TruncateTableInput, };

package/build/jobs/index.js

@@ -9,7 +9,8 @@ const resourceName = "jobs";
 class JobsApi extends BaseApi {
     /**
      * Get all jobs for the current company
-     * @returns {Promise<ApiRecords<Job>>} - Promise resolving with the list of jobs.
+     * @returns {Promise<ApiRecordsV2<Job>>} - Promise resolving with a page of jobs plus pagination
+     *   metadata (current_page, total_pages, total_records, prev_page, next_page).
      */
     async getJobs(parameters) {
         const queryString = this.constructQueryString(parameters);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "2.106.0",
+	"version": "2.108.0",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",
@@ -28,20 +28,20 @@
 		"@babel/core": "7.29.7",
 		"@babel/preset-env": "7.29.7",
 		"@babel/preset-typescript": "7.29.7",
-		"@biomejs/biome": "2.4.15",
-		"@commitlint/cli": "21.0.1",
-		"@commitlint/config-conventional": "21.0.1",
+		"@biomejs/biome": "2.4.16",
+		"@commitlint/cli": "21.0.2",
+		"@commitlint/config-conventional": "21.0.2",
 		"@types/jest": "30.0.0",
 		"@types/json-schema": "7.0.15",
 		"babel-jest": "30.4.1",
 		"jest": "30.4.2",
-		"lefthook": "2.1.8",
+		"lefthook": "2.1.9",
 		"ts-jest": "29.4.11"
 	},
 	"dependencies": {
 		"mande": "2.0.9",
 		"zod": "4.4.3",
-		"bignumber.js": "11.1.1"
+		"bignumber.js": "11.1.2"
 	},
 	"overrides": {
 		"semver@<7.5.2": "7.5.2"