@web-lite/api-types - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

CHANGELOG.md

 # Changelog
 
-## [Unreleased](https://github.com/weblite-wapps/api-types/tree/HEAD)
+## [v1.2.0](https://github.com/weblite-wapps/api-types/tree/v1.2.0) (2021-07-27)
 
-[Full Changelog](https://github.com/weblite-wapps/api-types/compare/v1.2.0-2...HEAD)
+[Full Changelog](https://github.com/weblite-wapps/api-types/compare/v1.2.0-2...v1.2.0)
 
@@ -7,0 +7,0 @@ **Merged pull requests:**

package.json

@@ -7,3 +7,3 @@ {
   "author": "Weblite Team",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Use W with type checking and mock out of the box.",
@@ -10,0 +10,0 @@ "license": "BSD-3-Clause",

README.md

@@ -46,3 +46,3 @@ # api-types
 
-mockWebliteApi({});
+mockWebliteApi();
 // or
@@ -52,3 +52,49 @@ mockWebliteApi({ user: { firstname: 'custom_name', id: 'custom_id' } });
 
+```ts
+export interface IMock {
+  config: {
+    debug: boolean;
+    timing: {
+      initializeAsync: number;
+      getProfile: number;
+      shareDB: number;
+      user: number;
+      chat: number;
+      message: number;
+    };
+    storage: 'localStorage' | 'sessionStorage';
+  };
+  __profile__: Record<string, any>;
+  profile: {
+    school?: {};
+  };
+
+  __users__: Record<string, Omit<IMock['user'], 'getInfo'>>;
+  user: {
+    id: string;
+    firstname: string;
+    lastname?: string;
+    username: string;
+    profileImage?: string;
+    bio?: string;
+    getInfo: () => Omit<IMock['user'], 'getInfo'>;
+  };
+
+  __wapps__: {
+    wisId?: string;
+    wappId: string;
+    mode: RunningWappMode;
+  };
+  wapps: {
+    inputs?: Record<string, any>;
+    admins?: string[];
+  };
+
+  __chat__: Record<string, ChatInfo>;
+
+  __db__: {};
+}
+```
+
 This will only set `window.W` in development.
 `process.env.NODE_ENV === 'development' && !window.W`

No alert changes

Improved metrics

Total package byte prevSize

65126

increased by1.31%

Number of lines in readme file

99

increased by86.79%

No dependency changes