@azure-net/kit 2.2.2 → 2.2.6

package/dist/core/delivery/schema/rules/Rules.d.ts

@@ -19,6 +19,12 @@ type ArrayItemRules<Context> = ValidationRuleResult<Context>[] | Record<string,
 type ArrayParams<Context> = LengthParams & {
     schema?: ArrayItemRules<Context>;
 };
+/**
+ *
+ * @param validationMessages - BaseValidationMessages
+ * @returns ValidationRuleResult<T, D>
+ * @description Creates the rules for the schema.
+ */
 export declare const createRules: <M extends BaseValidationMessages>(validationMessages: M) => {
     string: <T = unknown, D = unknown>(params?: ValidationRuleParams<"string", LengthParams>) => ValidationRuleResult<T, D>;
     number: <T = unknown, D_1 = unknown>(params?: ValidationRuleParams<"number", RangeParams>) => ValidationRuleResult<T, D_1>;

package/dist/core/delivery/schema/rules/Rules.js

@@ -1,8 +1,20 @@
 import { masks } from '../../../constants/masks.js';
+/**
+ *
+ * @param validationMessages - BaseValidationMessages
+ * @returns ValidationRuleResult<T, D>
+ * @description Creates the rules for the schema.
+ */
 export const createRules = (validationMessages) => {
     const checkVal = (val) => {
         return val !== undefined && val !== null;
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'string', LengthParams>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is a string and if it is within the length specified in the params.
+     */
     const string = (params) => {
         const { message, length } = { ...params, message: { ...validationMessages.string, ...params?.message } };
         return ({ val }) => {
@@ -22,6 +34,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'number', RangeParams>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is a whole number (integer) and if it is within the range specified in the params.
+     */
     const number = (params) => {
         const { message, range } = { ...params, message: { ...validationMessages.number, ...params?.message } };
         return ({ val }) => {
@@ -42,6 +60,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'finite', RangeParams & { maxDigitsAfterDot?: number }>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is a finite number and if it is within the range specified in the params.
+     */
     const finite = (params) => {
         const { message, maxDigitsAfterDot, range } = { ...params, message: { ...validationMessages.finite, ...params?.message } };
         return ({ val }) => {
@@ -65,6 +89,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'boolean', { expected?: boolean }>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is a boolean and if it is the expected value specified in the params.
+     */
     const boolean = (params) => {
         const { message, expected } = { ...params, message: { ...validationMessages.boolean, ...params?.message } };
         return ({ val }) => {
@@ -78,6 +108,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'array', ArrayParams<T>>
+     * @returns ValidationRuleResult<T>
+     * @description Checks if the value is an array and if it is within the length specified in the params. Can check every array item with the rules specified in the schema.
+     */
     const array = (params) => {
         const { message, length = {}, schema } = { ...params, message: { ...validationMessages.array, ...params?.message } };
         return ({ val, listValues, key }) => {
@@ -138,10 +174,15 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'phone'>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is a phone number and if it is valid.
+     */
+    const countryCodes = new Set(Object.values(masks).map((country) => country.cc)).add('8');
     const phone = (params) => {
         const { message } = { ...params, message: params?.message ?? validationMessages.phone };
-        const countryCodes = new Set(Object.values(masks).map((country) => country.cc));
-        countryCodes.add('8');
         return ({ val }) => {
             if (checkVal(val)) {
                 // eslint-disable-next-line
@@ -198,6 +239,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'email'>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is a valid email address.
+     */
     const email = (params) => {
         const { message } = { message: params?.message ?? validationMessages.email };
         const emailRegExp = 
@@ -211,6 +258,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'lettersOnly', { whiteSpaces?: boolean }>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is a string and if it contains only letters.
+     */
     const lettersOnly = (params) => {
         const { message, whiteSpaces = false } = { ...params, message: params?.message ?? validationMessages.lettersOnly };
         const lettersRegex = whiteSpaces ? /^[а-яА-Яa-zA-Z\s]+$/ : /^[а-яА-Яa-zA-Z]+$/;
@@ -222,6 +275,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'allowedOnly', { allowed?: unknown[] }>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is in the allowed values specified in the params.
+     */
     const allowedOnly = (params) => {
         const { message, allowed } = { ...params, message: params?.message ?? validationMessages.allowedOnly };
         return ({ val }) => {
@@ -239,6 +298,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'sameAs', { key: keyof T | string }>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is the same as the value of the field specified in the params.
+     */
     const sameAs = (params) => {
         const { message, key } = { ...params, message: params?.message ?? validationMessages.sameAs };
         return ({ val, listValues }) => {
@@ -252,7 +317,7 @@ export const createRules = (validationMessages) => {
                             return JSON.stringify(val) === JSON.stringify(listValues[key]) ? undefined : message(String(key));
                         }
                         catch {
-                            return undefined;
+                            return 'Parsing error';
                         }
                     default:
                         return String(val ?? '') === String(listValues?.[key] ?? '') ? undefined : message(String(key));
@@ -261,6 +326,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'notSameAs', { key: keyof T | string }>
+     * @returns ValidationRuleResult<T, D>
+     * @description Checks if the value is not the same as the value of the field specified in the params.
+     */
     const notSameAs = (params) => {
         const { message, key } = { ...params, message: params?.message ?? validationMessages.notSameAs };
         return ({ val, listValues }) => {
@@ -274,7 +345,7 @@ export const createRules = (validationMessages) => {
                             return JSON.stringify(val) !== JSON.stringify(listValues[key]) ? undefined : message(String(key));
                         }
                         catch {
-                            return undefined;
+                            return 'Parsing error';
                         }
                     default:
                         return String(val) === String(listValues?.[key]) ? undefined : message(String(key));
@@ -283,6 +354,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'required', { byCondition?: (params: ValidationParams<T, D, J>) => boolean }>
+     * @returns ValidationRuleResult<T, D, J>
+     * @description Marks the field as required. If the byCondition is specified, the field will be required only if the byCondition returns true.
+     */
     const required = (params) => {
         const { message, byCondition } = { ...params, message: params?.message ?? validationMessages.required };
         return ({ val, listValues, key }) => {
@@ -299,6 +376,12 @@ export const createRules = (validationMessages) => {
             return undefined;
         };
     };
+    /**
+     *
+     * @param params - ValidationRuleParams<'password', { length?: number; specialChars?: boolean | number; numbers?: boolean | number; lowerUpperCasePattern?: boolean }>
+     * @returns ValidationRuleResult<T, D>
+     * @description Sets the password rules. Can check the length, the number of special characters, the number of numbers and the presence of uppercase and lowercase letters.
+     */
     const password = (params) => {
         const { message, length = 8, specialChars, numbers, lowerUpperCasePattern } = { ...params, message: { ...validationMessages.password, ...params?.message } };
         return ({ val }) => {

package/dist/core/svelte/ActiveForm/ActiveForm.svelte.d.ts

@@ -1,9 +1,12 @@
 import type { RequestErrors } from '../../delivery/schema/index.js';
 import type { AsyncActionResponse } from '../../index.js';
+type InitialData<FormData> = Partial<FormData> | Promise<Partial<FormData>> | (() => Partial<FormData> | Promise<Partial<FormData>>);
 export interface FormConfig<FormData, Response> {
-    initialData?: Partial<FormData>;
+    initialData?: InitialData<FormData>;
     onSuccess?: (response: Response) => Promise<void> | void;
     onError?: () => Promise<void> | void;
+    beforeSubmit?: (form: ActiveFormController<FormData>, abort: () => void) => Promise<void> | void;
+    waitForInitialData?: boolean;
 }
 export interface ActiveForm<FormData, Response, Custom> {
     data: Partial<FormData>;
@@ -12,6 +15,12 @@ export interface ActiveForm<FormData, Response, Custom> {
     reset: (toInitial?: boolean) => void;
     pending: boolean;
     dirty: boolean;
+    ready: Promise<Partial<FormData>>;
+}
+export interface ActiveFormController<FormData> {
+    data: Partial<FormData>;
+    errors: RequestErrors<FormData>;
+    reset: (toInitial?: boolean) => void;
 }
 type ExtractResponse<T> = T extends AsyncActionResponse<infer R, unknown, unknown> ? R : never;
 type ExtractFormData<T> = T extends AsyncActionResponse<unknown, infer D, unknown> ? D : never;

package/dist/core/svelte/ActiveForm/ActiveForm.svelte.js

@@ -1,12 +1,50 @@
 import { ObjectUtil } from 'azure-net-tools';
 export const createActiveForm = (onSubmit, config) => {
-    const initial = config?.initialData ?? {};
+    const isPromise = (value) => {
+        return typeof value?.then === 'function';
+    };
+    const resolveInitialSource = () => {
+        const source = config?.initialData;
+        if (!source) {
+            return { sync: true, value: {} };
+        }
+        const result = typeof source === 'function' ? source() : source;
+        if (isPromise(result)) {
+            return { sync: false, promise: result };
+        }
+        return { sync: true, value: (result ?? {}) };
+    };
+    const initialSource = resolveInitialSource();
+    let initial = initialSource.sync ? initialSource.value : {};
     let formData = $state(ObjectUtil.deepClone(initial));
     let formErrors = $state({});
     let pending = $state(false);
     const dirty = $derived(JSON.stringify(formData) !== JSON.stringify(initial));
+    const ready = (async () => {
+        if (!initialSource.sync) {
+            initial = (await initialSource.promise) ?? {};
+            if (config?.waitForInitialData !== false) {
+                formData = ObjectUtil.deepClone(initial);
+            }
+        }
+        return initial;
+    })();
     const submit = async () => {
         pending = true;
+        if (config?.beforeSubmit) {
+            let aborted = false;
+            const abort = () => {
+                aborted = true;
+                pending = false;
+            };
+            await config.beforeSubmit(formApi, () => abort());
+            if (aborted) {
+                return {
+                    success: false,
+                    response: undefined
+                };
+            }
+        }
         try {
             const result = await onSubmit($state.snapshot(formData));
             if (result.error?.fields) {
@@ -28,7 +66,7 @@ export const createActiveForm = (onSubmit, config) => {
         formData = toInitial ? ObjectUtil.deepClone(initial) : {};
         formErrors = {};
     };
-    return {
+    const formApi = {
         get data() {
             return formData;
         },
@@ -38,12 +76,20 @@ export const createActiveForm = (onSubmit, config) => {
         get errors() {
             return formErrors;
         },
+        set errors(value) {
+            formErrors = value;
+        },
+        reset
+    };
+    return {
+        ...formApi,
         get dirty() {
             return dirty;
         },
         get pending() {
             return pending;
         },
+        ready,
         submit,
         reset
     };

package/dist/core/svelte/AsyncSignal/AsyncSignal.svelte.d.ts

@@ -15,6 +15,7 @@ export interface AsyncSignalSvelte<TData, TError = Error> {
     pending: boolean;
     execute: () => Promise<void>;
     refresh: () => Promise<void>;
+    ready: Promise<TData | undefined>;
     reset: () => void;
     abort: () => void;
 }

package/dist/core/svelte/AsyncSignal/AsyncSignal.svelte.js

@@ -52,7 +52,14 @@ export const createAsyncSignal = (handler, options = {}) => {
     let status = $state('idle');
     const pending = $derived(status === 'pending');
     let abortController = null;
-    async function execute() {
+    let currentPromise = null;
+    const ensurePromise = () => {
+        if (currentPromise)
+            return currentPromise;
+        currentPromise = run();
+        return currentPromise;
+    };
+    const run = async () => {
         if (abortController) {
             abortController.abort();
         }
@@ -62,25 +69,34 @@ export const createAsyncSignal = (handler, options = {}) => {
         try {
             const result = await handler(abortController.signal);
             if (abortController.signal.aborted) {
-                return;
+                return undefined;
             }
             data = result;
             status = 'success';
             if (options.onSuccess) {
                 options.onSuccess(result);
             }
+            return result;
         }
         catch (err) {
             if (err instanceof Error && err.name === 'AbortError') {
-                return;
+                return undefined;
             }
             error = err;
             status = 'error';
             if (options.onError) {
                 options.onError(err);
             }
+            return undefined;
         }
-    }
+    };
+    const execute = async () => {
+        if (status === 'pending' && currentPromise) {
+            await currentPromise;
+            return;
+        }
+        await ensurePromise();
+    };
     if (EnvironmentUtil.isBrowser) {
         const signalKey = key ?? asyncSignalManager.generateKey();
         asyncSignalManager.register(signalKey, () => execute());
@@ -127,12 +143,16 @@ export const createAsyncSignal = (handler, options = {}) => {
         get pending() {
             return pending;
         },
+        get ready() {
+            return ensurePromise();
+        },
         execute,
         refresh: execute,
         reset: () => {
             data = undefined;
             error = undefined;
             status = 'idle';
+            currentPromise = null;
             if (abortController) {
                 abortController.abort();
                 abortController = null;

package/dist/core/svelte/Query/Query.svelte.d.ts

@@ -0,0 +1,20 @@
+export type QuerySignal = {
+    refresh: () => Promise<void>;
+};
+export interface CreateQueryOptions<T extends Record<string, unknown>> {
+    initial: T;
+    signal?: QuerySignal;
+    excludeKeys?: (keyof T)[];
+    debounceMs?: number;
+    autoRefresh?: boolean;
+}
+export interface QueryController<T extends Record<string, unknown>> {
+    data: T;
+    patch: (values: Partial<T>) => void;
+    set: <K extends keyof T>(key: K, value: T[K]) => void;
+    reset: () => void;
+    snapshot: () => T;
+    initial: () => T;
+    attachSignal: (signal?: QuerySignal) => void;
+}
+export declare const createQuery: <T extends Record<string, unknown>>(options: CreateQueryOptions<T>) => QueryController<T>;

package/dist/core/svelte/Query/Query.svelte.js

@@ -0,0 +1,71 @@
+import { ObjectUtil } from 'azure-net-tools';
+export const createQuery = (options) => {
+    const { initial: initialValue, signal: initialSignal, excludeKeys, debounceMs = 0, autoRefresh = true } = options;
+    const baseInitial = ObjectUtil.deepClone(initialValue);
+    let signal = initialSignal;
+    let data = $state(ObjectUtil.deepClone(baseInitial));
+    const resolveKeys = () => {
+        const keys = Object.keys(baseInitial).slice();
+        if (excludeKeys?.length) {
+            return keys.filter((key) => !excludeKeys.includes(key));
+        }
+        return keys;
+    };
+    const keys = resolveKeys();
+    let isFirstRun = true;
+    let debounceTimer = null;
+    const scheduleRefresh = () => {
+        if (!signal)
+            return;
+        if (debounceTimer)
+            clearTimeout(debounceTimer);
+        if (debounceMs > 0) {
+            debounceTimer = setTimeout(() => {
+                void signal?.refresh();
+            }, debounceMs);
+        }
+        else {
+            void signal.refresh();
+        }
+    };
+    if (autoRefresh) {
+        $effect(() => {
+            keys.forEach((key) => {
+                void data[key];
+            });
+            if (isFirstRun) {
+                isFirstRun = false;
+                return;
+            }
+            scheduleRefresh();
+        });
+    }
+    const patch = (values) => {
+        data = { ...data, ...values };
+    };
+    const set = (key, value) => {
+        data = { ...data, [key]: value };
+    };
+    const reset = () => {
+        data = ObjectUtil.deepClone(baseInitial);
+    };
+    const snapshot = () => ObjectUtil.deepClone(data);
+    const initial = () => ObjectUtil.deepClone(baseInitial);
+    const attachSignal = (nextSignal) => {
+        signal = nextSignal;
+    };
+    return {
+        get data() {
+            return data;
+        },
+        set data(value) {
+            data = value;
+        },
+        patch,
+        set,
+        reset,
+        snapshot,
+        initial,
+        attachSignal
+    };
+};

package/dist/core/svelte/Query/index.d.ts

@@ -0,0 +1 @@
+export * from './Query.svelte.js';

package/dist/core/svelte/Query/index.js

@@ -0,0 +1 @@
+export * from './Query.svelte.js';

package/dist/core/svelte/index.d.ts

@@ -1,2 +1,3 @@
 export * from './AsyncSignal/index.js';
 export * from './ActiveForm/index.js';
+export * from './Query/index.js';

package/dist/core/svelte/index.js

@@ -1,2 +1,3 @@
 export * from './AsyncSignal/index.js';
 export * from './ActiveForm/index.js';
+export * from './Query/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-net/kit",
-  "version": "2.2.2",
+  "version": "2.2.6",
   "files": [
     "dist",
     "!dist/**/*.test.*",