chore: Add circular dependencies check and fix corresponding errors

.github/workflows/reviewdog.yml

@@ -41,3 +41,14 @@ jobs:
       - name: Linelint
         uses: fernandrone/linelint@master
         id: linelint
+
+  circular-deps:
+    runs-on: ubuntu-latest
+    name: Check for circular dependencies
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Build node env
+        uses: ./.github/actions/build_package
+      - name: Check for circular dependencies
+        run: yarn circular-deps

__tests__/helpers.ts

@@ -16,7 +16,8 @@ import {
 } from '@proto/ai/inworld/packets/packets_pb';
 import { v4 } from 'uuid';
 
-import { Capabilities, Extension, User } from '../src/common/data_structures';
+import { Capabilities, User } from '../src/common/data_structures';
+import { Extension } from '../src/common/data_structures/extension';
 import { protoTimestamp } from '../src/common/helpers';
 import { Character } from '../src/entities/character.entity';
 import {

package.json

@@ -39,7 +39,8 @@
     "lint:fix": "yarn run lint:check --fix",
     "prettier:check": "yarn prettier --check \"./{src,__tests__,examples}/**/*.{js,jsx,ts,tsx}\" --ignore-path .gitignore",
     "prettier:format": "yarn prettier --write \"./{src,__tests__,examples}/**/*.{js,jsx,ts,tsx}\" --ignore-path .gitignore",
-    "prepare": "husky install"
+    "prepare": "husky install",
+    "circular-deps": "madge --circular --extensions ts,tsx src"
   },
   "devDependencies": {
     "@release-it/keep-a-changelog": "^5.0.0",
@@ -60,6 +61,7 @@
     "husky": "^9.0.11",
     "jest": "^29.7.0",
     "jest-html-reporter": "^3.10.2",
+    "madge": "^8.0.0",
     "prettier": "^3.2.5",
     "release-it": "^17.1.1",
     "ts-jest": "^29.1.2",

src/clients/inworld.client.ts

@@ -5,12 +5,12 @@ import {
   Awaitable,
   Client,
   ClientConfiguration,
-  Extension,
   GenerateSessionTokenFn,
   GetterSetter,
   InternalClientConfiguration,
   User,
 } from '../common/data_structures';
+import { Extension } from '../common/data_structures/extension';
 import { SCENE_HAS_INVALID_FORMAT } from '../common/errors';
 import { Logger } from '../common/logger';
 import { Capability } from '../entities/capability.entity';

src/common/data_structures/extension.ts

@@ -0,0 +1,49 @@
+import {
+  CurrentSceneStatus,
+  InworldPacket as ProtoPacket,
+} from '@proto/ai/inworld/packets/packets_pb';
+
+import { Character } from '../../entities/character.entity';
+import { InworldPacket } from '../../entities/packets/inworld_packet.entity';
+import {
+  AudioSessionStartPacketParams,
+  CancelResponsesProps,
+  SendPacketParams,
+  TriggerParameter,
+} from './index';
+
+export interface Extension<
+  InworldPacketT extends InworldPacket = InworldPacket,
+> {
+  convertPacketFromProto?: (proto: ProtoPacket) => InworldPacketT;
+  beforeLoadScene?: (packets: ProtoPacket[]) => ProtoPacket[];
+  afterLoadScene?: (res: CurrentSceneStatus) => void;
+}
+
+export interface ConvesationInterface<
+  InworldPacketT extends InworldPacket = InworldPacket,
+> {
+  getConversationId(): string;
+  getParticipants(): string[];
+  getCharacters(): Character[];
+  changeParticipants(participants: string[]): void;
+  updateParticipants(participants: string[]): Promise<InworldPacketT>;
+  sendText: (text: string) => Promise<InworldPacketT>;
+  sendAudio: (chunk: string) => Promise<InworldPacketT>;
+  sendTrigger: (
+    name: string,
+    parameters?: { parameters?: TriggerParameter[]; character?: Character },
+  ) => Promise<InworldPacketT>;
+  sendAudioSessionStart(
+    params?: AudioSessionStartPacketParams,
+  ): Promise<InworldPacketT>;
+  sendAudioSessionEnd(): Promise<InworldPacketT>;
+  sendCancelResponse(
+    cancelResponses?: CancelResponsesProps,
+  ): Promise<InworldPacketT>;
+  sendTTSPlaybackMute(isMuted: boolean): Promise<InworldPacketT>;
+  sendNarratedAction(text: string): Promise<InworldPacketT>;
+  sendCustomPacket(
+    getPacket: (params: SendPacketParams) => ProtoPacket,
+  ): Promise<InworldPacketT>;
+}

src/common/data_structures.ts → src/common/data_structures/index.ts

@@ -6,21 +6,24 @@ import {
 } from '@proto/ai/inworld/engine/configuration/configuration_pb';
 import {
   Continuation,
-  CurrentSceneStatus,
   InworldPacket as ProtoPacket,
 } from '@proto/ai/inworld/packets/packets_pb';
-import { Character } from 'entities/character.entity';
 
-import { SessionContinuationProps } from '../entities/continuation/session_continuation.entity';
-import { InworldPacket } from '../entities/packets/inworld_packet.entity';
-import { SessionToken } from '../entities/session_token.entity';
-import { ConversationService } from '../services/conversation.service';
+import { Character } from '../../entities/character.entity';
+import { SessionContinuationProps } from '../../entities/continuation/session_continuation.entity';
+import { SessionToken } from '../../entities/session_token.entity';
 
 export interface ApiKey {
   key: string;
   secret: string;
 }
 
+export enum ConversationState {
+  ACTIVE = 'ACTIVE',
+  PROCESSING = 'PROCESSING',
+  INACTIVE = 'INACTIVE',
+}
+
 export interface Capabilities {
   audio?: boolean;
   debugInfo?: boolean;
@@ -90,13 +93,6 @@ export interface CancelResponsesProps {
   utteranceId?: string[];
 }
 
-export interface SessionTokenProps {
-  token: string;
-  type: string;
-  expirationTime: Date;
-  sessionId: string;
-}
-
 export interface GetterSetter<T> {
   get: () => Awaitable<T | undefined>;
   set: (entity: T) => Awaitable<any>;
@@ -108,14 +104,6 @@ export enum ConnectionState {
   INACTIVE = 'INACTIVE',
 }
 
-export interface Extension<
-  InworldPacketT extends InworldPacket = InworldPacket,
-> {
-  convertPacketFromProto?: (proto: ProtoPacket) => InworldPacketT;
-  beforeLoadScene?: (packets: ProtoPacket[]) => ProtoPacket[];
-  afterLoadScene?: (res: CurrentSceneStatus) => void;
-}
-
 export interface CustomParameter {
   name: string;
   value: string;
@@ -166,12 +154,6 @@ export enum InworldLatencyReportType {
   PING_PONG = 'PING_PONG',
 }
 
-export enum ConversationState {
-  ACTIVE = 'ACTIVE',
-  PROCESSING = 'PROCESSING',
-  INACTIVE = 'INACTIVE',
-}
-
 export enum ConversationIntializeState {
   ACTIVE = 'ACTIVE',
   PROCESSING = 'PROCESSING',
@@ -207,13 +189,6 @@ export interface AudioSessionStartPacketParams {
   understandingMode?: UnderstandingMode;
 }
 
-export interface ConversationMapItem<
-  InworldPacketT extends InworldPacket = InworldPacket,
-> {
-  service: ConversationService<InworldPacketT>;
-  state: ConversationState;
-}
-
 export enum ConversationParticipant {
   USER = 'USER',
 }

src/entities/session_token.entity.ts

@@ -1,9 +1,14 @@
 import { AccessToken } from '@proto/ai/inworld/engine/world-engine_pb';
 
-import { SessionTokenProps } from '../common/data_structures';
-
 const TIME_DIFF_MS = 50 * 60 * 1000; // 5 minutes
 
+export interface SessionTokenProps {
+  token: string;
+  type: string;
+  expirationTime: Date;
+  sessionId: string;
+}
+
 export class SessionToken {
   token: string;
   type: string;

src/index.ts

@@ -29,14 +29,14 @@ import {
   LogsEventLogDetail,
   MicrophoneMode,
   ProtobufValue,
-  SessionTokenProps,
   TaskParameter,
   TriggerParameter,
   UnderstandingMode,
   User,
   UserProfile,
   UserProfileField,
 } from './common/data_structures';
+import { Extension } from './common/data_structures/extension';
 import * as InworldTriggers from './common/inworld_triggers';
 import { Character } from './entities/character.entity';
 import {
@@ -73,7 +73,10 @@ import { TextEvent } from './entities/packets/text.entity';
 import { TriggerEvent } from './entities/packets/trigger.entity';
 import { Scene } from './entities/scene.entity';
 import { Session } from './entities/session.entity';
-import { SessionToken } from './entities/session_token.entity';
+import {
+  SessionToken,
+  SessionTokenProps,
+} from './entities/session_token.entity';
 import { ConversationService } from './services/conversation.service';
 import {
   FeedbackDislikeProps,
@@ -109,6 +112,7 @@ export {
   ErrorReconnectionType,
   ErrorResourceType,
   ErrorType,
+  Extension,
   Feedback,
   FeedbackDislikeProps,
   FeedbackLikeProps,

src/services/connection.service.ts

@@ -13,15 +13,17 @@ import {
   Awaitable,
   ChangeSceneProps,
   ConnectionState,
-  ConversationMapItem,
   ConversationState,
-  Extension,
   GenerateSessionTokenFn,
   GetterSetter,
   InternalClientConfiguration,
   InworldConversationEventType,
   User,
 } from '../common/data_structures';
+import {
+  ConvesationInterface,
+  Extension,
+} from '../common/data_structures/extension';
 import { calculateTimeDifference } from '../common/helpers';
 import { Logger } from '../common/logger';
 import { Capability } from '../entities/capability.entity';
@@ -87,8 +89,13 @@ export class ConnectionService<
   onError: (err: InworldError) => Awaitable<void>;
   onMessage: ((message: ProtoPacket) => Awaitable<void>) | undefined;
 
-  readonly conversations: Map<string, ConversationMapItem<InworldPacketT>> =
-    new Map();
+  readonly conversations: Map<
+    string,
+    {
+      service: ConvesationInterface<InworldPacketT>;
+      state: ConversationState;
+    }
+  > = new Map();
 
   constructor(props: ConnectionProps<InworldPacketT>) {
     this.connectionProps = props;

src/services/conversation.service.ts

@@ -8,16 +8,16 @@ import {
   AudioSessionStartPacketParams,
   CancelResponsesProps,
   ConversationParticipant,
-  ConversationState,
   SendPacketParams,
   TriggerParameter,
 } from '../common/data_structures';
+import { ConversationState } from '../common/data_structures';
+import { ConvesationInterface } from '../common/data_structures/extension';
 import { MULTI_CHAR_NARRATED_ACTIONS } from '../common/errors';
 import { Character } from '../entities/character.entity';
 import { InworldPacket } from '../entities/packets/inworld_packet.entity';
 import { EventFactory } from '../factories/event';
 import { ConnectionService } from './connection.service';
-
 export interface PacketQueueItem<
   InworldPacketT extends InworldPacket = InworldPacket,
 > {
@@ -27,7 +27,8 @@ export interface PacketQueueItem<
 
 export class ConversationService<
   InworldPacketT extends InworldPacket = InworldPacket,
-> {
+> implements ConvesationInterface<InworldPacketT>
+{
   private connection: ConnectionService<InworldPacketT>;
   private conversationId: string;
   private participants: string[];

src/services/gprc/world_engine_client_grpc.service.ts

@@ -30,10 +30,10 @@ import { CLIENT_ID, SCENE_PATTERN } from '../../common/constants';
 import {
   ApiKey,
   Awaitable,
-  Extension,
   InternalClientConfiguration,
   User,
 } from '../../common/data_structures';
+import { Extension } from '../../common/data_structures/extension';
 import { grpcOptions } from '../../common/helpers';
 import { Logger } from '../../common/logger';
 import { SessionContinuation } from '../../entities/continuation/session_continuation.entity';

src/services/inworld_connection.service.ts

@@ -6,9 +6,9 @@ import {
   ChangeSceneProps,
   ConversationIntializeState,
   ConversationParticipant,
-  ConversationState,
   TriggerParameter,
 } from '../common/data_structures';
+import { ConversationState } from '../common/data_structures';
 import {
   CHARACTER_HAS_INVALID_FORMAT,
   CURRENT_CHARACTER_NOT_SET,