feat!: refactor method response to clean up post robot response

Author: Kaushik Shetty

dist/index.js

@@ -18,12 +18,12 @@ export declare class AppConfig {
     setInstallationData: (installationData: IInstallationData) => Promise<GenericObjectType>;
     getInstallationData: () => Promise<IInstallationData>;
     /**
-     * Set the validation state of the app. If the validation is false, the Contentstack App Config
-     * will not allow to save the configuration. The message will be displayed if provided.
-     * @param isValid set the validation state of the app
-     * @param options additional options to be sent to the parent
-     * @returns returns a promise with the data sent from the parent
+     * Sets the validation state of the app. If the validation is false, the Contentstack App Config
+     * will not allow saving the configuration. The message will be displayed if provided.
+     * @param {boolean} isValid - The validation state of the app.
+     * @param {object} options - Additional options to be sent to the parent.
+     * @returns {Promise<void>} - A promise that resolves to void.
      */
-    setValidity(isValid: boolean, options?: ValidationOptions): Promise<Record<string, any>>;
+    setValidity(isValid: boolean, options?: ValidationOptions): Promise<void>;
 }
 //# sourceMappingURL=index.d.ts.map

dist/index.js.map

@@ -1 +1,10 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/appConfig/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAK1D,MAAM,CAAC,OAAO,WAAW,uBAAuB;IAC5C,aAAa,EAAE,MAAM,CAAC;CACzB;AAGD;;GAEG;AAEH,qBAAa,SAAS;IAClB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,WAAW,EAAE,OAAO,SAAS,CAAC;IAC9B,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,CAAC,eAAe,CAA0B;gBAG7C,IAAI,EAAE,kBAAkB,EACxB,UAAU,EAAE,OAAO,SAAS,EAC5B,OAAO,EAAE,YAAY,EACrB,cAAc,EAAE,uBAAuB;IAU3C,KAAK,cAIH;IAEF,mBAAmB,qBACG,iBAAiB,KACpC,QAAQ,iBAAiB,CAAC,CAK3B;IAEF,mBAAmB,QAAO,QAAQ,iBAAiB,CAAC,CAKlD;IAEF;;;;;;OAMG;IACG,WAAW,CACb,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,iBAAiB,GAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAsBlC"}
+{
+    "version": 3,
+    "file": "index.d.ts",
+    "sourceRoot": "",
+    "sources": [
+        "../../../src/appConfig/index.ts"
+    ],
+    "names": [],
+    "mappings": "AAAA,OAAO,KAAK,MAAM,UAAU,CAAC;AAC7B,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAI1D,MAAM,CAAC,OAAO,WAAW,uBAAuB;IAC5C,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AAEH,qBAAa,SAAS;IAClB,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC9B,WAAW,EAAE,GAAG,CAAC;IACjB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,CAAC,eAAe,CAA0B;gBAG7C,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC5B,UAAU,EAAE,GAAG,EACf,OAAO,EAAE,YAAY,EACrB,cAAc,EAAE,uBAAuB;IAU3C,KAAK,cAIH;IAEF,mBAAmB,qBACG,iBAAiB,KACpC,QAAQ,iBAAiB,CAAC,CAK3B;IAEF,mBAAmB,QAAO,QAAQ,iBAAiB,CAAC,CAKlD;IAEF;;;;;;OAMG;IACG,WAAW,CACb,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,iBAAiB,GAC5B,OAAO,CAAC,IAAI,CAAC;CAsBnB"
+}

dist/src/RTE/index.d.ts.map

