Skip to content

Commit 485c092

Browse files
committed
feat: added support for setdata on complex field and entry
1 parent 7b06617 commit 485c092

12 files changed

Lines changed: 320 additions & 191 deletions

File tree

.github/readme/blueprint.md

Lines changed: 74 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,121 @@
1-
Contentstack App SDK Readme
1+
# Contentstack App SDK Readme
2+
23
The Contentstack App SDK allows you to customize your applications. This document will help you integrate the App SDK with your application.
34

4-
Getting started
5+
## Getting started
56

67
Include the compiled version of the extension client library by adding the following line to your application.
78

9+
```html
810
<script
911
src="https://unpkg.com/@contentstack/app-sdk@{{pkg.version}}/dist/index.js"
1012
integrity="{{subresourceIntegrity.js}}"
1113
crossorigin="anonymous"
1214
></script>
15+
```
1316

1417
To include the App SDK in your project, you need to run the following command:
1518

19+
```sh
1620
npm install @contentstack/app-sdk
21+
```
22+
1723
Alternatively, you can use the following command within the script tag to install the App SDK:
1824

25+
```html
1926
<script src="https://unpkg.com/@contentstack/app-sdk@2.0.0/dist/index.js"></script>
27+
```
28+
29+
### Initializing the App SDK
2030

21-
Initializing the App SDK
2231
To Initialize the App SDK you need to run the following command:
2332

