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

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Component } from 'react';
 import { ComponentType } from 'react';
 import { History as History_2 } from 'history';
 import { Location as Location_2 } from 'history';
@@ -116,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 = {
@@ -129,70 +141,603 @@ declare type CompatiblePreviews = {
     google?: boolean;
 };
 
-declare interface ConfigDataType {
+/**
+ * Magda frontend application configuration data structure.
+ * This config data is only configurable at time of the deployment via [Magda web-server Helm Chart](https://github.com/magda-io/magda/tree/master/deploy/helm/internal-charts/web-server).
+ * At the beginning of starting up, the frontend application will retrieve this config data from the web server.
+ * For default values, please refer to [Magda web-server Helm Chart Doc](https://github.com/magda-io/magda/tree/master/deploy/helm/internal-charts/web-server).
+ *
+ * @export
+ * @interface ConfigDataType
+ */
+export declare interface ConfigDataType {
+    /**
+     * This field allow you to config the common settings of all [fetch requests](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch) sent by the frontend application.
+     * One common use case is to set [credentials field](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#credentials).
+     * Its default value is `"credentials": "same-origin"`. When running the web client locally for debugging purpose, you might want to set it to `"credentials": "include"`.
+     * This will allow `credentials` (e.g. cookie) to be shared with remote dev testing API server.
+     *
+     * @type {RequestInit}
+     * @memberof ConfigDataType
+     */
+    commonFetchRequestOptions: RequestInit;
+
+    /**
+     * The docker image information of the web server that serves all frontend resources of the application.
+     *
+     * @type {{
+     *         pullPolicy?: string;
+     *         repository?: string;
+     *         tag?: string;
+     *     }}
+     * @memberof ConfigDataType
+     */
     image?: {
         pullPolicy?: string;
         repository?: string;
         tag?: string;
     };
-    authApiBaseUrl?: string;
-    baseUrl?: string;
-    authPluginRedirectUrl?: string;
-    baseExternalUrl?: string;
-    uiBaseUrl?: string;
+
+    /**
+     * The authorisation API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    authApiBaseUrl: string;
+
+    /**
+     * The base URL path of all APIs (e.g. '/');
+     * The value of the field might be either from config data retrieved from the server or (when run web client locally) the hardcoded URL to a default "fallback" dev API server url for testing.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    baseUrl: string;
+
+    /**
+     * The default redirection url for all auth plugins once the authentication process is completed.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    authPluginRedirectUrl: string;
+
+    /**
+     * Similar to `baseUrl`. But this field always includes the external access domain of the application.
+     * You might want to use its value in use cases e.g. generating external accessible links for email content.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    baseExternalUrl: string;
+
+    /**
+     * The base url path where the web client will be served at.
+     * E.g.  when `uiBaseUrl`=`/`, the web client will served at `https://example.com/`.
+     * When `uiBaseUrl`=`/abc/def`, the web client will served at `https://example.com/abc/def`.
+     * Please note: this field only reflect where the wbe client / frontend application is served at.
+     * It doesn't reflect where all APIs are served. To find out it, the value `baseUrl` field should be used.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    uiBaseUrl: string;
+
+    /**
+     * Whether or not the notification banner should be shown.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     showNotificationBanner?: boolean;
-    contentApiBaseUrl?: string;
-    previewMapBaseUrl?: string;
-    indexerApiBaseUrl?: string;
-    registryApiBaseUrl?: string;
-    registryApiReadOnlyBaseUrl?: string;
-    searchApiBaseUrl?: string;
+
+    /**
+     * The content API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    contentApiBaseUrl: string;
+
+    /**
+     * The API endpoint URL to retrieve all default content items (e.g. header & footer items etc.).
+     * The value of this field is created from field `contentApiBaseUrl`.
+     * It includes all required query parameters in the URL and serves as a pre-configured short cut to retrieve all default content items for a user.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    contentUrl: string;
+
+    /**
+     * The map preview module base access URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    previewMapBaseUrl: string;
+
+    /**
+     * The CORS resource proxy url. Mainly used by map preview module to load CORS resources from whitelist domains.
+     * Its value is generated from `previewMapBaseUrl`.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    proxyUrl: string;
+
+    /**
+     * The indexer API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    indexerApiBaseUrl: string;
+
+    /**
+     * The registry API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     * Please note: this registry API endpoint can handle both read & write requests.
+     * Since v0.0.59, readonly (HTTP GET) requests that are sent to this endpoint externally will be auto-forward to the readonly endpoint `registryApiReadOnlyBaseUrl`.
+     * However, for performance consideration (as gateway doesn't need to check HTTP method), `registryApiReadOnlyBaseUrl` should still be the preferred endpoint for readonly requests.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    registryApiBaseUrl: string;
+
+    /**
+     * The registry readonly API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     * Please note: this registry API endpoint can only handle both read requests only.
+     * The readonly registry API endpoint can scale horizontally easily. Thus, should be the preferred endpoint for serving readonly requests.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    registryApiReadOnlyBaseUrl: string;
+
+    /**
+     * The search API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    searchApiBaseUrl: string;
+
+    /**
+     * The correspondence API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     correspondenceApiBaseUrl?: string;
-    storageApiBaseUrl?: string;
+
+    /**
+     * The storage API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    storageApiBaseUrl: string;
+
+    /**
+     * The admin API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    adminApiBaseUrl: string;
+
+    /**
+     * Google Analytics ID
+     *
+     * @type {Array<string>}
+     * @memberof ConfigDataType
+     */
     gapiIds?: Array<string>;
-    adminApiBaseUrl?: string;
-    disableAuthenticationFeatures?: boolean;
+
+    /**
+     * remote RSS news endpoint.
+     * This config field is deprecated & to be removed in future.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    rssUrl?: string;
+
+    /**
+     * When set to `true`, the user account related links & buttons will be removed.
+     * Default to `false`.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
+    disableAuthenticationFeatures: boolean;
+
+    /**
+     * The url of fallback dev API server for testing.
+     * It will only be used when the web client is run locally.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     fallbackUrl?: string;
-    featureFlags?: {
-        [id: string]: boolean;
-    };
-    useMagdaStorageByDefault?: boolean;
+
+    /**
+     * A set of feature flags to turn on/of a list of features.
+     *
+     * @type {{
+     *         [id: string]: boolean;
+     *     }}
+     * @memberof ConfigDataType
+     */
+    featureFlags: FeatureFlagsConfigType;
+
+    /**
+     * Whether or not the "use Magda storage" option should be pre-selected on dataset editor UI.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
+    useMagdaStorageByDefault: boolean;
+
+    /**
+     * A list of vocabulary api endpoints that are used to validate the auto-generated keywords in dataset editor UI.
+     * By default, it's set to:
+     * - "https://vocabs.ands.org.au/repository/api/lda/abares/australian-land-use-and-management-classification/version-8/concept.json",
+     * - "https://vocabs.ands.org.au/repository/api/lda/ands-nc/controlled-vocabulary-for-resource-type-genres/version-1-1/concept.json"
+     *
+     * @type {string[]}
+     * @memberof ConfigDataType
+     */
     vocabularyApiEndpoints: string[];
+
+    /**
+     * A list of keywords that should never be generated by the auto keyword generation module in the dataset editor UI.
+     *
+     * @type {string[]}
+     * @memberof ConfigDataType
+     */
+    keywordsBlackList?: string[];
+
+    /**
+     * Default Organization ID for dataset editor UI.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     defaultOrganizationId?: string;
+
+    /**
+     * Default email to forward users' inquiry.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     defaultContactEmail?: string;
+
+    /**
+     * deprecated. Not used anymore. To be removed in future.
+     *
+     * @type {number}
+     * @memberof ConfigDataType
+     */
     custodianOrgLevel: number;
+
+    /**
+     * The maximum size that a file can be in order to be automatically previewed by the ui as a map, graph or table.
+     *
+     * @type {number}
+     * @memberof ConfigDataType
+     */
     automaticPreviewMaxFileSize: number;
+
+    /**
+     * List all mandatory fields in dataset editor.
+     *
+     * @type {ValidationFieldList}
+     * @memberof ConfigDataType
+     */
     mandatoryFields: ValidationFieldList;
-    dateConfig?: DateConfig;
+
+    /**
+     * The date format config used in dataset editor auto date information extraction.
+     *
+     * @type {DateConfig}
+     * @memberof ConfigDataType
+     */
+    dateConfig: DateConfig;
+
+    /**
+     * Whether or not allow user to input manual keywords in the dataset editor.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     noManualKeywords?: boolean;
+
+    /**
+     * Whether or not allow user to input manual themes in the dataset editor.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     noManualThemes?: boolean;
+
+    /**
+     * Predefined dataset theme list used in the dataset editor.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     datasetThemes?: string[];
-    keywordsBlackList?: string[];
+
+    /**
+     * The openfaas API base URL config value that is supplied by the web server.
+     * When this value is not available from the server (e.g. when run web client locally), the default "fallback" API server url will be used to generate this value.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     openfaasBaseUrl?: string;
+
+    /**
+     * Config for optional dataset auto-sync to ckan feature.
+     * Only available when [magda-minion-ckan-exporter](https://github.com/magda-io/magda-minion-ckan-exporter) is deployed and feature flag `publishToDga` is `true`.
+     * This feature is still in beta.
+     *
+     * @type {{
+     *         [ckanServerUrl: string]: boolean;
+     *     }}
+     * @memberof ConfigDataType
+     */
     ckanExportServers: {
         [ckanServerUrl: string]: boolean;
     };
+
+    /**
+     * The default CKAN server for the optional dataset auto-sync to ckan feature.
+     * see config field `ckanExportServers`.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     defaultCkanServer: string;
+
+    /**
+     * The default timezone used in the application.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     defaultTimeZone?: string;
+
+    /**
+     * Indicate whether or not the crawler web view is enabled on [Magda web-server](https://github.com/magda-io/magda/tree/master/deploy/helm/internal-charts/web-server) to provide search engine optimized views.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     enableCrawlerViews?: boolean;
+
+    /**
+     * The discourse site url.
+     * For the optional discourse site integration feature.
+     * When its value is empty, the feature will be disabled.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     discourseSiteUrl?: string;
+
+    /**
+     * For the optional discourse site integration feature.
+     * Indicate whether show the discourse comment area on dataset page.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     discourseIntegrationDatasetPage?: boolean;
+
+    /**
+     * For the optional discourse site integration feature.
+     * Indicate whether show the discourse comment area on distribution page.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     discourseIntegrationDistributionPage?: boolean;
+
+    /**
+     * A list of optional external UI component plugins bundle URLs.
+     *
+     * @type {string[]}
+     * @memberof ConfigDataType
+     */
     externalUIComponents?: string[];
+
+    /**
+     * A list of optional external CSS files to overwrite the looking of the site.
+     *
+     * @type {string[]}
+     * @memberof ConfigDataType
+     */
     externalCssFiles?: string[];
+
+    /**
+     * The url used when user click `home` link or header logo.
+     * Default to "/"
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     homePageUrl?: string;
+
+    /**
+     * The responsive UI break points.
+     *
+     * @type {{
+     *         small: number;
+     *         medium: number;
+     *         large: number;
+     *     }}
+     * @memberof ConfigDataType
+     */
+    breakpoints?: {
+        small: number;
+        medium: number;
+        large: number;
+    };
+
+    /**
+     * Search panel facet config.
+     *
+     * @type {FacetConfigItem[]}
+     * @memberof ConfigDataType
+     */
+    facets?: FacetConfigItem[];
+
+    /**
+     * Header logo URL.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    headerLogoUrl?: string;
+
+    /**
+     * Header logo URL for mobile view.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    headerMobileLogoUrl?: string;
+
+    /**
+     * A list of month name to be used in the application
+     *
+     * @type {string[]}
+     * @memberof ConfigDataType
+     */
+    months?: string[];
+    /**
+     * Default boundingBox for map preview module
+     *
+     * @type {{
+     *         west: number;
+     *         south: number;
+     *         east: number;
+     *         north: number;
+     *     }}
+     * @memberof ConfigDataType
+     */
+    boundingBox: {
+        west: number;
+        south: number;
+        east: number;
+        north: number;
+    };
+
+    /**
+     * Whether the "Open in XXXX" button over the map preview module should support terria map v7 config format.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     supportExternalTerriaMapV7?: boolean;
+
+    /**
+     * The the "Open in XXXX" over the map preview module button text label.
+     * By default, it's set to "Open in National Map".
+     * But you can set to other value in case you want to send data to your own terria map.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     openInExternalTerriaMapButtonText?: string;
+
+    /**
+     * The target terria map URL that the "Open in XXXX" over the map preview module button should send data to.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     openInExternalTerriaMapTargetUrl?: string;
+
+    /**
+     * extraConfigData is mainly for config data passing to external UI plugins
+     *
+     * @type {{
+     *         [key: string]: any;
+     *     }}
+     * @memberof ConfigDataType
+     */
     extraConfigData?: {
-        // extraConfigData is mainly for config data passing to external UI plugins
         [key: string]: any;
     };
+
+    /**
+     * A format preference list for the map preview module.
+     * It controls, on dataset page, when more than one formats are available, which format data file / API will be used for best user experience.
+     *
+     * @type {RawPreviewMapFormatPerferenceItem[]}
+     * @memberof ConfigDataType
+     */
     previewMapFormatPerference?: RawPreviewMapFormatPerferenceItem[];
+
+    /**
+     * Whether or not show the contact button when the contact information of the dataset is not available.
+     * When set to `true`, the inquiries will be sent to the default contact email.
+     *
+     * @type {boolean}
+     * @memberof ConfigDataType
+     */
     showContactButtonForNoContactPointDataset?: boolean;
+
+    /**
+     * The default storage bucket that storage API should use.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
     defaultDatasetBucket?: string;
-    anonymousUserLandingPage?: string;
-    authenticatedUserLandingPage?: string;
+
+    /**
+     * The landing page URL for anonymous users.
+     * By default, it's "/home". You might want to set to "/account", if your system is not open to public users.
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    anonymousUserLandingPage: string;
+
+    /**
+     * The landing page URL for authenticated users.
+     * By default, it's "/home".
+     *
+     * @type {string}
+     * @memberof ConfigDataType
+     */
+    authenticatedUserLandingPage: string;
+
+    /**
+     * How long before reload the current user's auth data in the background.
+     * Useful to transit UI to correct status when user leave browser open without interaction for long time.
+     * Default: 5 mins
+     *
+     * @type {number}
+     * @memberof ConfigDataType
+     */
     authStatusRefreshInterval?: number;
 }
 
@@ -218,9 +763,16 @@ declare type CurrencyData = {
     }[];
 };
 
-export declare type DatasetEditButtonComponentPropsType = {
+/**
+ * The properties that DatasetEditButton Plugin Component will receive.
+ *
+ * @export
+ * @interface FooterComponentPropsType
+ * @extends {CommonPropsType}
+ */
+export declare interface DatasetEditButtonComponentPropsType extends CommonPropsType {
     dataset: ParsedDataset;
-};
+}
 
 /**
  * Dataset page `Edit Dataset` button external plugin component type
@@ -230,9 +782,16 @@ export declare type DatasetEditButtonComponentType = ComponentType<
     DatasetEditButtonComponentPropsType
 >;
 
-export declare type DatasetLikeButtonComponentPropsType = {
+/**
+ * The properties that DatasetLikeButton Plugin Component will receive.
+ *
+ * @export
+ * @interface FooterComponentPropsType
+ * @extends {CommonPropsType}
+ */
+export declare interface DatasetLikeButtonComponentPropsType extends CommonPropsType {
     dataset: ParsedDataset;
-};
+}
 
 /**
  * Search Result page `Like Button` external plugin component type
@@ -252,32 +811,65 @@ declare interface DateConfig {
     };
 }
 
-export declare type ExtraVisualisationSectionComponentPropsType = {
+/**
+ * The properties that ExtraVisualisationSection Plugin Component will receive.
+ *
+ * @export
+ * @interface FooterComponentPropsType
+ * @extends {CommonPropsType}
+ */
+export declare interface ExtraVisualisationSectionComponentPropsType
+    extends CommonPropsType {
     dataset: ParsedDataset;
     distributionId?: string;
-};
+}
 
 /**
  * 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<
     ExtraVisualisationSectionComponentPropsType
 >;
 
+declare interface FacetConfigItem {
+    id: string;
+    component: Component<any>;
+    showExplanation?: boolean;
+    name?: string;
+}
+
+declare type FeatureFlagsConfigType = Partial<Record<FeatureFlagType, boolean>>;
+
+declare type FeatureFlagType =
+    | "cataloguing"
+    | "publishToDga"
+    | "previewAddDataset"
+    | "datasetApprovalWorkflowOn"
+    | "useStorageApi"
+    | "datasetLikeButton"
+    | "enableAutoMetadataFetchButton";
+
 declare type FetchError = {
     title: string;
     detail: string;
 };
 
-export declare type FooterComponentPropsType = {
+/**
+ * The properties that Footer Plugin Component will receive.
+ *
+ * @export
+ * @interface FooterComponentPropsType
+ * @extends {CommonPropsType}
+ */
+export declare interface FooterComponentPropsType extends CommonPropsType {
     noTopMargin: boolean;
     footerMediumNavs: FooterNavLinkGroup[];
     footerSmallNavs: FooterNavLinkGroup[];
     footerCopyRightItems: CopyRightItem[];
-};
+}
 
 /**
  * Footer external plugin component type
@@ -309,7 +901,14 @@ export declare interface FooterNavLinkGroup {
     order: number;
 }
 
-export declare interface HeaderComponentProps {
+/**
+ * The properties that Header Plugin Component will receive.
+ *
+ * @export
+ * @interface FooterComponentPropsType
+ * @extends {CommonPropsType}
+ */
+export declare interface HeaderComponentProps extends CommonPropsType {
     headerNavItems: HeaderNavItem[];
 }
 
