foorm 0.0.2-alpha.1 → 0.0.2-alpha.2

package/dist/index.cjs

@@ -99,13 +99,16 @@ class Foorm {
                 };
                 if (ctx.entry) {
                     if (typeof evalEntry.disabled === 'function') {
-                        ctx.entry.disabled = evalEntry.disabled = evalEntry.disabled(ctx);
+                        ctx.entry.disabled = evalEntry.disabled =
+                            evalEntry.disabled(ctx);
                     }
                     if (typeof evalEntry.optional === 'function') {
-                        ctx.entry.optional = evalEntry.optional = evalEntry.optional(ctx);
+                        ctx.entry.optional = evalEntry.optional =
+                            evalEntry.optional(ctx);
                     }
                     if (typeof evalEntry.hidden === 'function') {
-                        ctx.entry.hidden = evalEntry.hidden = evalEntry.hidden(ctx);
+                        ctx.entry.hidden = evalEntry.hidden =
+                            evalEntry.hidden(ctx);
                     }
                 }
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/index.d.ts

@@ -1,3 +1,94 @@
-export * from './foorm';
-export * from './utils';
-export * from './types';
+type TFtring = {
+    __is_ftring__: true;
+    v: string;
+    __type__?: 'boolean' | 'string' | 'number';
+};
+type StringOrFtring = string | TFtring;
+type ObjSOF = Record<string, StringOrFtring>;
+type TFoormFnCtx<T = string> = {
+    v?: T;
+    data: Record<string, unknown>;
+    entry?: Pick<TFoormEntry<T, unknown, string, boolean>, TRelevantFields> & {
+        optional?: boolean;
+        disabled?: boolean;
+        hidden?: boolean;
+    };
+    action?: string;
+};
+type TFoormValidatorFn<T = string> = (ctx: TFoormFnCtx<T>) => string | boolean;
+type TFoormFn<T = string, R = string | boolean> = (ctx: TFoormFnCtx<T>) => R;
+type TRelevantFields = 'field' | 'type' | 'component' | 'name' | 'attrs' | 'length';
+interface TFoormEntry<T = string, O = string, SFTR = TFtring, BFTR = TFtring, FNFTR = TFtring> {
+    field: string;
+    label?: string | SFTR;
+    description?: string | SFTR;
+    hint?: string | SFTR;
+    placeholder?: string | SFTR;
+    classes?: (string | SFTR) | Record<string, boolean | BFTR>;
+    styles?: (string | SFTR) | Record<string, string | SFTR>;
+    type?: string;
+    component?: string;
+    name?: string;
+    value?: T;
+    options?: O[];
+    attrs?: Record<string, unknown>;
+    optional?: boolean | BFTR;
+    disabled?: boolean | BFTR;
+    hidden?: boolean | BFTR;
+    length?: number;
+    validators?: (FNFTR | TFoormValidatorFn<T>)[];
+}
+type RequireProps$1<T, K extends keyof T> = T & Required<Pick<T, K>>;
+type TFoormEntryExecutable<T = unknown, O = string> = RequireProps$1<TFoormEntry<T, O, TFoormFn<T, string>, TFoormFn<T, boolean>, TFoormValidatorFn<T>>, 'name' | 'label' | 'type'>;
+
+interface TFoormSubmit<S = TFtring, B = TFtring> {
+    text: string | S;
+    disabled?: boolean | B;
+}
+interface TFoormOptions {
+    title?: StringOrFtring;
+    entries: TFoormEntry[];
+    submit?: TFoormSubmit;
+}
+declare class Foorm {
+    protected entries: TFoormEntry[];
+    protected submit?: TFoormSubmit;
+    protected title?: StringOrFtring;
+    private fns;
+    constructor(opts?: TFoormOptions);
+    addEntry(entry: TFoormEntry): void;
+    setTitle(title: string): void;
+    setSubmit(submit: TFoormSubmit): void;
+    transportable(): Required<TFoormOptions>;
+    protected normalizeEntry<T, O>(e: TFoormEntry<T, O>): RequireProps<TFoormEntry<T, O>, 'label' | 'name' | 'type'>;
+    executable(): {
+        title: string | TFoormFn<undefined, string>;
+        submit: {
+            text: string | TFoormFn<undefined, string>;
+            disabled: boolean | TFoormFn<undefined, boolean>;
+        };
+        entries: TFoormEntryExecutable[];
+    };
+    prepareValidators(_validators: TFoormEntry['validators']): TFoormValidatorFn<string>[];
+    getFormValidator(): (inputs: Record<string, unknown>) => {
+        passed: boolean;
+        errors: Record<string, string>;
+    };
+}
+type TFoormExecutableMeta = ReturnType<Foorm['executable']>;
+type TFoormExecutableEntry = TFoormExecutableMeta['entries'][number];
+declare function validate<T = string>(opts: TFoormFnCtx<T> & {
+    validators: TFoormValidatorFn<T>[];
+}): {
+    passed: boolean;
+    error: string;
+} | {
+    passed: boolean;
+    error?: undefined;
+};
+type RequireProps<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+declare function isFtring(input: unknown): input is TFtring;
+declare function ftring(strings: TemplateStringsArray, __type__?: TFtring['__type__']): TFtring;
+
+export { Foorm, type ObjSOF, type StringOrFtring, type TFoormEntry, type TFoormEntryExecutable, type TFoormExecutableEntry, type TFoormExecutableMeta, type TFoormFn, type TFoormFnCtx, type TFoormOptions, type TFoormSubmit, type TFoormValidatorFn, type TFtring, ftring, isFtring, validate };

