@scalar/api-client 3.6.1 → 3.8.0

package/dist/v2/features/app/hooks/use-document-watcher.js

@@ -1,168 +0,0 @@
-import { computed, onBeforeUnmount, toValue, watch } from "vue";
-//#region src/v2/features/app/hooks/use-document-watcher.ts
-/**
-* Default timeout before the first poll attempt (in milliseconds).
-*/
-var DEFAULT_INITIAL_TIMEOUT = 5 * 1e3;
-/**
-* Maximum timeout cap for exponential backoff (in milliseconds).
-*/
-var MAX_TIMEOUT = 60 * 1e3;
-/**
-* Creates a timer manager for handling polling timeouts.
-*
-* @returns Object with methods to manage the polling timer.
-*/
-var createTimerManager = () => {
-	let timer = null;
-	/**
-	* Clears the current timer if it exists.
-	*/
-	const clear = () => {
-		if (timer) {
-			clearTimeout(timer);
-			timer = null;
-		}
-	};
-	/**
-	* Schedules the next poll after the specified timeout.
-	*
-	* @param callback - The function to call when the timeout expires.
-	* @param timeout - The delay in milliseconds before calling the callback.
-	*/
-	const schedule = (callback, timeout) => {
-		clear();
-		timer = setTimeout(callback, timeout);
-	};
-	return {
-		clear,
-		schedule
-	};
-};
-/**
-* Creates a timeout manager that handles exponential backoff on failures.
-*
-* @param initialTimeout - The initial timeout value in milliseconds.
-* @returns Object with methods to manage timeout values.
-*/
-var createTimeoutManager = (initialTimeout) => {
-	let currentTimeout = initialTimeout;
-	/**
-	* Resets the timeout to its initial value.
-	*/
-	const reset = () => {
-		currentTimeout = initialTimeout;
-	};
-	/**
-	* Doubles the timeout with exponential backoff, capped at MAX_TIMEOUT.
-	*/
-	const backoff = () => {
-		currentTimeout = Math.min(currentTimeout * 2, MAX_TIMEOUT);
-	};
-	/**
-	* Gets the current timeout value.
-	*/
-	const get = () => currentTimeout;
-	return {
-		reset,
-		backoff,
-		get
-	};
-};
-/**
-* Resolves conflicts by preferring remote changes.
-*
-* @param conflicts - Array of conflict tuples from the rebase result.
-* Each tuple contains two arrays: [remote changes, local changes].
-* @returns Array of remote changes to apply.
-*/
-var resolveConflicts = (conflicts) => {
-	return conflicts.flatMap(([remote]) => remote);
-};
-/**
-* Watches the specified document in the workspace store and periodically rebases it with its remote source.
-*
-* This utility sets up a watcher on the given document. If the document specifies an 'x-scalar-original-source-url'
-* and watch mode is enabled, this hook polls the remote source and calls `store.rebaseDocument`.
-* If rebase conflicts are detected, it applies automatic conflict resolution by preferring remote changes.
-* Uses exponential backoff on failures to avoid overwhelming the server.
-*
-* @param params - Configuration object for the document watcher.
-* @param params.documentName - The name/key of the document to watch and rebase.
-* @param params.store - The WorkspaceStore instance.
-* @param params.initialTimeout - Initial delay before the first poll attempt (default: 5000ms).
-*
-* @example
-* ```ts
-* import { useDocumentWatcher } from '@/hooks/use-document-watcher'
-* import { useScalarWorkspaceStore } from '@scalar/workspace-store'
-*
-* const store = useScalarWorkspaceStore()
-* useDocumentWatcher({ documentName: 'myApi', store })
-* ```
-*/
-var useDocumentWatcher = ({ documentName, store, initialTimeout = DEFAULT_INITIAL_TIMEOUT }) => {
-	const document = computed(() => {
-		const storeValue = toValue(store);
-		const documentNameValue = toValue(documentName);
-		if (!storeValue || !documentNameValue) return null;
-		return storeValue.workspace.documents[documentNameValue];
-	});
-	const timerManager = createTimerManager();
-	const timeoutManager = createTimeoutManager(initialTimeout);
-	/**
-	* Handles a successful poll result (with or without changes).
-	*/
-	const handleSuccess = () => {
-		timeoutManager.reset();
-		timerManager.schedule(poll, timeoutManager.get());
-	};
-	/**
-	* Handles a failed poll result with exponential backoff.
-	*/
-	const handleFailure = () => {
-		timeoutManager.backoff();
-		timerManager.schedule(poll, timeoutManager.get());
-	};
-	/**
-	* Polls the remote document source and attempts to rebase.
-	*/
-	const poll = async () => {
-		const storeValue = toValue(store);
-		const documentNameValue = toValue(documentName);
-		const sourceUrl = document.value?.["x-scalar-original-source-url"];
-		if (!storeValue || !documentNameValue || !sourceUrl) return;
-		const result = await storeValue.rebaseDocument({
-			name: documentNameValue,
-			url: sourceUrl
-		});
-		if (result?.ok) {
-			await result.applyChanges({ resolvedConflicts: resolveConflicts(result.conflicts) });
-			handleSuccess();
-		} else if (result?.ok === false && result.type === "NO_CHANGES_DETECTED") handleSuccess();
-		else handleFailure();
-	};
-	/**
-	* Watches for changes to the document's source URL and watch mode.
-	* Starts or stops polling based on these values.
-	*/
-	watch([() => document.value?.["x-scalar-original-source-url"], () => document.value?.["x-scalar-watch-mode"]], ([sourceUrl, watchMode = false]) => {
-		if (!toValue(store)) {
-			timerManager.clear();
-			return;
-		}
-		timerManager.clear();
-		if (!sourceUrl || !watchMode) {
-			timeoutManager.reset();
-			return;
-		}
-		timerManager.schedule(poll, timeoutManager.get());
-	}, { immediate: true });
-	onBeforeUnmount(() => {
-		timerManager.clear();
-	});
-};
-//#endregion
-export { useDocumentWatcher };
-
-//# sourceMappingURL=use-document-watcher.js.map

