@codingame/monaco-vscode-welcome-service-override 37.2.0 → 37.3.0

package/vscode/src/vs/workbench/contrib/onboarding/browser/spotlight/onboardingTarget.js

@@ -1,29 +0,0 @@
-
-import { registerCss } from '@codingame/monaco-vscode-api/css';
-import '@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle';
-import * as onboardingTarget from '../media/onboardingTarget.css';
-
-registerCss(onboardingTarget);
-const ONBOARDING_TARGET_ATTR = "data-onboarding-id";
-const onboardingTargetRegistrations = ( new WeakMap());
-function openOnboardingTarget(element) {
-    return onboardingTargetRegistrations.get(element)?.options.open?.();
-}
-function findOnboardingTarget(targetWindow, id) {
-    const selector = `[${ONBOARDING_TARGET_ATTR}="${CSS.escape(id)}"]`;
-    const targets = Array.from(targetWindow.document.querySelectorAll(selector));
-    return targets.find(target => isVisibleOnboardingTarget(targetWindow, target));
-}
-function isVisibleOnboardingTarget(targetWindow, target) {
-    if (!target.isConnected) {
-        return false;
-    }
-    const style = targetWindow.getComputedStyle(target);
-    if (style.display === "none" || style.visibility === "hidden") {
-        return false;
-    }
-    const rect = target.getBoundingClientRect();
-    return rect.width > 0 && rect.height > 0;
-}
-
-export { ONBOARDING_TARGET_ATTR, findOnboardingTarget, openOnboardingTarget };

package/vscode/src/vs/workbench/contrib/onboarding/browser/spotlight/spotlightTypes.d.ts

@@ -1,67 +0,0 @@
-import { IMarkdownString } from "@codingame/monaco-vscode-api/vscode/vs/base/common/htmlContent";
-import { ContextKeyExpression } from "@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey";
-/** The presentation `kind` handled by the spotlight presentation. */
-export declare const SPOTLIGHT_PRESENTATION_KIND = "spotlight";
-/** Preferred placement of the callout relative to the spotlighted target. */
-export type SpotlightPlacement = "above" | "below" | "left" | "right" | "auto";
-/** `advanceOnly` consumes target activation instead of running the target's action. */
-export type SpotlightTargetClickBehavior = boolean | "advanceOnly";
-/** Behavior when a spotlight target is not rendered when its step is reached. */
-export type SpotlightMissingTargetBehavior = {
-    readonly kind: "skip";
-} | {
-    readonly kind: "abort";
-} | {
-    readonly kind: "wait";
-    readonly timeoutMs: number;
-};
-/**
- * A single step in a spotlight tour. Steps are pure data; the spotlight
- * presentation turns them into the dim overlay, the cut-out highlight and the
- * anchored callout.
- */
-export interface ISpotlightStep {
-    /** Stable identifier (unique within the tour). */
-    readonly id: string;
-    /**
-     * The `data-onboarding-id` of the element to spotlight. Resolved on demand
-     * via {@link findOnboardingTarget} so steps work even if the element is not
-     * yet rendered when the tour starts.
-     */
-    readonly targetId: string;
-    /** Callout heading (localized). */
-    readonly title: string;
-    /** Callout body (localized string or markdown). */
-    readonly description: string | IMarkdownString;
-    /** Localized primary button label, replacing the default Next or Done. */
-    readonly nextButtonLabel?: string;
-    /** Preferred placement of the callout. Defaults to `'auto'`. */
-    readonly placement?: SpotlightPlacement;
-    /** When present and unsatisfied, the step is skipped. */
-    readonly when?: ContextKeyExpression;
-    /** Defaults to waiting two seconds before skipping; `abort` ends the run immediately if the target is missing. */
-    readonly missingTarget?: SpotlightMissingTargetBehavior;
-    /** Opens or expands the target through its owner before the step begins. */
-    readonly openTarget?: boolean;
-    /** Allow the spotlighted element to remain interactive. Defaults to `false`. */
-    readonly allowTargetInteraction?: boolean;
-    /** Advances on target activation; `advanceOnly` consumes the activation without running its action. */
-    readonly advanceOnTargetClick?: SpotlightTargetClickBehavior;
-    /** Overrides hiding Next when advancing on target clicks. `advanceWhen` always hides Next. */
-    readonly hideNext?: boolean;
-    /** Hides Next and advances once this context expression becomes satisfied. */
-    readonly advanceWhen?: ContextKeyExpression;
-    /** Extra padding (px) around the target when cutting the highlight hole. */
-    readonly padding?: number;
-    /**
-     * Optional hook run just before the step is shown, e.g. to open the view
-     * that hosts the target. Awaited before the target is resolved.
-     */
-    readonly onBeforeShow?: () => Promise<void> | void;
-}
-/**
- * The payload of a spotlight scenario: an ordered list of steps.
- */
-export interface ISpotlightPayload {
-    readonly steps: readonly ISpotlightStep[];
-}