package/dist/index.mjs

@@ -97,13 +97,16 @@ class Foorm {
                 };
                 if (ctx.entry) {
                     if (typeof evalEntry.disabled === 'function') {
-                        ctx.entry.disabled = evalEntry.disabled = evalEntry.disabled(ctx);
+                        ctx.entry.disabled = evalEntry.disabled =
+                            evalEntry.disabled(ctx);
                     }
                     if (typeof evalEntry.optional === 'function') {
-                        ctx.entry.optional = evalEntry.optional = evalEntry.optional(ctx);
+                        ctx.entry.optional = evalEntry.optional =
+                            evalEntry.optional(ctx);
                     }
                     if (typeof evalEntry.hidden === 'function') {
-                        ctx.entry.hidden = evalEntry.hidden = evalEntry.hidden(ctx);
+                        ctx.entry.hidden = evalEntry.hidden =
+                            evalEntry.hidden(ctx);
                     }
                 }
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foorm",
-  "version": "0.0.2-alpha.1",
+  "version": "0.0.2-alpha.2",
   "description": "foorm",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",

package/dist/foorm.d.ts

@@ -1,46 +0,0 @@
-import { StringOrFtring, TFoormEntry, TFoormValidatorFn, TFoormFnCtx, TFoormFn, TFtring, TFoormEntryExecutable } from './types';
-export interface TFoormSubmit<S = TFtring, B = TFtring> {
-    text: string | S;
-    disabled?: boolean | B;
-}
-export interface TFoormOptions {
-    title?: StringOrFtring;
-    entries: TFoormEntry[];
-    submit?: TFoormSubmit;
-}
-export declare class Foorm {
-    protected entries: TFoormEntry[];
-    protected submit?: TFoormSubmit;
-    protected title?: StringOrFtring;
-    private fns;
-    constructor(opts?: TFoormOptions);
-    addEntry(entry: TFoormEntry): void;
-    setTitle(title: string): void;
-    setSubmit(submit: TFoormSubmit): void;
-    transportable(): Required<TFoormOptions>;
-    protected normalizeEntry<T, O>(e: TFoormEntry<T, O>): TFoormEntry<T, O>;
-    executable(): {
-        title: string | TFoormFn<undefined, string>;
-        submit: {
-            text: string | TFoormFn<undefined, string>;
-            disabled: boolean | TFoormFn<undefined, boolean>;
-        };
-        entries: TFoormEntryExecutable[];
-    };
-    prepareValidators(_validators: TFoormEntry['validators']): TFoormValidatorFn<string>[];
-    getFormValidator(): (inputs: Record<string, unknown>) => {
-        passed: boolean;
-        errors: Record<string, string>;
-    };
-}
-export type TFoormExecutableMeta = ReturnType<Foorm['executable']>;
-export type TFoormExecutableEntry = TFoormExecutableMeta['entries'][number];
-export declare function validate<T = string>(opts: TFoormFnCtx<T> & {
-    validators: TFoormValidatorFn<T>[];
-}): {
-    passed: boolean;
-    error: string;
-} | {
-    passed: boolean;
-    error?: undefined;
-};

package/dist/foorm.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types.d.ts

@@ -1,42 +0,0 @@
-export type TFtring = {
-    __is_ftring__: true;
-    v: string;
-    __type__?: 'boolean' | 'string' | 'number';
-};
-export type StringOrFtring = string | TFtring;
-export type ObjSOF = Record<string, StringOrFtring>;
-export type TFoormFnCtx<T = string> = {
-    v?: T;
-    data: Record<string, unknown>;
-    entry?: Pick<TFoormEntry<T, unknown, string, boolean>, TRelevantFields> & {
-        optional?: boolean;
-        disabled?: boolean;
-        hidden?: boolean;
-    };
-    action?: string;
-};
-export type TFoormValidatorFn<T = string> = (ctx: TFoormFnCtx<T>) => string | boolean;
-export type TFoormFn<T = string, R = string | boolean> = (ctx: TFoormFnCtx<T>) => R;
-type TRelevantFields = 'field' | 'type' | 'component' | 'name' | 'attrs' | 'length';
-export interface TFoormEntry<T = string, O = string, SFTR = TFtring, BFTR = TFtring, FNFTR = TFtring> {
-    field: string;
-    label?: string | SFTR;
-    description?: string | SFTR;
-    hint?: string | SFTR;
-    placeholder?: string | SFTR;
-    classes?: (string | SFTR) | Record<string, boolean | BFTR>;
-    styles?: (string | SFTR) | Record<string, string | SFTR>;
-    type?: string;
-    component?: string;
-    name?: string;
-    value?: T;
-    options?: O[];
-    attrs?: Record<string, unknown>;
-    optional?: boolean | BFTR;
-    disabled?: boolean | BFTR;
-    hidden?: boolean | BFTR;
-    length?: number;
-    validators?: (FNFTR | TFoormValidatorFn<T>)[];
-}
-export type TFoormEntryExecutable<T = unknown, O = string> = TFoormEntry<T, O, TFoormFn<T, string>, TFoormFn<T, boolean>, TFoormValidatorFn<T>>;
-export {};

package/dist/utils.d.ts

@@ -1,3 +0,0 @@
-import { TFtring } from './types';
-export declare function isFtring(input: unknown): input is TFtring;
-export declare function ftring(strings: TemplateStringsArray, __type__?: TFtring['__type__']): TFtring;

package/dist/utils.spec.d.ts

@@ -1 +0,0 @@
-export {};