Merge pull request #45 from contentstack/develop

v1.3.0

Author: Deepak-Kharah

.DS_Store

@@ -1,5 +1,10 @@
 {
     "root": true,
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
     "parser": "@typescript-eslint/parser",
     "plugins": ["@typescript-eslint"],
     "extends": [

.eslintrc

@@ -0,0 +1,36 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: App SDK CI - Unit Testing
+
+on:
+  push:
+    branches: [master]
+
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+        with:
+          node-version: '14.x'
+
+      - name: Use Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+
+      - name: Install deps
+        run: npm ci
+
+      - name: Run unit test
+        run: npm run test

.github/workflows/unit-test.yml

@@ -128,7 +128,9 @@ storybook-static
 tmp/
 temp/
 
-dist/
+
+
+.DS_Store
 
 ### vscode ###
 .vscode/*

.gitignore

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm test

.husky/pre-push

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Contentstack
+Copyright (c) 2022-2023 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -13,7 +13,7 @@ npm install @contentstack/app-sdk
 Alternatively, you can use the following command within the script tag to install the App SDK:
 
 ```html
-<script src="https://unpkg.com/@contentstack/app-sdk@^1.2/dist/index.js"></script>
+<script src="https://unpkg.com/@contentstack/app-sdk@^1.3.0/dist/index.js"></script>
 ```
 
 ### Initializing the App SDK

README.md

@@ -74,12 +74,26 @@
         "name": "Extension Demo",
         "org_uid": "xxxxxx",
         "api_key": "xxxxxx",
+        "master_locale": "en-us",
+        "is_asset_download_public": true,
         "owner_uid": "xxxxxxx",
-        "enable_presence": true,
+        "user_uids": ["xxxxxxx"],
         "settings": {
             "version": "2017-10-14",
             "webhook_enabled": true
         },
+        "branches": [
+            {
+                "api_key": "xxxxxx",
+                "uid": "main_branch",
+                "source": "",
+                "alias": [
+                    {
+                        "uid": "branch_alias"
+                    }
+                ]
+            }
+        ],
         "SYS_ACL": {
             "others": {
                 "invite": false,

__test__/data/testData.json

@@ -0,0 +1,70 @@
+import Metadata from "../src/metadata";
+
+describe("Metadata", () => {
+    let connection: { sendToParent: typeof jest.fn };
+    let sendToParent: typeof jest.fn;
+
+    beforeEach(() => {
+        sendToParent = jest.fn().mockReturnValue(Promise.resolve({ data: {} }));
+        connection = { sendToParent: sendToParent };
+        jest.spyOn(connection, "sendToParent");
+    });
+
+    test("should retrieve metadata", async () => {
+        const metadata = new Metadata(connection);
+        const uid = "some-uid";
+        const metadataConfig = { uid };
+        await metadata.retrieveMetaData(metadataConfig);
+        expect(connection.sendToParent).toHaveBeenCalledWith("stackQuery", {
+            uid,
+            action: "getMetadata",
+            payload: {
+                metadata: {
+                    uid,
+                },
+            },
+        });
+    });
+
+    test("should retrieve all metadata", async () => {
+        const metadata = new Metadata(connection);
+        const metadataParams = { some: "config" };
+        await metadata.retrieveAllMetaData(metadataParams);
+        expect(connection.sendToParent).toHaveBeenCalledWith("stackQuery", {
+            action: "getAllMetadata",
+            params: metadataParams,
+        });
+    });
+
+    test("should update metadata", async () => {
+        const metadata = new Metadata(connection);
+        const uid = "some-uid";
+        const metadataConfig = { uid, some: "config" };
+        await metadata.updateMetaData(metadataConfig);
+        expect(connection.sendToParent).toHaveBeenCalledWith("stackQuery", {
+            uid,
+            action: "updateMetadata",
+            payload: {
+                metadata: {
+                    ...metadataConfig,
+                },
+            },
+        });
+    });
+
+    test("should delete metadata", async () => {
+        const metadata = new Metadata(connection);
+        const uid = "some-uid";
+        const metadataConfig = { uid };
+        await metadata.deleteMetaData(metadataConfig);
+        expect(connection.sendToParent).toHaveBeenCalledWith("stackQuery", {
+            uid,
+            action: "deleteMetadata",
+            payload: {
+                metadata: {
+                    uid,
+                },
+            },
+        });
+    });
+});