@ludeo/cloud-common 1.1.142 → 1.2.0

package/src/v4/events/terminate-stale-resources-task.ts

@@ -0,0 +1,16 @@
+import { LudeoEvent } from "../../infra";
+
+export class TerminateStaleResourcesTaskPayload {}
+
+export class TerminateStaleResourcesTask extends LudeoEvent {
+  static readonly EVENT_NAME = "cloud-pools.terminate-stale-resources-task";
+
+  constructor(payload: TerminateStaleResourcesTaskPayload, context: never) {
+    super(TerminateStaleResourcesTask.EVENT_NAME);
+    this.payload = payload;
+  }
+
+  context: never;
+
+  payload: TerminateStaleResourcesTaskPayload;
+}

package/src/v4/events/token-required.event.ts

@@ -0,0 +1,61 @@
+import { IsBoolean, IsNumber, IsString } from "class-validator";
+
+import { LudeoEvent } from "../../infra/ludeo-event";
+import { ValidateNestedType } from "../../decorators/validate-nested-type.decorator";
+
+export class TokenRequiredConnectionDetails {
+  @IsString()
+  resourceId: string;
+}
+
+export class TokenRequiredEventData {
+  @IsString()
+  defaultUser: string;
+
+  @IsString()
+  authSource: string;
+
+  @ValidateNestedType(() => TokenRequiredConnectionDetails)
+  connectionDetails: TokenRequiredConnectionDetails;
+
+  @IsString()
+  authToken: string;
+}
+
+export class TokenRequiredEventPayload {
+  @IsString()
+  id: string;
+
+  @IsString()
+  type: string;
+
+  @IsString()
+  userId: string;
+
+  @IsNumber()
+  expireAt: number;
+
+  @IsNumber()
+  quota: number;
+
+  @IsBoolean()
+  isUnique: boolean;
+
+  @ValidateNestedType(() => TokenRequiredEventData)
+  data: TokenRequiredEventData;
+}
+
+export class TokenRequired extends LudeoEvent {
+  static readonly EVENT_NAME = "tokens.token-required";
+
+  @ValidateNestedType(() => TokenRequiredEventPayload)
+  payload: TokenRequiredEventPayload;
+
+  context?: never;
+
+  constructor(payload: TokenRequiredEventPayload, context?: never) {
+    super(TokenRequired.EVENT_NAME);
+    this.payload = payload;
+    this.context = context;
+  }
+}

package/src/v4/index.ts

@@ -0,0 +1,3 @@
+export * as Events from "./events";
+export * as Types from "./types";
+export * as Contexts from "./contexts";

package/src/v4/types/cloud.ts

