@codingame/monaco-vscode-welcome-service-override 37.6.1 → 38.0.1

package/common.js

@@ -2,13 +2,18 @@
 import { SyncDescriptor } from '@codingame/monaco-vscode-api/vscode/vs/platform/instantiation/common/descriptors';
 import { IOnboardingScenarioService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingScenarioService.service';
 import { OnboardingScenarioService } from './vscode/src/vs/workbench/contrib/onboarding/browser/onboardingService.js';
+import { OnboardingTryoutService } from './vscode/src/vs/workbench/contrib/onboarding/browser/onboardingTryoutService.js';
+import { IOnboardingTryoutService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryout.service';
+import './vscode/src/vs/workbench/contrib/codeEditor/browser/diffEditorTryout.contribution.js';
+import './vscode/src/vs/workbench/contrib/onboarding/browser/onboardingTryout.contribution.js';
 import './vscode/src/vs/workbench/contrib/onboarding/browser/onboarding.contribution.js';
 import './vscode/src/vs/workbench/contrib/welcomeViews/common/viewsWelcome.contribution.js';
 import './vscode/src/vs/workbench/contrib/welcomeViews/common/newFile.contribution.js';
 
 function getServiceOverride() {
     return {
-        [IOnboardingScenarioService.toString()]: new SyncDescriptor(OnboardingScenarioService, [], true)
+        [IOnboardingScenarioService.toString()]: new SyncDescriptor(OnboardingScenarioService, [], true),
+        [IOnboardingTryoutService.toString()]: new SyncDescriptor(OnboardingTryoutService, [], true)
     };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codingame/monaco-vscode-welcome-service-override",
-  "version": "37.6.1",
+  "version": "38.0.1",
   "private": false,
   "description": "VSCode public API plugged on the monaco editor - welcome service-override",
   "keywords": [],
@@ -15,8 +15,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@codingame/monaco-vscode-api": "37.6.1",
-    "@codingame/monaco-vscode-katex-common": "37.6.1"
+    "@codingame/monaco-vscode-api": "38.0.1",
+    "@codingame/monaco-vscode-katex-common": "38.0.1"
   },
   "main": "index.js",
   "module": "index.js",

package/vscode/src/vs/platform/onboarding/common/onboardingTryoutHandoff.d.ts

@@ -0,0 +1,13 @@
+export declare const ONBOARDING_TRYOUT_CHANNEL = "onboardingTryout";
+export type OnboardingTryoutSource = "releaseNotes" | "externalLink" | "direct";
+export interface IOnboardingTryoutRunOptions {
+    readonly source: OnboardingTryoutSource;
+    readonly runId?: string;
+}
+export declare function isOnboardingTryoutSource(value: unknown): value is OnboardingTryoutSource;
+export interface IOnboardingTryoutWindowRequest {
+    readonly requestId: string;
+    readonly tryoutId: string;
+    readonly source: OnboardingTryoutSource;
+}
+export type OnboardingTryoutWindowRequestResult = "accepted" | "cancelled" | "rejected" | "superseded";

package/vscode/src/vs/platform/onboarding/common/onboardingTryoutHandoff.js

@@ -0,0 +1,7 @@
+
+
+function isOnboardingTryoutSource(value) {
+    return value === 'releaseNotes' || value === 'externalLink' || value === 'direct';
+}
+
+export { isOnboardingTryoutSource };

package/vscode/src/vs/workbench/contrib/chat/browser/chatSetup/media/microsoft-dark.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" fill="white"><path d="M7.5 1.5H1.5V7.5H7.5V1.5Z"/><path d="M14.5 1.5H8.5V7.5H14.5V1.5Z"/><path d="M14.5 8.5H8.5V14.5H14.5V8.5Z"/><path d="M7.5 8.5H1.5V14.5H7.5V8.5Z"/></svg>

package/vscode/src/vs/workbench/contrib/chat/browser/chatSetup/media/microsoft-light.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" fill="black"><path d="M7.5 1.5H1.5V7.5H7.5V1.5Z"/><path d="M14.5 1.5H8.5V7.5H14.5V1.5Z"/><path d="M14.5 8.5H8.5V14.5H14.5V8.5Z"/><path d="M7.5 8.5H1.5V14.5H7.5V8.5Z"/></svg>

package/vscode/src/vs/workbench/contrib/codeEditor/browser/diffEditorTryout.contribution.d.ts

@@ -0,0 +1 @@
+export {};

package/vscode/src/vs/workbench/contrib/codeEditor/browser/diffEditorTryout.contribution.js

@@ -0,0 +1,67 @@
+
+import { Disposable } from '@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle';
+import { localize } from '@codingame/monaco-vscode-api/vscode/vs/nls';
+import { registerWorkbenchContribution2, WorkbenchPhase } from '@codingame/monaco-vscode-api/vscode/vs/workbench/common/contributions';
+import { registerOnboardingTryout } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryout';
+
+class DiffEditorTryoutContribution extends Disposable {
+    static {
+        this.ID = "workbench.contrib.diffEditorTryout";
+    }
+    constructor() {
+        super();
+        this._register(registerOnboardingTryout({
+            id: "editor.smart-diff",
+            title: ( localize(15493, "Try Smart Diff Layout")),
+            description: ( localize(
+                15494,
+                "Open a read-only sample comparison. Use Diff View to choose Inline, Side by Side, or Automatic, then resize the editor."
+            )),
+            presentation: {
+                kind: "editorSample",
+                payload: {
+                    type: "diff",
+                    title: ( localize(15495, "Smart Diff Layout Example")),
+                    languageId: "typescript",
+                    original: [
+                        "interface Project {",
+                        "\tname: string;",
+                        "\tarchived: boolean;",
+                        "}",
+                        "",
+                        "export function findProject(projects: Project[], name: string): Project | undefined {",
+                        "\treturn projects.find(project => project.name === name);",
+                        "}",
+                        "",
+                        "export function listProjects(projects: Project[]): string[] {",
+                        "\treturn projects.map(project => project.name);",
+                        "}"
+                    ].join("\n"),
+                    modified: [
+                        "interface Project {",
+                        "\tname: string;",
+                        "\tarchived: boolean;",
+                        "}",
+                        "",
+                        "export function findProject(projects: Project[], name: string): Project | undefined {",
+                        "\tconst normalizedName = name.trim().toLowerCase();",
+                        "\treturn projects.find(project => project.name.toLowerCase() === normalizedName);",
+                        "}",
+                        "",
+                        "export function listProjects(projects: Project[]): string[] {",
+                        "\treturn projects",
+                        "\t\t.filter(project => !project.archived)",
+                        "\t\t.map(project => project.name)",
+                        "\t\t.sort();",
+                        "}"
+                    ].join("\n")
+                }
+            }
+        }));
+    }
+}
+registerWorkbenchContribution2(
+    DiffEditorTryoutContribution.ID,
+    DiffEditorTryoutContribution,
+    WorkbenchPhase.BlockRestore
+);

package/vscode/src/vs/workbench/contrib/onboarding/browser/media/spotlight.css

@@ -13,11 +13,28 @@
 	z-index: 2600;
 }
 
-/* Expanded pickers and mobile sheets remain above the spotlight blocker. */
+/*
+ * Expanded pickers stay above the scrim, but their full-window dismiss layers
+ * must not cover the callout's actions. Avoid a shared stacking context here.
+ */
 .spotlight-overlay.target-overlay-visible {
+	position: static;
+	z-index: auto;
+}
+
+.spotlight-overlay.target-overlay-visible .spotlight-blocker,
+.spotlight-overlay.target-overlay-visible .spotlight-hole {
 	z-index: 1999;
 }
 
+.spotlight-overlay.target-overlay-visible .spotlight-callout {
+	z-index: 2600;
+}
+
+.spotlight-overlay.target-overlay-visible .spotlight-callout-pointer {
+	z-index: 2601;
+}
+
 /* Full-screen click blocker. Transparent; swallows interaction outside the hole. */
 .spotlight-blocker {
 	position: fixed;

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

@@ -1 +1 @@
-export {};
+

package/vscode/src/vs/workbench/contrib/onboarding/browser/onboarding.contribution.js

@@ -17,8 +17,9 @@ import { ONBOARDING_DEVELOPER_MODE_VARIATIONS_CONFIG, ONBOARDING_DEVELOPER_MODE_
 import { IOnboardingScenarioService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingScenarioService.service';
 import './onboardingService.js';
 import { RunOnboardingStepPresentation } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/browser/sequence/runOnboardingStep';
-import { OnboardingSequencePresentation } from './sequence/sequencePresentation.js';
+import { OnboardingSequencePresentation } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/browser/sequence/sequencePresentation';
 import { SpotlightPresentation } from './spotlight/spotlightPresentation.js';
+import './onboardingTryout.contribution.js';
 
 const configurationRegistry = ( Registry.as(Extensions.Configuration));
 function buildDeveloperModeConfigurationNode() {
@@ -26,7 +27,10 @@ function buildDeveloperModeConfigurationNode() {
     const defaultValue = {};
     const variationProperties = {};
     const variationDefaultValue = {};
-    for (const scenario of [...onboardingScenarioRegistry.getScenarios()].sort((a, b) => a.id.localeCompare(b.id))) {
+    for (const scenario of [...onboardingScenarioRegistry.getScenarioDescriptors()].sort((a, b) => a.id.localeCompare(b.id))) {
+        if (scenario.tryout) {
+            continue;
+        }
         properties[scenario.id] = {
             type: "boolean",
             default: false
@@ -53,7 +57,7 @@ function buildDeveloperModeConfigurationNode() {
                 },
                 tags: ["experimental"],
                 description: ( localize(
-                    17128,
+                    19627,
                     "Map of onboarding scenario/tour id to whether developer mode is enabled for it. When enabled for a scenario, that onboarding tour ignores usage-based eligibility checks (such as how many sessions you have started), previously persisted shown state, and any linked experiment (so it is shown even if the experiment is not running or you are in the control group). It does not override the {0} setting. The tour is still shown at most once per window session, so reload the window to show it again.",
                     `\`#${ONBOARDING_ENABLED_CONFIG}#\``
                 ))
@@ -67,7 +71,7 @@ function buildDeveloperModeConfigurationNode() {
                 },
                 tags: ["experimental"],
                 description: ( localize(
-                    17129,
+                    19628,
                     "Map of onboarding scenario/tour id to the variation used while developer mode is enabled for that scenario. An empty value uses the experiment-selected or default variation."
                 ))
             }
@@ -82,7 +86,7 @@ configurationRegistry.registerConfiguration({
             type: "boolean",
             default: true,
             description: ( localize(
-                17130,
+                19629,
                 "When enabled, onboarding tours and hints may appear automatically to highlight features. Disabling this does not affect tours you start manually."
             ))
         }
@@ -126,7 +130,7 @@ registerAction2(class extends Action2 {
     constructor() {
         super({
             id: "workbench.action.onboarding.resetShownState",
-            title: ( localize2(17131, "Reset Onboarding Shown State")),
+            title: ( localize2(19630, "Reset Onboarding Shown State")),
             category: Categories.Developer,
             f1: true
         });

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

@@ -0,0 +1,25 @@
+import { Disposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
+import { URI } from "@codingame/monaco-vscode-api/vscode/vs/base/common/uri";
+import { ILanguageService } from "@codingame/monaco-vscode-api/vscode/vs/editor/common/languages/language.service";
+import { ITextModel } from "@codingame/monaco-vscode-api/vscode/vs/editor/common/model";
+import { IModelService } from "@codingame/monaco-vscode-api/vscode/vs/editor/common/services/model.service";
+import { ITextModelContentProvider } from "@codingame/monaco-vscode-model-service-override/vscode/vs/editor/common/services/resolverService";
+import { ITextModelService } from "@codingame/monaco-vscode-api/vscode/vs/editor/common/services/resolverService.service";
+import { IEditorService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/editor/common/editorService.service";
+import { IOnboardingTryoutPresentationDefinition, IOnboardingTryoutRunContext, OnboardingTryoutAvailability, OnboardingTryoutPreparation } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryout";
+import { IOnboardingTryoutService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryout.service";
+import { EditorSampleTryoutPayload, isEditorSampleTryoutPayload } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryoutActions";
+export declare class EditorSampleTryoutPresentation extends Disposable implements IOnboardingTryoutPresentationDefinition<EditorSampleTryoutPayload>, ITextModelContentProvider {
+    private readonly editorService;
+    private readonly textModelService;
+    private readonly modelService;
+    private readonly languageService;
+    private readonly tryoutService;
+    readonly kind = "editorSample";
+    readonly isPayload: typeof isEditorSampleTryoutPayload;
+    get onDidChangeAvailability(): import("@codingame/monaco-vscode-api/vscode/vs/sessions/sessions.web.main.internal").Event<void>;
+    constructor(editorService: IEditorService, textModelService: ITextModelService, modelService: IModelService, languageService: ILanguageService, tryoutService: IOnboardingTryoutService);
+    getAvailability(payload: EditorSampleTryoutPayload): OnboardingTryoutAvailability;
+    prepare(payload: EditorSampleTryoutPayload, context: IOnboardingTryoutRunContext): Promise<OnboardingTryoutPreparation>;
+    provideTextContent(resource: URI): Promise<ITextModel>;
+}

package/vscode/src/vs/workbench/contrib/onboarding/browser/onboardingSamplePresentation.js

@@ -0,0 +1,137 @@
+
+import { __decorate, __param } from '@codingame/monaco-vscode-api/external/tslib/tslib.es6';
+import { Disposable, thenRegisterOrDispose } from '@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle';
+import { Schemas } from '@codingame/monaco-vscode-api/vscode/vs/base/common/network';
+import { URI } from '@codingame/monaco-vscode-api/vscode/vs/base/common/uri';
+import { ILanguageService } from '@codingame/monaco-vscode-api/vscode/vs/editor/common/languages/language.service';
+import { IModelService } from '@codingame/monaco-vscode-api/vscode/vs/editor/common/services/model.service';
+import { ITextModelService } from '@codingame/monaco-vscode-api/vscode/vs/editor/common/services/resolverService.service';
+import { localize } from '@codingame/monaco-vscode-api/vscode/vs/nls';
+import { IEditorService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/services/editor/common/editorService.service';
+import { isOnboardingTryoutId } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryout';
+import { IOnboardingTryoutService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryout.service';
+import { isEditorSampleTryoutPayload } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/onboarding/common/onboardingTryoutActions';
+
+let EditorSampleTryoutPresentation = class EditorSampleTryoutPresentation extends Disposable {
+    get onDidChangeAvailability() {
+        return this.languageService.onDidChange;
+    }
+    constructor(
+        editorService,
+        textModelService,
+        modelService,
+        languageService,
+        tryoutService
+    ) {
+        super();
+        this.editorService = editorService;
+        this.textModelService = textModelService;
+        this.modelService = modelService;
+        this.languageService = languageService;
+        this.tryoutService = tryoutService;
+        this.kind = "editorSample";
+        this.isPayload = isEditorSampleTryoutPayload;
+    }
+    getAvailability(payload) {
+        return !payload.languageId || this.languageService.isRegisteredLanguageId(payload.languageId) ? {
+            kind: "ready"
+        } : {
+            kind: "unavailable",
+            message: ( localize(19631, "Language support for this example is not available yet."))
+        };
+    }
+    async prepare(payload, context) {
+        const original = ( URI.from({
+            scheme: Schemas.vscodeOnboardingSample,
+            path: `/${context.id}/${payload.type === "diff" ? "original" : "text"}`
+        }));
+        const modified = payload.type === "diff" ? ( URI.from({
+            scheme: Schemas.vscodeOnboardingSample,
+            path: `/${context.id}/modified`
+        })) : undefined;
+        await thenRegisterOrDispose(this.textModelService.createModelReference(original), context.store);
+        if (context.token.isCancellationRequested || context.store.isDisposed) {
+            return {
+                kind: "cancelled"
+            };
+        }
+        if (modified) {
+            await thenRegisterOrDispose(this.textModelService.createModelReference(modified), context.store);
+        }
+        if (context.token.isCancellationRequested || context.store.isDisposed) {
+            return {
+                kind: "cancelled"
+            };
+        }
+        return {
+            kind: "ready",
+            run: async () => {
+                if (context.token.isCancellationRequested) {
+                    return {
+                        kind: "cancelled"
+                    };
+                }
+                const pane = await this.editorService.openEditor(modified ? {
+                    original: {
+                        resource: original
+                    },
+                    modified: {
+                        resource: modified
+                    },
+                    label: payload.title,
+                    options: {
+                        pinned: true
+                    }
+                } : {
+                    resource: original,
+                    label: payload.title,
+                    options: {
+                        pinned: true
+                    }
+                });
+                return pane ? {
+                    kind: "opened"
+                } : {
+                    kind: "unavailable",
+                    message: ( localize(19632, "The example editor could not be opened."))
+                };
+            }
+        };
+    }
+    async provideTextContent(resource) {
+        const [, id, part, ...extra] = resource.path.split("/");
+        if (resource.scheme !== Schemas.vscodeOnboardingSample || resource.authority || resource.query || resource.fragment || extra.length || !isOnboardingTryoutId(id) || (part !== "text" && part !== "original" && part !== "modified")) {
+            throw ( new Error(( localize(
+                19633,
+                "This sample is no longer available. Open its feature example from the release notes again."
+            ))));
+        }
+        const model = this.modelService.getModel(resource);
+        if (model) {
+            return model;
+        }
+        const scenario = this.tryoutService.getTryout(id);
+        const payload = scenario?.presentation.payload;
+        if (scenario?.presentation.kind !== this.kind || !isEditorSampleTryoutPayload(payload)) {
+            throw ( new Error(( localize(
+                19633,
+                "This sample is no longer available. Open its feature example from the release notes again."
+            ))));
+        }
+        const text = payload.type === "text" && part === "text" ? payload.text : payload.type === "diff" && part === "original" ? payload.original : payload.type === "diff" && part === "modified" ? payload.modified : undefined;
+        if (text === undefined) {
+            throw ( new Error(( localize(
+                19633,
+                "This sample is no longer available. Open its feature example from the release notes again."
+            ))));
+        }
+        return this.modelService.createModel(
+            text,
+            this.languageService.createById(payload.languageId ?? "plaintext"),
+            resource
+        );
+    }
+};
+EditorSampleTryoutPresentation = ( __decorate([( __param(0, IEditorService)), ( __param(1, ITextModelService)), ( __param(2, IModelService)), ( __param(3, ILanguageService)), ( __param(4, IOnboardingTryoutService))], EditorSampleTryoutPresentation));
+
+export { EditorSampleTryoutPresentation };

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

@@ -1,4 +1,6 @@
+import { CancellationToken } from "@codingame/monaco-vscode-api/vscode/vs/base/common/cancellation";
 import { Disposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
+import { IReader } from "@codingame/monaco-vscode-api/vscode/vs/base/common/observable";
 import { IConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/configuration/common/configuration.service";
 import { IContextKeyService } from "@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey.service";
 import { ITelemetryService } from "@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetry.service";
@@ -36,6 +38,7 @@ export declare class OnboardingScenarioService extends Disposable implements IOn
     private _activeAbort;
     /** Resolved experiment treatment state, keyed by scenario id. */
     private readonly _experimentStates;
+    private readonly _experimentStatesChanged;
     /**
      * Assignment-context ids whose telemetry gate is open. While an onboarding id is *not* in
      * this set, the eagerly-registered filter excludes it from telemetry (see the prefix
@@ -50,8 +53,9 @@ export declare class OnboardingScenarioService extends Disposable implements IOn
     private _stop;
     start(): void;
     getScenarios(): readonly IOnboardingScenario[];
-    runScenario(id: string): Promise<OnboardingOutcome>;
+    runScenario(id: string, token?: CancellationToken): Promise<OnboardingOutcome>;
     hasBeenShown(id: string): boolean;
+    shouldShowNudge(id: string, reader?: IReader): boolean;
     reset(id: string): void;
     resetAll(): void;
     /**
@@ -82,17 +86,20 @@ export declare class OnboardingScenarioService extends Disposable implements IOn
      * moment: the telemetry gate is opened for the experiment's assignment-context id
      * (in both arms), and then only the treatment arm is enqueued to actually show the
      * tour. Control opens the gate but renders nothing and is not marked as shown.
+     * A pre-tour nudge opens the same gate earlier, at its own would-show moment.
      *
      * Developer mode is the exception: it shows the tour unconditionally and never
      * opens the telemetry gate, so a local preview can never affect the experiment
      * scorecard regardless of which arm the developer happens to be assigned to.
      */
     private _evaluate;
+    private _shouldShow;
     private _isAutoEligible;
     private _enqueue;
     private _pump;
     private _doPump;
     private _runPresentation;
+    private _showPresentation;
     /** Emit an impression when a presentation has rendered visible onboarding UI. */
     private _reportShown;
     /** Emit per-tour telemetry. Only called when a tour was actually shown. */