Add shared types for benchmark APIs (#1921)

Fixes OPS-3548.

## Additional Notes

Author: ravikiranvm

packages/shared/src/index.ts

@@ -14,6 +14,7 @@ export * from './lib/authentication/dto/sign-up-request';
 export * from './lib/authentication/model/authentication-type';
 export * from './lib/authentication/model/principal';
 export * from './lib/authentication/model/principal-type';
+export * from './lib/benchmark';
 export * from './lib/blocks';
 export * from './lib/code/dto/code-request';
 export * from './lib/common';

packages/shared/src/lib/benchmark/dto/benchmark-status-response.ts

@@ -0,0 +1,28 @@
+import { Static, Type } from '@sinclair/typebox';
+import { BenchmarkWorkflowBase } from './create-benchmark-response';
+
+export enum BenchmarkStatus {
+  RUNNING = 'RUNNING',
+  SUCCEEDED = 'SUCCEEDED',
+  FAILED = 'FAILED',
+}
+
+export const BenchmarkWorkflowStatusItem = Type.Intersect([
+  BenchmarkWorkflowBase,
+  Type.Object({
+    runStatus: Type.String(),
+    runId: Type.Optional(Type.String()),
+  }),
+]);
+
+export type BenchmarkWorkflowStatusItem = Static<
+  typeof BenchmarkWorkflowStatusItem
+>;
+
+export const BenchmarkStatusResponse = Type.Object({
+  benchmarkId: Type.String(),
+  status: Type.Enum(BenchmarkStatus),
+  workflows: Type.Array(BenchmarkWorkflowStatusItem),
+});
+
+export type BenchmarkStatusResponse = Static<typeof BenchmarkStatusResponse>;

packages/shared/src/lib/benchmark/dto/create-benchmark-request.ts

@@ -0,0 +1,8 @@
+import { Static, Type } from '@sinclair/typebox';
+import { BenchmarkConfiguration } from './wizard-request';
+
+export const CreateBenchmarkRequest = Type.Object({
+  benchmarkConfiguration: BenchmarkConfiguration,
+});
+
+export type CreateBenchmarkRequest = Static<typeof CreateBenchmarkRequest>;

packages/shared/src/lib/benchmark/dto/create-benchmark-response.ts

@@ -0,0 +1,17 @@
+import { Static, Type } from '@sinclair/typebox';
+
+export const BenchmarkWorkflowBase = Type.Object({
+  flowId: Type.String(),
+  displayName: Type.String(),
+  isOrchestrator: Type.Boolean(),
+});
+
+export type BenchmarkWorkflowBase = Static<typeof BenchmarkWorkflowBase>;
+
+export const CreateBenchmarkResponse = Type.Object({
+  benchmarkId: Type.String(),
+  folderId: Type.String(),
+  workflows: Type.Array(BenchmarkWorkflowBase),
+});
+
+export type CreateBenchmarkResponse = Static<typeof CreateBenchmarkResponse>;

packages/shared/src/lib/benchmark/dto/index.ts

@@ -0,0 +1,6 @@
+export * from './benchmark-status-response';
+export * from './create-benchmark-request';
+export * from './create-benchmark-response';
+export * from './run-benchmark-response';
+export * from './wizard-request';
+export * from './wizard-response';

packages/shared/src/lib/benchmark/dto/run-benchmark-response.ts

@@ -0,0 +1,7 @@
+import { Static, Type } from '@sinclair/typebox';
+
+export const RunBenchmarkResponse = Type.Object({
+  orchestratorRunId: Type.String(),
+});
+
+export type RunBenchmarkResponse = Static<typeof RunBenchmarkResponse>;

packages/shared/src/lib/benchmark/dto/wizard-request.ts

@@ -0,0 +1,15 @@
+import { Static, Type } from '@sinclair/typebox';
+
+export const BenchmarkConfiguration = Type.Record(
+  Type.String(),
+  Type.Array(Type.String()),
+);
+
+export type BenchmarkConfiguration = Static<typeof BenchmarkConfiguration>;
+
+export const BenchmarkWizardRequest = Type.Object({
+  currentStep: Type.Optional(Type.String()),
+  benchmarkConfiguration: Type.Optional(BenchmarkConfiguration),
+});
+
+export type BenchmarkWizardRequest = Static<typeof BenchmarkWizardRequest>;

packages/shared/src/lib/benchmark/dto/wizard-response.ts

@@ -0,0 +1,28 @@
+import { Static, Type } from '@sinclair/typebox';
+
+export const BenchmarkWizardOption = Type.Object({
+  id: Type.String(),
+  displayName: Type.String(),
+  imageLogoUrl: Type.Optional(Type.String()),
+  metadata: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
+});
+
+export type BenchmarkWizardOption = Static<typeof BenchmarkWizardOption>;
+
+export const BenchmarkWizardStepResponse = Type.Object({
+  currentStep: Type.String(),
+  title: Type.String(),
+  description: Type.Optional(Type.String()),
+  nextStep: Type.Union([Type.String(), Type.Null()]),
+  selectionType: Type.Union([
+    Type.Literal('single'),
+    Type.Literal('multi-select'),
+  ]),
+  options: Type.Array(BenchmarkWizardOption),
+  stepIndex: Type.Number(),
+  totalSteps: Type.Number(),
+});
+
+export type BenchmarkWizardStepResponse = Static<
+  typeof BenchmarkWizardStepResponse
+>;

packages/shared/src/lib/benchmark/index.ts

@@ -0,0 +1 @@
+export * from './dto';