@nativescript/vite 8.0.0-alpha.3 → 8.0.0-alpha.31

package/hmr/frameworks/vue/client/vue-sfc-update-overlay.d.ts

@@ -0,0 +1,82 @@
+/**
+ * HMR-applying overlay driver for Vue SFC updates.
+ *
+ * The Vue HMR cycle is driven by two messages on the wire:
+ *
+ *   1. `ns:hmr-pending` — fires at the start of `handleHotUpdate` on
+ *      the server. The client's `applyHmrPendingFrame` shows the
+ *      'received' (5%) frame so the user sees an instant reaction to
+ *      their save.
+ *   2. `ns:vue-sfc-registry-update` — fires once the SFC artifact is
+ *      ready. The client loads the new component definition via
+ *      `handleVueSfcRegistryUpdate` and then swaps the root view via
+ *      `performResetRoot`.
+ *
+ * Without an explicit completion call between these two messages the
+ * overlay sticks at "Preparing update (5%)" forever — exactly the
+ * "toast never goes away" symptom this helper exists to prevent.
+ *
+ * The driver mirrors the Angular client's stage progression so the UX
+ * feels consistent across flavors:
+ *
+ *   received  → ns:hmr-pending (driven by applyHmrPendingFrame)
+ *   evicting  → before loadSfcComponent — surfaces the SFC artifact lookup
+ *   reimporting → during loadSfcComponent — the network/HTTP-ESM fetch
+ *   rebooting → before performResetRoot — the actual view-tree swap
+ *   complete  → after performResetRoot — auto-hides via the overlay's
+ *               internal timer
+ *
+ * The helper is intentionally a pure orchestrator so the stage
+ * sequence can be verified without booting nativescript-vue or the
+ * full HMR client. The CSS overlay helpers (`css-update-overlay.ts`)
+ * follow the same shape; this is the Vue equivalent.
+ */
+export type VueOverlayApiLike = {
+    setUpdateStage?: (stage: string, info?: {
+        detail?: string;
+        progress?: number | null;
+    }) => unknown;
+    hide?: (reason?: string) => unknown;
+} | null | undefined;
+export type VueSfcUpdateOverlayDeps = {
+    /** Resolves the live overlay API. Returning null/undefined is treated as "no overlay installed". */
+    getOverlay: () => VueOverlayApiLike;
+    /** Override the build-time gate for testing. Defaults to reading `__NS_HMR_PROGRESS_OVERLAY_ENABLED__` (or `true` when undefined). */
+    overlayEnabled?: boolean;
+    /** Time source — exposed so tests can stub deterministically. */
+    now?: () => number;
+};
+export type VueSfcUpdateOverlayRun<TComponent> = {
+    /** The changed SFC path as broadcast by the server (e.g. `/src/components/Home.vue`). */
+    filePath?: string;
+    /** Resolves the component to mount. Returning `null`/`undefined` is treated as "no swap needed" and still completes the overlay. */
+    loadComponent: () => Promise<TComponent | null | undefined>;
+    /** Performs the view-tree swap once the component is loaded. Return value is intentionally `unknown` (callers like `performResetRoot` return `Promise<boolean>`; we only care about resolution, not the payload). */
+    applyComponent: (component: TComponent) => Promise<unknown>;
+};
+export type VueSfcUpdateOverlayResult = {
+    /** True when the overlay reached the 'complete' stage (whether the swap actually ran or was skipped). */
+    completed: boolean;
+    /** True when `applyComponent` was called and resolved without throwing. */
+    swapped: boolean;
+    /** Wall-clock duration of the orchestration window. */
+    elapsedMs: number;
+    /** Captured error from `loadComponent` / `applyComponent`, if any. */
+    error?: unknown;
+};
+export declare function buildSfcLoadingDetail(filePath: string | undefined): string;
+export declare function buildSfcRemountDetail(filePath: string | undefined): string;
+export declare function buildSfcCompleteDetail(filePath: string | undefined, elapsedMs: number): string;
+export declare function buildSfcSkippedDetail(filePath: string | undefined): string;
+export declare function buildSfcFailedDetail(filePath: string | undefined): string;
+/**
+ * Orchestrate the apply-progress overlay around a single Vue SFC
+ * registry update.
+ *
+ * The function never throws — every overlay call is guarded — and
+ * always resolves the orchestration even if the underlying load/apply
+ * functions reject. Callers can inspect the returned `error` field for
+ * diagnostics, but the visual contract is that the user always sees a
+ * completed (or hidden) overlay at the end of the call.
+ */
+export declare function driveVueSfcUpdateOverlay<TComponent>(run: VueSfcUpdateOverlayRun<TComponent>, deps: VueSfcUpdateOverlayDeps): Promise<VueSfcUpdateOverlayResult>;

