Merge pull request #69 from contentstack/MKT-1823/type-support

MKT 1756/improved type support

Author: Kaushik Shetty

.gitignore

@@ -128,7 +128,8 @@ storybook-static
 tmp/
 temp/
 
-
+# Docs
+jsdocs/
 
 .DS_Store
 
@@ -139,6 +140,3 @@ temp/
 !.vscode/launch.json
 !.vscode/extensions.json
 *.code-workspace
-
-
-# End of https://www.toptal.com/developers/gitignore/api/node,web,vscode

.jsdoc.json

@@ -0,0 +1,19 @@
+{
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc"]
+    },
+    "source": {
+        "include": ["src"],
+        "includePattern": ".(js|ts)$"
+    },
+    "opts": {
+        "template": "node_modules/better-docs",
+        "destination": "./jsdocs/"
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    },
+    "plugins": ["node_modules/better-docs/typescript"]
+}

__test__/appConfig.test.ts

@@ -11,8 +11,8 @@ describe("app config", () => {
         stack: {},
     };
     const appConfig: AppConfig = new AppConfig(
-        mockData,
-        mockConnection,
+        mockData as any,
+        mockConnection as any,
         mockEmitter,
         { currentBranch: "master" }
     );

__test__/assetSidebarWidget.test.ts

@@ -1,7 +1,7 @@
 import EventEmitter from "wolfy87-eventemitter";
 
 import AssetSidebarWidget from "../src/AssetSidebarWidget";
-import { IAssetSidebarInitData } from "../src/types";
+import { IAssetSidebarInitData, LocationType } from "../src/types";
 import Asset from "../src/stack/api/asset";
 
 jest.mock("post-robot", () => ({
@@ -16,18 +16,16 @@ jest.mock("../src/stack/api/asset");
 describe("AssetSidebarWidget", () => {
     let assetSidebarWidget: AssetSidebarWidget;
     let mockInitData: IAssetSidebarInitData = {
-        data: {
-            type: "ASSET_SIDEBAR_WIDGET",
-            currentAsset: {},
-            config: {},
-            app_id: "mock_app_uid",
-            installation_uid: "mock_installation_uid",
-            extension_uid: "mock_extension_uid",
-            stack: {} as any,
-            user: {},
-            currentBranch: "mock_branch",
-            region: "region",
-        },
+        type: LocationType.ASSET_SIDEBAR_WIDGET,
+        currentAsset: {} as any,
+        config: {},
+        app_id: "mock_app_uid",
+        installation_uid: "mock_installation_uid",
+        extension_uid: "mock_extension_uid",
+        stack: {} as any,
+        user: {} as any,
+        currentBranch: "mock_branch",
+        region: "region",
     };
 
     let connection: { sendToParent: (...props: any[]) => any };
@@ -53,7 +51,7 @@ describe("AssetSidebarWidget", () => {
         jest.spyOn(connection, "sendToParent");
         assetSidebarWidget = new AssetSidebarWidget(
             mockInitData as IAssetSidebarInitData,
-            connection,
+            connection as any,
             emitter
         );
     });
@@ -63,17 +61,15 @@ describe("AssetSidebarWidget", () => {
     });
 
     it("should set instance properties in constructor", () => {
-        expect(assetSidebarWidget.currentAsset).toBe(
-            mockInitData.data.currentAsset
-        );
+        expect(assetSidebarWidget.currentAsset).toBe(mockInitData.currentAsset);
         expect(assetSidebarWidget._emitter).toBe(emitter);
         expect(assetSidebarWidget._connection).toBe(connection);
     });
 
     describe("getData", () => {
         it("should return the current asset", () => {
             const currentAsset = assetSidebarWidget.getData();
-            expect(currentAsset).toBe(mockInitData.data.currentAsset);
+            expect(currentAsset).toBe(mockInitData.currentAsset);
         });
     });
 
@@ -85,15 +81,15 @@ describe("AssetSidebarWidget", () => {
                 "setData",
                 asset
             );
-            expect(result).toEqual({ data: {} });
+            expect(result).toEqual(undefined);
         });
     });
 
     describe("syncAsset", () => {
         it("should sync the upstream asset with the current", async () => {
             const result = await assetSidebarWidget.syncAsset();
             expect(connection.sendToParent).toHaveBeenCalledWith("syncAsset");
-            expect(result).toEqual({ data: {} });
+            expect(result).toEqual(undefined);
         });
     });
 
@@ -112,7 +108,7 @@ describe("AssetSidebarWidget", () => {
                 "updateAssetSidebarWidth",
                 mockWidth
             );
-            expect(result).toEqual({ data: {} });
+            expect(result).toEqual(undefined);
         });
     });
 

__test__/entry.test.ts

@@ -1,4 +1,5 @@
 import Entry from "../src/entry";
+import { GenericObjectType } from "../src/types/common.types";
 import testData from "./data/testData.json";
 import { jest } from "@jest/globals";
 
@@ -29,8 +30,11 @@ describe("Entry", () => {
         const changedData = JSON.parse(JSON.stringify(testData));
         changedData.entry.title = "changed title";
 
-        // @ts-ignore
-        entry = new Entry({ data: testData, changedData }, connection, emitter);
+        entry = new Entry(
+            { ...testData, changedData } as any,
+            connection as any,
+            emitter
+        );
     });
 
     it("init", (done) => {
@@ -127,21 +131,14 @@ describe("Entry", () => {
             expect(field.uid).toBe(uid);
             expect(field.schema).toEqual(schema);
             expect(field.data_type).toEqual(schema.data_type);
-
         });
         it("should use custom Field instance if internal flag is set", () => {
-            const fieldInstance = jest.fn();
-            entry = new Entry(
-                // @ts-ignore
-                { data: testData },
-                connection,
-                emitter,
-                {
-                    _internalFlags: {
-                        FieldInstance: fieldInstance,
-                    },
-                }
-            );
+            const fieldInstance: any = jest.fn();
+            entry = new Entry(testData as any, connection as any, emitter, {
+                _internalFlags: {
+                    FieldInstance: fieldInstance,
+                },
+            });
 
             entry.getField("title");
 
@@ -175,15 +172,15 @@ describe("Entry", () => {
     it("getField within Create page", function () {
         const dataWithoutEntry = JSON.parse(JSON.stringify(testData));
         dataWithoutEntry.entry = {};
-        // @ts-ignore
-        entry = new Entry({ data: dataWithoutEntry }, connection, emitter);
+        entry = new Entry(dataWithoutEntry, connection as any, emitter);
         expect(() => entry.getField("invaliduid")).toThrowError(
             "The data is unsaved. Save the data before requesting the field."
         );
     });
 
     it("onSave Callback must be a function", function () {
-        // @ts-ignore
-        expect(() => entry.onSave()).toThrow("Callback must be a function");
+        expect(() => (entry as any).onSave()).toThrow(
+            "Callback must be a function"
+        );
     });
-});
+});