@sparkstudio/realtime-sdk 1.0.2

package/dist/index.d.cts

@@ -0,0 +1,203 @@
+/**
+* Auto-generated client for the Home controller.
+*/
+declare class Home {
+    private baseUrl;
+    constructor(baseUrl: string);
+}
+
+type Guid = string & {
+    readonly __brand: unique symbol;
+};
+
+/**
+ * Represents an Auto-generated model for RoomInstanceDTO.
+ */
+interface IRoomInstanceDTO {
+    Id: Guid;
+    HostUserId: Guid;
+    UniqueId: Guid;
+    Data?: string;
+    MaxUsers: number;
+}
+type RoomInstanceDTOInit = Partial<IRoomInstanceDTO> & Pick<IRoomInstanceDTO, "Id" | "HostUserId" | "UniqueId" | "MaxUsers">;
+declare class RoomInstanceDTO implements IRoomInstanceDTO {
+    Id: Guid;
+    HostUserId: Guid;
+    UniqueId: Guid;
+    Data?: string;
+    MaxUsers: number;
+    constructor(init: RoomInstanceDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for RoomInstanceViewDTO.
+ */
+interface IRoomInstanceViewDTO {
+    Id: Guid;
+    RoomInstance: RoomInstanceDTO;
+    UsersInRoom: number;
+}
+type RoomInstanceViewDTOInit = Partial<IRoomInstanceViewDTO> & Pick<IRoomInstanceViewDTO, "Id" | "RoomInstance" | "UsersInRoom">;
+declare class RoomInstanceViewDTO implements IRoomInstanceViewDTO {
+    Id: Guid;
+    RoomInstance: RoomInstanceDTO;
+    UsersInRoom: number;
+    constructor(init: RoomInstanceViewDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for UniqueViewDTO.
+ */
+interface IUniqueViewDTO {
+    Id: Guid;
+    UserCount: number;
+}
+type UniqueViewDTOInit = Partial<IUniqueViewDTO> & Pick<IUniqueViewDTO, "Id" | "UserCount">;
+declare class UniqueViewDTO implements IUniqueViewDTO {
+    Id: Guid;
+    UserCount: number;
+    constructor(init: UniqueViewDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for WebSocketConnectionDTO.
+ */
+interface IWebSocketConnectionDTO {
+    Id: Guid;
+    UserId: Guid;
+    ConnectionId?: string;
+}
+type WebSocketConnectionDTOInit = Partial<IWebSocketConnectionDTO> & Pick<IWebSocketConnectionDTO, "Id" | "UserId">;
+declare class WebSocketConnectionDTO implements IWebSocketConnectionDTO {
+    Id: Guid;
+    UserId: Guid;
+    ConnectionId?: string;
+    constructor(init: WebSocketConnectionDTOInit);
+}
+
+/**
+* Auto-generated client for the RoomInstance controller.
+*/
+declare class RoomInstance {
+    private baseUrl;
+    constructor(baseUrl: string);
+    ReadByUserId(userId: Guid): Promise<RoomInstanceDTO[]>;
+    ReadViewPageByUniqueId(uniqueId: Guid, pageNumber: number, pageSize: number): Promise<RoomInstanceViewDTO[]>;
+    ReadUserCountByUniqueId(uniqueId: Guid): Promise<UniqueViewDTO>;
+    Read(roomInstanceId: Guid): Promise<RoomInstanceViewDTO>;
+    ReadConnectionsById(roomInstanceId: Guid): Promise<WebSocketConnectionDTO[]>;
+    ReadByConnectionId(connectionId: string): Promise<RoomInstanceDTO[]>;
+    Join(roomInstanceId: Guid, connectionId: string): Promise<RoomInstanceDTO>;
+    Leave(roomInstanceId: Guid): Promise<RoomInstanceDTO>;
+    Create(uniqueId: Guid, maxUsers: number): Promise<RoomInstanceDTO>;
+    Remove(roomInstanceId: Guid): Promise<RoomInstanceDTO>;
+}
+
+declare enum UserStatusType {
+    Offline = 0,
+    Online = 1,
+    Away = 2,
+    DoNotDisturb = 3
+}
+
+/**
+ * Represents an Auto-generated model for UserSettingDTO.
+ */
+interface IUserSettingDTO {
+    Id: Guid;
+    UserId: Guid;
+    Status: UserStatusType;
+    StatusDescription?: string;
+    TimeZone?: string;
+}
+type UserSettingDTOInit = Partial<IUserSettingDTO> & Pick<IUserSettingDTO, "Id" | "UserId" | "Status">;
+declare class UserSettingDTO implements IUserSettingDTO {
+    Id: Guid;
+    UserId: Guid;
+    Status: UserStatusType;
+    StatusDescription?: string;
+    TimeZone?: string;
+    constructor(init: UserSettingDTOInit);
+}
+
+/**
+* Auto-generated client for the UserSetting controller.
+*/
+declare class UserSetting {
+    private baseUrl;
+    constructor(baseUrl: string);
+    GetOrCreate(userId: Guid): Promise<UserSettingDTO>;
+    Set(userSettingDTO: UserSettingDTO): Promise<UserSettingDTO>;
+}
+
+/**
+ * Represents an Auto-generated model for StringResultDTO.
+ */
+interface IStringResultDTO {
+    Result?: string;
+}
+type StringResultDTOInit = Partial<IStringResultDTO>;
+declare class StringResultDTO implements IStringResultDTO {
+    Result?: string;
+    constructor(init: StringResultDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for GuidResultDTO.
+ */
+interface IGuidResultDTO {
+    Result: Guid;
+}
+type GuidResultDTOInit = Partial<IGuidResultDTO> & Pick<IGuidResultDTO, "Result">;
+declare class GuidResultDTO implements IGuidResultDTO {
+    Result: Guid;
+    constructor(init: GuidResultDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for WebSocketClientRequestDTO.
+ */
+interface IWebSocketClientRequestDTO {
+    AccessToken?: string;
+    Data?: string;
+    Type?: string;
+    ControllerName?: string;
+    MethodName?: string;
+}
+type WebSocketClientRequestDTOInit = Partial<IWebSocketClientRequestDTO>;
+declare class WebSocketClientRequestDTO implements IWebSocketClientRequestDTO {
+    AccessToken?: string;
+    Data?: string;
+    Type?: string;
+    ControllerName?: string;
+    MethodName?: string;
+    constructor(init: WebSocketClientRequestDTOInit);
+}
+
+/**
+* Auto-generated client for the WebSocketConnection controller.
+*/
+declare class WebSocketConnection {
+    private baseUrl;
+    constructor(baseUrl: string);
+    Create(webSocketConnectionDTO: WebSocketConnectionDTO): Promise<WebSocketConnectionDTO>;
+    Remove(connectionId: string): Promise<StringResultDTO>;
+    ReadConnections(userId: Guid): Promise<WebSocketConnectionDTO[]>;
+    ReadUserIdByConnectionId(connectionId: string): Promise<GuidResultDTO>;
+    Clear(): Promise<StringResultDTO>;
+    SendMessage(webSocketClientRequestDTO: WebSocketClientRequestDTO): Promise<WebSocketClientRequestDTO>;
+}
+
+/**
+* Auto-generated API client.
+*/
+declare class SparkStudioRealtimeSDK {
+    home: Home;
+    roomInstance: RoomInstance;
+    userSetting: UserSetting;
+    webSocketConnection: WebSocketConnection;
+    constructor(baseUrl: string);
+}
+
+export { GuidResultDTO, Home, type IGuidResultDTO, type IRoomInstanceDTO, type IRoomInstanceViewDTO, type IStringResultDTO, type IUniqueViewDTO, type IUserSettingDTO, type IWebSocketClientRequestDTO, type IWebSocketConnectionDTO, RoomInstance, RoomInstanceDTO, RoomInstanceViewDTO, SparkStudioRealtimeSDK, StringResultDTO, UniqueViewDTO, UserSetting, UserSettingDTO, UserStatusType, WebSocketClientRequestDTO, WebSocketConnection, WebSocketConnectionDTO };

package/dist/index.d.ts

@@ -0,0 +1,203 @@
+/**
+* Auto-generated client for the Home controller.
+*/
+declare class Home {
+    private baseUrl;
+    constructor(baseUrl: string);
+}
+
+type Guid = string & {
+    readonly __brand: unique symbol;
+};
+
+/**
+ * Represents an Auto-generated model for RoomInstanceDTO.
+ */
+interface IRoomInstanceDTO {
+    Id: Guid;
+    HostUserId: Guid;
+    UniqueId: Guid;
+    Data?: string;
+    MaxUsers: number;
+}
+type RoomInstanceDTOInit = Partial<IRoomInstanceDTO> & Pick<IRoomInstanceDTO, "Id" | "HostUserId" | "UniqueId" | "MaxUsers">;
+declare class RoomInstanceDTO implements IRoomInstanceDTO {
+    Id: Guid;
+    HostUserId: Guid;
+    UniqueId: Guid;
+    Data?: string;
+    MaxUsers: number;
+    constructor(init: RoomInstanceDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for RoomInstanceViewDTO.
+ */
+interface IRoomInstanceViewDTO {
+    Id: Guid;
+    RoomInstance: RoomInstanceDTO;
+    UsersInRoom: number;
+}
+type RoomInstanceViewDTOInit = Partial<IRoomInstanceViewDTO> & Pick<IRoomInstanceViewDTO, "Id" | "RoomInstance" | "UsersInRoom">;
+declare class RoomInstanceViewDTO implements IRoomInstanceViewDTO {
+    Id: Guid;
+    RoomInstance: RoomInstanceDTO;
+    UsersInRoom: number;
+    constructor(init: RoomInstanceViewDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for UniqueViewDTO.
+ */
+interface IUniqueViewDTO {
+    Id: Guid;
+    UserCount: number;
+}
+type UniqueViewDTOInit = Partial<IUniqueViewDTO> & Pick<IUniqueViewDTO, "Id" | "UserCount">;
+declare class UniqueViewDTO implements IUniqueViewDTO {
+    Id: Guid;
+    UserCount: number;
+    constructor(init: UniqueViewDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for WebSocketConnectionDTO.
+ */
+interface IWebSocketConnectionDTO {
+    Id: Guid;
+    UserId: Guid;
+    ConnectionId?: string;
+}
+type WebSocketConnectionDTOInit = Partial<IWebSocketConnectionDTO> & Pick<IWebSocketConnectionDTO, "Id" | "UserId">;
+declare class WebSocketConnectionDTO implements IWebSocketConnectionDTO {
+    Id: Guid;
+    UserId: Guid;
+    ConnectionId?: string;
+    constructor(init: WebSocketConnectionDTOInit);
+}
+
+/**
+* Auto-generated client for the RoomInstance controller.
+*/
+declare class RoomInstance {
+    private baseUrl;
+    constructor(baseUrl: string);
+    ReadByUserId(userId: Guid): Promise<RoomInstanceDTO[]>;
+    ReadViewPageByUniqueId(uniqueId: Guid, pageNumber: number, pageSize: number): Promise<RoomInstanceViewDTO[]>;
+    ReadUserCountByUniqueId(uniqueId: Guid): Promise<UniqueViewDTO>;
+    Read(roomInstanceId: Guid): Promise<RoomInstanceViewDTO>;
+    ReadConnectionsById(roomInstanceId: Guid): Promise<WebSocketConnectionDTO[]>;
+    ReadByConnectionId(connectionId: string): Promise<RoomInstanceDTO[]>;
+    Join(roomInstanceId: Guid, connectionId: string): Promise<RoomInstanceDTO>;
+    Leave(roomInstanceId: Guid): Promise<RoomInstanceDTO>;
+    Create(uniqueId: Guid, maxUsers: number): Promise<RoomInstanceDTO>;
+    Remove(roomInstanceId: Guid): Promise<RoomInstanceDTO>;
+}
+
+declare enum UserStatusType {
+    Offline = 0,
+    Online = 1,
+    Away = 2,
+    DoNotDisturb = 3
+}
+
+/**
+ * Represents an Auto-generated model for UserSettingDTO.
+ */
+interface IUserSettingDTO {
+    Id: Guid;
+    UserId: Guid;
+    Status: UserStatusType;
+    StatusDescription?: string;
+    TimeZone?: string;
+}
+type UserSettingDTOInit = Partial<IUserSettingDTO> & Pick<IUserSettingDTO, "Id" | "UserId" | "Status">;
+declare class UserSettingDTO implements IUserSettingDTO {
+    Id: Guid;
+    UserId: Guid;
+    Status: UserStatusType;
+    StatusDescription?: string;
+    TimeZone?: string;
+    constructor(init: UserSettingDTOInit);
+}
+
+/**
+* Auto-generated client for the UserSetting controller.
+*/
+declare class UserSetting {
+    private baseUrl;
+    constructor(baseUrl: string);
+    GetOrCreate(userId: Guid): Promise<UserSettingDTO>;
+    Set(userSettingDTO: UserSettingDTO): Promise<UserSettingDTO>;
+}
+
+/**
+ * Represents an Auto-generated model for StringResultDTO.
+ */
+interface IStringResultDTO {
+    Result?: string;
+}
+type StringResultDTOInit = Partial<IStringResultDTO>;
+declare class StringResultDTO implements IStringResultDTO {
+    Result?: string;
+    constructor(init: StringResultDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for GuidResultDTO.
+ */
+interface IGuidResultDTO {
+    Result: Guid;
+}
+type GuidResultDTOInit = Partial<IGuidResultDTO> & Pick<IGuidResultDTO, "Result">;
+declare class GuidResultDTO implements IGuidResultDTO {
+    Result: Guid;
+    constructor(init: GuidResultDTOInit);
+}
+
+/**
+ * Represents an Auto-generated model for WebSocketClientRequestDTO.
+ */
+interface IWebSocketClientRequestDTO {
+    AccessToken?: string;
+    Data?: string;
+    Type?: string;
+    ControllerName?: string;
+    MethodName?: string;
+}
+type WebSocketClientRequestDTOInit = Partial<IWebSocketClientRequestDTO>;
+declare class WebSocketClientRequestDTO implements IWebSocketClientRequestDTO {
+    AccessToken?: string;
+    Data?: string;
+    Type?: string;
+    ControllerName?: string;
+    MethodName?: string;
+    constructor(init: WebSocketClientRequestDTOInit);
+}
+
+/**
+* Auto-generated client for the WebSocketConnection controller.
+*/
+declare class WebSocketConnection {
+    private baseUrl;
+    constructor(baseUrl: string);
+    Create(webSocketConnectionDTO: WebSocketConnectionDTO): Promise<WebSocketConnectionDTO>;
+    Remove(connectionId: string): Promise<StringResultDTO>;
+    ReadConnections(userId: Guid): Promise<WebSocketConnectionDTO[]>;
+    ReadUserIdByConnectionId(connectionId: string): Promise<GuidResultDTO>;
+    Clear(): Promise<StringResultDTO>;
+    SendMessage(webSocketClientRequestDTO: WebSocketClientRequestDTO): Promise<WebSocketClientRequestDTO>;
+}
+
+/**
+* Auto-generated API client.
+*/
+declare class SparkStudioRealtimeSDK {
+    home: Home;
+    roomInstance: RoomInstance;
+    userSetting: UserSetting;
+    webSocketConnection: WebSocketConnection;
+    constructor(baseUrl: string);
+}
+
+export { GuidResultDTO, Home, type IGuidResultDTO, type IRoomInstanceDTO, type IRoomInstanceViewDTO, type IStringResultDTO, type IUniqueViewDTO, type IUserSettingDTO, type IWebSocketClientRequestDTO, type IWebSocketConnectionDTO, RoomInstance, RoomInstanceDTO, RoomInstanceViewDTO, SparkStudioRealtimeSDK, StringResultDTO, UniqueViewDTO, UserSetting, UserSettingDTO, UserStatusType, WebSocketClientRequestDTO, WebSocketConnection, WebSocketConnectionDTO };