@narrative.io/data-collaboration-sdk-ts 0.0.81 → 0.0.83

package/build/index.d.ts

@@ -25,8 +25,9 @@ import { convertNqlObjectToForecastBody } from './nql/DataRulesConverter';
 import { AuthenticationApi, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse } from './authentication';
 import { AppsApi, type App } from './apps';
 import type { ForecastBody } from './nql/types';
+import { type ConversationMessageRole, isConversationMessageRole, type ConversationMessageName, isConversationMessageName, type ConversationUserMessage, isConversationUserMessage, type ConversationAssistantMessage, isConversationAssistantMessage, type ConversationSystemMessage, isConversationSystemMessage, type ConversationFunctionMessage, isConversationFunctionMessage, type ConversationMessage, isConversationMessage, type ConversationIOtMessage, isConversationInputMessage, type ConversationMessages, isConversationMessages, isType, type RosettaMessageEvent, type RosettaResponseMessageEvent, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall } from './rosetta/types';
 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, 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, getNqlObject, buildNql, convertNqlObjectToForecastBody, type ForecastBody };
+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, 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 ConversationIOtMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaMessageEvent, type RosettaResponseMessageEvent, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall };

package/build/index.js

@@ -18,7 +18,8 @@ import { getNqlObject, buildNql } from './nql/NQLParser';
 import { convertNqlObjectToForecastBody } from './nql/DataRulesConverter';
 import { AuthenticationApi } from './authentication';
 import { AppsApi } from './apps';
+import { isConversationMessageRole, isConversationMessageName, isConversationUserMessage, isConversationAssistantMessage, isConversationSystemMessage, isConversationFunctionMessage, isConversationMessage, isConversationInputMessage, isConversationMessages, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall } from './rosetta/types';
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [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 };
+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 };

package/build/rosetta/types.d.ts