package/dist/v2/features/app/hooks/use-document-watcher.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-document-watcher.js","names":[],"sources":["../../../../../src/v2/features/app/hooks/use-document-watcher.ts"],"sourcesContent":["import type { Difference } from '@scalar/json-magic/diff'\nimport type { WorkspaceStore } from '@scalar/workspace-store/client'\nimport { type MaybeRefOrGetter, computed, onBeforeUnmount, toValue, watch } from 'vue'\n\n/**\n * Default timeout before the first poll attempt (in milliseconds).\n */\nconst DEFAULT_INITIAL_TIMEOUT = 5 * 1000 // 5 seconds\n\n/**\n * Maximum timeout cap for exponential backoff (in milliseconds).\n */\nconst MAX_TIMEOUT = 60 * 1000 // 60 seconds\n\n/**\n * Creates a timer manager for handling polling timeouts.\n *\n * @returns Object with methods to manage the polling timer.\n */\nconst createTimerManager = () => {\n  let timer: ReturnType<typeof setTimeout> | null = null\n\n  /**\n   * Clears the current timer if it exists.\n   */\n  const clear = (): void => {\n    if (timer) {\n      clearTimeout(timer)\n      timer = null\n    }\n  }\n\n  /**\n   * Schedules the next poll after the specified timeout.\n   *\n   * @param callback - The function to call when the timeout expires.\n   * @param timeout - The delay in milliseconds before calling the callback.\n   */\n  const schedule = (callback: () => void, timeout: number): void => {\n    clear()\n    timer = setTimeout(callback, timeout)\n  }\n\n  return {\n    clear,\n    schedule,\n  }\n}\n\n/**\n * Creates a timeout manager that handles exponential backoff on failures.\n *\n * @param initialTimeout - The initial timeout value in milliseconds.\n * @returns Object with methods to manage timeout values.\n */\nconst createTimeoutManager = (initialTimeout: number) => {\n  let currentTimeout = initialTimeout\n\n  /**\n   * Resets the timeout to its initial value.\n   */\n  const reset = (): void => {\n    currentTimeout = initialTimeout\n  }\n\n  /**\n   * Doubles the timeout with exponential backoff, capped at MAX_TIMEOUT.\n   */\n  const backoff = (): void => {\n    currentTimeout = Math.min(currentTimeout * 2, MAX_TIMEOUT)\n  }\n\n  /**\n   * Gets the current timeout value.\n   */\n  const get = (): number => currentTimeout\n\n  return {\n    reset,\n    backoff,\n    get,\n  }\n}\n\n/**\n * Resolves conflicts by preferring remote changes.\n *\n * @param conflicts - Array of conflict tuples from the rebase result.\n * Each tuple contains two arrays: [remote changes, local changes].\n * @returns Array of remote changes to apply.\n */\nconst resolveConflicts = (conflicts: Array<[Difference<unknown>[], Difference<unknown>[]]>): Difference<unknown>[] => {\n  return conflicts.flatMap(([remote]) => remote)\n}\n\n/**\n * Watches the specified document in the workspace store and periodically rebases it with its remote source.\n *\n * This utility sets up a watcher on the given document. If the document specifies an 'x-scalar-original-source-url'\n * and watch mode is enabled, this hook polls the remote source and calls `store.rebaseDocument`.\n * If rebase conflicts are detected, it applies automatic conflict resolution by preferring remote changes.\n * Uses exponential backoff on failures to avoid overwhelming the server.\n *\n * @param params - Configuration object for the document watcher.\n * @param params.documentName - The name/key of the document to watch and rebase.\n * @param params.store - The WorkspaceStore instance.\n * @param params.initialTimeout - Initial delay before the first poll attempt (default: 5000ms).\n *\n * @example\n * ```ts\n * import { useDocumentWatcher } from '@/hooks/use-document-watcher'\n * import { useScalarWorkspaceStore } from '@scalar/workspace-store'\n *\n * const store = useScalarWorkspaceStore()\n * useDocumentWatcher({ documentName: 'myApi', store })\n * ```\n */\nexport const useDocumentWatcher = ({\n  documentName,\n  store,\n  initialTimeout = DEFAULT_INITIAL_TIMEOUT,\n}: {\n  documentName: MaybeRefOrGetter<string | undefined>\n  store: MaybeRefOrGetter<WorkspaceStore | null>\n  initialTimeout?: number\n}): void => {\n  const document = computed(() => {\n    const storeValue = toValue(store)\n    const documentNameValue = toValue(documentName)\n    if (!storeValue || !documentNameValue) {\n      return null\n    }\n    return storeValue.workspace.documents[documentNameValue]\n  })\n\n  const timerManager = createTimerManager()\n  const timeoutManager = createTimeoutManager(initialTimeout)\n\n  /**\n   * Handles a successful poll result (with or without changes).\n   */\n  const handleSuccess = (): void => {\n    timeoutManager.reset()\n    timerManager.schedule(poll, timeoutManager.get())\n  }\n\n  /**\n   * Handles a failed poll result with exponential backoff.\n   */\n  const handleFailure = (): void => {\n    timeoutManager.backoff()\n    timerManager.schedule(poll, timeoutManager.get())\n  }\n\n  /**\n   * Polls the remote document source and attempts to rebase.\n   */\n  const poll = async (): Promise<void> => {\n    const storeValue = toValue(store)\n    const documentNameValue = toValue(documentName)\n    const sourceUrl = document.value?.['x-scalar-original-source-url']\n\n    if (!storeValue || !documentNameValue || !sourceUrl) {\n      return\n    }\n\n    const result = await storeValue.rebaseDocument({\n      name: documentNameValue,\n      url: sourceUrl,\n    })\n\n    if (result?.ok) {\n      // On conflicts, prefer remote changes by automatically choosing the first option for each conflict tuple\n      await result.applyChanges({ resolvedConflicts: resolveConflicts(result.conflicts) })\n      handleSuccess()\n    } else if (result?.ok === false && result.type === 'NO_CHANGES_DETECTED') {\n      // Still a successful call, just nothing changed\n      handleSuccess()\n    } else {\n      // Exponential backoff on failure\n      handleFailure()\n    }\n  }\n\n  /**\n   * Watches for changes to the document's source URL and watch mode.\n   * Starts or stops polling based on these values.\n   */\n  watch(\n    [() => document.value?.['x-scalar-original-source-url'], () => document.value?.['x-scalar-watch-mode']],\n    ([sourceUrl, watchMode = false]) => {\n      const storeValue = toValue(store)\n\n      // Clear timer if store is unavailable\n      if (!storeValue) {\n        timerManager.clear()\n        return\n      }\n\n      // Clear any existing timer\n      timerManager.clear()\n\n      // Stop polling if source URL is missing or watch mode is disabled\n      if (!sourceUrl || !watchMode) {\n        timeoutManager.reset()\n        return\n      }\n\n      // Start polling\n      timerManager.schedule(poll, timeoutManager.get())\n    },\n    { immediate: true },\n  )\n\n  // Cleanup timer on component unmount\n  onBeforeUnmount(() => {\n    timerManager.clear()\n  })\n}\n"],"mappings":";;;;;AAOA,IAAM,0BAA0B,IAAI;;;;AAKpC,IAAM,cAAc,KAAK;;;;;;AAOzB,IAAM,2BAA2B;CAC/B,IAAI,QAA8C;;;;CAKlD,MAAM,cAAoB;AACxB,MAAI,OAAO;AACT,gBAAa,MAAM;AACnB,WAAQ;;;;;;;;;CAUZ,MAAM,YAAY,UAAsB,YAA0B;AAChE,SAAO;AACP,UAAQ,WAAW,UAAU,QAAQ;;AAGvC,QAAO;EACL;EACA;EACD;;;;;;;;AASH,IAAM,wBAAwB,mBAA2B;CACvD,IAAI,iBAAiB;;;;CAKrB,MAAM,cAAoB;AACxB,mBAAiB;;;;;CAMnB,MAAM,gBAAsB;AAC1B,mBAAiB,KAAK,IAAI,iBAAiB,GAAG,YAAY;;;;;CAM5D,MAAM,YAAoB;AAE1B,QAAO;EACL;EACA;EACA;EACD;;;;;;;;;AAUH,IAAM,oBAAoB,cAA4F;AACpH,QAAO,UAAU,SAAS,CAAC,YAAY,OAAO;;;;;;;;;;;;;;;;;;;;;;;;AAyBhD,IAAa,sBAAsB,EACjC,cACA,OACA,iBAAiB,8BAKP;CACV,MAAM,WAAW,eAAe;EAC9B,MAAM,aAAa,QAAQ,MAAM;EACjC,MAAM,oBAAoB,QAAQ,aAAa;AAC/C,MAAI,CAAC,cAAc,CAAC,kBAClB,QAAO;AAET,SAAO,WAAW,UAAU,UAAU;GACtC;CAEF,MAAM,eAAe,oBAAoB;CACzC,MAAM,iBAAiB,qBAAqB,eAAe;;;;CAK3D,MAAM,sBAA4B;AAChC,iBAAe,OAAO;AACtB,eAAa,SAAS,MAAM,eAAe,KAAK,CAAC;;;;;CAMnD,MAAM,sBAA4B;AAChC,iBAAe,SAAS;AACxB,eAAa,SAAS,MAAM,eAAe,KAAK,CAAC;;;;;CAMnD,MAAM,OAAO,YAA2B;EACtC,MAAM,aAAa,QAAQ,MAAM;EACjC,MAAM,oBAAoB,QAAQ,aAAa;EAC/C,MAAM,YAAY,SAAS,QAAQ;AAEnC,MAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,UACxC;EAGF,MAAM,SAAS,MAAM,WAAW,eAAe;GAC7C,MAAM;GACN,KAAK;GACN,CAAC;AAEF,MAAI,QAAQ,IAAI;AAEd,SAAM,OAAO,aAAa,EAAE,mBAAmB,iBAAiB,OAAO,UAAU,EAAE,CAAC;AACpF,kBAAe;aACN,QAAQ,OAAO,SAAS,OAAO,SAAS,sBAEjD,gBAAe;MAGf,gBAAe;;;;;;AAQnB,OACE,OAAO,SAAS,QAAQ,uCAAuC,SAAS,QAAQ,uBAAuB,GACtG,CAAC,WAAW,YAAY,WAAW;AAIlC,MAAI,CAHe,QAAQ,MAAM,EAGhB;AACf,gBAAa,OAAO;AACpB;;AAIF,eAAa,OAAO;AAGpB,MAAI,CAAC,aAAa,CAAC,WAAW;AAC5B,kBAAe,OAAO;AACtB;;AAIF,eAAa,SAAS,MAAM,eAAe,KAAK,CAAC;IAEnD,EAAE,WAAW,MAAM,CACpB;AAGD,uBAAsB;AACpB,eAAa,OAAO;GACpB"}

