@digital-ai/devops-page-object-release 0.0.1

package/types/index.ts

@@ -0,0 +1,141 @@
+interface BaseConfigurationItem {
+  id: string;
+  type: string;
+}
+
+interface PlanItem extends BaseConfigurationItem {
+  title: string;
+}
+
+export interface Release extends PlanItem {
+  allowConcurrentReleasesFromTrigger: boolean;
+  attachments: Array<Attachment>;
+  description: string;
+  dueDate?: Date;
+  endDate?: Date;
+  extensions: Array<ReleaseExtension>;
+  owner?: string;
+  passwordVariableValues?: VariableValues;
+  phases: Array<Phase>;
+  queryableEndDate?: Date;
+  queryableStartDate?: Date;
+  scheduledStartDate?: Date;
+  scriptUserPassword?: string;
+  scriptUsername?: string;
+  startDate?: Date;
+  status: ReleaseStatus;
+  summary?: Dashboard;
+  teams: Array<Team>;
+  variableValues?: VariableValues;
+  variables: Array<Variable>;
+}
+
+interface VariableValues {
+  [key: string]: any;
+}
+
+export interface Variable extends PlanItem {
+  key: string;
+  requiresValue: boolean;
+  showOnReleaseStart: boolean;
+  value: any;
+  valueProvider?: VariableValueProvider;
+}
+
+export interface VariableValueProvider {
+  id: string;
+  variable: string;
+}
+
+export interface Container extends PlanItem {
+  tasks: Array<Task>;
+}
+
+export interface Phase extends Container {
+  status: PhaseStatus;
+}
+
+export interface Task extends PlanItem {
+  attachments: Array<Attachment>;
+  comments: Array<Comment>;
+  conditions: Array<Condition>;
+  dependencies: Array<Dependency>;
+  links: Array<Link>;
+  owner?: string;
+  pythonScript?: PythonScript;
+  status: TaskStatus;
+  tasks: Array<Task>;
+  templateVariables: Array<Variable>;
+}
+
+type Condition = PlanItem;
+type Dependency = PlanItem;
+type Link = PlanItem;
+type Comment = PlanItem;
+type Attachment = PlanItem;
+
+export interface Dashboard extends ReleaseExtension {
+  tiles: Array<Tile>;
+}
+
+type ReleaseExtension = BaseConfigurationItem;
+export type Tile = BaseConfigurationItem;
+
+interface PythonScript extends BaseConfigurationItem {
+  customScriptTask: string;
+}
+
+type ReleaseStatus = 'TEMPLATE' | 'PLANNED' | 'IN_PROGRESS' | 'PAUSED' | 'FAILING' | 'FAILED' | 'COMPLETED' | 'ABORTED';
+type PhaseStatus = 'PLANNED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILING' | 'FAILED' | 'SKIPPED' | 'ABORTED';
+type TaskStatus =
+  | 'IN_PROGRESS'
+  | 'PLANNED'
+  | 'SKIPPED_IN_ADVANCE'
+  | 'COMPLETED_IN_ADVANCE'
+  | 'COMPLETED'
+  | 'SKIPPED'
+  | 'ABORTED'
+  | 'PENDING'
+  | 'FACET_CHECK_IN_PROGRESS'
+  | 'FAILED'
+  | 'FAILING'
+  | 'FAILURE_HANDLER_IN_PROGRESS'
+  | 'ABORT_SCRIPT_IN_PROGRESS'
+  | 'PRECONDITION_IN_PROGRESS'
+  | 'QUEUED'
+  | 'ABORT_SCRIPT_QUEUED'
+  | 'WAITING_FOR_INPUT'
+  | 'FAILURE_HANDLER_QUEUED';
+
+type Team = BaseConfigurationItem;
+
+type FeatureCategory = 'Stable' | 'Incubating';
+type FeatureType = 'xlrelease.TaskDrawer'; // add more as needed
+export interface FixtureFeature {
+  category: FeatureCategory;
+  enabled: boolean;
+  id: string;
+  type: FeatureType;
+}
+
+type DeepPartial<T> = {
+  [P in keyof T]?: DeepPartial<T[P]>;
+};
+
+// for fixtures we allow releases with everything optional expect the `id`
+export type FixtureRelease = DeepPartial<Release> & Pick<Release, 'id'>;
+
+export interface FixtureConfiguration extends PlanItem {
+  password?: string;
+  url: string;
+  username?: string;
+}
+
+export interface FixtureTrigger extends PlanItem {
+  folderId?: string;
+  gitRepository?: string;
+  periodicity?: number | string;
+  pollType?: string;
+  releaseTitle: string;
+  template: string;
+}