@@ -0,0 +1,709 @@
+import z from 'zod';
+declare const ChatCompletionRequestMessageRoleEnum: z.ZodEnum<["system", "user", "assistant", "function"]>;
+type ConversationMessageRole = z.infer<typeof ChatCompletionRequestMessageRoleEnum>;
+declare const isConversationMessageRole: (input: unknown) => input is "function" | "system" | "user" | "assistant";
+declare const ChatCompletionRequestMessageName: z.ZodEffects<z.ZodString, string, string>;
+type ConversationMessageName = z.infer<typeof ChatCompletionRequestMessageName>;
+declare const isConversationMessageName: (input: unknown) => input is string;
+declare const ChatCompletionRequestUserMessageSchema: z.ZodObject<{
+    role: z.ZodEnum<["user"]>;
+    content: z.ZodString;
+    name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>;
+type ConversationUserMessage = z.infer<typeof ChatCompletionRequestUserMessageSchema>;
+declare const isConversationUserMessage: (input: unknown) => input is {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+};
+declare const ChatCompletionRequestMessageFunctionCall: z.ZodObject<{
+    name: z.ZodString;
+    arguments: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    arguments: string;
+}, {
+    name: string;
+    arguments: string;
+}>;
+type ConversationMessageFunctionCall = z.infer<typeof ChatCompletionRequestMessageFunctionCall>;
+declare const isConversationMessageFunctionCall: (input: unknown) => input is {
+    name: string;
+    arguments: string;
+};
+declare const ChatCompletionRequestAssistantMessageWithFunctionCall: 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>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>;
+type ConversationAssistantMessageWithFunctionCall = z.infer<typeof ChatCompletionRequestAssistantMessageWithFunctionCall>;
+declare const isConversationAssistantMessageWithFunctionCall: (input: unknown) => input is {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+};
+declare const ChatCompletionAssistantMessage: z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEnum<["assistant"]>;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | 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>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>]>;
+type ConversationAssistantMessage = z.infer<typeof ChatCompletionAssistantMessage>;
+declare const isConversationAssistantMessage: (input: unknown) => input is {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+};
+declare const ChatCompletionSystemMessageSchema: z.ZodObject<{
+    role: z.ZodEnum<["system"]>;
+    content: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role: "system";
+    content: string;
+}, {
+    role: "system";
+    content: string;
+}>;
+type ConversationSystemMessage = z.infer<typeof ChatCompletionSystemMessageSchema>;
+declare const isConversationSystemMessage: (input: unknown) => input is {
+    role: "system";
+    content: string;
+};
+declare const ChatCompletionFunctionMessageSchema: z.ZodObject<{
+    role: z.ZodEnum<["function"]>;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function";
+    content: string;
+}, {
+    name: string;
+    role: "function";
+    content: string;
+}>;
+type ConversationFunctionMessage = z.infer<typeof ChatCompletionFunctionMessageSchema>;
+declare const isConversationFunctionMessage: (input: unknown) => input is {
+    name: string;
+    role: "function";
+    content: string;
+};
+declare const ChatCompletionRequestMessageSchema: 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>;
+}, "strip", z.ZodTypeAny, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEnum<["assistant"]>;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | 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>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>]>, z.ZodObject<{
+    role: z.ZodEnum<["system"]>;
+    content: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role: "system";
+    content: string;
+}, {
+    role: "system";
+    content: string;
+}>, z.ZodObject<{
+    role: z.ZodEnum<["function"]>;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function";
+    content: string;
+}, {
+    name: string;
+    role: "function";
+    content: string;
+}>]>;
+type ConversationMessage = z.infer<typeof ChatCompletionRequestMessageSchema>;
+declare const isConversationMessage: (input: unknown) => input is {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+};
+declare const ChatCompletionRequestMessagesSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodArray<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>;
+}, "strip", z.ZodTypeAny, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEnum<["assistant"]>;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | 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>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>]>, z.ZodObject<{
+    role: z.ZodEnum<["system"]>;
+    content: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role: "system";
+    content: string;
+}, {
+    role: "system";
+    content: string;
+}>, z.ZodObject<{
+    role: z.ZodEnum<["function"]>;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function";
+    content: string;
+}, {
+    name: string;
+    role: "function";
+    content: string;
+}>]>, "many">, ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[], ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[]>, ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[], ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[]>, ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[], ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[]>, ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[], ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[]>;
+type ConversationMessages = z.infer<typeof ChatCompletionRequestMessagesSchema>;
+declare const isConversationMessages: (input: unknown) => input is ({
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "system";
+    content: string;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+})[];
+declare const ChatCompletionRequestInputMessageSchema: 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>;
+}, "strip", z.ZodTypeAny, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEnum<["assistant"]>;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string;
+    timestamp?: number | 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>;
+}, "strict", z.ZodTypeAny, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>]>, z.ZodObject<{
+    role: z.ZodEnum<["function"]>;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function";
+    content: string;
+}, {
+    name: string;
+    role: "function";
+    content: string;
+}>]>;
+type ConversationIOtMessage = z.infer<typeof ChatCompletionRequestInputMessageSchema>;
+declare const isConversationInputMessage: (input: unknown) => input is {
+    role: "user";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    name: string;
+    role: "function";
+    content: string;
+};
+interface AddMessageEvent {
+    type: 'addMessage';
+    data: ConversationIOtMessage;
+}
+interface PingEvent {
+    type: 'ping';
+}
+interface ClearHistoryEvent {
+    type: 'clearHistory';
+}
+interface HistoryEvent {
+    type: 'history';
+}
+type RosettaRequestMessage = AddMessageEvent | PingEvent | ClearHistoryEvent | HistoryEvent;
+interface RosettaMessageEvent extends MessageEvent {
+    data: RosettaRequestMessage;
+}
+interface AddMessageResponse {
+    type: 'newMessage';
+    data: ConversationIOtMessage;
+}
+interface HistoryResponse {
+    type: 'history';
+    data: ConversationIOtMessage[];
+}
+interface ClearHistoryResponse {
+    type: 'historyCleared';
+}
+interface PingResponse {
+    type: 'pong';
+}
+type RosettaResponseMessage = AddMessageResponse | HistoryResponse | ClearHistoryResponse | PingResponse;
+interface RosettaResponseMessageEvent extends MessageEvent {
+    data: RosettaResponseMessage;
+}
+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 ConversationIOtMessage, isConversationInputMessage, type ConversationMessages, isConversationMessages, isType, type RosettaMessageEvent, type RosettaResponseMessageEvent, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall };

package/build/rosetta/types.js