package/dist/v2/features/app/hooks/use-network-status.d.ts

@@ -1,29 +0,0 @@
-import { type ComputedRef, type Ref } from 'vue';
-/**
- * Reactive accessor for the browser's online / offline status.
- *
- * Wires up `online` and `offline` listeners on `window` and exposes
- * a read-only `isOnline` ref alongside a derived `isOffline` boolean
- * for ergonomic template usage. Listeners are cleaned up automatically
- * when the surrounding effect scope (typically a Vue component) is
- * disposed.
- *
- * The hook is safe to call in non-browser contexts: it short-circuits
- * before touching `window` so callers do not have to guard against SSR
- * or test environments themselves. In those cases the client is
- * reported as online and the status simply never changes.
- *
- * @example
- * ```ts
- * const { isOnline, isOffline } = useNetworkStatus()
- *
- * const canPush = computed(() => isOnline.value && hasPendingChanges.value)
- * ```
- */
-export declare const useNetworkStatus: () => {
-    /** Reactive flag, `true` while the browser reports a live connection. */
-    isOnline: Readonly<Ref<boolean>>;
-    /** Convenience inverse of `isOnline` for `:disabled` / icon swaps. */
-    isOffline: ComputedRef<boolean>;
-};
-//# sourceMappingURL=use-network-status.d.ts.map