package/hmr/frameworks/vue/client/vue-sfc-update-overlay.js

@@ -0,0 +1,133 @@
+/**
+ * HMR-applying overlay driver for Vue SFC updates.
+ *
+ * The Vue HMR cycle is driven by two messages on the wire:
+ *
+ *   1. `ns:hmr-pending` — fires at the start of `handleHotUpdate` on
+ *      the server. The client's `applyHmrPendingFrame` shows the
+ *      'received' (5%) frame so the user sees an instant reaction to
+ *      their save.
+ *   2. `ns:vue-sfc-registry-update` — fires once the SFC artifact is
+ *      ready. The client loads the new component definition via
+ *      `handleVueSfcRegistryUpdate` and then swaps the root view via
+ *      `performResetRoot`.
+ *
+ * Without an explicit completion call between these two messages the
+ * overlay sticks at "Preparing update (5%)" forever — exactly the
+ * "toast never goes away" symptom this helper exists to prevent.
+ *
+ * The driver mirrors the Angular client's stage progression so the UX
+ * feels consistent across flavors:
+ *
+ *   received  → ns:hmr-pending (driven by applyHmrPendingFrame)
+ *   evicting  → before loadSfcComponent — surfaces the SFC artifact lookup
+ *   reimporting → during loadSfcComponent — the network/HTTP-ESM fetch
+ *   rebooting → before performResetRoot — the actual view-tree swap
+ *   complete  → after performResetRoot — auto-hides via the overlay's
+ *               internal timer
+ *
+ * The helper is intentionally a pure orchestrator so the stage
+ * sequence can be verified without booting nativescript-vue or the
+ * full HMR client. The CSS overlay helpers (`css-update-overlay.ts`)
+ * follow the same shape; this is the Vue equivalent.
+ */
+export function buildSfcLoadingDetail(filePath) {
+    if (!filePath || filePath === '<unknown>')
+        return 'Loading SFC update';
+    return `Loading ${filePath}`;
+}
+export function buildSfcRemountDetail(filePath) {
+    if (!filePath || filePath === '<unknown>')
+        return 'Re-mounting view tree';
+    return `Re-mounting ${filePath}`;
+}
+export function buildSfcCompleteDetail(filePath, elapsedMs) {
+    const ms = Number.isFinite(elapsedMs) && elapsedMs >= 0 ? Math.round(elapsedMs) : 0;
+    if (!filePath || filePath === '<unknown>')
+        return `Update applied in ${ms}ms`;
+    return `Updated ${filePath} in ${ms}ms`;
+}
+export function buildSfcSkippedDetail(filePath) {
+    if (!filePath || filePath === '<unknown>')
+        return 'No SFC swap required';
+    return `Skipped ${filePath}`;
+}
+export function buildSfcFailedDetail(filePath) {
+    if (!filePath || filePath === '<unknown>')
+        return 'SFC update failed';
+    return `Update failed for ${filePath}`;
+}
+function resolveOverlayEnabled(deps) {
+    if (typeof deps.overlayEnabled === 'boolean')
+        return deps.overlayEnabled;
+    try {
+        return typeof __NS_HMR_PROGRESS_OVERLAY_ENABLED__ === 'boolean' ? __NS_HMR_PROGRESS_OVERLAY_ENABLED__ : true;
+    }
+    catch {
+        return true;
+    }
+}
+function resolveOverlay(deps) {
+    try {
+        return deps.getOverlay();
+    }
+    catch {
+        return null;
+    }
+}
+function setStage(api, stage, detail) {
+    if (!api || typeof api.setUpdateStage !== 'function')
+        return;
+    try {
+        api.setUpdateStage(stage, { detail });
+    }
+    catch {
+        // A bad overlay state must never break the HMR cycle.
+    }
+}
+/**
+ * Orchestrate the apply-progress overlay around a single Vue SFC
+ * registry update.
+ *
+ * The function never throws — every overlay call is guarded — and
+ * always resolves the orchestration even if the underlying load/apply
+ * functions reject. Callers can inspect the returned `error` field for
+ * diagnostics, but the visual contract is that the user always sees a
+ * completed (or hidden) overlay at the end of the call.
+ */
+export async function driveVueSfcUpdateOverlay(run, deps) {
+    const now = typeof deps.now === 'function' ? deps.now : () => Date.now();
+    const enabled = resolveOverlayEnabled(deps);
+    const overlay = enabled ? resolveOverlay(deps) : null;
+    const startedAt = now();
+    const filePath = run.filePath;
+    setStage(overlay, 'evicting', buildSfcLoadingDetail(filePath));
+    let component = null;
+    try {
+        setStage(overlay, 'reimporting', buildSfcLoadingDetail(filePath));
+        component = await run.loadComponent();
+    }
+    catch (error) {
+        const elapsedMs = Math.max(0, now() - startedAt);
+        setStage(overlay, 'complete', buildSfcFailedDetail(filePath));
+        return { completed: true, swapped: false, elapsedMs, error };
+    }
+    if (component == null) {
+        const elapsedMs = Math.max(0, now() - startedAt);
+        setStage(overlay, 'complete', buildSfcSkippedDetail(filePath));
+        return { completed: true, swapped: false, elapsedMs };
+    }
+    try {
+        setStage(overlay, 'rebooting', buildSfcRemountDetail(filePath));
+        await run.applyComponent(component);
+    }
+    catch (error) {
+        const elapsedMs = Math.max(0, now() - startedAt);
+        setStage(overlay, 'complete', buildSfcFailedDetail(filePath));
+        return { completed: true, swapped: false, elapsedMs, error };
+    }
+    const elapsedMs = Math.max(0, now() - startedAt);
+    setStage(overlay, 'complete', buildSfcCompleteDetail(filePath, elapsedMs));
+    return { completed: true, swapped: true, elapsedMs };
+}
+//# sourceMappingURL=vue-sfc-update-overlay.js.map