@@ -0,0 +1,155 @@
+import { GameCast } from "@ludeo/aws-gamecast-sdk";
+import {
+  IsDefined,
+  IsEnum,
+  IsNotEmpty,
+  IsNumber,
+  IsOptional,
+  IsString,
+  IsUUID,
+} from "class-validator";
+import { ValidateNestedType } from "../../decorators";
+
+export class AWSRequestData {
+  @IsString()
+  @IsNotEmpty()
+  signalRequest: string;
+}
+
+export type CloudProviderRequest = AWSRequestData;
+
+export enum CloudProvider {
+  AWS = "aws",
+  NVIDIA = "nvidia",
+}
+
+export class AWSProviderSettings {
+  streamGroupId: GameCast.Identifier;
+  additionalEnvironmentVariables?: GameCast.EnvironmentVariables;
+  protocol?: GameCast.Protocol;
+  connectionTimeoutSeconds?: GameCast.ConnectionTimeoutSeconds;
+  sessionLengthSeconds?: GameCast.SessionLengthSeconds;
+  applicationIdentifier?: GameCast.Identifier;
+  machinePoolSize?: number;
+  region?: string;
+}
+
+export type CloudProviderSettings = AWSProviderSettings;
+
+export class AwsAllocationData {
+  @IsString()
+  streamGroupId: string;
+
+  @IsString()
+  streamSessionId: string;
+
+  @IsString()
+  signalResponse: string;
+}
+
+export type CloudProviderAllocationData = AwsAllocationData;
+
+export class AWSResourceProviderSettings {
+  @IsOptional()
+  @IsString()
+  streamSessionId?: string;
+
+  @IsOptional()
+  @IsString()
+  streamGroupId?: string;
+
+  @IsEnum(CloudProvider)
+  @IsOptional()
+  cloudProvider?: CloudProvider;
+
+  @IsOptional()
+  @IsString()
+  region?: string;
+}
+
+export type CloudResourceProviderSettings = AWSResourceProviderSettings;
+
+export class AWSGameCreationResponse {
+  @IsString()
+  @IsNotEmpty()
+  streamSessionId: string;
+}
+
+export type GameCreationResponse = AWSGameCreationResponse;
+
+export class AllocationRequestData {
+  @ValidateNestedType(() => AWSRequestData)
+  @IsDefined()
+  cloudProviderRequest: CloudProviderRequest;
+
+  @IsString()
+  @IsOptional()
+  clientIp?: string;
+
+  @IsString()
+  @IsOptional()
+  region?: string;
+}
+
+export enum CloudSessionStatus {
+  Created = "created",
+  PendingAllocation = "pending",
+  SwappingUser = "swappingUser",
+  LudeoObtained = "ludeoObtained",
+  Allocated = "allocated",
+  Terminated = "terminated",
+  Failed = "failed",
+}
+
+export class CloudSession {
+  @IsUUID()
+  id: string;
+
+  @IsUUID()
+  userId: string;
+
+  @IsUUID()
+  gameId: string;
+
+  @IsUUID()
+  ludeoId: string;
+
+  @IsNumber()
+  createdAt: number;
+
+  @IsNumber()
+  updatedAt: number;
+
+  @IsEnum(CloudSessionStatus)
+  status: CloudSessionStatus;
+
+  @IsEnum(CloudProvider)
+  cloudProvider: CloudProvider;
+
+  @IsOptional()
+  @IsUUID()
+  gameResourceId?: string;
+
+  @IsOptional()
+  @IsUUID()
+  poolId?: string;
+
+  @ValidateNestedType(() => AllocationRequestData)
+  requestData: AllocationRequestData;
+
+  @IsOptional()
+  @ValidateNestedType(() => AwsAllocationData)
+  allocationData?: CloudProviderAllocationData;
+
+  @IsUUID()
+  clientRequestId: string;
+
+  @IsOptional()
+  @IsString()
+  sessionToken?: string;
+
+  // For backwards compatability
+  @IsOptional()
+  @IsString()
+  resourceId?: string;
+}

package/src/v4/types/index.ts

@@ -0,0 +1,2 @@
+export * from "./cloud";
+export * from "./pools";

package/src/v4/types/pools/configuration/attributes/base.ts

@@ -0,0 +1,15 @@
+import { IsEnum, IsOptional, IsString } from "class-validator";
+import { CloudProvider } from "../../../cloud";
+
+export class BasePoolAttributes {
+  @IsEnum(CloudProvider)
+  cloudProvider: CloudProvider;
+
+  @IsOptional()
+  @IsString()
+  friendlyName?: string;
+
+  @IsOptional()
+  @IsString()
+  region?: string;
+}

package/src/v4/types/pools/configuration/attributes/game.ts

@@ -0,0 +1,7 @@
+import { IsString } from "class-validator";
+import { MachinePoolAttributes } from "./machine";
+
+export class GamePoolAttributes extends MachinePoolAttributes {
+  @IsString()
+  gameId: string;
+}

package/src/v4/types/pools/configuration/attributes/index.ts

@@ -0,0 +1,4 @@
+export * from "./game";
+export * from "./machine";
+export * from "./base";
+export * from "./ludeo";

package/src/v4/types/pools/configuration/attributes/ludeo.ts

@@ -0,0 +1,7 @@
+import { IsString } from "class-validator";
+import { GamePoolAttributes } from "./game";
+
+export class LudeoPoolAttributes extends GamePoolAttributes {
+  @IsString()
+  ludeoId: string;
+}

package/src/v4/types/pools/configuration/attributes/machine.ts

@@ -0,0 +1,8 @@
+import { IsString } from "class-validator";
+
+import { BasePoolAttributes } from "./base";
+
+export class MachinePoolAttributes extends BasePoolAttributes {
+  @IsString()
+  machineClass: string;
+}

package/src/v4/types/pools/configuration/base.ts

