Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"yaml.schemas": {
"https://json.schemastore.org/github-action.json": "file:///Users/timbendt/Sites/frets/.github/workflows/deploy.yml"
}
}
1,773 changes: 1,773 additions & 0 deletions build/browser/frets.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions build/browser/frets.js.map

Large diffs are not rendered by default.

87 changes: 7 additions & 80 deletions build/main/Frets.d.ts
Original file line number Diff line number Diff line change
@@ -1,83 +1,10 @@
import { Projector, VNode } from 'maquette';
import { Path } from 'path-parser';
import { FunFrets, Mountable, SetupOptions } from './Frets.types';
import { PropsWithFields } from './props-field-registry';
export interface IValidationObject {
notEmpty?: {
value: boolean;
message: string;
};
minLength?: {
value: number;
message: string;
};
maxLength?: {
value: number;
message: string;
};
}
export interface IRegisteredField<T> {
handler: (evt: Event, skipValidation?: boolean) => void | boolean;
validate: () => void;
validationErrors: string[];
isValid: () => boolean;
isDirty: () => boolean;
value: T;
clear: () => void;
key: string;
}
export interface IRouteRegistry<T> {
[key: string]: {
calculator: (routeName: string, routeParams: any, props: Readonly<T>) => T;
spec: Path;
};
}
declare type ActionFn<T> = (e: Event, data: Readonly<T>) => Partial<T>;
declare type RouteActionFn<T extends PropsWithFields> = (context: {
key: string;
path: string;
data: any;
}, present: IPresent<T>) => void;
export interface IActionsObj<V> {
[k: string]: ActionFn<V>;
}
/**
* FRETS class is the main way to instantiate a new application and hang your models, actions, and state off it
* @template T, U
* Creates a Frets application, it takes initial modelProps for your data model, and a function to be called when first run
* @param {T} modelProps
* @param {(fretsApp:FunFrets<T>)=>void} setupFn
* @param {SetupOptions} options?
* @returns Mountable
*/
export declare type IPresent<T extends PropsWithFields> = (proposal: Partial<T>) => void;
export declare type IActionEventHandler = (event: Event) => void;
export declare type IActionFn<T extends PropsWithFields> = (event: Event, present: IPresent<T>) => void;
export declare type IModelPresenter<T extends PropsWithFields> = (proposal: Partial<T>, state: (props: Partial<T>) => void) => void;
export declare type IRegisterFieldFn = <U>(key: string, defaultValue?: U, validation?: IValidationObject) => IRegisteredField<U>;
export interface IFunFrets<T extends PropsWithFields> {
modelProps: T;
present: (proposal: Partial<T>) => void;
projector: Projector;
registerView: (renderFn: (app: IFunFrets<T>) => VNode) => void;
registerField: IRegisterFieldFn;
registerAction: (key: string, actionFn: IActionFn<T>) => IActionEventHandler;
registerRouteAction: (key: string, path: string, actionFn: RouteActionFn<T>) => void;
registerAcceptor: (presenterFn: IModelPresenter<T>) => void;
registerStateGraph: (entryState: IStateNode<T>) => void;
currentStateNode: IStateNode<T>;
getRouteLink: (key: string, data?: any) => string | false;
navToRoute: (key: string, data?: any) => void;
navToPath: (key: string, data?: any) => void;
}
export interface IMountable<T extends PropsWithFields> {
fretsApp: IFunFrets<T>;
mountTo: (id: string) => void;
stateRenderer: () => VNode;
present: (proposal: Partial<T>) => void;
}
export interface ISetupOptions {
projector: Projector;
}
export interface IStateNode<T extends PropsWithFields> {
name: string;
guard?: (modelProps: T) => boolean;
edges?: Array<IStateNode<T>>;
renderer: (app: IFunFrets<T>) => VNode;
}
export declare function setup<T extends PropsWithFields>(modelProps: T, setupFn: (fretsApp: IFunFrets<T>) => void, opts?: ISetupOptions): IMountable<T>;
export {};
export declare function setup<T extends PropsWithFields>(modelProps: T, setupFn: (fretsApp: FunFrets<T>) => void, options?: SetupOptions): Mountable<T>;
122 changes: 51 additions & 71 deletions build/main/Frets.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions build/main/Frets.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading