sodas-sdk 1.1.11 → 1.1.12

package/dist/SODAS_SDK_CLASS/DCAT/dataset.d.ts

@@ -46,6 +46,8 @@ declare class Dataset extends DCAT_RESOURCE {
     toDTO(): DatasetDTO;
     populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
     populateDistributionFromDTO(dto: DatasetDTO): Promise<void>;
+    static syncToCurrentHub(dataset: Dataset): Promise<void>;
+    populateToSync(source: Dataset): void;
     createDBRecord(): Promise<void>;
     private deleteNotMaintainedDistributions;
     updateDBRecord(): Promise<void>;

package/dist/SODAS_SDK_CLASS/DCAT/datasetSeries.d.ts

@@ -27,6 +27,19 @@ declare class DatasetSeries extends DCAT_RESOURCE {
     private WasGeneratedBy;
     private SeriesMembers;
     private SeriesMemberIDs;
+    static syncToCurrentHub(datasetSeries: DatasetSeries): Promise<void>;
+    /**
+     * Populates this instance with values from the given DatasetSeries, except for:
+     * - DB identity / temporal fields (ID, IRI, Issued, Modified, CreatedAt, UpdatedAt)
+     * - Version/lineage fields (IsVersionOf, PreviousVersionID, NextVersionID, VersionInfos)
+     * - Series identity fields (DatasetSeriesID, InSeriesID)
+     * - Fields explicitly set to `undefined` on the source instance
+     *
+     * Additionally, when SeriesMembers are present on the source, this method
+     * resolves each member via Dataset.getDBRecordByAssetID (by AssetID) and
+     * replaces this.SeriesMemberIDs with the resolved IDs.
+     */
+    populateToSync(source: DatasetSeries): Promise<void>;
     /**
      * Initializes or updates the API_URL and LIST_URL for Dataset.
      *
@@ -38,10 +51,17 @@ declare class DatasetSeries extends DCAT_RESOURCE {
     populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
     populateSeriesMembersFromDTO(dto: DatasetSeriesDTO): Promise<void>;
     deleteDBRecord(): Promise<void>;
+    /**
+     * Creates a dataset series DB record in an interoperated context
+     * (e.g. together with related Dataset instances or other resources).
+     *
+     * The implementation will be added later.
+     */
+    createInteroperatedDBRecord(): Promise<void>;
     appendSeriesMember(dataset: Dataset): void;
     switchSeriesMembers(index1: number, index2: number): void;
     get datasetSeriesID(): IDType;
-    get seriesMembereIDs(): IDType[];
+    get seriesMemberIDs(): IDType[];
     get seriesMembers(): Dataset[];
     get frequency(): string;
     set frequency(value: string);

package/dist/SODAS_SDK_CLASS/DCAT/distribution.d.ts

@@ -44,6 +44,12 @@ declare class Distribution extends DCAT_MODEL {
     private TitleML;
     private HasPolicy;
     private Checksum;
+    /**
+     * Populates this instance with values from the given Distribution, except for:
+     * - DB identity / temporal fields (ID, IRI, Issued, Modified, CreatedAt, UpdatedAt)
+     * - Fields that are explicitly set to `undefined` on the source instance
+     */
+    populateToSync(source: Distribution): void;
     toDTO(): DistributionDTO;
     populateFromDTO(dto: DCAT_MODEL_DTO): Promise<void>;
     /**

package/dist/SODAS_SDK_CLASS/dcatClass.d.ts

@@ -23,6 +23,13 @@ declare abstract class DCAT_MODEL extends SODAS_SDK_CLASS {
     createDBRecord(): Promise<void>;
     static getDBRecord<GENERIC_DCAT_MODEL extends DCAT_MODEL>(this: DCAT_MODEL_STATIC<GENERIC_DCAT_MODEL>, ID: IDType): Promise<GENERIC_DCAT_MODEL>;
     static getDBRecordByAssetID<GENERIC_DCAT_MODEL extends DCAT_MODEL>(this: DCAT_MODEL_STATIC<GENERIC_DCAT_MODEL>, assetID: IDType): Promise<GENERIC_DCAT_MODEL>;
+    /**
+     * Checks whether a DB record exists for the given AssetID and returns its ID.
+     *
+     * This method wraps getDBRecordByAssetID and converts a 404 response to `null`,
+     * while rethrowing any other kind of error.
+     */
+    static checkDBRecordOfAssetID(assetID: IDType): Promise<IDType | null>;
     updateDBRecord(): Promise<void>;
     deleteDBRecord(): Promise<void>;
     get createdAt(): Date;

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/dataset/interoperation.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/dataset/populateToSync.small.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/datasetSeries/interoperation.medium.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/datasetSeries/populateToSync.small.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/SODAS_SDK_CLASS/DCAT/distribution/populateToSync.small.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.browser.js

@@ -2501,6 +2501,70 @@ class Dataset extends _dcatResource__WEBPACK_IMPORTED_MODULE_4__["default"] {
             }
         });
     }
