@magda/external-ui-plugin-sdk 2.2.5 → 2.3.0-alpha.0

package/dist/index.d.ts

@@ -763,6 +763,17 @@ declare type CurrencyData = {
     }[];
 };
 
+declare type DatasetDraft = {
+    data: string;
+    timestamp: string;
+    dataset?: {
+        title?: string;
+        description?: string;
+        themes?: string[];
+        keywords?: string[];
+    };
+};
+
 /**
  * The properties that DatasetEditButton Plugin Component will receive.
  *
@@ -802,6 +813,10 @@ export declare type DatasetLikeButtonComponentType = ComponentType<
     DatasetLikeButtonComponentPropsType
 >;
 
+declare type DatasetPublisher = {
+    publisher: Publisher;
+};
+
 declare interface DateConfig {
     dateFormats: string[];
     dateRegexes: {
@@ -811,6 +826,40 @@ declare interface DateConfig {
     };
 }
 
+declare type DcatDatasetStrings = {
+    title: string;
+    description: string;
+    issued?: string;
+    modified?: string;
+    languages?: string[];
+    publisher?: string;
+    accrualPeriodicity?: string;
+    accrualPeriodicityRecurrenceRule?: string;
+    spatial?: string;
+    temporal?: {
+        start?: string;
+        end?: string;
+    };
+    themes?: string[];
+    keywords?: Array<string>;
+    contactPoint?: string;
+    landingPage?: string;
+    defaultLicense?: string;
+};
+
+declare type dcatDistributionStrings = {
+    format: string;
+    downloadURL: string;
+    accessURL: string;
+    issued?: string;
+    modified: string;
+    license: string;
+    description: string;
+    title: string;
+    useStorageApi?: boolean;
+    byteSize: number;
+};
+
 /**
  * The properties that ExtraVisualisationSection Plugin Component will receive.
  *
@@ -989,6 +1038,7 @@ declare type ParsedDataset = {
     ckanExport?: CkanExportAspectType;
     access: Access;
     defaultLicense?: string;
+    rawData: RawDataset;
 };
 
 declare type ParsedDistribution = {
@@ -1017,6 +1067,7 @@ declare type ParsedDistribution = {
     };
     version?: VersionAspectData;
     byteSize?: number;
+    rawData: RawDistribution;
 };
 
 declare type ParsedInformationSecurity = {
@@ -1046,6 +1097,7 @@ declare interface Permission {
     createTime?: Date;
     editBy?: string;
     editTime?: Date;
+    allowExemption: boolean;
 }
 
 /**
@@ -1069,6 +1121,22 @@ declare interface Permission {
  */
 export declare const PREFIX = "MagdaPluginComponent";
 
+declare type previewMapSettingsAspect = {
+    enable?: boolean;
+    format?: string;
+};
+
+declare type Provenance = {
+    mechanism?: string;
+    sourceSystem?: string;
+    derivedFrom?: {
+        id?: string[];
+        name?: string;
+    }[];
+    isOpenData?: boolean;
+    affiliatedOrganizationIds?: Record_2[];
+};
+
 declare type Publisher = {
     id: string;
     name: string;
@@ -1087,6 +1155,74 @@ declare type Publisher = {
     };
 };
 
+declare type PublishingAspect = {
+    custodianOrgUnitId?: string;
+    managingOrgUnitId?: string;
+    state?: "draft" | "published" | "archived";
+    level?:
+        | "organization"
+        | "custodian"
+        | "team"
+        | "creatorOrgUnit"
+        | "selectedOrgUnit";
+    contactPointDisplay?: "team" | "organization" | "custodian";
+    publishAsOpenData?: {
+        [key: string]: any;
+    };
+};
+
+declare type RawDataset = {
+    id: string;
+    name: string;
+    message?: string;
+    aspects: {
+        "dcat-dataset-strings": DcatDatasetStrings;
+        source?: {
+            url: string;
+            name: string;
+            type: string;
+        };
+        "dataset-publisher"?: DatasetPublisher;
+        "dataset-distributions"?: {
+            distributions: Array<RawDistribution>;
+        };
+        "temporal-coverage"?: TemporalCoverage;
+        provenance?: Provenance;
+        access: Access;
+        version?: VersionAspectData;
+        "dataset-draft"?: DatasetDraft;
+        currency?: CurrencyData;
+        publishing?: PublishingAspect;
+        "preview-map-settings"?: previewMapSettingsAspect;
+    };
+};
+
+declare type RawDistribution = {
+    id: string;
+    name: string;
+    aspects: {
+        "dcat-distribution-strings": dcatDistributionStrings;
+        "source-link-status": {
+            status?: string;
+        };
+        "visualization-info": {
+            fields: any;
+            format: string;
+            timeseries: boolean;
+            wellFormed: boolean;
+            compatiblePreviews: CompatiblePreviews;
+        };
+        "preview-map-settings"?: previewMapSettingsAspect;
+        "spatial-coverage": {
+            bbox?: number[];
+        };
+        publishing: {
+            state?: string;
+        };
+        version?: VersionAspectData;
+    };
+};
+
 declare interface RawPreviewMapFormatPerferenceItem {
     format: string;
     isDataFile?: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/external-ui-plugin-sdk",
   "description": "MAGDA external UI plugin SDK",
-  "version": "2.2.5",
+  "version": "2.3.0-alpha.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.5",
+    "@magda/web-client": "^2.3.0-alpha.0",
     "typescript": "~4.2.4"
   },
   "peerDependencies": {