33+
```js
2434
ContentstackAppSdk.init().then(function (appSdk) {
25-
// add code here
35+
// add code here
2636
});
27-
For more information, please refer to our App SDK API Reference document.
37+
```
38+
39+
For more information, please refer to our [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#contentstack-app-sdk-api-reference) document.
40+
41+
## Download the Boilerplate
2842

29-
Download the Boilerplate
3043
You can extend or customize the functionality of Contentstack CMS with Marketplace apps. To simplify and speed up the building process, boilerplates describe repetitive elements in a project. This boilerplate will help you build custom applications for your organization or stack.
3144

32-
Download the boilerplate.
45+
Download the [boilerplate](https://github.com/contentstack/marketplace-app-boilerplate/archive/refs/heads/master.zip).
46+
47+
## UI Locations and Examples
3348

34-
UI Locations and Examples
3549
UI Locations allow you to extend Contentstack's functionality. Through these UI locations, you can customize Contentstack's default behavior and UI. Integration of third-party applications is possible using different UI locations.
3650

3751
The Contentstack App SDK currently supports the following UI Locations:
3852

39-
Custom Field Location
40-
Dashboard Location
41-
Asset Sidebar Location
42-
App Config Location
43-
RTE Location
44-
Sidebar Location
45-
Field Modifier Location
46-
Full Page Location
47-
Custom Field Location
48-
Custom Field Location allows you to create custom fields that can be used in your content types. You can integrate with various business applications, such as Bynder, Cloudinary, Shopify, by adding them as a custom field to your stack's content type.
49-
50-
Dashboard Location
51-
With the Dashboard Location, you can create widgets for your stack dashboard. Integration with Google Analytics provides meaningful insights about your website.
52-
53-
Asset Sidebar Location
53+
- [Custom Field Location](https://www.contentstack.com/docs/developers/developer-hub/custom-field-location)
54+
- [Dashboard Location](https://www.contentstack.com/docs/developers/developer-hub/dashboard-location)
55+
- [Asset Sidebar Location](https://www.contentstack.com/docs/developers/developer-hub/asset-sidebar-location)
56+
- [App Config Location](https://www.contentstack.com/docs/developers/developer-hub/app-config-location)
57+
- [RTE Location](https://www.contentstack.com/docs/developers/developer-hub/rte-location)
58+
- [Sidebar Location](https://www.contentstack.com/docs/developers/developer-hub/sidebar-location)
59+
- [Field Modifier Location](https://www.contentstack.com/docs/developers/developer-hub/field-modifier-location/)
60+
- [Full Page Location](https://www.contentstack.com/docs/developers/developer-hub/full-page-location)
61+
62+
### Custom Field Location
63+
64+
Custom Field Location allows you to create custom fields that can be used in your content types. You can integrate with various business applications, such as [Bynder](https://www.contentstack.com/docs/developers/marketplace-apps/bynder), [Cloudinary](https://www.contentstack.com/docs/developers/marketplace-apps/cloudinary), [Shopify](https://www.contentstack.com/docs/developers/marketplace-apps/shopify), by adding them as a custom field to your stack's content type.
65+
66+
### Dashboard Location
67+
68+
With the Dashboard Location, you can create widgets for your stack dashboard. Integration with [Google Analytics](https://www.contentstack.com/docs/developers/marketplace-apps/google-analytics/) provides meaningful insights about your website.
69+
70+
### Asset Sidebar Location
71+
5472
Using the Asset Sidebar Location, you can create customized sidebar widgets to extend the functionality of your assets.
5573

56-
Manage, transform, and optimize your stack's assets efficiently using the Image Preset Builder.
74+
Manage, transform, and optimize your stack's assets efficiently using the [Image Preset Builder](https://www.contentstack.com/docs/developers/marketplace-apps/image-preset-builder).
75+
76+
### App Config Location
5777

58-
App Config Location
5978
App Config UI Location allows you to manage all the app settings centrally. Once configured, all other locations (where the app is installed) can access these settings.
6079

61-
RTE Location
80+
### RTE Location
81+
6282
The RTE Location allows you to create custom plugins to expand the functionality of your JSON Rich Text Editor. Using the Audience and Variables plugin, you can tailor your content as per your requirements.
6383

64-
Sidebar Location
65-
The Sidebar Location provides powerful tools for analyzing and recommending ideas for your entry. Use the Smartling sidebar location to help translate your content.
84+
### Sidebar Location
85+
86+
The Sidebar Location provides powerful tools for analyzing and recommending ideas for your entry. Use the [Smartling](https://help.smartling.com/hc/en-us/articles/4865477629083) sidebar location to help translate your content.
87+
88+
### Field Modifier Location
6689

67-
Field Modifier Location
6890
The Field Modifier Location is a type of UI location which extends the capabilities of entry fields. With the Field Modifier UI location, you can allow the different apps to appear on defined field data types such as Text, Number, JSON, Boolean, File, Reference fields etc.
6991

70-
Full Page Location
71-
The Full Page location is a type of UI location that lets you view full page apps such as Release Preview within your stack.
92+
### Full Page Location
93+
94+
The Full Page location is a type of UI location that lets you view full page apps such as [Release Preview](https://www.contentstack.com/docs/developers/marketplace-apps/release-preview) within your stack.
95+
96+
## Using Contentstack styles
7297

73-
Using Contentstack styles
7498
Install the Venus UI library package to style your app according to the Contentstack UI:
7599

100+
```sh
76101
npm i @contentstack/venus-components --save
77-
For more information on styling your application, refer to our style guide.
102+
```
103+
104+
For more information on styling your application, refer to our [style guide](https://www.contentstack.com/docs/developers/venus-component-library/).
105+
106+
## More information
107+
108+
- [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#readme)
109+
- [Marketplace Platform Guides](https://www.contentstack.com/docs/developers/marketplace-platform-guides/)
110+
- [Marketplace Apps](https://www.contentstack.com/docs/developers/marketplace-apps/)
111+
- [Contentstack App Development](https://www.contentstack.com/docs/developers/developer-hub/)
112+
113+
## App SDK v2.0.0 Migration Guide
114+
115+
This guide provides instructions for migrating your application to App SDK version 2.0.0. It covers changes in metadata responses, field modifier and full page location updates, and the transition from the `_extension` property to `_uiLocation`. If you are upgrading your app to the latest version, make sure to follow these steps for a smooth transition.
78116

79-
More information
80-
App SDK API Reference
81-
Marketplace Platform Guides
82-
Marketplace Apps
83-
Contentstack App Development
84-
App SDK v2.0.0 Migration Guide
85-
This guide provides instructions for migrating your application to App SDK version 2.0.0. It covers changes in metadata responses, field modifier and full page location updates, and the transition from the \_extension property to \_uiLocation. If you are upgrading your app to the latest version, make sure to follow these steps for a smooth transition.
117+
[Read the Migration Guide](./docs/app-sdk-v2-migration.md)
86118

87-
Read the Migration Guide
119+
## License
88120

89-
License
90-
Licensed under MIT.
121+
Licensed under [MIT](https://opensource.org/licenses/MIT).

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
1+
<!-- ⚠️ This README has been generated from the file(s) "./.github/readme/blueprint.md" ⚠️-->
2+
[](#contentstack-app-sdk-readme)
3+
14
# Contentstack App SDK Readme
25

36
The Contentstack App SDK allows you to customize your applications. This document will help you integrate the App SDK with your application.
47

8+
9+
[](#getting-started)
10+
511
## Getting started
612

713
Include the compiled version of the extension client library by adding the following line to your application.
814

915
```html
1016
<script
11-
src="https://unpkg.com/@contentstack/app-sdk@2.3.6/dist/index.js"
12-
integrity="sha512-emopr/zIeDgm48mJPZsk0xuAautCD26qEG0RV5c8/R/MMhGG+N1TUZf2HxOVmS9BexQ6beP8YT5Q9MLf+ZK0Hw=="
17+
src="https://unpkg.com/@contentstack/app-sdk@2.4.0/dist/index.js"
18+
integrity="sha512-oS3voAIrtiBqIsDI51ASg/yTDsH/cLfjlKAwqHQHMVswsHHzJw9thwb+4k6RQsk5E4OBCS96gFUtzySjkWXmQw=="
1319
crossorigin="anonymous"
1420
></script>
1521
```
@@ -23,7 +29,7 @@ npm install @contentstack/app-sdk
2329
Alternatively, you can use the following command within the script tag to install the App SDK:
2430

2531
```html
26-
<script src="https://unpkg.com/@contentstack/app-sdk@2.3.6/dist/index.js"></script>
32+
<script src="https://unpkg.com/@contentstack/app-sdk@2.0.0/dist/index.js"></script>
2733
```
2834

2935
### Initializing the App SDK
@@ -32,18 +38,24 @@ To Initialize the App SDK you need to run the following command:
3238

3339
```js
3440
ContentstackAppSdk.init().then(function (appSdk) {
35-
// add code here
41+
// add code here
3642
});
3743
```
3844

3945
For more information, please refer to our [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#contentstack-app-sdk-api-reference) document.
4046

47+
48+
[](#download-the-boilerplate)
49+
4150
## Download the Boilerplate
4251

4352
You can extend or customize the functionality of Contentstack CMS with Marketplace apps. To simplify and speed up the building process, boilerplates describe repetitive elements in a project. This boilerplate will help you build custom applications for your organization or stack.
4453

4554
Download the [boilerplate](https://github.com/contentstack/marketplace-app-boilerplate/archive/refs/heads/master.zip).
4655

56+
57+
[](#ui-locations-and-examples)
58+
4759
## UI Locations and Examples
4860

4961
UI Locations allow you to extend Contentstack's functionality. Through these UI locations, you can customize Contentstack's default behavior and UI. Integration of third-party applications is possible using different UI locations.
@@ -93,6 +105,9 @@ The Field Modifier Location is a type of UI location which extends the capabilit
93105

94106
The Full Page location is a type of UI location that lets you view full page apps such as [Release Preview](https://www.contentstack.com/docs/developers/marketplace-apps/release-preview) within your stack.
95107

108+
109+
[](#using-contentstack-styles)
110+
96111
## Using Contentstack styles
97112

98113
Install the Venus UI library package to style your app according to the Contentstack UI:
@@ -103,19 +118,28 @@ npm i @contentstack/venus-components --save
103118

104119
For more information on styling your application, refer to our [style guide](https://www.contentstack.com/docs/developers/venus-component-library/).
105120

121+
122+
[](#more-information)
123+
106124
## More information
107125

108126
- [App SDK API Reference](https://github.com/contentstack/app-sdk-docs#readme)
109127
- [Marketplace Platform Guides](https://www.contentstack.com/docs/developers/marketplace-platform-guides/)
110128
- [Marketplace Apps](https://www.contentstack.com/docs/developers/marketplace-apps/)
111129
- [Contentstack App Development](https://www.contentstack.com/docs/developers/developer-hub/)
112130

131+
132+
[](#app-sdk-v200-migration-guide)
133+
113134
## App SDK v2.0.0 Migration Guide
114135

115136
This guide provides instructions for migrating your application to App SDK version 2.0.0. It covers changes in metadata responses, field modifier and full page location updates, and the transition from the `_extension` property to `_uiLocation`. If you are upgrading your app to the latest version, make sure to follow these steps for a smooth transition.
116137

117138
[Read the Migration Guide](./docs/app-sdk-v2-migration.md)
118139

140+
141+
[](#license)
142+
119143
## License
120144

121145
Licensed under [MIT](https://opensource.org/licenses/MIT).

blueprint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
},
77
"line": "none",
88
"subresourceIntegrity": {
9-
"js": "sha512-emopr/zIeDgm48mJPZsk0xuAautCD26qEG0RV5c8/R/MMhGG+N1TUZf2HxOVmS9BexQ6beP8YT5Q9MLf+ZK0Hw=="
9+
"js": "sha512-oS3voAIrtiBqIsDI51ASg/yTDsH/cLfjlKAwqHQHMVswsHHzJw9thwb+4k6RQsk5E4OBCS96gFUtzySjkWXmQw=="
1010
}
1111
}

0 commit comments

Comments
 (0)