dotvvm-types 4.2.0-preview05-final → 4.2.0-preview06-final

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotvvm-types",
-  "version": "4.2.0-preview05-final",
+  "version": "4.2.0-preview06-final",
   "description": "MVVM framework for ASP.NET",
   "types": "./types/index.d.ts",
   "repository": {

package/types/index.d.ts

@@ -70,6 +70,7 @@ declare module "utils/objects" {
         (o: object): string[];
         (o: {}): string[];
     };
+    export function defineConstantProperty(obj: any, name: string, value: any): void;
 }
 declare module "metadata/typeMap" {
     export function getTypeInfo(typeId: string | object): TypeMetadata;
@@ -324,9 +325,13 @@ declare module "viewModules/viewModuleManager" {
             [name: string]: (...args: any[]) => Promise<any>;
         };
         module: any;
+        setState: (state: any) => void;
+        patchState: (state: any) => void;
+        updateState: (updateFunction: StateUpdate<any>) => void;
+        state: any;
         constructor(moduleName: string, elements: HTMLElement[], properties: {
             [name: string]: any;
-        });
+        }, viewModel: DotvvmObservable<any>);
         registerNamedCommand: (name: string, command: (...args: any[]) => Promise<any>) => void;
         unregisterNamedCommand: (name: string) => void;
     }
@@ -850,6 +855,8 @@ declare module "dotvvm-root" {
         };
         readonly state: Readonly<RootViewModel>;
         patchState(a: any): void;
+        setState(a: any): void;
+        updateState(updateFunction: StateUpdate<any>): void;
         viewModelObservables: {
             readonly root: KnockoutObservable<DeepKnockoutObservableObject<RootViewModel>>;
         };
@@ -888,7 +895,7 @@ declare module "dotvvm-root" {
     global {
         interface DotvvmGlobalExtensions {
         }
-        type DotvvmGlobal = DotvvmGlobalExtensions & typeof dotvvmExports & {
+        type DotvvmGlobal = DotvvmGlobalExtensions & typeof dotvvmExports & DotvvmStateContainer<any> & {
             debug?: true;
             isSpaReady?: typeof isSpaReady;
             handleSpaNavigation?: typeof handleSpaNavigation;
@@ -1080,26 +1087,30 @@ declare type DeepPartial<T> = T extends object ? {
 declare type DeepReadonly<T> = T extends TypeDefinition ? T : T extends (infer R)[] ? readonly DeepReadonly<R>[] : T extends object ? {
     readonly [P in keyof T]: DeepReadonly<T[P]>;
 } : T;
-/** Knockout observable that is found in the DotVVM ViewModel - all nested objects and arrays are also observable + it has some helper functions (state, patchState, ...) */
-declare type DotvvmObservable<T> = DeepKnockoutObservable<T> & {
-    /** A property, returns latest state from dotvvm.state. It does not contain any knockout observable and does not have any propagation delay, as the value in the observable */
+declare type DotvvmStateContainer<T> = {
+    /** A property, returns latest state from dotvvm.state. It does not contain any knockout observable and does not have any propagation delay, as the value in the ko.observables */
     readonly state: DeepReadonly<T>;
     /** Sets new state directly into the dotvvm.state.
-     * Note that the value arrives into the observable itself asynchronously, so there might be slight delay */
+     * Note that the value arrives into the ko.observables asynchronously, so there might be slight delay */
     readonly setState: (newState: DeepReadonly<T>) => void;
     /** Patches the current state and sets it into dotvvm.state.
      * Compared to setState, when property does not exist in the patch parameter, the old value from state is used.
-     * Note that the value arrives into the observable itself asynchronously, so there might be slight delay
+     * Note that the value arrives into the ko.observables asynchronously, so there might be slight delay
      * @example observable.patchState({ Prop2: 0 }) // Only must be specified, although Prop1 also exists and is required  */
     readonly patchState: (patch: DeepReadonly<DeepPartial<T>>) => void;
     /** Dispatches update of the state.
-     * Note that the value arrives into the observable itself asynchronously, so there might be slight delay
-     * @example observable.updater(state => [ ...state, newElement ]) // This appends an element to an (observable) array
-     * @example observable.updater(state => state + 1) // Increments the value by one
-     * @example observable.updater(state => ({ ...state, MyProperty: state.MyProperty + 1 })) // Increments the property MyProperty by one
+     * Note that the value arrives into the ko.observables asynchronously, so there might be slight delay
+     * @example observable.updateState(state => [ ...state, newElement ]) // This appends an element to an (observable) array
+     * @example observable.updateState(state => state + 1) // Increments the value by one
+     * @example observable.updateState(state => ({ ...state, MyProperty: state.MyProperty + 1 })) // Increments the property MyProperty by one
      */
-    readonly updater: UpdateDispatcher<T>;
+    readonly updateState: UpdateDispatcher<T>;
 };
+/** Knockout observable that is found in the DotVVM ViewModel - all nested objects and arrays are also observable + it has some helper functions (state, patchState, ...) */
+declare type DotvvmObservable<T> = DeepKnockoutObservable<T> & {
+    /** @deprecated Use updateState instead */
+    readonly updater: UpdateDispatcher<T>;
+} & DotvvmStateContainer<T>;
 declare type RootViewModel = {
     $type: string;
     $csrfToken?: string;
@@ -1199,7 +1210,7 @@ declare type DotvvmViewModule = {
     $dispose?: (context: any) => void;
     [commandName: DotvvmViewModuleCommandName]: (...args: any[]) => Promise<any> | any;
 };
-declare type DotvvmModuleContext = {
+declare type DotvvmModuleContext<TViewModelType = any> = {
     /** Name of the resource defining the view module */
     moduleName: string;
     /** Instance of the view module */
@@ -1208,10 +1219,10 @@ declare type DotvvmModuleContext = {
     elements: HTMLElement[];
     /** Properties of the markup control which were sent to the client */
     properties: {
-        [name: string]: any;
+        [name: string]: DotvvmObservable<any>;
     };
     /** <dot:NamedCommand /> declared in the dothtml/dotcontrol view. */
     namedCommands: {
         [name: string]: (...args: any[]) => Promise<any>;
     };
-};
+} & DotvvmStateContainer<TViewModelType>;