vorma 0.85.0-pre.12 → 0.85.0-pre.13

package/vorma/core/effect_runtime/route_revalidator.ts

@@ -17,14 +17,14 @@ import {
 	WORK_REVALIDATION_STATUS_DEBOUNCING,
 	WORK_REVALIDATION_STATUS_RETRYING,
 	WORK_REVALIDATION_STATUS_RUNNING,
-	type WorkRevalidation,
+	type WorkRevalidationInput,
 	type WorkStateActor,
 } from "./work_state_actor.ts";
 
 export type RouteRevalidator = {
 	request: (
 		reason: Exclude<RevalidationReason, "retry">,
-		options?: { debounce?: boolean },
+		options?: { debounce?: boolean; skipWorkIndicator?: boolean },
 	) => Effect.Effect<RevalidationResult>;
 	cancel: Effect.Effect<void>;
 	snapshot: Effect.Effect<RevalidationCoordinatorSnapshot>;
@@ -139,7 +139,7 @@ function run_revalidation_attempt(
 
 function work_revalidation_from_snapshot(
 	snapshot: RevalidationCoordinatorSnapshot,
-): WorkRevalidation | null {
+): WorkRevalidationInput | null {
 	if (snapshot.phase === "idle") {
 		return null;
 	}
@@ -147,17 +147,20 @@ function work_revalidation_from_snapshot(
 		return {
 			status: WORK_REVALIDATION_STATUS_DEBOUNCING,
 			attempt: snapshot.attempt,
+			skipWorkIndicator: snapshot.skipWorkIndicator,
 		};
 	}
 	if (snapshot.phase === "retrying") {
 		return {
 			status: WORK_REVALIDATION_STATUS_RETRYING,
 			attempt: snapshot.attempt,
+			skipWorkIndicator: snapshot.skipWorkIndicator,
 		};
 	}
 	return {
 		status: WORK_REVALIDATION_STATUS_RUNNING,
 		attempt: snapshot.attempt,
+		skipWorkIndicator: snapshot.skipWorkIndicator,
 	};
 }
 

package/vorma/core/effect_runtime/submit_manager.ts

@@ -73,7 +73,10 @@ export type SubmitManagerOptions = {
 	dispatch: (
 		request: SubmitDispatch,
 	) => Effect.Effect<Response, SubmitDispatchFailed | SubmitAborted>;
-	revalidate?: (reason: "apiRequest") => Effect.Effect<RevalidationResult>;
+	revalidate?: (
+		reason: "apiRequest",
+		options?: { skipWorkIndicator?: boolean },
+	) => Effect.Effect<RevalidationResult>;
 	redirect?: (href: string, kind: "client" | "hard") => Effect.Effect<void>;
 	report_build_skew?: (
 		dispatch: SubmitDispatch,
@@ -161,7 +164,12 @@ export function make_submit_manager(
 			});
 		const revalidate =
 			options.revalidate ??
-			((_reason: "apiRequest") => {
+			((
+				_reason: "apiRequest",
+				_options?: {
+					skipWorkIndicator?: boolean;
+				},
+			) => {
 				return Effect.succeed(REVALIDATION_OK);
 			});
 		const report_build_skew =
@@ -204,6 +212,7 @@ export function make_submit_manager(
 
 		const revalidation_now = (
 			should_revalidate: boolean,
+			skip_work_indicator?: boolean,
 		): Effect.Effect<Effect.Effect<RevalidationResult>> => {
 			if (!should_revalidate) {
 				return Effect.succeed(Effect.succeed(REVALIDATION_OK));
@@ -212,7 +221,9 @@ export function make_submit_manager(
 				const deferred_result =
 					yield* Deferred.make<RevalidationResult>();
 				yield* Effect.forkDaemon(
-					revalidate("apiRequest").pipe(
+					revalidate("apiRequest", {
+						skipWorkIndicator: skip_work_indicator,
+					}).pipe(
 						Effect.flatMap((result) => {
 							return Deferred.succeed(deferred_result, result);
 						}),
@@ -242,6 +253,7 @@ export function make_submit_manager(
 				yield* Fiber.interruptFork(submission.fiber);
 				const revalidation_effect = yield* revalidation_now(
 					submission.shouldRevalidate,
+					submission.skipWorkIndicator,
 				);
 				yield* resolve_waiter(submission.waiter, {
 					success: false,
@@ -398,6 +410,7 @@ export function make_submit_manager(
 			dispatch: SubmitDispatch,
 			response: Response,
 			should_revalidate: boolean,
+			skip_work_indicator: boolean,
 		): Effect.Effect<SubmitResult, never> => {
 			return Effect.catchAll(
 				Effect.gen(function* () {
@@ -439,8 +452,10 @@ export function make_submit_manager(
 						};
 					}
 					if (!response.ok) {
-						const revalidation_effect =
-							yield* revalidation_now(should_revalidate);
+						const revalidation_effect = yield* revalidation_now(
+							should_revalidate,
+							skip_work_indicator,
+						);
 						return {
 							success: false as const,
 							error: response.statusText,
@@ -449,8 +464,10 @@ export function make_submit_manager(
 						};
 					}
 					const data = yield* response_data(response);
-					const revalidation_effect =
-						yield* revalidation_now(should_revalidate);
+					const revalidation_effect = yield* revalidation_now(
+						should_revalidate,
+						skip_work_indicator,
+					);
 					return {
 						success: true as const,
 						data,
@@ -472,6 +489,7 @@ export function make_submit_manager(
 		const run_submission = (
 			dispatch: SubmitDispatch,
 			should_revalidate: boolean,
+			skip_work_indicator: boolean,
 		): Effect.Effect<void, never> => {
 			const normalize_defect = (error: unknown): Effect.Effect<void> => {
 				return Queue.offer(queue, {
@@ -491,6 +509,7 @@ export function make_submit_manager(
 						dispatch,
 						response,
 						should_revalidate,
+						skip_work_indicator,
 					);
 				}),
 				Effect.flatMap((result) => {
@@ -504,8 +523,10 @@ export function make_submit_manager(
 				Effect.catchAll((error) => {
 					if (error instanceof SubmitAborted) {
 						return Effect.gen(function* () {
-							const revalidation_effect =
-								yield* revalidation_now(should_revalidate);
+							const revalidation_effect = yield* revalidation_now(
+								should_revalidate,
+								skip_work_indicator,
+							);
 							yield* Queue.offer(queue, {
 								_tag: "Completed",
 								id: dispatch.id,
@@ -519,8 +540,10 @@ export function make_submit_manager(
 						});
 					}
 					return Effect.gen(function* () {
-						const revalidation_effect =
-							yield* revalidation_now(should_revalidate);
+						const revalidation_effect = yield* revalidation_now(
+							should_revalidate,
+							skip_work_indicator,
+						);
 						yield* Queue.offer(queue, {
 							_tag: "Completed",
 							id: dispatch.id,
@@ -566,6 +589,7 @@ export function make_submit_manager(
 					run_submission(
 						prepared.dispatch,
 						prepared.shouldRevalidate,
+						command.request.options?.skipWorkIndicator === true,
 					),
 				);
 				next_active.set(key, {

package/vorma/core/effect_runtime/work_indicator.ts

@@ -93,7 +93,7 @@ export function make_work_indicator(): Effect.Effect<
 					previous.options &&
 					previous.options !== options
 				) {
-					previous.options.hide();
+					previous.options.stop();
 				}
 				yield* Ref.set(state_ref, {
 					...previous,
@@ -111,7 +111,7 @@ export function make_work_indicator(): Effect.Effect<
 			yield* cancel_timer(state.show_timer);
 			yield* cancel_timer(state.hide_timer);
 			if (state.visible && state.options) {
-				state.options.hide();
+				state.options.stop();
 			}
 			release_vorma_work = null;
 			yield* Ref.set(state_ref, {
@@ -180,7 +180,7 @@ function sync_indicator(
 				return;
 			}
 			const show_timer = yield* start_timer(
-				options.showDelayMS ?? WORK_INDICATOR_DEFAULT_SHOW_DELAY_MS,
+				options.startDelayMS ?? WORK_INDICATOR_DEFAULT_SHOW_DELAY_MS,
 				show_indicator(state_ref),
 			);
 			yield* Ref.set(state_ref, {
@@ -191,6 +191,13 @@ function sync_indicator(
 			return;
 		}
 		yield* cancel_timer(state.show_timer);
+		if (!state.visible) {
+			yield* Ref.set(state_ref, {
+				...state,
+				show_timer: null,
+			});
+			return;
+		}
 		if (state.hide_timer) {
 			yield* Ref.set(state_ref, {
 				...state,
@@ -199,7 +206,7 @@ function sync_indicator(
 			return;
 		}
 		const hide_timer = yield* start_timer(
-			options.hideDelayMS ?? WORK_INDICATOR_DEFAULT_HIDE_DELAY_MS,
+			options.stopDelayMS ?? WORK_INDICATOR_DEFAULT_HIDE_DELAY_MS,
 			hide_indicator(state_ref),
 		);
 		yield* Ref.set(state_ref, {
@@ -222,7 +229,7 @@ function show_indicator(
 			});
 			return;
 		}
-		state.options.show();
+		state.options.start();
 		yield* Ref.set(state_ref, {
 			...state,
 			visible: true,
@@ -243,7 +250,7 @@ function hide_indicator(
 			});
 			return;
 		}
-		state.options.hide();
+		state.options.stop();
 		yield* Ref.set(state_ref, {
 			...state,
 			hide_timer: null,

package/vorma/core/effect_runtime/work_state_actor.ts

@@ -30,6 +30,9 @@ export type WorkIndicatorActivity = {
 export type WorkNavigationInput = WorkNavigation & {
 	skipWorkIndicator?: boolean;
 };
+export type WorkRevalidationInput = WorkRevalidation & {
+	skipWorkIndicator?: boolean;
+};
 export type WorkAPIRequestInput = WorkAPIRequest & {
 	skipWorkIndicator?: boolean;
 };
@@ -39,7 +42,7 @@ export type WorkStateActor = {
 		navigation: WorkNavigationInput | null,
 	) => Effect.Effect<void>;
 	set_revalidation: (
-		revalidation: WorkRevalidation | null,
+		revalidation: WorkRevalidationInput | null,
 	) => Effect.Effect<void>;
 	set_prefetch: (prefetch: WorkPrefetch | null) => Effect.Effect<void>;
 	set_api_requests: (
@@ -65,6 +68,7 @@ type Model = {
 	readonly state: WorkState;
 	readonly last_emitted: WorkState;
 	readonly navigation_skip_work_indicator: boolean;
+	readonly revalidation_skip_work_indicator: boolean;
 	readonly api_request_skip_work_indicators: ReadonlyMap<string, boolean>;
 	readonly last_indicator_activity: WorkIndicatorActivity;
 };
@@ -77,7 +81,7 @@ type Command =
 	  }
 	| {
 			readonly _tag: typeof COMMAND_SET_REVALIDATION;
-			readonly revalidation: WorkRevalidation | null;
+			readonly revalidation: WorkRevalidationInput | null;
 			readonly ack: Deferred.Deferred<void>;
 	  }
 	| {
@@ -130,6 +134,7 @@ export function make_work_state_actor(
 			state: EMPTY_WORK_STATE,
 			last_emitted: EMPTY_WORK_STATE,
 			navigation_skip_work_indicator: false,
+			revalidation_skip_work_indicator: false,
 			api_request_skip_work_indicators: new Map(),
 			last_indicator_activity: EMPTY_WORK_INDICATOR_ACTIVITY,
 		});
@@ -283,16 +288,29 @@ export function make_work_state_actor(
 			});
 		};
 
+		const public_revalidation = (
+			revalidation: WorkRevalidationInput,
+		): WorkRevalidation => {
+			return {
+				status: revalidation.status,
+				attempt: revalidation.attempt,
+			};
+		};
+
 		const set_revalidation_now = (
-			revalidation: WorkRevalidation | null,
+			revalidation: WorkRevalidationInput | null,
 		): Effect.Effect<void> => {
 			return update_model((current) => {
 				return {
 					...current,
 					state: {
 						...current.state,
-						revalidation,
+						revalidation: revalidation
+							? public_revalidation(revalidation)
+							: null,
 					},
+					revalidation_skip_work_indicator:
+						revalidation?.skipWorkIndicator === true,
 				};
 			});
 		};
@@ -455,7 +473,9 @@ function indicator_activity_from_model(current: Model): WorkIndicatorActivity {
 		navigation:
 			current.state.navigation !== null &&
 			!current.navigation_skip_work_indicator,
-		revalidation: current.state.revalidation !== null,
+		revalidation:
+			current.state.revalidation !== null &&
+			!current.revalidation_skip_work_indicator,
 		apiRequests: current.state.apiRequests.some((request) => {
 			return (
 				current.api_request_skip_work_indicators.get(request.key) !==

package/vorma/core/make_link_props.ts

@@ -38,6 +38,7 @@ export type LinkNavFns = {
 		href: string;
 		replace?: boolean;
 		scrollToTop?: boolean;
+		skipWorkIndicator?: boolean;
 		state?: unknown;
 	}) => Promise<{ didNavigate: boolean }>;
 	start_prefetch: (href: string) => void;
@@ -57,6 +58,8 @@ export type LinkNavFns = {
 	};
 };
 
+export const skip_work_indicator_link_prop = "skipWorkIndicator";
+
 const VORMA_KEYS = new Set([
 	"attributeMatchRules",
 	"pattern",
@@ -64,6 +67,7 @@ const VORMA_KEYS = new Set([
 	"prefetchDelayMs",
 	"replace",
 	"scrollToTop",
+	skip_work_indicator_link_prop,
 	"state",
 	"visitOnPointerDown",
 ]);
@@ -196,6 +200,9 @@ export function make_link_props(
 	const prefetch_delay = (props.prefetchDelayMs as number | undefined) ?? 100;
 	const replace = props.replace as boolean | undefined;
 	const scroll_to_top = props.scrollToTop as boolean | undefined;
+	const skip_work_indicator = props[skip_work_indicator_link_prop] as
+		| boolean
+		| undefined;
 	const state = props.state as unknown;
 	const target_attr = props.target as string | undefined;
 	const visit_on_pointer_down = props.visitOnPointerDown as
@@ -265,6 +272,9 @@ export function make_link_props(
 					href,
 					replace,
 					scrollToTop: scroll_to_top,
+					...(skip_work_indicator === undefined
+						? {}
+						: { skipWorkIndicator: skip_work_indicator }),
 					state,
 				});
 			} catch (err) {
@@ -317,6 +327,12 @@ export function make_link_props(
 								href,
 								replace,
 								scrollToTop: scroll_to_top,
+								...(skip_work_indicator === undefined
+									? {}
+									: {
+											skipWorkIndicator:
+												skip_work_indicator,
+										}),
 							});
 						} catch (err) {
 							console.error(

package/vorma/core/types.ts

@@ -102,6 +102,7 @@ export type LinkPropsBase = {
 	visitOnPointerDown?: boolean;
 	replace?: boolean;
 	scrollToTop?: boolean;
+	skipWorkIndicator?: boolean;
 };
 
 /////// APP CONFIG

package/vorma/core/ui_adapter_core.ts

@@ -238,6 +238,7 @@ export function create_adapter_base<A extends AppConfig>(
 			return core.navigate(args.href, {
 				replace: args.replace,
 				scrollToTop: args.scrollToTop,
+				skipWorkIndicator: args.skipWorkIndicator,
 				state: args.state,
 			});
 		},

package/vorma/create/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-vorma",
-	"version": "0.85.0-pre.12",
+	"version": "0.85.0-pre.13",
 	"description": "CLI for creating new Vorma applications.",
 	"type": "module",
 	"license": "BSD-3-Clause",