@narrative.io/data-collaboration-sdk-ts 0.0.80 → 0.0.82

package/build/authentication/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from '../base-api';
-import { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest } from './types';
+import { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse } from './types';
 /**
  * A class for accessing the Authentication API
  * @extends BaseApi
@@ -23,8 +23,8 @@ declare class AuthenticationApi extends BaseApi {
      * Checks the resgistration status of a user.
      *
      * @param {RegistrationStatusRequest} statusRewquest - request payload of user login for whom to check status.
-     * @returns {Promise<RegistrationStatus>} - A promise that resolves to the response.
+     * @returns {Promise<RegistrationStatusResponse>} - A promise that resolves to the response.
      */
-    checkRegistrationStatus(statusRequest: RegistrationStatusRequest): Promise<RegistrationStatus>;
+    checkRegistrationStatus(statusRequest: RegistrationStatusRequest): Promise<RegistrationStatusResponse>;
 }
-export { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, AuthenticationApi };
+export { type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, AuthenticationApi };

package/build/authentication/index.js

@@ -33,7 +33,7 @@ class AuthenticationApi extends BaseApi {
      * Checks the resgistration status of a user.
      *
      * @param {RegistrationStatusRequest} statusRewquest - request payload of user login for whom to check status.
-     * @returns {Promise<RegistrationStatus>} - A promise that resolves to the response.
+     * @returns {Promise<RegistrationStatusResponse>} - A promise that resolves to the response.
      */
     async checkRegistrationStatus(statusRequest) {
         return await this.post(`${resourceName}/registration-status`, statusRequest);

package/build/authentication/types.d.ts

@@ -1,6 +1,5 @@
 export interface LoginRequest {
-    stytch_token: StytchToken;
-    session_duration_minutes?: number;
+    stytch_session_token: string;
 }
 export interface LoginResponse {
     user: {
@@ -13,8 +12,6 @@ export interface LoginResponse {
     };
     api_token: ApiToken;
     legacy_token: string;
-    stytch_session_token: string;
-    stytch_session_jwt: string;
 }
 export interface ApiToken {
     access_token: string;
@@ -23,7 +20,7 @@ export interface ApiToken {
     refresh_token_expires_in: number;
 }
 export interface RegisterRequest {
-    stytch_token: StytchToken;
+    stytch_session_token: string;
     name?: string;
     company_name: string;
 }
@@ -45,5 +42,11 @@ export interface StytchToken {
 export type UserRole = 'global_admin' | 'partner_admin' | 'partner_user';
 export interface RegistrationStatusRequest {
     stytch_token: StytchToken;
+    session_duration_minutes?: number;
+}
+export interface RegistrationStatusResponse {
+    status: RegistrationStatus;
+    stytch_session_token: string;
+    stytch_session_jwt: string;
 }
 export type RegistrationStatus = 'complete' | 'pending';

package/build/index.d.ts

@@ -22,11 +22,12 @@ import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostFore
 import { ContractsApi, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView } from './contracts';
 import { getNqlObject, buildNql } from './nql/NQLParser';
 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 } from './authentication';
+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 } 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, 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, 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 };

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 } 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 };

package/build/rosetta/types.d.ts