@@ -16,7 +16,11 @@ declare class Field {
     _resolvedData: GenericObjectType;
     _self: boolean;
     _connection: typeof postRobot;
-    constructor(fieldDataObject: IFieldInitData | IFieldModifierLocationInitData, connection: typeof postRobot, emitter: EventEmitter);
+    constructor(
+        fieldDataObject: IFieldInitData | IFieldModifierLocationInitData,
+        connection: typeof postRobot,
+        emitter: EventEmitter
+    );
     /**
      * Sets the data for the current field.
      * @param {Object|string|number} data Data to be set on the field
@@ -29,19 +33,21 @@ declare class Field {
      * @param  {boolean} options.resolved If the resolved parameter is set to true for the File field, then the method will return a resolved asset object along with all the field metadata, e.g. 'field.getData({resolved:true})'.
      * @return {Object|string|number} Returns the field data.
      */
-    getData({ resolved }?: {
+    getData({
+        resolved,
+    }?: {
         resolved?: boolean | undefined;
     }): GenericObjectType;
     /**
      * Sets the focus for a field when an extension is being used. This method shows user presence and highlights the extension field that the user is currently accessing in Contentstack UI.
-     * @return {Object} A promise object which is resolved when Contentstack UI returns an acknowledgement of the focused state.
+     * @return {Promise<void} A promise object which is resolved when Contentstack UI returns an acknowledgement of the focused state.
      */
-    setFocus(): void;
+    setFocus(): Promise<void>;
     /**
      * This function is called when another extension programmatically changes data of this field using field.setData() function, only available for extension field, only support extensions of data type text, number, boolean or date.
      * @param {function} callback The function to be called when an entry is published.
      */
     onChange?(callback: (data: any) => any): void;
 }
 export default Field;
-//# sourceMappingURL=field.d.ts.map
+//# sourceMappingURL=field.d.ts.map

dist/src/appConfig/index.d.ts

@@ -1 +1,10 @@
-{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/field.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AA6B7C,iGAAiG;AACjG,cAAM,KAAK;IACP;;OAEG;IAEH,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE,iBAAiB,CAAC;IACzB,aAAa,EAAE,iBAAiB,CAAC;IACjC,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,OAAO,SAAS,CAAC;gBAG1B,eAAe,EAAE,cAAc,GAAG,8BAA8B,EAChE,UAAU,EAAE,OAAO,SAAS,EAC5B,OAAO,EAAE,YAAY;IAgDzB;;;;OAIG;IAEH,OAAO,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;IA8BlC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,QAAgB,EAAE;;KAAK;IAIjC;;;OAGG;IACH,QAAQ;IAIR;;;OAGG;IACH,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG;CAYzC;AAED,eAAe,KAAK,CAAC"}
+{
+    "version": 3,
+    "file": "field.d.ts",
+    "sourceRoot": "",
+    "sources": [
+        "../../src/field.ts"
+    ],
+    "names": [],
+    "mappings": "AAAA,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,8BAA8B,EAAE,MAAM,SAAS,CAAC;AA4BzE,iGAAiG;AACjG,cAAM,KAAK;IACP;;OAEG;IAEH,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC/B,QAAQ,EAAE,YAAY,CAAC;IACvB,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAC9B,aAAa,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACtC,KAAK,EAAE,GAAG,CAAC;IACX,WAAW,EAAE,GAAG,CAAC;gBAGb,eAAe,EAAE,cAAc,GAAG,8BAA8B,EAChE,UAAU,EAAE,GAAG,EACf,OAAO,EAAE,YAAY;IAgDzB;;;;OAIG;IAEH,OAAO,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;IA8BlC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,QAAgB,EAAE;;KAAK;;;IAIjC;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;;OAGG;IACH,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG;CAYzC;AAED,eAAe,KAAK,CAAC"
+}

dist/src/appConfig/index.d.ts.map

@@ -37,48 +37,43 @@ declare class Metadata {
     /**
      * Creates a new Metadata record.
      * @param {IMetadataCreateDto} metadataConfig The metadata configuration data required to create the metadata.
-     * @returns {Promise<ResponseMessageEvent<{ metadata: IMetadata }>>} A promise that resolves to the newly created metadata record.
+     * @returns {Promise<{ metadata: IMetadata }>} A promise that resolves to the newly created metadata record.
      */
-    createMetaData(metadataConfig: IMetadataCreateDto): Promise<ResponseMessageEvent<{
+    createMetaData(metadataConfig: IMetadataCreateDto): Promise<{
         metadata: IMetadata;
-    }>>;
+    }>;
     /**
      * Retrieves a metadata record by its ID.
      * @param {IMetadataRetrieveDto} metadataConfig The metadata configuration containing its uid.
-     * @returns {Promise<ResponseMessageEvent<{ metadata: IMetadata }>> } A promise that resolves to the metadata record with the specified ID.
+     * @returns {Promise<{ metadata: IMetadata }> } A promise that resolves to the metadata record with the specified ID.
      */
-    retrieveMetaData(metadataConfig: IMetadataRetrieveDto): Promise<ResponseMessageEvent<{
+    retrieveMetaData(metadataConfig: IMetadataRetrieveDto): Promise<{
         metadata: IMetadata;
-    }>>;
+    }>;
     /**
      * Retrieves all metadata records.
      * @param {GenericObjectType} params Optional parameters for the query.
-     * @returns {Promise<ResponseMessageEvent<{ metadata: IMetadata[] }>>} A promise that resolves to an array of all metadata records.
+     * @returns {Promise<{ metadata: IMetadata[] }>} A promise that resolves to an array of all metadata records.
      */
-    retrieveAllMetaData(params?: GenericObjectType): Promise<ResponseMessageEvent<{
+    retrieveAllMetaData(params?: GenericObjectType): Promise<{
         metadata: IMetadata[];
-    }>>;
+    }>;
     /**
      * Updates a metadata record.
      * @param {IMetadataUpdateDto} metadataConfig The metadata configuration that needs to be updated.
-     * @returns {Promise<ResponseMessageEvent<{ metadata: IMetadata }>>} A promise that resolves when the metadata record that has been updated.
-     * ? A promise that resolves to the updated metadata record.
+     * @returns {Promise<{ metadata: IMetadata }>} A promise that resolves to the metadata record that has been updated.
      */
-    updateMetaData(metadataConfig: IMetadataUpdateDto): Promise<ResponseMessageEvent<{
+    updateMetaData(metadataConfig: IMetadataUpdateDto): Promise<{
         metadata: IMetadata;
-    }>>;
+    }>;
     /**
      * Deletes a metadata record.
      * @param {IMetadataDeleteDto} metadataConfig The metadata configuration.
-     * @returns {Promise<ResponseMessageEvent<undefined>>} A promise that resolves when the metadata record has been deleted.
-     * ? A promise that resolves to the deleted metadata record.
+     * @returns {Promise<{ notice: string }>} A promise that resolves with a message upon successful deletion of the metadata record.
      */
-    deleteMetaData(metadataConfig: IMetadataDeleteDto): Promise<ResponseMessageEvent<undefined>>;
+    deleteMetaData(metadataConfig: IMetadataDeleteDto): Promise<{
+        notice: string;
+    }>;
 }
 export default Metadata;
-/**
- * NOTE:
- * Publish and unpublish metadata methods are missing
- * Methods return the entire post robot response and not just the actual response
- */
 //# sourceMappingURL=metadata.d.ts.map