@narrative.io/data-collaboration-sdk-ts 0.0.86 → 0.0.88

package/build/data-streams/index.d.ts

@@ -1,6 +1,6 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
-import { type DataStream } from './types';
+import { type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet } from './types';
 /**
  * @module DataStreamsApi
  * @description This module provides methods for interacting with Data Streams.
@@ -24,4 +24,4 @@ declare class DataStreamsApi extends BaseApi {
     getDataStreamBySlug(slug: string, companyId: number, authenticated: boolean): Promise<DataStream>;
     private getBaseUri;
 }
-export { DataStreamsApi, type DataStream };
+export { DataStreamsApi, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type DataStream };

package/build/index.d.ts

@@ -17,7 +17,7 @@ import { type Product, ProductsApi } from './products';
 import { CompanyInfoApi, type CompanyInfo } from './company-info';
 import { InstallationsApi, type Installation } from './installations';
 import { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression } from './nql';
-import { DataStreamsApi, type DataStream } from './data-streams';
+import { DataStreamsApi, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet } from './data-streams';
 import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from './forecast';
 import { ContractsApi, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView } from './contracts';
 import { getNqlObject, buildNql } from './nql/NQLParser';
@@ -30,4 +30,4 @@ declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type RefAttribute, type SubAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, 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 ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type RefAttribute, type SubAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type Nql, 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 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 ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall };

package/build/rosetta/types.d.ts

@@ -818,206 +818,29 @@ declare const isConversationInputMessage: (input: unknown) => input is {
     id?: string | undefined;
 };
 declare const RosettaRequestMessageSchema: z.ZodUnion<[z.ZodObject<{
-    type: z.ZodLiteral<"addMessage">;
-    data: z.ZodUnion<[z.ZodObject<{
-        role: z.ZodEnum<["user"]>;
-        content: z.ZodString;
-        name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
-        timestamp: z.ZodOptional<z.ZodNumber>;
-        id: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"request">;
+    data: z.ZodObject<{
+        input: z.ZodString;
+        apiKey: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
-        role: "user";
-        content: string;
-        name?: string | undefined;
-        timestamp?: number | undefined;
-        id?: string | undefined;
+        input: string;
+        apiKey?: string | undefined;
     }, {
-        role: "user";
-        content: string;
-        name?: string | undefined;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }>, z.ZodUnion<[z.ZodObject<{
-        role: z.ZodEnum<["assistant"]>;
-        content: z.ZodString;
-        timestamp: z.ZodOptional<z.ZodNumber>;
-        id: z.ZodOptional<z.ZodString>;
-    }, "strict", z.ZodTypeAny, {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }, {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }>, z.ZodObject<{
-        role: z.ZodEnum<["assistant"]>;
-        content: z.ZodUnion<[z.ZodNull, z.ZodString]>;
-        function_call: z.ZodObject<{
-            name: z.ZodString;
-            arguments: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            name: string;
-            arguments: string;
-        }, {
-            name: string;
-            arguments: string;
-        }>;
-        timestamp: z.ZodOptional<z.ZodNumber>;
-        id: z.ZodOptional<z.ZodString>;
-    }, "strict", z.ZodTypeAny, {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }, {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }>]>, z.ZodObject<{
-        role: z.ZodEnum<["function"]>;
-        content: z.ZodString;
-        name: z.ZodString;
-        timestamp: z.ZodOptional<z.ZodNumber>;
-        id: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        role: "function";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }, {
-        name: string;
-        role: "function";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }>]>;
+        input: string;
+        apiKey?: string | undefined;
+    }>;
 }, "strip", z.ZodTypeAny, {
-    type: "addMessage";
+    type: "request";
     data: {
-        role: "user";
-        content: string;
-        name?: string | undefined;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        name: string;
-        role: "function";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | ({
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } & {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }) | ({
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } & {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    });
+        input: string;
+        apiKey?: string | undefined;
+    };
 }, {
-    type: "addMessage";
+    type: "request";
     data: {
-        role: "user";
-        content: string;
-        name?: string | undefined;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        name: string;
-        role: "function";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | ({
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } & {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }) | ({
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } & {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    });
+        input: string;
+        apiKey?: string | undefined;
+    };
 }>, z.ZodObject<{
     type: z.ZodLiteral<"ping">;
 }, "strip", z.ZodTypeAny, {
@@ -1039,62 +862,11 @@ declare const RosettaRequestMessageSchema: z.ZodUnion<[z.ZodObject<{
 }>]>;
 type RosettaRequestMessage = z.infer<typeof RosettaRequestMessageSchema>;
 declare const isRosettaRequestMessage: (input: unknown) => input is {
-    type: "addMessage";
+    type: "request";
     data: {
-        role: "user";
-        content: string;
-        name?: string | undefined;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | {
-        name: string;
-        role: "function";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } | ({
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } & {
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    }) | ({
-        role: "assistant";
-        content: string;
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    } & {
-        role: "assistant";
-        content: string | null;
-        function_call: {
-            name: string;
-            arguments: string;
-        };
-        timestamp?: number | undefined;
-        id?: string | undefined;
-    });
+        input: string;
+        apiKey?: string | undefined;
+    };
 } | {
     type: "ping";
 } | {
@@ -1107,13 +879,21 @@ interface InfoMessageData {
     message: string;
     code?: string;
 }
-type ConversationHistoryType = 'conversationHistory';
-type ConversationHistoryData = ConversationIOMessage[];
+interface ConverationHistoryObj {
+    type: 'human' | 'ai';
+    text: string;
+    timestamp: number;
+    reference?: string;
+    reference_type?: string;
+}
+type ConversationHistoryType = 'history';
+type ConversationHistoryData = ConverationHistoryObj[];
 type ConversationUpdatedType = 'conversationUpdated';
 type ConversationDeletedType = 'conversationDeleted';
 interface ConversationUpdatedData {
     change: ConversationDeletedType;
     message?: string;
+    conversationId: string;
 }
 interface InfoMessage {
     type: InfoMessageType;
@@ -1127,6 +907,17 @@ interface ConversationUpdatedMessage {
     type: ConversationUpdatedType;
     data: ConversationUpdatedData;
 }
+interface ConversationSummary {
+    id: string;
+    description?: string;
+    timestamp?: string;
+}
+type ConversationsType = 'userConversations';
+type ConversationsData = ConversationSummary[];
+interface ConversationListMessage {
+    type: ConversationsType;
+    data: ConversationsData;
+}
 type PongType = 'pong';
 interface PongMessage {
     type: PongType;
@@ -1140,14 +931,26 @@ interface ErrorMessage {
     type: ErrorType;
     data: ErrorData;
 }
-type ThoughtType = 'thought';
+type ThoughtType = 'thought-start';
 interface ThoughtData {
-    message: string;
+    text: string;
+    timestamp?: string;
 }
 interface ThoughtMessage {
     type: ThoughtType;
     data: ThoughtData;
 }
-type RosettaResponseMessage = InfoMessage | HistoryMessage | ConversationUpdatedMessage | PongMessage | ErrorMessage | ThoughtMessage;
+type ResponseType = 'response';
+interface ReponseData {
+    response: string;
+    reference_type?: string;
+    reference?: string;
+    timestamp?: string;
+}
+interface RespomseMessage {
+    type: ResponseType;
+    data: ReponseData;
+}
+type RosettaResponseMessage = InfoMessage | HistoryMessage | ConversationUpdatedMessage | PongMessage | ErrorMessage | ThoughtMessage | RespomseMessage | ConversationListMessage;
 declare function isType<T>(input: unknown, schema: z.ZodType<T>): input is T;
 export { type ConversationMessageRole, isConversationMessageRole, type ConversationMessageName, isConversationMessageName, type ConversationUserMessage, isConversationUserMessage, type ConversationAssistantMessage, isConversationAssistantMessage, type ConversationSystemMessage, isConversationSystemMessage, type ConversationFunctionMessage, isConversationFunctionMessage, type ConversationMessage, isConversationMessage, type ConversationIOMessage, isConversationInputMessage, type ConversationMessages, isConversationMessages, isType, type RosettaRequestMessage, isRosettaRequestMessage, type RosettaResponseMessage, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall, type ConversationAssistantMessageWithoutFunctionCall, isConversationAssistantMessageWithoutFunctionCall };

package/build/rosetta/types.js

@@ -162,9 +162,12 @@ const isConversationInputMessage = (input) => {
 /// ///////////////////////////
 // WebSocket Client -> Server
 /// ///////////////////////////
-const AddMessageEventSchema = z.object({
-    type: z.literal('addMessage'),
-    data: ChatCompletionRequestInputMessageSchema
+const RequestMessageSchema = z.object({
+    type: z.literal('request'),
+    data: z.object({
+        input: z.string(),
+        apiKey: z.string().optional()
+    })
 });
 const PingEventSchema = z.object({
     type: z.literal('ping')
@@ -176,7 +179,7 @@ const HistoryEventSchema = z.object({
     type: z.literal('history')
 });
 const RosettaRequestMessageSchema = z.union([
-    AddMessageEventSchema,
+    RequestMessageSchema,
     PingEventSchema,
     ClearHistoryEventSchema,
     HistoryEventSchema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.86",
+  "version": "0.0.88",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",