@@ -0,0 +1,36 @@
+import { IsNumber, IsEnum, IsUUID, IsOptional } from "class-validator";
+
+import {
+  AWSProviderSettings,
+  CloudProvider,
+  CloudProviderSettings,
+} from "../../cloud";
+import { CloudPoolType } from "../type";
+import { BasePoolAttributes } from "./attributes";
+import { ValidateNestedType } from "../../../../decorators";
+
+export class PoolScaleConfiguration {
+  @IsNumber()
+  size: number;
+}
+
+export class BaseCloudPoolConfiguration {
+  @IsOptional()
+  @ValidateNestedType(() => AWSProviderSettings)
+  providerSettings?: CloudProviderSettings;
+
+  @IsEnum(CloudProvider)
+  cloudProvider: CloudProvider;
+
+  @IsUUID()
+  poolId: string;
+
+  @ValidateNestedType(() => PoolScaleConfiguration)
+  poolScaleConfiguration: PoolScaleConfiguration;
+
+  @IsEnum(CloudPoolType)
+  type: CloudPoolType;
+
+  @ValidateNestedType(() => BasePoolAttributes)
+  attributes: BasePoolAttributes;
+}

package/src/v4/types/pools/configuration/game.ts

@@ -0,0 +1,20 @@
+import { IsEnum, IsUUID } from "class-validator";
+
+import { CloudPoolType } from "../type";
+import { GamePoolAttributes } from "./attributes";
+import { BaseCloudPoolConfiguration } from "./base";
+import { ValidateNestedType } from "../../../../decorators";
+
+export class GamePoolConfiguration extends BaseCloudPoolConfiguration {
+  @IsEnum(CloudPoolType)
+  type: CloudPoolType.GAME;
+
+  @IsUUID()
+  gameId: string;
+
+  @IsUUID()
+  machinePoolId: string;
+
+  @ValidateNestedType(() => GamePoolAttributes)
+  attributes: GamePoolAttributes;
+}

package/src/v4/types/pools/configuration/index.ts

@@ -0,0 +1,6 @@
+export * from "./base";
+export * from "./game";
+export * from "./machine";
+export * from "./type";
+export * from "./attributes";
+export * from "./ludeo";

package/src/v4/types/pools/configuration/ludeo.ts

@@ -0,0 +1,20 @@
+import { IsEnum, IsUUID } from "class-validator";
+
+import { CloudPoolType } from "../type";
+import { LudeoPoolAttributes } from "./attributes";
+import { BaseCloudPoolConfiguration } from "./base";
+import { ValidateNestedType } from "../../../../decorators";
+
+export class LudeoPoolConfiguration extends BaseCloudPoolConfiguration {
+  @IsEnum(CloudPoolType)
+  type: CloudPoolType.LUDEO;
+
+  @IsUUID()
+  ludeoId: string;
+
+  @IsUUID()
+  gamePoolId: string;
+
+  @ValidateNestedType(() => LudeoPoolAttributes)
+  attributes: LudeoPoolAttributes;
+}

package/src/v4/types/pools/configuration/machine.ts

@@ -0,0 +1,14 @@
+import { IsEnum } from "class-validator";
+
+import { CloudPoolType } from "../type";
+import { BaseCloudPoolConfiguration } from "./base";
+import { MachinePoolAttributes } from "./attributes";
+import { ValidateNestedType } from "../../../../decorators";
+
+export class MachinePoolConfiguration extends BaseCloudPoolConfiguration {
+  @IsEnum(CloudPoolType)
+  type: CloudPoolType.MACHINE;
+
+  @ValidateNestedType(() => MachinePoolAttributes)
+  attributes: MachinePoolAttributes;
+}

package/src/v4/types/pools/configuration/type.ts

@@ -0,0 +1,17 @@
+import { CloudPoolType } from "../type";
+import { GamePoolConfiguration } from "./game";
+import { LudeoPoolConfiguration } from "./ludeo";
+import { BaseCloudPoolConfiguration } from "./base";
+import { MachinePoolConfiguration } from "./machine";
+
+export type CloudPoolConfigurationType<
+  T extends CloudPoolType | undefined = undefined
+> = T extends undefined
+  ? BaseCloudPoolConfiguration
+  : T extends CloudPoolType.GAME
+  ? GamePoolConfiguration
+  : T extends CloudPoolType.MACHINE
+  ? MachinePoolConfiguration
+  : T extends CloudPoolType.LUDEO
+  ? LudeoPoolConfiguration
+  : BaseCloudPoolConfiguration;

package/src/v4/types/pools/index.ts

@@ -0,0 +1,5 @@
+export * from "./status";
+export * from "./configuration";
+export * from "./type";
+export * from "./resource";
+export * from "./pool";

package/src/v4/types/pools/pool.ts