@@ -0,0 +1,668 @@
+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.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>;
+type ConversationUserMessage = z.infer<typeof ChatCompletionRequestUserMessageSchema>;
+declare const isConversationUserMessage: (input: unknown) => input is {
+    role: "function" | "system" | "user" | "assistant";
+    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 ChatCompletionAssistantMessage: z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "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: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "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: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+};
+declare const ChatCompletionSystemMessageSchema: z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}>;
+type ConversationSystemMessage = z.infer<typeof ChatCompletionSystemMessageSchema>;
+declare const isConversationSystemMessage: (input: unknown) => input is {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+};
+declare const ChatCompletionFunctionMessageSchema: z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}>;
+type ConversationFunctionMessage = z.infer<typeof ChatCompletionFunctionMessageSchema>;
+declare const isConversationFunctionMessage: (input: unknown) => input is {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+};
+declare const ChatCompletionRequestMessageSchema: z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "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: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>]>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}>]>;
+type ConversationMessage = z.infer<typeof ChatCompletionRequestMessageSchema>;
+declare const isConversationMessage: (input: unknown) => input is {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+};
+declare const ChatCompletionRequestMessagesSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "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: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>]>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}>]>, "many">, ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[], ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[]>, ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[], ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[]>, ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[], ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[]>, ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[], ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[]>;
+type ConversationMessages = z.infer<typeof ChatCompletionRequestMessagesSchema>;
+declare const isConversationMessages: (input: unknown) => input is ({
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+})[];
+declare const ChatCompletionRequestInputMessageSchema: z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+}>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "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: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}, {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+}>]>, z.ZodObject<{
+    role: z.ZodEffects<z.ZodEnum<["system", "user", "assistant", "function"]>, "function" | "system" | "user" | "assistant", "function" | "system" | "user" | "assistant">;
+    content: z.ZodString;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}, {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+}>]>;
+type ConversationIOtMessage = z.infer<typeof ChatCompletionRequestInputMessageSchema>;
+declare const isConversationInputMessage: (input: unknown) => input is {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    name?: string | undefined;
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string | null;
+    function_call: {
+        name: string;
+        arguments: string;
+    };
+    timestamp?: number | undefined;
+} | {
+    role: "function" | "system" | "user" | "assistant";
+    content: string;
+    timestamp?: number | undefined;
+} | {
+    name: string;
+    role: "function" | "system" | "user" | "assistant";
+    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 };

package/build/rosetta/types.js

@@ -0,0 +1,170 @@
+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: ChatCompletionRequestMessageRoleEnum.refine((value) => value === 'user', {
+        message: 'Role must be 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: ChatCompletionRequestMessageRoleEnum.refine((value) => value === 'assistant', {
+        message: 'Role must be assistant'
+    }),
+    content: z.null().or(z.string()),
+    function_call: ChatCompletionRequestMessageFunctionCall,
+    timestamp: ChatCompletionRequestMessageTimestamp.optional()
+}).strict();
+const ChatCompletionRequestAssistantMessage = z.object({
+    role: ChatCompletionRequestMessageRoleEnum.refine((value) => value === 'assistant', {
+        message: 'Role must be 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: ChatCompletionRequestMessageRoleEnum.refine((value) => value === 'system', {
+        message: 'Role must be system'
+    }),
+    content: z.string()
+});
+const isConversationSystemMessage = (input) => {
+    return ChatCompletionSystemMessageSchema.safeParse(input).success;
+};
+/// ///////////////////
+// Function Message
+/// ///////////////////
+const ChatCompletionFunctionMessageSchema = z.object({
+    role: ChatCompletionRequestMessageRoleEnum.refine((value) => value === 'function', {
+        message: 'Role must be 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.80",
+  "version": "0.0.82",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -20,28 +20,25 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/preset-env": "^7.20.2",
+    "@babel/core": "^7.22.5",
+    "@babel/preset-env": "^7.22.5",
     "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^17.4.2",
     "@commitlint/config-conventional": "^17.4.2",
     "@types/jest": "^29.5.0",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
     "babel-jest": "^29.4.3",
-    "eslint": "^8.33.0",
-    "eslint-config-standard-with-typescript": "^35.0.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-n": "^15.7.0",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint-config-standard-with-typescript": "^36.0.0",
     "husky": "^8.0.0",
     "jest": "^29.4.3",
-    "ts-jest": "^29.0.5",
-    "typescript": "^5.0.2"
+    "ts-jest": "^29.0.5"
   },
   "dependencies": {
     "mande": "^2.0.3",
     "zod": "^3.21.4"
   },
+  "overrides": {
+    "semver@<7.5.2": "7.5.2"
+  },
   "files": [
     "build"
   ]