+    static syncToCurrentHub(dataset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            try {
+                const checkExisting = yield Dataset.getDBRecordByAssetID((0,_core_type__WEBPACK_IMPORTED_MODULE_1__.asID)(dataset.assetID));
+                if (checkExisting) {
+                    checkExisting.populateToSync(dataset);
+                    yield checkExisting.updateDBRecord();
+                }
+            }
+            catch (error) {
+                if (axios__WEBPACK_IMPORTED_MODULE_6__["default"].isAxiosError(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                    const newDataset = new Dataset();
+                    newDataset.populateToSync(dataset);
+                    yield newDataset.createDBRecord();
+                }
+                else {
+                    throw error;
+                }
+            }
+        });
+    }
+    populateToSync(source) {
+        const excludedKeys = new Set([
+            "ID",
+            "DatasetID",
+            "IsVersionOf",
+            "PreviousVersionID",
+            "NextVersionID",
+            "VersionInfos",
+            "InSeriesID",
+            "FirstID",
+            "PreviousID",
+            "NextID",
+            "LastID",
+            "DistributionIDs",
+        ]);
+        for (const key in source) {
+            if (!Object.prototype.hasOwnProperty.call(source, key))
+                continue;
+            if (key === "Distributions")
+                continue;
+            if (excludedKeys.has(key))
+                continue;
+            const value = source[key];
+            if (value !== undefined) {
+                this[key] = value;
+            }
+        }
+        // Handle distributions separately so that we can preserve identity fields
+        // of existing distributions while syncing other fields, and create new
+        // distributions for any additional ones in the source.
+        const sourceDistributions = source.Distributions;
+        if (!sourceDistributions || sourceDistributions.length === 0) {
+            return;
+        }
+        this.Distributions = [];
+        for (let i = 0; i < sourceDistributions.length; i++) {
+            const srcDist = sourceDistributions[i];
+            const targetDist = new _distribution__WEBPACK_IMPORTED_MODULE_5__["default"]();
+            targetDist.populateToSync(srcDist);
+            this.Distributions.push(targetDist);
+        }
+    }
     createDBRecord() {
         const _super = Object.create(null, {
             createDBRecord: { get: () => super.createDBRecord }
@@ -2690,6 +2754,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
 /* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
 /* harmony export */ });
+/* harmony import */ var axios__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! axios */ "./node_modules/axios/lib/axios.js");
 /* harmony import */ var _core_error__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../../core/error */ "./lib/core/error.ts");
 /* harmony import */ var _core_type__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../../core/type */ "./lib/core/type.ts");
 /* harmony import */ var _core_util__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ../../core/util */ "./lib/core/util.ts");
@@ -2709,10 +2774,105 @@ var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _argume
 
 
 