@@ -336,13 +935,12 @@ export declare interface HeaderNavItem {
     order: number;
 }
 
-declare type OperationRecord = {
+declare interface Operation {
     id: string;
     uri: string;
     name: string;
-    description: string;
-    resource_id: string;
-};
+    description?: string;
+}
 
 declare type OrgUnit = {
     id: string;
@@ -390,6 +988,7 @@ declare type ParsedDataset = {
     };
     ckanExport?: CkanExportAspectType;
     access: Access;
+    defaultLicense?: string;
 };
 
 declare type ParsedDistribution = {
@@ -433,21 +1032,41 @@ declare type ParsedProvenance = {
     isOpenData?: boolean;
 };
 
-declare interface PermissionRecord {
+declare interface Permission {
     id: string;
     name: string;
-    description: string;
-    resource_id: string;
-    user_ownership_constraint: boolean;
-    org_unit_ownership_constraint: boolean;
-    pre_authorised_constraint: boolean;
-    owner_id: string;
-    create_time: string;
-    create_by: string;
-    edit_time: string;
-    edit_by: string;
+    description?: string;
+    resourceId: string;
+    resourceUri: string;
+    userOwnershipConstraint: boolean;
+    orgUnitOwnershipConstraint: boolean;
+    preAuthorisedConstraint: boolean;
+    operations: Operation[];
+    createBy?: string;
+    createTime?: Date;
+    editBy?: string;
+    editTime?: Date;
 }
 
+/**
+ * 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 `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";
 
 declare type Publisher = {
@@ -487,11 +1106,6 @@ declare type Role = {
     permissionIds: string[];
 };
 
-declare interface RolePermissionRecord extends PermissionRecord {
-    resource_uri: string;
-    operations?: OperationRecord[];
-}
-
 declare type TemporalCoverage = {
     intervals: {
         start?: string;
@@ -510,7 +1124,7 @@ declare type User = {
     sourceId?: string;
     isAdmin: boolean;
     roles: Role[];
-    permissions: RolePermissionRecord[];
+    permissions: Permission[];
     orgUnitId?: string;
     orgUnit?: OrgUnit;
     managingOrgUnitIds?: string[];

package/package.json

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