Merge pull request #23 from contentstack/develop

Add: Dynamic display type support and Custom upload handler

Author: Deepak-Kharah

README.md

@@ -64,29 +64,54 @@ This is a callback function that is executed after you unpublish an asset.
 
 It is the property that you can modify using the setData() method.
 
-## Metadata SDK Reference
+## Metadata
 
-**IMetadata**
-This object represents the structure of the metadata.
+Metadata is a piece of information that lets you describe or classify an asset/entry. You can manage your digital entities effectively and enable improved accessibility with additional metadata. This object manages all the CRUD operations you can perform with metadata, e.g., adding, updating, or deleting additional metadata.
+
+
+> Note: The Metadata feature allows users to update their asset metadata or entry metadata without incrementing the asset or entry version.
+
+### createMetadata(metadataConfig: IMetadataCreate)
 
 ```ts
-{
-    uid: string;
-    type: "asset" | "entry";
+IMetadataCreate {
+    entity_uid: string;
+    type?: "asset" | "entry"; // default: "asset"
     _content_type_uid?: string;
     locale?: string;
-    [key: string]: any;
+    [key: string]: any; // other fields you want to add
+}
+```
+
+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: IMetadataRetrieve)
+
+```ts
+IMetadateRetrieve {
+    uid: string;
 }
 ```
 
-**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.
+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.
 
-**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: IMetadataUpdate)
 
-**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.
+```ts
+IMetadataUpdate {
+    uid: string;
+    [key: string]: any; // other fields you want to update
+}
+```
+
+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: IMetadataDelete)
+
+```ts
+IMetadateDelete {
+    uid: string;
+}
+```
 
-**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.
+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.

__test__/entry.test.ts

@@ -138,6 +138,16 @@ 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);
+        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");

dist/__test__/entry.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=entry.test.d.ts.map

dist/__test__/entry.test.d.ts.map

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=field.test.d.ts.map

dist/__test__/field.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=frame.test.d.ts.map

dist/__test__/field.test.d.ts.map

@@ -0,0 +1,7 @@
+declare const _default: {
+    clone: (source: {
+        [key: string]: any;
+    }) => any;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map