@@ -0,0 +1,14 @@
+import { CloudPoolType } from "./type";
+import { CloudPoolStatus } from "./status";
+import { CloudPoolConfigurationType } from "./configuration";
+import { BaseCloudResource } from "./resource";
+
+export type CloudResourcesMap<T extends BaseCloudResource> = Record<string, T>;
+
+export class CloudPool<T extends CloudPoolType | undefined = undefined> {
+  id: string;
+  status: CloudPoolStatus;
+  createdAt: number;
+  updatedAt?: number;
+  config: CloudPoolConfigurationType<T>;
+}

package/src/v4/types/pools/resource/base.ts

@@ -0,0 +1,26 @@
+import { IsEnum, IsNumber, IsOptional, IsUUID } from "class-validator";
+
+import { CloudResourceStatus } from "./status";
+import { AWSResourceProviderSettings } from "../../cloud";
+import { ValidateNestedType } from "../../../../decorators";
+
+export class BaseCloudResource {
+  @IsUUID()
+  id: string;
+
+  @IsEnum(CloudResourceStatus)
+  status: CloudResourceStatus;
+
+  @IsNumber()
+  createdAt: number;
+
+  @IsUUID()
+  poolId: string;
+
+  @IsNumber()
+  @IsOptional()
+  updatedAt?: number;
+
+  @ValidateNestedType(() => AWSResourceProviderSettings)
+  settings?: AWSResourceProviderSettings;
+}

package/src/v4/types/pools/resource/game.ts

@@ -0,0 +1,17 @@
+import { IsOptional, IsString } from "class-validator";
+
+import { BaseCloudResource } from "./base";
+
+export class GameCloudResource extends BaseCloudResource {
+  @IsString()
+  @IsOptional()
+  machineResourceId?: string;
+
+  @IsString()
+  @IsOptional()
+  ludeoResourceId?: string;
+
+  @IsString()
+  @IsOptional()
+  ludeoPoolId?: string;
+}

package/src/v4/types/pools/resource/index.ts

@@ -0,0 +1,7 @@
+export * from "./base";
+export * from "./game";
+export * from "./machine";
+export * from "./status";
+export * from "./statusMap";
+export * from "./type";
+export * from "./ludeo";

package/src/v4/types/pools/resource/ludeo.ts

@@ -0,0 +1,9 @@
+import { IsOptional, IsString } from "class-validator";
+
+import { BaseCloudResource } from "./base";
+
+export class LudeoCloudResource extends BaseCloudResource {
+  @IsString()
+  @IsOptional()
+  gameResourceId?: string;
+}

package/src/v4/types/pools/resource/machine.ts

@@ -0,0 +1,12 @@
+import { IsOptional, IsUUID } from "class-validator";
+import { BaseCloudResource } from "./base";
+
+export class MachineCloudResource extends BaseCloudResource {
+  @IsOptional()
+  @IsUUID()
+  gameResourceId?: string;
+
+  @IsOptional()
+  @IsUUID()
+  gamePoolId?: string;
+}

package/src/v4/types/pools/resource/status.ts

@@ -0,0 +1,10 @@
+export enum CloudResourceStatus {
+  Allocated = "allocated",
+  Available = "available",
+  Creating = "creating",
+  Created = "created",
+  Allocating = "allocating",
+  Error = "error",
+  Terminating = "terminating",
+  Terminated = "terminated",
+}

package/src/v4/types/pools/resource/statusMap.ts

@@ -0,0 +1,3 @@
+import { CloudResourceStatus } from "./status";
+
+export type CloudResourcesStatusMap = Record<CloudResourceStatus, number>;

package/src/v4/types/pools/resource/type.ts

@@ -0,0 +1,16 @@
+import { CloudPoolType } from "../type";
+import { BaseCloudResource } from "./base";
+import { GameCloudResource } from "./game";
+import { LudeoCloudResource } from "./ludeo";
+import { MachineCloudResource } from "./machine";
+
+export type CloudResourceType<T extends CloudPoolType | undefined = undefined> =
+  T extends undefined
+    ? BaseCloudResource
+    : T extends CloudPoolType.GAME
+    ? GameCloudResource
+    : T extends CloudPoolType.MACHINE
+    ? MachineCloudResource
+    : T extends CloudPoolType.LUDEO
+    ? LudeoCloudResource
+    : BaseCloudResource;

package/src/v4/types/pools/status.ts

@@ -0,0 +1,6 @@
+export enum CloudPoolStatus {
+  Active = "active",
+  Created = "created",
+  Scaling = "scaling",
+  Terminated = "terminated",
+}

package/src/v4/types/pools/type.ts

@@ -0,0 +1,5 @@
+export enum CloudPoolType {
+  GAME = "game",
+  MACHINE = "machine",
+  LUDEO = "ludeo",
+}