package/dist/v2/features/app/hooks/use-network-status.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-network-status.d.ts","sourceRoot":"","sources":["../../../../../src/v2/features/app/hooks/use-network-status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAA2C,MAAM,KAAK,CAAA;AAezF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB,QAAO;IAClC,yEAAyE;IACzE,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAA;IAChC,sEAAsE;IACtE,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;CA2BhC,CAAA"}

package/dist/v2/features/app/hooks/use-network-status.js

@@ -1,58 +0,0 @@
-import { computed, onScopeDispose, readonly, ref } from "vue";
-//#region src/v2/features/app/hooks/use-network-status.ts
-/**
-* Resolves whether the browser currently believes the client is online.
-* Falls back to `true` when `navigator` is not available (SSR, tests
-* running without `jsdom`) so consumers do not accidentally disable
-* network-dependent UI in those environments.
-*/
-var resolveInitialOnlineStatus = () => {
-	if (typeof navigator === "undefined") return true;
-	return navigator.onLine;
-};
-/**
-* Reactive accessor for the browser's online / offline status.
-*
-* Wires up `online` and `offline` listeners on `window` and exposes
-* a read-only `isOnline` ref alongside a derived `isOffline` boolean
-* for ergonomic template usage. Listeners are cleaned up automatically
-* when the surrounding effect scope (typically a Vue component) is
-* disposed.
-*
-* The hook is safe to call in non-browser contexts: it short-circuits
-* before touching `window` so callers do not have to guard against SSR
-* or test environments themselves. In those cases the client is
-* reported as online and the status simply never changes.
-*
-* @example
-* ```ts
-* const { isOnline, isOffline } = useNetworkStatus()
-*
-* const canPush = computed(() => isOnline.value && hasPendingChanges.value)
-* ```
-*/
-var useNetworkStatus = () => {
-	const isOnline = ref(resolveInitialOnlineStatus());
-	if (typeof window !== "undefined") {
-		const handleOnline = () => {
-			isOnline.value = true;
-		};
-		const handleOffline = () => {
-			isOnline.value = false;
-		};
-		window.addEventListener("online", handleOnline);
-		window.addEventListener("offline", handleOffline);
-		onScopeDispose(() => {
-			window.removeEventListener("online", handleOnline);
-			window.removeEventListener("offline", handleOffline);
-		});
-	}
-	return {
-		isOnline: readonly(isOnline),
-		isOffline: computed(() => !isOnline.value)
-	};
-};
-//#endregion
-export { useNetworkStatus };
-
-//# sourceMappingURL=use-network-status.js.map