+
 /**
  * Represents a series of datasets.
  */
 class DatasetSeries extends _dcatResource__WEBPACK_IMPORTED_MODULE_4__["default"] {
+    static syncToCurrentHub(datasetSeries) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            try {
+                const checkExisting = yield DatasetSeries.getDBRecordByAssetID((0,_core_type__WEBPACK_IMPORTED_MODULE_1__.asID)(datasetSeries.assetID));
+                if (checkExisting) {
+                    yield checkExisting.populateToSync(datasetSeries);
+                    yield checkExisting.updateDBRecord();
+                }
+            }
+            catch (error) {
+                if (axios__WEBPACK_IMPORTED_MODULE_5__["default"].isAxiosError(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                    const newDatasetSeries = new DatasetSeries();
+                    yield newDatasetSeries.populateToSync(datasetSeries);
+                    yield newDatasetSeries.createDBRecord();
+                }
+                else {
+                    throw error;
+                }
+            }
+        });
+    }
+    /**
+     * Populates this instance with values from the given DatasetSeries, except for:
+     * - DB identity / temporal fields (ID, IRI, Issued, Modified, CreatedAt, UpdatedAt)
+     * - Version/lineage fields (IsVersionOf, PreviousVersionID, NextVersionID, VersionInfos)
+     * - Series identity fields (DatasetSeriesID, InSeriesID)
+     * - Fields explicitly set to `undefined` on the source instance
+     *
+     * Additionally, when SeriesMembers are present on the source, this method
+     * resolves each member via Dataset.getDBRecordByAssetID (by AssetID) and
+     * replaces this.SeriesMemberIDs with the resolved IDs.
+     */
+    populateToSync(source) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const excludedKeys = new Set([
+                "ID",
+                "IsVersionOf",
+                "PreviousVersionID",
+                "NextVersionID",
+                "VersionInfos",
+                "DatasetSeriesID",
+                "InSeriesID",
+            ]);
+            for (const key in source) {
+                if (!Object.prototype.hasOwnProperty.call(source, key))
+                    continue;
+                if (key === "SeriesMembers")
+                    continue;
+                if (excludedKeys.has(key))
+                    continue;
+                const value = source[key];
+                if (value !== undefined) {
+                    this[key] = value;
+                }
+            }
+            this.SeriesMembers = [];
+            const sourceMembers = source.SeriesMembers;
+            if (!sourceMembers || sourceMembers.length === 0) {
+                return;
+            }
+            const resolvedIDs = [];
+            for (const member of sourceMembers) {
+                if (!member)
+                    continue;
+                const assetIDStr = member.assetID;
+                if (!assetIDStr)
+                    continue;
+                const assetID = (0,_core_type__WEBPACK_IMPORTED_MODULE_1__.asID)(assetIDStr);
+                // Prefer existing record by AssetID; if not found, create a new one.
+                try {
+                    const existing = yield _dataset__WEBPACK_IMPORTED_MODULE_3__["default"].getDBRecordByAssetID(assetID);
+                    if (existing) {
+                        existing.populateToSync(member);
+                        yield existing.updateDBRecord();
+                        resolvedIDs.push(existing.id);
+                    }
+                }
+                catch (error) {
+                    if (axios__WEBPACK_IMPORTED_MODULE_5__["default"].isAxiosError(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                        const newMember = new _dataset__WEBPACK_IMPORTED_MODULE_3__["default"]();
+                        newMember.populateToSync(member);
+                        yield newMember.createDBRecord();
+                        resolvedIDs.push(newMember.id);
+                    }
+                    else {
+                        throw error;
+                    }
+                }
+            }
+            this.SeriesMemberIDs = resolvedIDs;
+        });
+    }
     /**
      * Initializes or updates the API_URL and LIST_URL for Dataset.
      *
@@ -2753,11 +2913,17 @@ class DatasetSeries extends _dcatResource__WEBPACK_IMPORTED_MODULE_4__["default"
     }
     populateSeriesMembersFromDTO(dto) {
         return __awaiter(this, void 0, void 0, function* () {
+            this.SeriesMembers = [];
             if (dto.SeriesMemberIDs && dto.SeriesMemberIDs.length != 0) {
                 this.SeriesMemberIDs = (0,_core_type__WEBPACK_IMPORTED_MODULE_1__.asIDs)(dto.SeriesMemberIDs);
-                this.SeriesMembers = yield Promise.all(dto.SeriesMemberIDs.map((seriesMemberID) => __awaiter(this, void 0, void 0, function* () {
-                    return yield _dataset__WEBPACK_IMPORTED_MODULE_3__["default"].getDBRecord(seriesMemberID);
-                })));
+                if (this.SeriesMemberIDs && this.SeriesMemberIDs.length != 0) {
+                    for (const seriesMemberID of this.SeriesMemberIDs) {
+                        const seriesMember = yield _dataset__WEBPACK_IMPORTED_MODULE_3__["default"].getDBRecord(seriesMemberID);
+                        if (seriesMember) {
+                            this.SeriesMembers.push(seriesMember);
+                        }
+                    }
+                }
             }
         });
     }
@@ -2776,6 +2942,17 @@ class DatasetSeries extends _dcatResource__WEBPACK_IMPORTED_MODULE_4__["default"
             yield _super.deleteDBRecord.call(this);
         });
     }
+    /**
+     * Creates a dataset series DB record in an interoperated context
+     * (e.g. together with related Dataset instances or other resources).
+     *
+     * The implementation will be added later.
+     */
+    createInteroperatedDBRecord() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: Implement interoperated create logic.
+        });
+    }
     appendSeriesMember(dataset) {
         if (!this.SeriesMemberIDs) {
             this.SeriesMemberIDs = [];
@@ -2808,7 +2985,7 @@ class DatasetSeries extends _dcatResource__WEBPACK_IMPORTED_MODULE_4__["default"
     get datasetSeriesID() {
         return this.DatasetSeriesID;
     }
-    get seriesMembereIDs() {
+    get seriesMemberIDs() {
         return this.SeriesMemberIDs;
     }
     get seriesMembers() {
@@ -3232,8 +3409,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
 /* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
 /* harmony export */ });
-/* harmony import */ var _core_type__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../../core/type */ "./lib/core/type.ts");
-/* harmony import */ var _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../../SODAS_SDK_FILE/dataFile */ "./lib/SODAS_SDK_FILE/dataFile.ts");
+/* harmony import */ var _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../../SODAS_SDK_FILE/dataFile */ "./lib/SODAS_SDK_FILE/dataFile.ts");
+/* harmony import */ var _core_type__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ../../core/type */ "./lib/core/type.ts");
 /* harmony import */ var _dcatClass__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ../dcatClass */ "./lib/SODAS_SDK_CLASS/dcatClass.ts");
 var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -3248,6 +3425,24 @@ var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _argume
 
 
 class Distribution extends _dcatClass__WEBPACK_IMPORTED_MODULE_2__["default"] {
+    /**
+     * Populates this instance with values from the given Distribution, except for:
+     * - DB identity / temporal fields (ID, IRI, Issued, Modified, CreatedAt, UpdatedAt)
+     * - Fields that are explicitly set to `undefined` on the source instance
+     */
+    populateToSync(source) {
+        const excludedKeys = new Set(["ID", "IsDistributionOf", "AccessServiceID"]);
+        for (const key in source) {
+            if (!Object.prototype.hasOwnProperty.call(source, key))
+                continue;
+            if (excludedKeys.has(key))
+                continue;
+            const value = source[key];
+            if (value !== undefined) {
+                this[key] = value;
+            }
+        }
+    }
     toDTO() {
         return Object.assign(Object.assign(Object.assign(Object.assign({}, super.toDTO()), (this.IsDistributionOf && { IsDistributionOf: this.IsDistributionOf })), (this.AccessServiceID && { AccessServiceID: this.AccessServiceID })), { AccessURL: this.AccessURL, ByteSize: this.ByteSize, CompressFormat: this.CompressFormat, DownloadURL: this.DownloadURL, MediaType: this.MediaType, PackageFormat: this.PackageFormat, SpatialResolutionInMeters: this.SpatialResolutionInMeters, TemporalResolution: this.TemporalResolution, AccessRights: this.AccessRights, ConformsTo: this.ConformsTo, DescriptionML: this.DescriptionML, Format: this.Format, License: this.License, Rights: this.Rights, TitleML: this.TitleML, HasPolicy: this.HasPolicy, Checksum: this.Checksum });
     }
@@ -3259,7 +3454,7 @@ class Distribution extends _dcatClass__WEBPACK_IMPORTED_MODULE_2__["default"] {
             yield _super.populateFromDTO.call(this, dto);
             const distributionDTO = dto;
             distributionDTO.AccessServiceID &&
-                (this.AccessServiceID = (0,_core_type__WEBPACK_IMPORTED_MODULE_0__.asID)(distributionDTO.AccessServiceID));
+                (this.AccessServiceID = (0,_core_type__WEBPACK_IMPORTED_MODULE_1__.asID)(distributionDTO.AccessServiceID));
             distributionDTO.AccessURL && (this.AccessURL = distributionDTO.AccessURL);
             distributionDTO.ByteSize && (this.ByteSize = distributionDTO.ByteSize);
             distributionDTO.CompressFormat &&
@@ -3287,7 +3482,7 @@ class Distribution extends _dcatClass__WEBPACK_IMPORTED_MODULE_2__["default"] {
             distributionDTO.HasPolicy && (this.HasPolicy = distributionDTO.HasPolicy);
             distributionDTO.Checksum && (this.Checksum = distributionDTO.Checksum);
             distributionDTO.IsDistributionOf &&
-                (this.IsDistributionOf = (0,_core_type__WEBPACK_IMPORTED_MODULE_0__.asID)(distributionDTO.IsDistributionOf));
+                (this.IsDistributionOf = (0,_core_type__WEBPACK_IMPORTED_MODULE_1__.asID)(distributionDTO.IsDistributionOf));
         });
     }
     /**
@@ -3303,7 +3498,7 @@ class Distribution extends _dcatClass__WEBPACK_IMPORTED_MODULE_2__["default"] {
         Distribution.DOWNLOAD_API_URL = `${url}/data/download`;
     }
     static configureBucketName(bucketName) {
-        _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_1__["default"].configureBucketName(bucketName);
+        _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_0__["default"].configureBucketName(bucketName);
     }
     /**
      * Sets file information for a browser environment.
@@ -3311,7 +3506,7 @@ class Distribution extends _dcatClass__WEBPACK_IMPORTED_MODULE_2__["default"] {
      */
     setUploadingDataForBrowser(file) {
         if (!this.UploadingData) {
-            this.UploadingData = new _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_1__["default"]();
+            this.UploadingData = new _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_0__["default"]();
         }
         this.UploadingData.setFileForBrowser(file);
     }