package/hmr/frameworks/vue/client/vue-sfc-update-overlay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue-sfc-update-overlay.js","sourceRoot":"","sources":["../../../../../../../packages/vite/hmr/frameworks/vue/client/vue-sfc-update-overlay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAyCH,MAAM,UAAU,qBAAqB,CAAC,QAA4B;IACjE,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,oBAAoB,CAAC;IACvE,OAAO,WAAW,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,QAA4B;IACjE,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,uBAAuB,CAAC;IAC1E,OAAO,eAAe,QAAQ,EAAE,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,QAA4B,EAAE,SAAiB;IACrF,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpF,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,qBAAqB,EAAE,IAAI,CAAC;IAC9E,OAAO,WAAW,QAAQ,OAAO,EAAE,IAAI,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,QAA4B;IACjE,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,sBAAsB,CAAC;IACzE,OAAO,WAAW,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAA4B;IAChE,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,WAAW;QAAE,OAAO,mBAAmB,CAAC;IACtE,OAAO,qBAAqB,QAAQ,EAAE,CAAC;AACxC,CAAC;AAED,SAAS,qBAAqB,CAAC,IAA6B;IAC3D,IAAI,OAAO,IAAI,CAAC,cAAc,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC,cAAc,CAAC;IACzE,IAAI,CAAC;QACJ,OAAO,OAAO,mCAAmC,KAAK,SAAS,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9G,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAED,SAAS,cAAc,CAAC,IAA6B;IACpD,IAAI,CAAC;QACJ,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC1B,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAED,SAAS,QAAQ,CAAC,GAAsB,EAAE,KAAyE,EAAE,MAAc;IAClI,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,CAAC,cAAc,KAAK,UAAU;QAAE,OAAO;IAC7D,IAAI,CAAC;QACJ,GAAG,CAAC,cAAc,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACvC,CAAC;IAAC,MAAM,CAAC;QACR,sDAAsD;IACvD,CAAC;AACF,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAa,GAAuC,EAAE,IAA6B;IAChI,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;IACzE,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACtD,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;IACxB,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IAE9B,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;IAE/D,IAAI,SAAS,GAAkC,IAAI,CAAC;IACpD,IAAI,CAAC;QACJ,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAClE,SAAS,GAAG,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC;IACvC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;QACjD,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9D,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAC9D,CAAC;IAED,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;QACjD,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/D,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACvD,CAAC;IAED,IAAI,CAAC;QACJ,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAChE,MAAM,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;QACjD,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9D,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAC9D,CAAC;IAED,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;IACjD,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,sBAAsB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IAC3E,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AACtD,CAAC"}

package/hmr/frameworks/vue/server/sfc-route-assemble.d.ts

@@ -0,0 +1,7 @@
+import type { ViteDevServer } from 'vite';
+import type { RegisterSfcHandlersOptions } from './sfc-route-shared.js';
+/**
+ * Registers `GET /ns/asm` — the deterministic, self-contained SFC assembler module.
+ * Extracted verbatim from `websocket-sfc.ts` (pure move, no behavior change).
+ */
+export declare function registerSfcAsmRoute(server: ViteDevServer, options: RegisterSfcHandlersOptions): void;