package/dist/v2/features/app/hooks/use-network-status.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-network-status.js","names":[],"sources":["../../../../../src/v2/features/app/hooks/use-network-status.ts"],"sourcesContent":["import { type ComputedRef, type Ref, computed, onScopeDispose, readonly, ref } from 'vue'\n\n/**\n * Resolves whether the browser currently believes the client is online.\n * Falls back to `true` when `navigator` is not available (SSR, tests\n * running without `jsdom`) so consumers do not accidentally disable\n * network-dependent UI in those environments.\n */\nconst resolveInitialOnlineStatus = (): boolean => {\n  if (typeof navigator === 'undefined') {\n    return true\n  }\n  return navigator.onLine\n}\n\n/**\n * Reactive accessor for the browser's online / offline status.\n *\n * Wires up `online` and `offline` listeners on `window` and exposes\n * a read-only `isOnline` ref alongside a derived `isOffline` boolean\n * for ergonomic template usage. Listeners are cleaned up automatically\n * when the surrounding effect scope (typically a Vue component) is\n * disposed.\n *\n * The hook is safe to call in non-browser contexts: it short-circuits\n * before touching `window` so callers do not have to guard against SSR\n * or test environments themselves. In those cases the client is\n * reported as online and the status simply never changes.\n *\n * @example\n * ```ts\n * const { isOnline, isOffline } = useNetworkStatus()\n *\n * const canPush = computed(() => isOnline.value && hasPendingChanges.value)\n * ```\n */\nexport const useNetworkStatus = (): {\n  /** Reactive flag, `true` while the browser reports a live connection. */\n  isOnline: Readonly<Ref<boolean>>\n  /** Convenience inverse of `isOnline` for `:disabled` / icon swaps. */\n  isOffline: ComputedRef<boolean>\n} => {\n  const isOnline = ref(resolveInitialOnlineStatus())\n\n  // `window` may be unavailable in SSR or unit tests without a DOM, so\n  // we degrade to a static \"online\" signal rather than throwing.\n  if (typeof window !== 'undefined') {\n    const handleOnline = (): void => {\n      isOnline.value = true\n    }\n    const handleOffline = (): void => {\n      isOnline.value = false\n    }\n\n    window.addEventListener('online', handleOnline)\n    window.addEventListener('offline', handleOffline)\n\n    onScopeDispose(() => {\n      window.removeEventListener('online', handleOnline)\n      window.removeEventListener('offline', handleOffline)\n    })\n  }\n\n  return {\n    isOnline: readonly(isOnline),\n    isOffline: computed(() => !isOnline.value),\n  }\n}\n"],"mappings":";;;;;;;;AAQA,IAAM,mCAA4C;AAChD,KAAI,OAAO,cAAc,YACvB,QAAO;AAET,QAAO,UAAU;;;;;;;;;;;;;;;;;;;;;;;AAwBnB,IAAa,yBAKR;CACH,MAAM,WAAW,IAAI,4BAA4B,CAAC;AAIlD,KAAI,OAAO,WAAW,aAAa;EACjC,MAAM,qBAA2B;AAC/B,YAAS,QAAQ;;EAEnB,MAAM,sBAA4B;AAChC,YAAS,QAAQ;;AAGnB,SAAO,iBAAiB,UAAU,aAAa;AAC/C,SAAO,iBAAiB,WAAW,cAAc;AAEjD,uBAAqB;AACnB,UAAO,oBAAoB,UAAU,aAAa;AAClD,UAAO,oBAAoB,WAAW,cAAc;IACpD;;AAGJ,QAAO;EACL,UAAU,SAAS,SAAS;EAC5B,WAAW,eAAe,CAAC,SAAS,MAAM;EAC3C"}