@@ -0,0 +1,163 @@
+import z from 'zod';
+/// ///////////////////
+// Role Enum
+/// ///////////////////
+const ChatCompletionRequestMessageRoleEnum = z.enum(['system', 'user', 'assistant', 'function']);
+const isConversationMessageRole = (input) => {
+    return ChatCompletionRequestMessageRoleEnum.safeParse(input).success;
+};
+/// ///////////////////
+// Name Type
+/// ///////////////////
+const ChatCompletionRequestMessageName = z.string().max(64).refine((value) => /^[\w]*$/.test(value), {
+    message: 'String may only contain a-z, A-Z, 0-9, and underscores'
+});
+const isConversationMessageName = (input) => {
+    return ChatCompletionRequestMessageName.safeParse(input).success;
+};
+// Valid timestampes for Rosetta AI Messages
+const ChatCompletionRequestMessageTimestamp = z.number().int().min(1670112000000).max(Date.now() + (1000 * 60 * 60 * 24));
+/// ///////////////////
+// User Message
+/// ///////////////////
+const ChatCompletionRequestUserMessageSchema = z.object({
+    role: z.enum(['user']),
+    content: z.string().min(1),
+    name: ChatCompletionRequestMessageName.optional(),
+    timestamp: ChatCompletionRequestMessageTimestamp.optional()
+});
+const isConversationUserMessage = (input) => {
+    return ChatCompletionRequestUserMessageSchema.safeParse(input).success;
+};
+/// ///////////////////
+// Function Call
+/// ///////////////////
+const ChatCompletionRequestMessageFunctionCall = z.object({
+    name: z.string(),
+    arguments: z.string()
+});
+const isConversationMessageFunctionCall = (input) => {
+    return ChatCompletionRequestMessageFunctionCall.safeParse(input).success;
+};
+/// ///////////////////
+// Assistant Message
+/// ///////////////////
+const ChatCompletionRequestAssistantMessageWithFunctionCall = z.object({
+    role: z.enum(['assistant']),
+    content: z.null().or(z.string()),
+    function_call: ChatCompletionRequestMessageFunctionCall,
+    timestamp: ChatCompletionRequestMessageTimestamp.optional()
+}).strict();
+const isConversationAssistantMessageWithFunctionCall = (input) => {
+    return ChatCompletionRequestAssistantMessageWithFunctionCall.safeParse(input).success;
+};
+const ChatCompletionRequestAssistantMessage = z.object({
+    role: z.enum(['assistant']),
+    content: z.string(),
+    timestamp: ChatCompletionRequestMessageTimestamp.optional()
+}).strict();
+const ChatCompletionAssistantMessage = ChatCompletionRequestAssistantMessage.or(ChatCompletionRequestAssistantMessageWithFunctionCall);
+const isConversationAssistantMessage = (input) => {
+    return ChatCompletionAssistantMessage.safeParse(input).success;
+};
+/// ///////////////////
+// System Message
+/// ///////////////////
+const ChatCompletionSystemMessageSchema = z.object({
+    role: z.enum(['system']),
+    content: z.string()
+});
+const isConversationSystemMessage = (input) => {
+    return ChatCompletionSystemMessageSchema.safeParse(input).success;
+};
+/// ///////////////////
+// Function Message
+/// ///////////////////
+const ChatCompletionFunctionMessageSchema = z.object({
+    role: z.enum(['function']),
+    content: z.string(),
+    name: z.string()
+});
+const isConversationFunctionMessage = (input) => {
+    return ChatCompletionFunctionMessageSchema.safeParse(input).success;
+};
+/// ///////////////////
+// Conversation Message
+/// ///////////////////
+const ChatCompletionRequestMessageSchema = z.union([
+    ChatCompletionRequestUserMessageSchema,
+    ChatCompletionAssistantMessage,
+    ChatCompletionSystemMessageSchema,
+    ChatCompletionFunctionMessageSchema
+]);
+const isConversationMessage = (input) => {
+    return ChatCompletionRequestMessageSchema.safeParse(input).success;
+};
+/// ///////////////////
+// Conversation Messages
+/// ///////////////////
+function validateFunctionOrder(messages) {
+    for (let i = 1; i < messages.length; i++) {
+        // Start from the second element
+        if (messages[i].role === 'function') {
+            const previousMessage = messages[i - 1];
+            if (!(previousMessage.role === 'assistant' && 'function_call' in previousMessage)) {
+                console.error('A message with role `function` must directly follow a message with role `assistant` and function_call not undefined', JSON.stringify(messages[i], null, 2), JSON.stringify(previousMessage, null, 2));
+                return { valid: false, error: 'A message with role `function` must directly follow a message with role `assistant` and function_call not undefined', index: i };
+            }
+        }
+    }
+    return { valid: true };
+}
+const ChatCompletionRequestMessagesSchema = z.array(ChatCompletionRequestMessageSchema).min(1)
+    .refine(
+// We should have at most one system message
+(data) => {
+    const systemMessageCount = data.filter((message) => message.role === 'system').length;
+    return systemMessageCount <= 1;
+}, {
+    message: 'The message array can have at most one system message'
+})
+    .refine(
+// If there is a system message it should be the first message
+(data) => {
+    const systemMessageIndex = data.findIndex((message) => message.role === 'system');
+    return systemMessageIndex === 0 || systemMessageIndex === -1;
+}, {
+    message: 'The system message needs to be the first message in the array'
+})
+    .refine(
+// We should have at most one system message
+(data) => {
+    const userMessageCount = data.find((message) => message.role === 'user');
+    return userMessageCount !== undefined;
+}, {
+    message: 'The message array must have at least one user message'
+})
+    .refine((data) => {
+    return validateFunctionOrder(data).valid;
+});
+const isConversationMessages = (input) => {
+    return ChatCompletionRequestMessagesSchema.safeParse(input).success;
+};
+/// ///////////////////
+// Input Conversation Message
+/// ///////////////////
+const ChatCompletionRequestInputMessageSchema = z.union([
+    ChatCompletionRequestUserMessageSchema,
+    ChatCompletionAssistantMessage,
+    ChatCompletionFunctionMessageSchema
+]);
+const isConversationInputMessage = (input) => {
+    return ChatCompletionRequestInputMessageSchema.safeParse(input).success;
+};
+/// ///////////////////
+// Utilities
+/// ///////////////////
+function isType(input, schema) {
+    return schema.safeParse(input).success;
+}
+/// ///////////////////
+// Exports
+/// ///////////////////
+export { isConversationMessageRole, isConversationMessageName, isConversationUserMessage, isConversationAssistantMessage, isConversationSystemMessage, isConversationFunctionMessage, isConversationMessage, isConversationInputMessage, isConversationMessages, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall };

package/package.json

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