package/vscode/src/vs/workbench/contrib/onboarding/browser/spotlight/spotlightTypes.js

@@ -1,5 +0,0 @@
-
-
-const SPOTLIGHT_PRESENTATION_KIND = 'spotlight';
-
-export { SPOTLIGHT_PRESENTATION_KIND };

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingRegistry.d.ts

@@ -1,21 +0,0 @@
-import { Event } from "@codingame/monaco-vscode-api/vscode/vs/base/common/event";
-import { IDisposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
-import { IOnboardingScenario } from "./onboardingScenario.js";
-/**
- * Registry of onboarding scenarios. Feature areas register their scenarios here
- * (pure data); the engine reads from it to decide what to run.
- */
-export interface IOnboardingScenarioRegistry {
-    /** Register a scenario. Throws if a scenario with the same id already exists. */
-    register(scenario: IOnboardingScenario): IDisposable;
-    /** All currently registered scenarios. */
-    getScenarios(): readonly IOnboardingScenario[];
-    /** Look up a single scenario by id. */
-    getScenario(id: string): IOnboardingScenario | undefined;
-    /** Fires when scenarios are added or removed. */
-    readonly onDidChange: Event<void>;
-}
-/**
- * Global scenario registry. Scenario data files register here on import.
- */
-export declare const onboardingScenarioRegistry: IOnboardingScenarioRegistry;

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingRegistry.js

@@ -1,35 +0,0 @@
-
-import { Emitter } from '@codingame/monaco-vscode-api/vscode/vs/base/common/event';
-
-class OnboardingScenarioRegistry {
-    constructor() {
-        this._scenarios = ( new Map());
-        this._onDidChange = ( new Emitter());
-        this.onDidChange = this._onDidChange.event;
-    }
-    register(scenario) {
-        const id = scenario.id;
-        if (( this._scenarios.has(id))) {
-            throw ( new Error(`An onboarding scenario with id '${id}' is already registered.`));
-        }
-        this._scenarios.set(id, scenario);
-        this._onDidChange.fire();
-        return {
-            dispose: () => {
-                if (this._scenarios.get(id) === scenario) {
-                    this._scenarios.delete(id);
-                    this._onDidChange.fire();
-                }
-            }
-        };
-    }
-    getScenarios() {
-        return Array.from(( this._scenarios.values()));
-    }
-    getScenario(id) {
-        return this._scenarios.get(id);
-    }
-}
-const onboardingScenarioRegistry = ( new OnboardingScenarioRegistry());
-
-export { onboardingScenarioRegistry };

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingScenario.d.ts

@@ -1,172 +0,0 @@
-import { IObservable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/observable";
-import { ContextKeyExpression } from "@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey";
-/**
- * Describes when an onboarding scenario becomes eligible to run automatically.
- */
-export type OnboardingTrigger = 
-/** Eligible as soon as the scenario's `when` clause is satisfied. */
-{
-    readonly kind: "auto";
-}
-/** Only started explicitly via a command (never runs automatically). */
- | {
-    readonly kind: "command";
-    readonly commandId: string;
-}
-/** Eligible whenever the provided observable yields `true`. */
- | {
-    readonly kind: "observable";
-    readonly signal: IObservable<boolean>;
-};
-/**
- * A reference to a registered {@link IOnboardingPresentation} together with the
- * opaque payload that presentation understands (e.g. spotlight steps).
- */
-export interface IOnboardingPresentationRef<TPayload = unknown> {
-    /** The presentation kind, e.g. `'spotlight'`. */
-    readonly kind: string;
-    /** Presentation-specific data. The engine never inspects this. */
-    readonly payload: TPayload;
-}
-/**
- * Reserved prefix that every onboarding experiment's **assignment-context identifier** must
- * use (for example `onb-newsession-2026q3`).
- *
- * ### Why this exists
- * The experimentation platform stamps every telemetry event with the user's assignment
- * context as soon as the assignments are fetched at startup. For onboarding experiments we
- * must *not* emit the identifier until the user actually reaches the point where the
- * onboarding would be shown — otherwise the scorecard counts activity from before the
- * experiment could have had any effect.
- *
- * The treatment flags that tell the client *which* variant belongs to a given tour resolve
- * asynchronously, after the assignment context has already been committed to telemetry, so
- * they are too late to block the very first events. This prefix solves that race: because it
- * is a *static, well-known* string, the client can pre-emptively exclude **any**
- * assignment-context entry that starts with it from the very first event, and then
- * selectively unblock the one specific variant once the user reaches the onboarding moment.
- *
- * ### Contract for experiment authors
- * - Every onboarding experiment configured in ExP MUST use variant names beginning with this
- *   prefix.
- * - Each arm's variant name MUST be returned by the experiment's
- *   {@link IOnboardingExperiment.assignmentContextIdFlag} treatment flag.
- *
- * The engine enforces this defensively: an id that lacks the prefix is rejected (the experiment
- * is treated as inactive and the misconfiguration is reported via `onUnexpectedError`) so a bad
- * id can never leak into telemetry ungated. A prefixed id that is never claimed by a registered
- * tour simply stays blocked forever.
- */
-export declare const ONBOARDING_ASSIGNMENT_CONTEXT_PREFIX = "onb-";
-/**
- * Experiment configuration for an onboarding scenario. The two treatment flag *names* are
- * resolved against the experimentation service; the experiment is only considered **active**
- * when *both* resolve: the boolean to a boolean and the id to a non-empty string that starts
- * with {@link ONBOARDING_ASSIGNMENT_CONTEXT_PREFIX}. If either flag is missing or the id lacks
- * the required prefix, the experiment is **inactive** and the scenario does not run
- * automatically (it can still be started explicitly via a command/`runScenario`, which
- * bypasses experiment gating and does not open the telemetry gate; or by enabling
- * `onboarding.developerMode` for the scenario, which previews the tour without opening the
- * telemetry gate).
- */
-export interface IOnboardingExperiment {
-    /**
-     * Name of the boolean treatment flag that decides the *experience*: `true` shows the tour
-     * (treatment arm), `false` does not (control arm). In both arms the assignment-context
-     * identifier starts flowing once the user reaches the onboarding moment.
-     */
-    readonly behaviorFlag: string;
-    /**
-     * Name of the string treatment flag whose value is the current arm's ExP variant name. The
-     * telemetry entry appends `:<allocationId>`; the value itself MUST start with
-     * {@link ONBOARDING_ASSIGNMENT_CONTEXT_PREFIX}; an id without the prefix is rejected (the
-     * experiment is treated as inactive) so it can never leak into telemetry ungated.
-     */
-    readonly assignmentContextIdFlag: string;
-}
-/**
- * A declarative onboarding scenario. Scenarios are pure data: they describe
- * *when* onboarding should happen and *which* presentation renders it, but not
- * *how* it is rendered (that is the presentation's job).
- */
-export interface IOnboardingScenario<TPayload = unknown> {
-    /** Stable identifier. Used as the persistence key for "shown once" state. */
-    readonly id: string;
-    /**
-     * Persistence key for the once-per-user "shown" state. Scenarios that share a
-     * `seenKey` are treated as the *same* onboarding for once-per-user gating:
-     * showing any one of them marks them all as seen, so the others never run
-     * automatically. Use this for variations of the same tour that should be
-     * shown at most once between them. Defaults to {@link id}.
-     */
-    readonly seenKey?: string;
-    /** Eligibility gate. AND-ed with the engine's own checks. */
-    readonly when?: ContextKeyExpression;
-    /** How the scenario becomes eligible to run automatically. */
-    readonly trigger: OnboardingTrigger;
-    /** Higher priority scenarios run first when several are eligible at once. Default `0`. */
-    readonly priority?: number;
-    /** The presentation that renders this scenario plus its payload. */
-    readonly presentation: IOnboardingPresentationRef<TPayload>;
-    /**
-     * Optional experiment that gates and measures this scenario. When present, the scenario
-     * only runs if the experiment is active (both treatment flags set). See
-     * {@link IOnboardingExperiment}.
-     */
-    readonly experiment?: IOnboardingExperiment;
-    /** Variations exposed through the onboarding developer-mode variation override. */
-    readonly developerModeVariations?: readonly string[];
-    /** When `true`, the scenario runs on every eligible session instead of once per user. */
-    readonly repeatable?: boolean;
-}
-/**
- * The result of running a scenario's presentation.
- */
-export declare enum OnboardingOutcome {
-    /** The user reached the end of the scenario. */
-    Completed = "completed",
-    /** The user explicitly skipped the scenario. */
-    Skipped = "skipped",
-    /** The scenario was dismissed (e.g. closed without an explicit skip). */
-    Dismissed = "dismissed",
-    /** The scenario was aborted by the engine (e.g. window shutdown, target lost). */
-    Aborted = "aborted"
-}
-/**
- * The concrete mechanism that ended a scenario run. Refines {@link OnboardingOutcome} with
- * the specific user action, primarily for telemetry (e.g. distinguishing the Skip button
- * from the Escape key).
- */
-export declare enum OnboardingDismissReason {
-    /** The user reached and advanced past the final step. */
-    Completed = "completed",
-    /** The user pressed the Skip button. */
-    SkipButton = "skipButton",
-    /** The user pressed the Escape key. */
-    EscapeKey = "escapeKey",
-    /** The user advanced by clicking the highlighted target on the final step. */
-    TargetClick = "targetClick",
-    /** The engine aborted the run (window shutdown, target lost, ...). */
-    Aborted = "aborted"
-}
-/**
- * Rich result returned by a presentation's `run`, carrying the outcome plus the data the
- * engine needs to emit per-tour telemetry (how far the user got and how the run ended).
- */
-export interface IOnboardingRunResult {
-    /** Coarse engine-level outcome. */
-    readonly outcome: OnboardingOutcome;
-    /**
-     * Whether the presentation actually displayed anything to the user. `false` for a
-     * degenerate run that rendered no UI (e.g. a scenario with no steps, or every step
-     * skipped because its target/`when` was unavailable). The engine only emits outcome
-     * telemetry when a tour was genuinely shown.
-     */
-    readonly shown: boolean;
-    /** Concrete reason/mechanism that ended the run. */
-    readonly dismissReason: OnboardingDismissReason;
-    /** Furthest 0-based step index the user reached (`0` if the first step never showed). */
-    readonly lastStepIndex: number;
-    /** Total number of steps the scenario declared. */
-    readonly stepCount: number;
-}

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingScenario.js

@@ -1,20 +0,0 @@
-
-
-const ONBOARDING_ASSIGNMENT_CONTEXT_PREFIX = 'onb-';
-var OnboardingOutcome;
-(function (OnboardingOutcome) {
-    OnboardingOutcome["Completed"] = "completed";
-    OnboardingOutcome["Skipped"] = "skipped";
-    OnboardingOutcome["Dismissed"] = "dismissed";
-    OnboardingOutcome["Aborted"] = "aborted";
-})(OnboardingOutcome || (OnboardingOutcome = {}));
-var OnboardingDismissReason;
-(function (OnboardingDismissReason) {
-    OnboardingDismissReason["Completed"] = "completed";
-    OnboardingDismissReason["SkipButton"] = "skipButton";
-    OnboardingDismissReason["EscapeKey"] = "escapeKey";
-    OnboardingDismissReason["TargetClick"] = "targetClick";
-    OnboardingDismissReason["Aborted"] = "aborted";
-})(OnboardingDismissReason || (OnboardingDismissReason = {}));
-
-export { ONBOARDING_ASSIGNMENT_CONTEXT_PREFIX, OnboardingDismissReason, OnboardingOutcome };

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingScenarioService.d.ts

@@ -1,48 +0,0 @@
-import { IConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/configuration/common/configuration.service";
-/** Global setting that enables/disables *automatic* onboarding scenarios. */
-export declare const ONBOARDING_ENABLED_CONFIG = "onboarding.enabled";
-/**
- * Developer/advanced setting. A map of scenario/tour id to a boolean: when a
- * scenario's flag is `true`, that scenario bypasses the gating that normally
- * keeps it from showing, so it can be triggered on demand for testing. Concretely,
- * developer mode for a scenario:
- *  - bypasses usage-based eligibility gating (e.g. the new-session tour's "first
- *    few sessions" check),
- *  - bypasses the once-per-user persisted "shown" state, and
- *  - bypasses the experiment gate: a tour with a linked experiment will show even
- *    if the experiment is not running, or the user is in the control arm. A
- *    developer-mode preview never opens the assignment-context telemetry gate (in
- *    any arm), so it can never affect an experiment scorecard.
- *
- * Developer mode does NOT override the global `onboarding.enabled` switch: when
- * onboarding is disabled, nothing shows automatically regardless of this setting.
- *
- * The scenario is still shown at most once per window session (tracked in memory,
- * not persisted), so reload the window to replay it — the "Reset Onboarding Shown
- * State" command only clears the persisted state and does not affect developer-mode
- * replays.
- *
- * The default value lists every registered scenario id set to `false`, so the
- * available ids are discoverable (and toggleable) in the settings editor.
- */
-export declare const ONBOARDING_DEVELOPER_MODE_CONFIG = "onboarding.developerMode";
-/** Developer override for a scenario's experiment-selected variation. */
-export declare const ONBOARDING_DEVELOPER_MODE_VARIATIONS_CONFIG = "onboarding.developerModeVariations";
-/**
- * The shape of the {@link ONBOARDING_DEVELOPER_MODE_CONFIG} setting: a map of
- * scenario/tour id to whether developer mode is enabled for that scenario.
- */
-export type OnboardingDeveloperMode = {
-    readonly [scenarioId: string]: boolean;
-};
-/** The shape of the {@link ONBOARDING_DEVELOPER_MODE_VARIATIONS_CONFIG} setting. */
-export type OnboardingDeveloperModeVariations = {
-    readonly [scenarioId: string]: string;
-};
-/**
- * Whether onboarding developer mode is enabled for the given scenario/tour id.
- * Reads {@link ONBOARDING_DEVELOPER_MODE_CONFIG} and returns `true` only when the
- * setting is an object whose entry for `scenarioId` is explicitly `true`.
- */
-export declare function isOnboardingDeveloperModeEnabled(configurationService: IConfigurationService, scenarioId: string): boolean;
-export declare function getOnboardingDeveloperModeVariation(configurationService: IConfigurationService, scenarioId: string): string | undefined;

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingScenarioService.js

@@ -1,11 +0,0 @@
-
-
-const ONBOARDING_ENABLED_CONFIG = 'onboarding.enabled';
-const ONBOARDING_DEVELOPER_MODE_CONFIG = 'onboarding.developerMode';
-const ONBOARDING_DEVELOPER_MODE_VARIATIONS_CONFIG = 'onboarding.developerModeVariations';
-function isOnboardingDeveloperModeEnabled(configurationService, scenarioId) {
-    const value = configurationService.getValue(ONBOARDING_DEVELOPER_MODE_CONFIG);
-    return typeof value === 'object' && value !== null && value[scenarioId] === true;
-}
-
-export { ONBOARDING_DEVELOPER_MODE_CONFIG, ONBOARDING_DEVELOPER_MODE_VARIATIONS_CONFIG, ONBOARDING_ENABLED_CONFIG, isOnboardingDeveloperModeEnabled };

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingSequence.d.ts

@@ -1,45 +0,0 @@
-import { CancellationToken } from "@codingame/monaco-vscode-api/vscode/vs/base/common/cancellation";
-import { IDisposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
-import { IOnboardingRunContext } from "./onboardingPresentation.js";
-import { OnboardingDismissReason } from "./onboardingScenario.js";
-export declare const ONBOARDING_SEQUENCE_PRESENTATION_KIND = "sequence";
-/** One entry in a heterogeneous onboarding sequence. */
-export interface IOnboardingSequenceStep<TPayload = unknown> {
-    readonly id: string;
-    readonly kind: string;
-    readonly payload: TPayload;
-}
-/** Payload rendered by the sequence presentation. */
-export interface IOnboardingSequencePayload {
-    readonly steps: readonly IOnboardingSequenceStep[];
-}
-/** Context passed to a sequence step presentation. */
-export interface IOnboardingSequenceStepContext extends IOnboardingRunContext {
-    readonly cancellationToken: CancellationToken;
-    readonly stepIndex: number;
-    readonly visualStepIndex: number;
-    readonly visualStepCount: number;
-    readonly canGoBack: boolean;
-    readonly isLastVisualStep: boolean;
-}
-/** Traversal result returned by one sequence step. */
-export interface IOnboardingSequenceStepResult {
-    readonly action: "next" | "back" | "skipStep" | "skipSequence" | "abort";
-    readonly shown: boolean;
-    readonly dismissReason?: OnboardingDismissReason;
-}
-/** Renders one kind of sequence step. */
-export interface IOnboardingSequenceStepPresentation {
-    readonly kind: string;
-    /** Whether this kind participates in visual progress counters. */
-    readonly countsAsVisualStep: boolean;
-    /** Whether a forward revisit skips a step that already ran. */
-    readonly runOnce?: boolean;
-    runStep(step: IOnboardingSequenceStep, context: IOnboardingSequenceStepContext): Promise<IOnboardingSequenceStepResult>;
-}
-/** Registry of sequence step presentations by kind. */
-export interface IOnboardingSequenceStepPresentationRegistry {
-    register(presentation: IOnboardingSequenceStepPresentation): IDisposable;
-    get(kind: string): IOnboardingSequenceStepPresentation | undefined;
-}
-export declare const onboardingSequenceStepPresentationRegistry: IOnboardingSequenceStepPresentationRegistry;

package/vscode/src/vs/workbench/contrib/onboarding/common/onboardingSequence.js

@@ -1,29 +0,0 @@
-
-
-const ONBOARDING_SEQUENCE_PRESENTATION_KIND = "sequence";
-class OnboardingSequenceStepPresentationRegistry {
-    constructor() {
-        this._presentations = ( new Map());
-    }
-    register(presentation) {
-        if (( this._presentations.has(presentation.kind))) {
-            throw ( new Error(
-                `An onboarding sequence step presentation with kind '${presentation.kind}' is already registered.`
-            ));
-        }
-        this._presentations.set(presentation.kind, presentation);
-        return {
-            dispose: () => {
-                if (this._presentations.get(presentation.kind) === presentation) {
-                    this._presentations.delete(presentation.kind);
-                }
-            }
-        };
-    }
-    get(kind) {
-        return this._presentations.get(kind);
-    }
-}
-const onboardingSequenceStepPresentationRegistry = ( new OnboardingSequenceStepPresentationRegistry());
-
-export { ONBOARDING_SEQUENCE_PRESENTATION_KIND, onboardingSequenceStepPresentationRegistry };