@windmill-labs/shared-utils 1.0.5 → 1.0.12

package/package.json

@@ -1,12 +1,12 @@
 {
-  "name": "@windmill-labs/shared-utils",
-  "version": "1.0.5",
-  "type": "module",
-  "private": false,
-  "main": "./lib.es.js",
-  "module": "./lib.es.js",
-  "exports": {
-    ".": "./lib.es.js"
-  },
-  "types": "./lib.d.ts"
-}
+	"name": "@windmill-labs/shared-utils",
+	"version": "1.0.12",
+	"type": "module",
+	"private": false,
+	"main": "./lib.es.js",
+	"module": "./lib.es.js",
+	"exports": {
+		".": "./lib.es.js"
+	},
+	"types": "./lib.d.ts"
+}

package/stores.d.ts

@@ -27,6 +27,7 @@ export interface UserWorkspace {
 export declare function getWorkspaceFromStorage(): string | undefined;
 export declare function clearWorkspaceFromStorage(): void;
 export declare const tutorialsToDo: import("svelte/store").Writable<number[]>;
+export declare const skippedAll: import("svelte/store").Writable<boolean>;
 export declare const globalEmailInvite: import("svelte/store").Writable<string>;
 export declare const awarenessStore: import("svelte/store").Writable<Record<string, string>>;
 export declare const enterpriseLicense: import("svelte/store").Writable<string | undefined>;

package/svelte5Utils.svelte.d.ts

@@ -1,4 +1,6 @@
-import type { StateStore } from './utils';
+import { type StateStore } from './utils';
+import * as runed from 'runed/kit';
+import type z from 'zod';
 export declare function withProps<Component, Props>(component: Component, props: Props): {
     component: Component;
     props: Props;
@@ -30,6 +32,9 @@ export type UsePromiseOptions = {
     loadInit?: boolean;
     clearValueOnRefresh?: boolean;
 };
+/**
+ * @deprecated Use `resource` from `runed` instead
+ */
 export declare function usePromise<T>(createPromise: () => Promise<T>, { loadInit, clearValueOnRefresh }?: UsePromiseOptions): UsePromiseResult<T>;
 /**
  * Generic change tracker class that monitors changes in state using deep equality comparison
@@ -47,3 +52,29 @@ export declare class ChangeTracker<T> {
      */
     track(value: T): boolean;
 }
+/**
+ * This allows using async resources that only fetch missing data based on a set of keys.
+ * It maintains a Record of the fetched data and only calls the fetcher for keys that
+ * are not already present in the map.
+ * The fetcher takes a record of keys to allow fetching multiple items in a single call.
+ */
+export declare class MapResource<U, T> {
+    private _cached;
+    private _fetcherResource;
+    constructor(getValues: () => Record<string, U>, fetcher: (toFetch: Record<string, U>) => Promise<Record<string, T>>);
+    get current(): Record<string, T> | undefined;
+    get loading(): boolean;
+    get error(): Error | undefined;
+}
+export declare class ChangeOnDeepInequality<T> {
+    private _cached;
+    constructor(compute: () => T);
+    get value(): T;
+}
+export declare function useSearchParams<S extends z.ZodType>(schema: S, options?: runed.SearchParamsOptions): runed.ReturnUseSearchParams<S>;
+export declare class StaleWhileLoading<T> {
+    private _current;
+    private _currentTimeout;
+    constructor(getter: () => T, timeout?: number);
+    get current(): T | undefined;
+}

package/utils.d.ts

@@ -38,7 +38,7 @@ export declare function validateUsername(username: string): string;
 export declare function parseQueryParams(url: string | undefined): Record<string, string>;
 export declare function displayDateOnly(dateString: string | Date | undefined): string;
 export declare function retrieveCommonWorkerPrefix(workerName: string): string;
-export declare function subtractDaysFromDateString(dateString: string | undefined, days: number): string | undefined;
+export declare function subtractDaysFromDateString(dateString: string | null, days: number): string | undefined;
 export declare function displayDate(dateString: string | Date | undefined, displaySecond?: boolean, displayDate?: boolean): string;
 export declare function displayTime(dateString: string | Date | undefined): string;
 export declare function displaySize(sizeInBytes: number | undefined): string | undefined;
@@ -63,6 +63,7 @@ export declare function clickOutside(node: Node, options?: ClickOutsideOptions |
     destroy(): void;
     update(newOptions: ClickOutsideOptions | boolean): void;
 };
+export declare function undefinedIfEmpty(obj: any): any;
 export declare function pointerDownOutside(node: Node, options?: ClickOutsideOptions): {
     destroy(): void;
     update(newOptions: ClickOutsideOptions): void;
@@ -136,6 +137,12 @@ export declare function throttle<T>(func: (...args: any[]) => T, wait: number):
 export declare function isMac(): boolean;
 export declare function getModifierKey(): string;
 export declare function isValidHexColor(color: string): boolean;
+/**
+ * Generates a text color with the same hue as the background but adjusted lightness for good contrast
+ * @param backgroundColor Hex color string (e.g., "#FF0000" or "#F00")
+ * @returns Hex color string with same hue but good contrast, or undefined if invalid
+ */
+export declare function getContrastTextColor(backgroundColor: string | null | undefined): string | undefined;
 export declare function sortObject<T>(o: T & object): T;
 export declare function sortArray<T>(array: T[], compareFn?: (a: T, b: T) => number): T[];
 export declare function generateRandomString(len?: number): string;
@@ -180,7 +187,7 @@ export declare function getSchemaFromProperties(properties: {
 }): Schema;
 export declare function validateFileExtension(ext: string): boolean;
 export declare function isFlowPreview(job_kind: Job['job_kind'] | undefined): job_kind is "flowpreview" | "flownode";
-export declare function isNotFlow(job_kind: Job['job_kind'] | undefined): job_kind is "script" | "aiagent" | "identity" | "preview" | "dependencies" | "flowdependencies" | "appdependencies" | "script_hub" | "deploymentcallback" | "flowscript" | "appscript" | undefined;
+export declare function isNotFlow(job_kind: Job['job_kind'] | undefined): job_kind is "script" | "aiagent" | "identity" | "preview" | "dependencies" | "flowdependencies" | "appdependencies" | "script_hub" | "deploymentcallback" | "flowscript" | "appscript" | "unassigned_script" | "unassigned_flow" | "unassigned_singlestepflow" | undefined;
 export declare function isScriptPreview(job_kind: Job['job_kind'] | undefined): job_kind is "preview" | "flowscript" | "appscript";
 export declare function conditionalMelt(node: HTMLElement, meltItem: AnyMeltElement | undefined): void | import("svelte/action").ActionReturn<undefined, Record<never, any>>;
 export type Item = {
@@ -195,6 +202,7 @@ export type Item = {
     hide?: boolean | undefined;
     extra?: Snippet;
     id?: string;
+    tooltip?: string;
 };
 export declare function isObjectTooBig(obj: any): boolean;
 export declare function localeConcatAnd(items: string[]): string;
@@ -202,11 +210,9 @@ export declare function formatDate(dateString: string | undefined): string;
 export declare function formatDateShort(dateString: string | undefined): string;
 export declare function toJsonStr(result: any): string;
 export declare function getOS(): "Windows" | "macOS" | "iOS" | "Android" | "Linux" | "Unknown OS";
-import { type ClassValue } from 'clsx';
 import type { Component, Snippet } from 'svelte';
 import { OpenAPIV2, type OpenAPI, type OpenAPIV3, type OpenAPIV3_1 } from 'openapi-types';
 import type { IPosition } from 'monaco-editor';
-export declare function cn(...inputs: ClassValue[]): string;
 export type StateStore<T> = {
     val: T;
 };
@@ -241,6 +247,7 @@ export declare function wait(ms: number): Promise<unknown>;
 export declare function validateRetryConfig(retry: Retry | undefined): string | null;
 export type CssColor = keyof (typeof tokensFile)['tokens']['light'];
 import tokensFile from './assets/tokens/tokens.json';
+import { Package } from 'lucide-svelte';
 export declare function getCssColor(color: CssColor, { alpha, format }: {
     alpha?: number;
     format?: 'css-var' | 'hex-dark' | 'hex-light';
@@ -248,3 +255,11 @@ export declare function getCssColor(color: CssColor, { alpha, format }: {
 export type IconType = Component<{
     size?: number;
 }> | typeof import('lucide-svelte').Dot;
+export declare function getJobKindIcon(jobKind: Job['job_kind']): import("svelte/legacy").LegacyComponentType | typeof Package | undefined;
+export declare function chunkBy<T>(array: T[], getKey: (key: T) => string): T[][];
+export declare function getQueryStmtCountHeuristic(query: string): number;
+export declare function countChars(str: string, char: string): number;
+export declare function buildReactiveObj<T extends object>(fields: {
+    [name in keyof T]: [() => T[name], (v: T[name]) => void];
+}): T;
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: readonly K[]): Pick<T, K>;