@@ -3321,7 +3516,7 @@ class Distribution extends _dcatClass__WEBPACK_IMPORTED_MODULE_2__["default"] {
      */
     setUploadingDataForNode(filePath) {
         if (!this.UploadingData) {
-            this.UploadingData = new _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_1__["default"]();
+            this.UploadingData = new _SODAS_SDK_FILE_dataFile__WEBPACK_IMPORTED_MODULE_0__["default"]();
         }
         this.UploadingData.setFileForNode(filePath);
     }
@@ -3514,7 +3709,7 @@ class Distribution extends _dcatClass__WEBPACK_IMPORTED_MODULE_2__["default"] {
         return this.IsDistributionOf;
     }
     set isDistributionOf(value) {
-        this.IsDistributionOf = (0,_core_type__WEBPACK_IMPORTED_MODULE_0__.asID)(value);
+        this.IsDistributionOf = (0,_core_type__WEBPACK_IMPORTED_MODULE_1__.asID)(value);
     }
 }
 /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (Distribution);
@@ -3767,6 +3962,27 @@ class DCAT_MODEL extends _sodasSDKClass__WEBPACK_IMPORTED_MODULE_3__["default"]
             }
         });
     }
+    /**
+     * Checks whether a DB record exists for the given AssetID and returns its ID.
+     *
+     * This method wraps getDBRecordByAssetID and converts a 404 response to `null`,
+     * while rethrowing any other kind of error.
+     */
+    static checkDBRecordOfAssetID(assetID) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            try {
+                const record = (yield this.getDBRecordByAssetID(assetID));
+                return record.id;
+            }
+            catch (error) {
+                if (axios__WEBPACK_IMPORTED_MODULE_4__["default"].isAxiosError(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                    return null;
+                }
+                throw error;
+            }
+        });
+    }
     updateDBRecord() {
         return __awaiter(this, void 0, void 0, function* () {
             this.throwErrorIfAPIURLNotSet();