@magda/external-ui-plugin-sdk 2.2.0-alpha.3 → 2.2.0

package/dist/index.d.ts

@@ -117,6 +117,17 @@ export declare interface CommonPropsType {
      * @memberof CommonPropsType
      */
     fetchContent: (noCache?: boolean) => Promise<void>;
+
+    /**
+     * An optional property contains a list of names of plugin components who are mounted to replace a built-in component.
+     * Only available for component types that supports more than one plugins to be mounted.
+     * e.g. `ExtraVisualisationSection` plugin components.
+     * When more than one components are mounted to replace a built-in component, each of the plugin component will receive this property.
+     *
+     * @type {string[]}
+     * @memberof CommonPropsType
+     */
+    loadedPluginNames?: string[];
 }
 
 declare type CompatiblePreviews = {
@@ -816,7 +827,7 @@ export declare interface ExtraVisualisationSectionComponentPropsType
 /**
  * Visualisation Section external plugin component type.
  * This plugin will be mounted on dataset or distribution page.
- * More info & example please refer to repo: [magda-ui-plugin-component-dap-thumbnail-viewer](https://github.com/magda-io/magda-ui-plugin-component-dap-thumbnail-viewer)
+ * More info & example please refer to repo: [magda-ui-plugin-component-dap-image-gallery](https://github.com/magda-io/magda-ui-plugin-component-dap-image-gallery)
  * @category External UI Plugin Component Types
  */
 export declare type ExtraVisualisationSectionComponentType = ComponentType<
@@ -977,6 +988,7 @@ declare type ParsedDataset = {
     };
     ckanExport?: CkanExportAspectType;
     access: Access;
+    defaultLicense?: string;
 };
 
 declare type ParsedDistribution = {
@@ -1037,12 +1049,23 @@ declare interface Permission {
 }
 
 /**
- * The constant define the prefix that is used to create the global scope variable name, to which the external UI plugin bundle should export to.
+ * The constant define the prefix that is used to create the global scope variable name `MagdaPluginComponentxxxx`, to which the external UI plugin bundle should export to.
+ * Here, `xxxx` is the plugin UI component type name
  * e.g. The Header Component should bundled & export to global scope variable `MagdaPluginComponentHeader`.
+ *
+ * The currently support all type names are:
+ * - Header
+ * - Footer
+ * - DatasetEditButton
+ * - DatasetLikeButton
+ * - ExtraVisualisationSection
+ *
+ * Please refer to `External UI Plugin Component Types Type Aliases` section for functionality of each plugin UI component type.
+ *
  * > Since Magda v2.2.0, users can load more than one "Extra Visualisation Section" type Magda UI Plugin Components.
- * To allow this, the component is required to be packaged as a library and exported to global scope `MagdaPluginComponentExtraVisualisationSections.xxxx`.
- * Here, `MagdaPluginComponentExtraVisualisationSections` should be an object with key `xxxx` set to the plugin component.
- * e.g. the DAP thumbnail viewer plugin choose to export itself to `MagdaPluginComponentExtraVisualisationSections.DAPThumbnailViewer`.
+ * To allow this, the component is required to be packaged as a library and exported to global scope `MagdaPluginComponentExtraVisualisationSection.xxxx`.
+ * Here, `MagdaPluginComponentExtraVisualisationSection` should be an object with key `xxxx` set to the plugin component.
+ * e.g. the [DAP image gallery plugin](https://github.com/magda-io/magda-ui-plugin-component-dap-image-gallery) choose to export itself to `MagdaPluginComponentExtraVisualisationSection.DAPImageGallery`.
  */
 export declare const PREFIX = "MagdaPluginComponent";
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/external-ui-plugin-sdk",
   "description": "MAGDA external UI plugin SDK",
-  "version": "2.2.0-alpha.3",
+  "version": "2.2.0",
   "scripts": {
     "prebuild": "rimraf dist tsconfig.tsbuildinfo",
     "build": "api-extractor run -l",
@@ -18,7 +18,7 @@
     "directory": "packages/external-ui-plugin-sdk"
   },
   "devDependencies": {
-    "@magda/web-client": "^2.2.0-alpha.3",
+    "@magda/web-client": "^2.2.0",
     "typescript": "~4.2.4"
   },
   "peerDependencies": {