@narrative.io/data-collaboration-sdk-ts 2.58.0 → 2.59.0

package/README.md

@@ -1,18 +1,316 @@
-# SDK
+# Narrative.io Data Collaboration SDK for TypeScript
 
-## Make a release
+[![npm version](https://img.shields.io/npm/v/@narrative.io/data-collaboration-sdk-ts.svg)](https://www.npmjs.com/package/@narrative.io/data-collaboration-sdk-ts)
 
-To make a new release of the SDK, create a branch, make your changes, create a commit with a message following this
-format: `chore(main): release x.y.z` where x.y.z is the release number that you want. You can calculate it like this:
+The official TypeScript SDK for the Narrative.io Data Collaboration Platform. This SDK provides a simple and intuitive interface for interacting with Narrative's APIs, allowing you to manage datasets, subscriptions, data streams, and more.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [API Overview](#api-overview)
+- [Usage Examples](#usage-examples)
+- [Configuration](#configuration)
+- [TypeScript Support](#typescript-support)
+- [Error Handling](#error-handling)
+- [API Reference](#api-reference)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Install the SDK using npm:
+
+```bash
+npm install @narrative.io/data-collaboration-sdk-ts
+```
+
+Or using yarn:
+
+```bash
+yarn add @narrative.io/data-collaboration-sdk-ts
+```
+
+Or using bun:
 
 ```bash
-VERSION=$(cat package.json | jq -r .version); \
-PATCH=$(expr $(echo $VERSION|cut -f3 -d.) + 1); \
-NEW_VERSION=$(printf "$(echo $VERSION | cut -f1,2 -d.).$PATCH\n"); \
-echo $NEW_VERSION | pbcopy; \
-echo "The new VERSION=${NEW_VERSION} is in your clipboard."
+bun add @narrative.io/data-collaboration-sdk-ts
+```
+
+## Quick Start
+
+```typescript
+import { NarrativeApi } from '@narrative.io/data-collaboration-sdk-ts';
+
+// Initialize the SDK with your API key
+const narrative = new NarrativeApi({
+  apiKey: 'your-api-key-here',
+  environment: 'prod' // 'prod' or 'dev'
+});
+
+// Make your first API call
+async function getMyCompanyInfo() {
+  try {
+    const companyInfo = await narrative.getCompanyInfo();
+    console.log('Company:', companyInfo);
+  } catch (error) {
+    console.error('Error:', error);
+  }
+}
+
+getMyCompanyInfo();
+```
+
+## API Overview
+
+The SDK provides access to the following Narrative.io API modules:
+
+### Core APIs
+- **Authentication** - Manage API authentication
+- **Company Info** - Retrieve company information
+- **Health Check** - Check API health status
+- **Who Am I** - Get current user information
+
+### Data Management
+- **Datasets** - Create and manage datasets
+- **Data Streams** - Configure real-time data streams
+- **Data Planes** - Manage data plane configurations
+- **Subscriptions** - Handle data subscriptions
+- **Uploads** - Upload data files
+
+### Data Operations
+- **Queries** - Execute data queries
+- **Forecast** - Generate data forecasts
+- **NQL (Narrative Query Language)** - Build and execute NQL queries
+- **Views** - Create and manage data views
+
+### Marketplace & Collaboration
+- **Products** - Browse and manage data products
+- **Contracts** - Handle data contracts
+- **Connections** - Manage data connections
+- **Installations** - Track app installations
+
+### Advanced Features
+- **Attributes** - Define data attributes
+- **Mappings** - Configure data mappings
+- **Models** - Work with ML models
+- **Model Training** - Train custom models
+- **Rosetta Stone** - Data transformation tools
+- **Access Rules** - Set data access permissions
+- **Access Tokens** - Manage API tokens
+- **Encryption Materials** - Handle encryption keys
+
+## Usage Examples
+
+### Working with Datasets
+
+```typescript
+// List all datasets
+const datasets = await narrative.getDatasets();
+console.log(`Found ${datasets.length} datasets`);
+
+// Get a specific dataset
+const datasetId = 'your-dataset-id';
+const dataset = await narrative.getDataset(datasetId);
+console.log('Dataset name:', dataset.name);
+
+// Create a new dataset
+const newDataset = await narrative.createDataset({
+  name: 'My New Dataset',
+  description: 'A dataset created via SDK',
+  schema: {
+    // Your schema definition
+  }
+});
+```
+
+### Managing Subscriptions
+
+```typescript
+// List active subscriptions
+const subscriptions = await narrative.getSubscriptions();
+subscriptions.forEach(sub => {
+  console.log(`Subscription: ${sub.name} - Status: ${sub.status}`);
+});
+
+// Create a subscription
+const subscription = await narrative.createSubscription({
+  name: 'Daily Data Feed',
+  datasetId: 'dataset-id',
+  frequency: 'daily'
+});
+```
+
+### Executing NQL Queries
+
+```typescript
+// Build and execute an NQL query
+const nqlQuery = `
+  SELECT *
+  FROM narrative.datasets
+  WHERE created_date >= '2024-01-01'
+  LIMIT 100
+`;
+
+const results = await narrative.executeNql(nqlQuery);
+console.log('Query returned', results.rows.length, 'rows');
+```
+
+### Uploading Data
+
+```typescript
+// Upload a file to a dataset
+const upload = await narrative.createUpload({
+  datasetId: 'your-dataset-id',
+  fileName: 'data.csv',
+  fileSize: 1024000 // Size in bytes
+});
+
+// Get the upload URL and upload your file
+console.log('Upload URL:', upload.uploadUrl);
+// Use the uploadUrl to PUT your file data
+```
+
+## Configuration
+
+### Environment Configuration
+
+The SDK supports multiple environments:
+
+```typescript
+// Production environment (default)
+const narrativeProd = new NarrativeApi({
+  apiKey: 'your-api-key'
+});
+
+// Development environment
+const narrativeDev = new NarrativeApi({
+  apiKey: 'your-api-key',
+  environment: 'dev'
+});
+```
+
+### Custom Headers
+
+Add custom headers to all requests:
+
+```typescript
+const narrative = new NarrativeApi({
+  apiKey: 'your-api-key',
+  headers: {
+    'X-Custom-Header': 'custom-value'
+  }
+});
+```
+
+### API Key Management
+
+Store your API key securely using environment variables:
+
+```typescript
+// .env file
+NARRATIVE_API_KEY=your-api-key-here
+
+// Your code
+import { NarrativeApi } from '@narrative.io/data-collaboration-sdk-ts';
+
+const narrative = new NarrativeApi({
+  apiKey: process.env.NARRATIVE_API_KEY!
+});
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and provides comprehensive type definitions:
+
+```typescript
+import { 
+  NarrativeApi,
+  Dataset,
+  Subscription,
+  DataStream,
+  NqlQuery
+} from '@narrative.io/data-collaboration-sdk-ts';
+
+// Type-safe API calls
+const narrative = new NarrativeApi({
+  apiKey: 'your-api-key'
+});
+
+// TypeScript will provide intellisense and type checking
+const dataset: Dataset = await narrative.getDataset('dataset-id');
+const subscriptions: Subscription[] = await narrative.getSubscriptions();
+```
+
+### Working with Types
+
+```typescript
+import type { 
+  Config,
+  PaginationOptions,
+  Dataset,
+  CreateDatasetRequest 
+} from '@narrative.io/data-collaboration-sdk-ts';
+
+// Use types for better code organization
+const config: Config = {
+  apiKey: process.env.NARRATIVE_API_KEY!,
+  environment: 'prod'
+};
+
+const paginationOptions: PaginationOptions = {
+  limit: 100,
+  offset: 0
+};
 ```
 
-Push your changes to the branch, merge it to the `main` branch. Once the merge is completed (i.e., github actions
-completed) a new release pull request will be available on the github project. Merge the new pull request and the
-github actions will publish the new version of the SKD for you.
+## Error Handling
+
+The SDK provides detailed error information:
+
+```typescript
+import { NarrativeApi } from '@narrative.io/data-collaboration-sdk-ts';
+
+const narrative = new NarrativeApi({
+  apiKey: 'your-api-key'
+});
+
+try {
+  const dataset = await narrative.getDataset('non-existent-id');
+} catch (error) {
+  if (error.response) {
+    // API returned an error response
+    console.error('API Error:', error.response.status);
+    console.error('Error Message:', error.response.data.message);
+  } else if (error.request) {
+    // Request was made but no response received
+    console.error('Network Error:', error.message);
+  } else {
+    // Something else happened
+    console.error('Error:', error.message);
+  }
+}
+```
+
+### Common Error Patterns
+
+```typescript
+// Handle specific error codes
+try {
+  const result = await narrative.someApiCall();
+} catch (error) {
+  if (error.response?.status === 401) {
+    console.error('Authentication failed. Check your API key.');
+  } else if (error.response?.status === 404) {
+    console.error('Resource not found.');
+  } else if (error.response?.status === 429) {
+    console.error('Rate limit exceeded. Please retry later.');
+  } else {
+    console.error('Unexpected error:', error);
+  }
+}
+```
+
+## API Reference
+
+For detailed API documentation, please visit the [Narrative.io API Documentation](https://api.narrative.dev).

package/build/index.d.ts

@@ -1,53 +1,82 @@
-import { type AccessRule, AccessRulesApi, type AccessRuleV2, type CreateAccessRuleV2Request, type GetAccessRulesParameters, type OwnedAccessRule, type SharedAccessRule, type UpdateAccessRuleV2Request } from "./access-rules/";
-import type { AccessRuleSchema } from "./access-rules/types";
-import { type AccessTokenMetadata, AccessTokensApi, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest } from "./access-tokens";
-import { type Permission, resources } from "./access-tokens/types";
-import { type App, AppsApi } from "./apps";
+export * from "./access-rules/";
+export * from "./access-tokens";
+export { resources } from "./access-tokens/types";
+export type { App } from "./apps";
+export * from "./attributes";
+export * from "./authentication";
+export * from "./base-api";
+export * from "./company-info";
+export * from "./connections";
+export * from "./contracts";
+export * from "./data-planes";
+export * from "./data-planes/types";
+export * from "./data-streams";
+export * from "./datasets";
+export * from "./datasets/types";
+export * from "./encryption-materials";
+export * from "./encryption-materials/types";
+export * from "./forecast";
+export * from "./health";
+export * from "./health/types";
+export * from "./installations";
+export * from "./jobs";
+export { default as JsonBigNumber } from "./json-big-number";
+export * from "./mappings";
+export * from "./mappings/types";
+export * from "./model-training";
+export * from "./models";
+export * from "./nql";
+export { compileStatement, parseStatement } from "./nql";
+export { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
+export { buildNql, getNqlObject } from "./nql/NQLParser";
+export type { AstNodeMetadata, AstNodeType, ForecastBody } from "./nql/types";
+export * from "./ping";
+export * from "./ping/types";
+export * from "./products";
+export * from "./queries";
+export * from "./resources";
+export * from "./rosetta/types";
+export * from "./rosetta-stone";
+export * from "./rosetta-stone/types";
+export * from "./subscriptions";
+export * from "./types";
+export * from "./uploads";
+export * from "./uploads/types";
+export { applyMixins } from "./utils";
+export * from "./views";
+export * from "./whoami";
+export * from "./whoami/types";
+import { AccessRulesApi } from "./access-rules/";
+import { AccessTokensApi } from "./access-tokens";
+import { AppsApi } from "./apps";
 import { AttributeApi, AttributeApiV2 } from "./attributes";
-import type { ArrayAttribute, Attribute, ObjectAttribute, PrimitiveAttribute, RefAttribute, ShallowAttribute, SubAttribute } from "./attributes/types";
-import { type ApiToken, AuthenticationApi, type LoggedInUser, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type StytchToken, type UserRole } from "./authentication";
+import { AuthenticationApi } from "./authentication";
 import { BaseApi } from "./base-api";
-import { type CompanyInfo, CompanyInfoApi } from "./company-info";
-import { type Connection, ConnectionsApi } from "./connections";
-import { type ContractDetails, type ContractRateView, ContractsApi, type CustomerContract, type PaymentMethod } from "./contracts";
+import { CompanyInfoApi } from "./company-info";
+import { ConnectionsApi } from "./connections";
+import { ContractsApi } from "./contracts";
 import { DataPlaneApi } from "./data-planes";
-import type { DataPlane } from "./data-planes/types";
-import { type AttributeSet, type ColumnSet, type ColumnWithFilterAndExport, type DataRules, type DataStream, DataStreamsApi } from "./data-streams";
+import { DataStreamsApi } from "./data-streams";
 import { DatasetApi } from "./datasets";
-import type { AdvancedStatistics, AdvancedStatisticsMetadata, BasicStatistics, ColumnStatistics, ColumnSummary, Columns, Configuration, CreateDatasetRefreshScheduleRequest, CreateDatasetRequest, Dataset, DatasetStatus, DatasetTableSummary, DatasetTableSummaryAPIResponse, DatasetWriteMode, FilePerSnapshotResponse, Histogram, IngestDatasetFileRequest, RetentionPolicy, Schema, SchemaArrayItems, SchemaArrayItemsArray, SchemaArrayItemsObject, SchemaArrayItemsPrimitive, SchemaArrayProperty, SchemaFileConfig, SchemaFileConfigType, SchemaObjectProperty, SchemaPrimitiveProperty, SchemaProperties, SchemaPropertiesType, SchemaProperty, SnapshotRange, UpdateDatasetRefreshScheduleRequest, UpdateDatasetRequest, Value } from "./datasets/types";
 import { EncryptionMaterialApi } from "./encryption-materials";
-import type { BaseDataEncryptionMaterial, CreateEncryptionMaterialRequest, DataEncryptionMaterial, OwnedDataEncryptionMaterial, SharedDataEncryptionMaterial, UpdateEncryptionMaterialRequest } from "./encryption-materials/types";
-import { type CostForecastRequest, type CostForecastResponse, type CostForecastResult, ForecastApi, type ForecastRequest, type ForecastResponse, type ForecastResult, type ForecastResultFailure, type JobState } from "./forecast";
+import { ForecastApi } from "./forecast";
 import { HealthCheckApi } from "./health";
-import type { HealthCheckResult } from "./health/types";
-import { type Installation, InstallationsApi, type Profile } from "./installations";
-import { type ColumnDetails, type DatasetsCalculateColumnStatsJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsSampleJob, type DeleteInput, type DeliverInput, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastJob, type GetJobsParameters, type Job, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, JobsApi, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type SampleInput, type StatsInput } from "./jobs";
-import JsonBigNumber from "./json-big-number";
-import { type Mapping, MappingsApi, type MappingTestResult } from "./mappings";
-import type { CreateMapping, ObjectMapping, ValueMapping } from "./mappings/types";
-import { ModelTrainingApi, type ModelTrainingConfig, type OutputModel, type TrainModelRequest, type TrainModelResponse } from "./model-training";
-import { type CreateModelRequest, type Model, type ModelCollaborators, ModelsApi, type UpdateModelRequest } from "./models";
-import { type CompiledNql, type CreateMaterializedView, compileStatement, type Deduplication, type Explain, type Expression, type Nql, NqlApi, type NqlAst, type NqlBooleanExpression, type NqlCompileResult, type NqlExpression, type NqlField, type NqlFilterBinaryExpression, type NqlFilterExpression, type NqlFilterUnaryExpression, type NqlQueryInput, type NqlResult, type NqlWhere, parseStatement, type Raw, type Select, type Statement, type Table } from "./nql";
-import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
-import { buildNql, getNqlObject } from "./nql/NQLParser";
-import type { AstNodeMetadata, AstNodeType, ForecastBody } from "./nql/types";
+import { InstallationsApi } from "./installations";
+import { JobsApi } from "./jobs";
+import { MappingsApi } from "./mappings";
+import { ModelTrainingApi } from "./model-training";
+import { ModelsApi } from "./models";
+import { NqlApi } from "./nql";
 import { PingApi } from "./ping";
-import type { PingStatus } from "./ping/types";
-import { type Product, ProductsApi } from "./products";
-import { type CreateNqlQueryRequest, type NqlOwnedQueryResponse, type NqlQueryAst, type NqlQueryCollaborators, type NqlQueryMetadata, type NqlQueryOwner, type NqlQueryResponse, type NqlSharedQueryResponse, QueriesApi, type UpdateNqlQueryRequest } from "./queries";
-import { type BucketCreationRequest, type Resource, ResourceApi, type UpdateAccessTypeRequest } from "./resources";
-import { type ConversationAssistantMessage, type ConversationAssistantMessageWithFunctionCall, type ConversationAssistantMessageWithoutFunctionCall, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageFunctionCall, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, isConversationAssistantMessage, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageFunctionCall, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isRosettaRequestMessage, isType, type RosettaRequestMessage, type RosettaResponseMessage } from "./rosetta/types";
+import { QueriesApi } from "./queries";
+import { ResourceApi } from "./resources";
 import { RosettaStoneApi } from "./rosetta-stone";
-import type { SampleRecords } from "./rosetta-stone/types";
-import { type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type Subscription, type SubscriptionBudget, type SubscriptionDetails, type SubscriptionOutput, type SubscriptionStatus, SubscriptionsApi, type SubscriptionType } from "./subscriptions";
-import type { ApiRecords, ApiRecordsV2, CollaboratorList, CollaboratorsConfig, Config, Environment, GeneralCollaborator, GeneralCollaboratorType, MonetaryAmount, NonAuthenticatedCollaborator, QueryAccess, QueryCollaborator, SpecificCollaboratorType, ViewAccess, ViewCollaborator } from "./types";
+import { SubscriptionsApi } from "./subscriptions";
 import { UploadsApi } from "./uploads";
-import type { UploadsResponse } from "./uploads/types";
-import { type CreateViewRequest, type OwnedView, type SharedView, type UpdateViewRequest, type View, type ViewOwner, ViewsApi } from "./views";
+import { ViewsApi } from "./views";
 import { WhoAmIApi } from "./whoami";
-import type { User } from "./whoami/types";
 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, EncryptionMaterialApi, WhoAmIApi {
 }
-export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, EncryptionMaterialApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, ModelTrainingApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, type DataPlane, type AccessTokenMetadata, type CreateSystemAccessTokenRequest, type CreateSystemAccessTokenResponse, type UpdateSystemAccessTokenRequest, type App, type Resource, type AccessRuleV2, type GetAccessRulesParameters, type CreateAccessRuleV2Request, type UpdateAccessRuleV2Request, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type Connection, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type ApiRecordsV2, type GeneralCollaboratorType, type SpecificCollaboratorType, type NonAuthenticatedCollaborator, type CollaboratorList, type GeneralCollaborator, type QueryCollaborator, type ViewCollaborator, type QueryAccess, type ViewAccess, type CollaboratorsConfig, type Dataset, type HealthCheckResult, type SampleRecords, type Permission, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type UpdateDatasetRequest, type UpdateDatasetRefreshScheduleRequest, type CreateDatasetRefreshScheduleRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type ForecastResult, type CostForecastResult, type ForecastResultFailure, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type AstNodeType, type AstNodeMetadata, type SharedAccessRule, type OwnedAccessRule, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type AccessRuleSchema, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, type Job, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, type ForecastInput, type ForecastJob, type ExplainInput, type ExplainJob, type ExplainOutput, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type DeleteInput, type DatasetsDeleteTableJob, type DeliverInput, type DatasetsDeliverDataJob, type SampleInput, type DatasetsSampleJob, type ColumnDetails, type StatsInput, type DatasetsCalculateColumnStatsJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type GetJobsParameters, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, type CreateNqlQueryRequest, type UpdateNqlQueryRequest, type NqlQueryResponse, type NqlSharedQueryResponse, type NqlOwnedQueryResponse, type NqlQueryCollaborators, type NqlQueryOwner, type NqlQueryMetadata, type NqlQueryAst, type View, type OwnedView, type SharedView, type ViewOwner, type CreateViewRequest, type UpdateViewRequest, type OutputModel, type TrainModelRequest, type TrainModelResponse, type ModelTrainingConfig, type CreateModelRequest, type Model, type ModelCollaborators, type UpdateModelRequest, type CreateEncryptionMaterialRequest, type DataEncryptionMaterial, type BaseDataEncryptionMaterial, type OwnedDataEncryptionMaterial, type SharedDataEncryptionMaterial, type UpdateEncryptionMaterialRequest, compileStatement, parseStatement, JsonBigNumber, };
+export { NarrativeApi };

package/build/index.js

@@ -1,38 +1,81 @@
-import { AccessRulesApi, } from "./access-rules/";
-import { AccessTokensApi, } from "./access-tokens";
-import { resources } from "./access-tokens/types";
+// This approach maintains EXACT same exports as before
+export * from "./access-rules/";
+export * from "./access-tokens";
+export { resources } from "./access-tokens/types";
+export * from "./attributes";
+export * from "./authentication";
+export * from "./base-api";
+export * from "./company-info";
+export * from "./connections";
+export * from "./contracts";
+export * from "./data-planes";
+export * from "./data-planes/types";
+export * from "./data-streams";
+export * from "./datasets";
+export * from "./datasets/types";
+export * from "./encryption-materials";
+export * from "./encryption-materials/types";
+export * from "./forecast";
+export * from "./health";
+export * from "./health/types";
+export * from "./installations";
+export * from "./jobs";
+// Special imports that might be from default exports or need special handling
+export { default as JsonBigNumber } from "./json-big-number";
+export * from "./mappings";
+export * from "./mappings/types";
+export * from "./model-training";
+export * from "./models";
+export * from "./nql";
+export { compileStatement, parseStatement } from "./nql";
+export { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
+export { buildNql, getNqlObject } from "./nql/NQLParser";
+export * from "./ping";
+export * from "./ping/types";
+export * from "./products";
+export * from "./queries";
+export * from "./resources";
+export * from "./rosetta/types";
+export * from "./rosetta-stone";
+export * from "./rosetta-stone/types";
+export * from "./subscriptions";
+export * from "./types";
+export * from "./uploads";
+export * from "./uploads/types";
+export { applyMixins } from "./utils";
+export * from "./views";
+export * from "./whoami";
+export * from "./whoami/types";
+import { AccessRulesApi } from "./access-rules/";
+import { AccessTokensApi } from "./access-tokens";
 import { AppsApi } from "./apps";
 import { AttributeApi, AttributeApiV2 } from "./attributes";
-import { AuthenticationApi, } from "./authentication";
+import { AuthenticationApi } from "./authentication";
+// Handle the NarrativeApi class with mixins
 import { BaseApi } from "./base-api";
 import { CompanyInfoApi } from "./company-info";
 import { ConnectionsApi } from "./connections";
-import { ContractsApi, } from "./contracts";
+import { ContractsApi } from "./contracts";
 import { DataPlaneApi } from "./data-planes";
-import { DataStreamsApi, } from "./data-streams";
+import { DataStreamsApi } from "./data-streams";
 import { DatasetApi } from "./datasets";
 import { EncryptionMaterialApi } from "./encryption-materials";
-import { ForecastApi, } from "./forecast";
+import { ForecastApi } from "./forecast";
 import { HealthCheckApi } from "./health";
-import { InstallationsApi, } from "./installations";
-import { JobsApi, } from "./jobs";
-import JsonBigNumber from "./json-big-number";
+import { InstallationsApi } from "./installations";
+import { JobsApi } from "./jobs";
 import { MappingsApi } from "./mappings";
-import { ModelTrainingApi, } from "./model-training";
-import { ModelsApi, } from "./models";
-import { compileStatement, NqlApi, parseStatement, } from "./nql";
-import { convertNqlObjectToForecastBody } from "./nql/DataRulesConverter";
-import { buildNql, getNqlObject } from "./nql/NQLParser";
+import { ModelTrainingApi } from "./model-training";
+import { ModelsApi } from "./models";
+import { NqlApi } from "./nql";
 import { PingApi } from "./ping";
-import { ProductsApi } from "./products";
-import { QueriesApi, } from "./queries";
-import { ResourceApi, } from "./resources";
-import { isConversationAssistantMessage, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageFunctionCall, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isRosettaRequestMessage, isType, } from "./rosetta/types";
+import { QueriesApi } from "./queries";
+import { ResourceApi } from "./resources";
 import { RosettaStoneApi } from "./rosetta-stone";
-import { SubscriptionsApi, } from "./subscriptions";
+import { SubscriptionsApi } from "./subscriptions";
 import { UploadsApi } from "./uploads";
 import { applyMixins } from "./utils";
-import { ViewsApi, } from "./views";
+import { ViewsApi } from "./views";
 import { WhoAmIApi } from "./whoami";
 class NarrativeApi extends BaseApi {
 }
@@ -68,4 +111,4 @@ applyMixins(NarrativeApi, [
     EncryptionMaterialApi,
     WhoAmIApi,
 ]);
-export { NarrativeApi, AttributeApi, AttributeApiV2, AccessTokensApi, DataPlaneApi, HealthCheckApi, DatasetApi, EncryptionMaterialApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, ModelTrainingApi, WhoAmIApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, resources, compileStatement, parseStatement, JsonBigNumber, };
+export { NarrativeApi };

package/build/jobs/types.d.ts

@@ -162,7 +162,7 @@ export interface ModelsTrainClassifierJob extends BaseJob {
     result: ModelsTrainClassifierResults;
 }
 export type Job = ForecastJob | ExplainJob | MaterializedViewJob | DatasetsDeleteTableJob | DatasetsDeliverDataJob | DatasetsSampleJob | DatasetsCalculateColumnStatsJob | ModelTrainingRunJob | ModelsDeliverModelJob | ModelsTrainClassifierJob | UnknownJob;
-interface ModelsTrainClassifierTrainingSummary {
+export interface ModelsTrainClassifierTrainingSummary {
     total_features: number;
     feature_types: Record<"text" | "categorical" | "embedding" | "numeric", number>;
     test_accuracy: number;
@@ -170,7 +170,7 @@ interface ModelsTrainClassifierTrainingSummary {
     class_names: Record<string, string>;
     error?: unknown;
 }
-interface ModelsTrainClassifierRegistryInfo {
+export interface ModelsTrainClassifierRegistryInfo {
     model_stored: boolean;
     model_name: string;
     model_version: string;
@@ -178,7 +178,7 @@ interface ModelsTrainClassifierRegistryInfo {
     registry_schema: string;
     model_task: string;
 }
-interface ModelsTrainClassifierMinimalMetrics {
+export interface ModelsTrainClassifierMinimalMetrics {
     num_classes: number;
     class_names: Record<string, string>;
     accuracy: number;
@@ -186,12 +186,12 @@ interface ModelsTrainClassifierMinimalMetrics {
     precision_macro: number;
     recall_macro: number;
 }
-interface ModelsTrainClassifierConfig {
+export interface ModelsTrainClassifierConfig {
     name: string;
     version: string;
     [key: string]: unknown;
 }
-type ModelsTrainClassifierResults = {
+export type ModelsTrainClassifierResults = {
     status: "success" | "error";
     registry_info?: ModelsTrainClassifierRegistryInfo;
     num_categories: number;
@@ -205,16 +205,16 @@ type ModelsTrainClassifierResults = {
     config: ModelsTrainClassifierConfig;
     training_summary: ModelsTrainClassifierTrainingSummary;
 };
-type Metric<V = unknown, M extends Record<string, unknown> = Record<string, unknown>> = {
+export type Metric<V = unknown, M extends Record<string, unknown> = Record<string, unknown>> = {
     value: V;
     metadata: M;
 };
-interface AveragePredictionEntropy {
+export interface AveragePredictionEntropy {
     correct_predictions: number;
     incorrect_predictions: number;
     entropy_difference: number;
 }
-interface PerClassMetricsLabeledPost {
+export interface PerClassMetricsLabeledPost {
     class: string;
     f1_score: number;
     precision: number;
@@ -224,7 +224,7 @@ interface PerClassMetricsLabeledPost {
     total_instances: number;
     correct_predictions: number;
 }
-interface EntropyStats {
+export interface EntropyStats {
     min: number;
     max: number;
     mean: number;
@@ -235,21 +235,21 @@ interface EntropyStats {
     normalized_perplexity_mean: number;
     normalized_perplexity_median: number;
 }
-interface EntropyPrioritizationHistogram {
+export interface EntropyPrioritizationHistogram {
     min: number;
     max: number;
     count: number;
     inclusive_left: number;
     inclusive_right: number;
 }
-interface TopEntropyRecord {
+export interface TopEntropyRecord {
     entropy: number;
     top5_predicted_classes: [string, number][];
     ID_COLUMN: string;
     LABEL_COLUMN: string;
     [key: string]: unknown;
 }
-interface GlobalMetrics {
+export interface GlobalMetrics {
     num_documents_corpus_pre: Metric<number, never>;
     num_documents_labeled_pre: Metric<number, never>;
     percent_labeled_corpus_pre: Metric<number, never>;
@@ -270,15 +270,15 @@ interface GlobalMetrics {
     entropy_prioritization_histogram: Metric<EntropyPrioritizationHistogram[], never>;
     top_entropy_records: Metric<TopEntropyRecord[], never>;
 }
-type TopTermsValue = Record<string, number>;
-interface FeatureError {
+export type TopTermsValue = Record<string, number>;
+export interface FeatureError {
     feature: string;
     prevalence_diff: number;
     incorrect_prevalence: number;
     correct_prevalence: number;
     ratio: number;
 }
-interface ErrorConcentration {
+export interface ErrorConcentration {
     feature: string;
     records_with_feature: number;
     errors_with_feature: number;
@@ -286,13 +286,13 @@ interface ErrorConcentration {
     overall_error_rate: number;
     error_lift: number;
 }
-interface ErrorPredictionImportance {
+export interface ErrorPredictionImportance {
     feature: string;
     correlation: number;
     p_value: number;
     abs_correlation: number;
 }
-interface DynamicTextFeatureMetrics {
+export interface DynamicTextFeatureMetrics {
     [key: `${string}_avg_doc_length_corpus_pre`]: Metric<number>;
     [key: `${string}_avg_doc_length_labeled_pre`]: Metric<number>;
     [key: `${string}_ngram_vocab_size_corpus_pre`]: Metric<number>;

package/build/model-training/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from "../base-api";
-import type { ModelTrainingConfig, OutputModel, TrainModelRequest, TrainModelResponse } from "./types";
+import type { ModelTrainingConfig, OutputModel, TrainClassifierRequest, TrainClassifierResponse, TrainModelRequest, TrainModelResponse } from "./types";
 /**
  * A class for accessing the Model Training API.
  * @extends BaseApi
@@ -12,5 +12,12 @@ declare class ModelTrainingApi extends BaseApi {
      * @returns {Promise<NqlQueryResponse>} A promise that resolves with the model training response.
      */
     trainModel(data: TrainModelRequest): Promise<TrainModelResponse>;
+    /**
+     * Trains a classifier model.
+     *
+     * @param {TrainClassifierRequest} data - The data for the classifier training.
+     * @returns {Promise<TrainClassifierResponse>} A promise that resolves with the classifier training response.
+     */
+    trainClassifier(data: TrainClassifierRequest): Promise<TrainClassifierResponse>;
 }
-export { ModelTrainingApi, type OutputModel, type TrainModelRequest, type TrainModelResponse, type ModelTrainingConfig, };
+export { ModelTrainingApi, type OutputModel, type TrainModelRequest, type TrainModelResponse, type ModelTrainingConfig, type TrainClassifierRequest, type TrainClassifierResponse, };

package/build/model-training/index.js

@@ -20,5 +20,14 @@ class ModelTrainingApi extends BaseApi {
     async trainModel(data) {
         return await this.post(`${resourceName}/run`, data);
     }
+    /**
+     * Trains a classifier model.
+     *
+     * @param {TrainClassifierRequest} data - The data for the classifier training.
+     * @returns {Promise<TrainClassifierResponse>} A promise that resolves with the classifier training response.
+     */
+    async trainClassifier(data) {
+        return await this.post("train-classifier", data);
+    }
 }
 export { ModelTrainingApi, };

package/build/model-training/types.d.ts

@@ -19,3 +19,11 @@ export interface ModelTrainingConfig {
     instance_type: string;
     custom_axolotl_config_override?: string;
 }
+export interface TrainClassifierRequest {
+    config: Record<string, unknown>;
+    data_plane_id: string;
+    tags: string[];
+}
+export interface TrainClassifierResponse {
+    job_id: string;
+}

package/build/nql/types.d.ts

@@ -336,7 +336,7 @@ export interface QueryDetails {
 export interface QueryPricing {
     micro_cents_usd: number;
 }
-export interface DataRules {
+interface DataRules {
     attributes: DataRulesAttributes[];
 }
 export interface DataRulesAttributes {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "2.58.0",
+	"version": "2.59.0",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",
@@ -26,15 +26,15 @@
 		"@biomejs/biome": "2.1.2",
 		"@commitlint/cli": "19.8.1",
 		"@commitlint/config-conventional": "19.8.1",
-		"@types/jest": "29.5.14",
-		"babel-jest": "29.7.0",
-		"jest": "29.7.0",
+		"@types/jest": "30.0.0",
+		"babel-jest": "30.0.5",
+		"jest": "30.0.5",
 		"lefthook": "1.12.2",
 		"ts-jest": "29.4.0"
 	},
 	"dependencies": {
 		"mande": "2.0.9",
-		"zod": "4.0.8",
+		"zod": "4.0.10",
 		"bignumber.js": "9.3.1"
 	},
 	"overrides": {