feat: Asset extension(#14)

Author: Deepak-Kharah

.DS_Store

@@ -0,0 +1,3 @@
+node_modules
+dist
+__test__

.eslintignore

@@ -0,0 +1,19 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint"],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": 0,
+        "@typescript-eslint/prefer-const": 0,
+        "@typescript-eslint/no-this-alias": 0,
+        "@typescript-eslint/ban-ts-comment": 0,
+        "prefer-rest-params": 0,
+        "@typescript-eslint/no-unused-vars": 0,
+        "@typescript-eslint/no-empty-function": 0
+    }
+}

.eslintrc

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.APP_SDK_AUTOMATION}}

.github/workflows/npm-publish.yml

@@ -128,6 +128,8 @@ storybook-static
 tmp/
 temp/
 
+# dist/
+
 ### vscode ###
 .vscode/*
 !.vscode/settings.json

.gitignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -1,7 +1,92 @@
 # App Framework SDK
 
+## JSON Rich text editor plugin
 
-For more information on styling your extension, refer to our [style guide](https://www.contentstack.com/docs/extensions/style-guide/).
+The **JSON Rich Text Editor Plugins** lets you add/create custom plugins to extend the functionality of your [JSON Rich Text Editor](https://www.contentstack.com/docs/developers/json-rich-text-editor/about-json-rich-text-editor/) as per your needs. You can use the prebuilt JSON RTE plugins by modifying the code to suit your requirement.
 
-## More information
-- [SDK API reference](./docs/api.md)
+Some of the examples of the prebuilt JSON Rich Text Editor plugins are:
+
+-   Highlight: Allows you to highlight certain parts of your content, such as a whole line of text or a paragraph.
+
+-   Info Panel: Allows you to place important content inside a colored panel to make it stand out.
+
+-   Word Count: Allows you to track the word count for your JSON Rich Text Editor content.
+
+You can create JSON Rich Text Editor Plugins using the Contentstack App SDK. For more information, read our [documentation](https://www.contentstack.com/docs/developers/json-rich-text-editor-plugins/about-json-rte-plugins/).
+
+## Asset Sidebar Extension
+
+**Asset Sidebar Extensions** enable you to customize and enhance your **asset editing experience**. Using customized extensions, you can tailor your images on Contentstack according to your branding requirements..
+
+You can create Asset Sidebar Extensions using the Contentstack App SDK. For more information, read our documentation.
+
+### AssetSidebarWidget Reference
+
+It is an object representing the current Asset Sidebar Widget reference in the Contentstack UI.
+
+**getData()**
+
+This method returns the object representing the current asset.
+
+**setData(asset: Partial<AssetData>)**
+
+This method modifies the properties of the current asset.
+
+**syncAsset()**
+
+If your asset has been modified externally, you can use this method to load the new asset and sync its settings with the current asset.
+
+**updateWidth(width: number)**
+
+This method is used to modify the width of the asset sidebar panel. Using this method, you can resize the panel depending on the resolution of your content.
+
+**replaceAsset(file: File)**
+
+This method is used to replace the current asset with a new file. Unlike setData(), where you can only modify the properties, you can use this method to replace the actual file.
+
+**onSave(callback: anyFunction)**
+
+This is a callback function that runs after you save the asset settings.
+
+**onChange(callback: anyFunction)**
+
+This is a callback function that runs every time the user modifies the asset data.
+
+**onPublish(callback: anyFunction)**
+
+This is a callback function that is executed after a user publishes an asset.
+
+**onUnPublish(callback: anyFunction)**
+
+This is a callback function that is executed after you unpublish an asset.
+
+**AssetData**
+
+It is the property that you can modify using the setData() method.
+
+## Metadata SDK Reference
+
+**IMetadata**
+This object represents the structure of the metadata.
+
+```ts
+{
+    uid: string;
+    type: "asset" | "entry";
+    _content_type_uid?: string;
+    locale?: string;
+    [key: string]: any;
+}
+```
+
+**createMetaData(metadataConfig: IMetadata)**
+This method adds new metadata for an asset or entry. It accepts metadata configuration as required arguments. This config contains basic details that you need to identify the `metadata` object and other data you need for your app.
+
+**retrieveMetaData(metadataConfig: IMetadata)**
+This method retrieves metadata for an asset or entry. It accepts metadata configuration as required arguments. This config contains basic details that you need to identify the `metadata` object you want to retrieve.
+
+**updateMetaData(metadataConfig: IMetadata)**
+This method updates existing metadata for an asset or entry. It accepts metadata configuration as required arguments. This config contains basic details that you need to identify the `metadata` object and other data you want to update.
+
+**deleteMetaData(metadataConfig: IMetadata)**
+This method deletes existing metadata for an asset or entry. It accepts metadata configuration as required arguments. This config contains basic details that you need to identify the `metadata` object you want to delete.