@pellux/goodvibes-tui 0.19.24 → 0.19.26

package/src/input/onboarding/onboarding-wizard-types.ts

@@ -0,0 +1,170 @@
+import { isIP } from 'node:net';
+import type { ModelPickerTarget } from '../model-picker.ts';
+import {
+  deriveOnboardingStepState,
+  type OnboardingAcknowledgementReason,
+  type OnboardingAcknowledgementTarget,
+  type OnboardingApplyOperation,
+  type OnboardingApplyRequest,
+  type OnboardingMode,
+  type OnboardingSnapshotState,
+  type OnboardingStep1CapabilityId,
+  type OnboardingStep1CapabilityItem,
+  type OnboardingStepDerivationState,
+} from '../../runtime/onboarding/index.ts';
+import type { ConfigKey } from '../../config/index.ts';
+
+export type OnboardingWizardMode = OnboardingMode;
+
+export type OnboardingWizardStepId =
+  | 'loading'
+  | 'capabilities'
+  | 'network'
+  | 'access'
+  | 'external-services'
+  | 'provider-access'
+  | 'default-model'
+  | 'experience'
+  | 'review';
+
+export type OnboardingWizardFieldKind =
+  | 'status'
+  | 'checklist'
+  | 'radio'
+  | 'text'
+  | 'masked'
+  | 'acknowledgement'
+  | 'modelPicker'
+  | 'action';
+
+export type OnboardingWizardAction =
+  | 'apply'
+  | 'select-all-capabilities'
+  | 'clear-capabilities'
+  | 'start-openai-subscription'
+  | 'finish-openai-subscription';
+
+export interface OnboardingWizardRadioOption {
+  readonly id: string;
+  readonly label: string;
+  readonly hint: string;
+}
+
+export interface OnboardingWizardModelSelection {
+  readonly providerId: string;
+  readonly modelId: string;
+  readonly enabled?: boolean;
+}
+
+interface OnboardingWizardFieldBase {
+  readonly id: string;
+  readonly kind: OnboardingWizardFieldKind;
+  readonly label: string;
+  readonly hint: string;
+}
+
+export interface OnboardingWizardChecklistFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'checklist';
+  readonly defaultValue: boolean;
+  readonly capabilityId?: OnboardingStep1CapabilityId;
+}
+
+export interface OnboardingWizardRadioFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'radio';
+  readonly options: readonly OnboardingWizardRadioOption[];
+  readonly defaultValue: string;
+}
+
+export interface OnboardingWizardTextFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'text';
+  readonly defaultValue: string;
+  readonly placeholder: string;
+  readonly required?: boolean;
+}
+
+export interface OnboardingWizardMaskedFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'masked';
+  readonly defaultValue: string;
+  readonly placeholder: string;
+  readonly required?: boolean;
+}
+
+export interface OnboardingWizardStatusFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'status';
+  readonly defaultValue: string;
+}
+
+export interface OnboardingWizardAcknowledgementFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'acknowledgement';
+  readonly defaultValue: boolean;
+  readonly required: boolean;
+  readonly reason: OnboardingAcknowledgementReason;
+  readonly target?: OnboardingAcknowledgementTarget;
+}
+
+export interface OnboardingWizardModelPickerFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'modelPicker';
+  readonly target: ModelPickerTarget;
+  readonly defaultSelection: OnboardingWizardModelSelection;
+}
+
+export interface OnboardingWizardActionFieldDefinition extends OnboardingWizardFieldBase {
+  readonly kind: 'action';
+  readonly action: OnboardingWizardAction;
+  readonly defaultValue: string;
+}
+
+export type OnboardingWizardFieldDefinition =
+  | OnboardingWizardStatusFieldDefinition
+  | OnboardingWizardChecklistFieldDefinition
+  | OnboardingWizardRadioFieldDefinition
+  | OnboardingWizardTextFieldDefinition
+  | OnboardingWizardMaskedFieldDefinition
+  | OnboardingWizardAcknowledgementFieldDefinition
+  | OnboardingWizardModelPickerFieldDefinition
+  | OnboardingWizardActionFieldDefinition;
+
+export interface OnboardingWizardStepDefinition {
+  readonly id: OnboardingWizardStepId;
+  readonly title: string;
+  readonly shortLabel: string;
+  readonly description: string;
+  readonly summaryTitle: string;
+  readonly summaryLines: readonly string[];
+  readonly fields: readonly OnboardingWizardFieldDefinition[];
+}
+
+export interface OnboardingWizardFieldWindow {
+  readonly start: number;
+  readonly end: number;
+  readonly total: number;
+  readonly fields: readonly OnboardingWizardFieldDefinition[];
+}
+
+export interface OnboardingWizardSnapshot {
+  readonly active: boolean;
+  readonly mode: OnboardingWizardMode;
+  readonly stepIndex: number;
+  readonly scrollOffsets: readonly number[];
+  readonly selectedFieldIndices: readonly number[];
+  readonly dirtyStepIds: readonly OnboardingWizardStepId[];
+  readonly pendingModelPickerTarget: ModelPickerTarget | null;
+  readonly pendingAction: OnboardingWizardAction | null;
+  readonly toggleState: ReadonlyArray<readonly [string, boolean]>;
+  readonly radioState: ReadonlyArray<readonly [string, string]>;
+  readonly textState: ReadonlyArray<readonly [string, string]>;
+  readonly modelSelectionState: ReadonlyArray<readonly [ModelPickerTarget, OnboardingWizardModelSelection]>;
+  readonly touchedActionFields: readonly string[];
+  readonly editingFieldId: string | null;
+  readonly editBuffer: string;
+  readonly hydrationPending: boolean;
+  readonly hydrationError: string | null;
+  readonly hydration: OnboardingWizardRuntimeHydration;
+}
+
+export interface OnboardingWizardRuntimeHydration {
+  readonly snapshot?: OnboardingSnapshotState | null;
+  readonly derived?: Partial<OnboardingStepDerivationState> | null;
+}
+
+export type MutableModelSelectionMap = Map<ModelPickerTarget, OnboardingWizardModelSelection>;