@esri/hub-common 12.12.0 → 12.13.0

package/dist/esm/versioning/updateVersion.js

@@ -6,16 +6,37 @@ import { getVersionData } from "./_internal/getVersionData";
 import { VERSION_RESOURCE_NAME, VERSION_RESOURCE_PROPERTIES, } from "./_internal/constants";
 import { getIncludeListFromItemType } from "./_internal/getIncludeListFromItemType";
 import { updateItemResource } from "@esri/arcgis-rest-portal";
+import { checkForStaleVersion } from "./utils";
+/**
+ * Custom error to be thrown when attempting to save a stale version
+ * @class StaleVersionError
+ * @extends {Error}
+ */
+class StaleVersionError extends Error {
+    constructor(id, updated) {
+        super(`Version ${id} is stale. Use force to overwrite.`);
+        this.updated = updated;
+        this.name = "StaleVersionError";
+    }
+}
 /**
  * Updates the specified version with with the state of the supplied model
+ * throws an exception if the version is stale and force is not true
  * @param model
  * @param version
  * @param requestOptions
+ * @param force
  * @returns
  */
-export async function updateVersion(model, version, requestOptions) {
+export async function updateVersion(model, version, requestOptions, force) {
     // we expect the model to contain the changes that we want to apply to the version
     // but we also need the versionResource so we can preserve the created and creator props
+    if (!force) {
+        const isStaleResponse = await checkForStaleVersion(model.item.id, version, requestOptions);
+        if (isStaleResponse.isStale) {
+            throw new StaleVersionError(version.id, isStaleResponse.updated);
+        }
+    }
     const includeList = getIncludeListFromItemType(model);
     version.data = getVersionData(model, includeList);
     const prefix = getPrefix(version.id);

package/dist/esm/versioning/updateVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGpE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC;IAEtC,kFAAkF;IAClF,wFAAwF;IAExF,MAAM,WAAW,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,2BAA2B,CAAC,CAAC;IAE1E,MAAM,kBAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,qBAAqB,EAC3B,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,OAAO,EAAE,IAAI,EACb,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGpE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE/C;;;;GAIG;AACH,MAAM,iBAAkB,SAAQ,KAAK;IACnC,YAAY,EAAU,EAAS,OAAe;QAC5C,KAAK,CAAC,WAAW,EAAE,oCAAoC,CAAC,CAAC;QAD5B,YAAO,GAAP,OAAO,CAAQ;QAE5C,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC,EACtC,KAAe;IAEf,kFAAkF;IAClF,wFAAwF;IAExF,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,eAAe,GAAG,MAAM,oBAAoB,CAChD,KAAK,CAAC,IAAI,CAAC,EAAE,EACb,OAAO,EACP,cAAc,CACf,CAAC;QACF,IAAI,eAAe,CAAC,OAAO,EAAE;YAC3B,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;SAClE;KACF;IAED,MAAM,WAAW,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,2BAA2B,CAAC,CAAC;IAE1E,MAAM,kBAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,qBAAqB,EAC3B,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,OAAO,EAAE,IAAI,EACb,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/esm/versioning/utils.js

@@ -1,5 +1,6 @@
 import { cloneObject } from "../util";
 import { mergeObjects } from "../objects/merge-objects";
+import { getVersion } from "./getVersion";
 import { getIncludeListFromItemType } from "./_internal/getIncludeListFromItemType";
 /**
  * Applies the versioned data to the model
@@ -14,4 +15,19 @@ export function applyVersion(model, version, includeList) {
     }
     return mergeObjects(version.data, cloneObject(model), includeList);
 }
+/**
+ * Checks if the upstream version is newer than the passed in version
+ * @param itemId
+ * @param version
+ * @param requestOptions
+ * @returns
+ */
+export async function checkForStaleVersion(itemId, version, requestOptions) {
+    const upstream = await getVersion(itemId, version.id, requestOptions);
+    const isStale = upstream.updated > version.updated;
+    return {
+        isStale,
+        updated: upstream.updated,
+    };
+}
 //# sourceMappingURL=utils.js.map

package/dist/esm/versioning/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/versioning/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAGxD,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AAEpF;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,OAAiB,EACjB,WAAsB;IAEtB,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;KACjD;IACD,OAAO,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;AACrE,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/versioning/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAGxD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AAEpF;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,OAAiB,EACjB,WAAsB;IAEtB,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;KACjD;IACD,OAAO,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;AACrE,CAAC;AAOD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,OAAiB,EACjB,cAAsC;IAEtC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACnD,OAAO;QACL,OAAO;QACP,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC;AACJ,CAAC"}

package/dist/node/versioning/updateVersion.js

@@ -9,16 +9,37 @@ const getVersionData_1 = require("./_internal/getVersionData");
 const constants_1 = require("./_internal/constants");
 const getIncludeListFromItemType_1 = require("./_internal/getIncludeListFromItemType");
 const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const utils_1 = require("./utils");
+/**
+ * Custom error to be thrown when attempting to save a stale version
+ * @class StaleVersionError
+ * @extends {Error}
+ */
+class StaleVersionError extends Error {
+    constructor(id, updated) {
+        super(`Version ${id} is stale. Use force to overwrite.`);
+        this.updated = updated;
+        this.name = "StaleVersionError";
+    }
+}
 /**
  * Updates the specified version with with the state of the supplied model
+ * throws an exception if the version is stale and force is not true
  * @param model
  * @param version
  * @param requestOptions
+ * @param force
  * @returns
  */
-async function updateVersion(model, version, requestOptions) {
+async function updateVersion(model, version, requestOptions, force) {
     // we expect the model to contain the changes that we want to apply to the version
     // but we also need the versionResource so we can preserve the created and creator props
+    if (!force) {
+        const isStaleResponse = await utils_1.checkForStaleVersion(model.item.id, version, requestOptions);
+        if (isStaleResponse.isStale) {
+            throw new StaleVersionError(version.id, isStaleResponse.updated);
+        }
+    }
     const includeList = getIncludeListFromItemType_1.getIncludeListFromItemType(model);
     version.data = getVersionData_1.getVersionData(model, includeList);
     const prefix = getPrefix_1.getPrefix(version.id);

package/dist/node/versioning/updateVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":";;;AACA,kDAA8C;AAC9C,4DAAwD;AACxD,0EAAoE;AAGpE,qDAAkD;AAClD,+DAA4D;AAC5D,qDAG+B;AAC/B,uFAAoF;AACpF,iEAA8D;AAE9D;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC;IAEtC,kFAAkF;IAClF,wFAAwF;IAExF,MAAM,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,+BAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,sCAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,4BAAY,CAAC,OAAO,EAAE,EAAE,EAAE,uCAA2B,CAAC,CAAC;IAE1E,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,kBAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EAAE,kBAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,OAAO,EAAE,IAAI,EACb,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AA7BD,sCA6BC"}
+{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":";;;AACA,kDAA8C;AAC9C,4DAAwD;AACxD,0EAAoE;AAGpE,qDAAkD;AAClD,+DAA4D;AAC5D,qDAG+B;AAC/B,uFAAoF;AACpF,iEAA8D;AAC9D,mCAA+C;AAE/C;;;;GAIG;AACH,MAAM,iBAAkB,SAAQ,KAAK;IACnC,YAAY,EAAU,EAAS,OAAe;QAC5C,KAAK,CAAC,WAAW,EAAE,oCAAoC,CAAC,CAAC;QAD5B,YAAO,GAAP,OAAO,CAAQ;QAE5C,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC,EACtC,KAAe;IAEf,kFAAkF;IAClF,wFAAwF;IAExF,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,eAAe,GAAG,MAAM,4BAAoB,CAChD,KAAK,CAAC,IAAI,CAAC,EAAE,EACb,OAAO,EACP,cAAc,CACf,CAAC;QACF,IAAI,eAAe,CAAC,OAAO,EAAE;YAC3B,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;SAClE;KACF;IAED,MAAM,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,+BAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,sCAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,4BAAY,CAAC,OAAO,EAAE,EAAE,EAAE,uCAA2B,CAAC,CAAC;IAE1E,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,kBAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EAAE,kBAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,OAAO,EAAE,IAAI,EACb,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAzCD,sCAyCC"}

package/dist/node/versioning/utils.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyVersion = void 0;
+exports.checkForStaleVersion = exports.applyVersion = void 0;
 const util_1 = require("../util");
 const merge_objects_1 = require("../objects/merge-objects");
+const getVersion_1 = require("./getVersion");
 const getIncludeListFromItemType_1 = require("./_internal/getIncludeListFromItemType");
 /**
  * Applies the versioned data to the model
@@ -18,4 +19,20 @@ function applyVersion(model, version, includeList) {
     return merge_objects_1.mergeObjects(version.data, util_1.cloneObject(model), includeList);
 }
 exports.applyVersion = applyVersion;
+/**
+ * Checks if the upstream version is newer than the passed in version
+ * @param itemId
+ * @param version
+ * @param requestOptions
+ * @returns
+ */
+async function checkForStaleVersion(itemId, version, requestOptions) {
+    const upstream = await getVersion_1.getVersion(itemId, version.id, requestOptions);
+    const isStale = upstream.updated > version.updated;
+    return {
+        isStale,
+        updated: upstream.updated,
+    };
+}
+exports.checkForStaleVersion = checkForStaleVersion;
 //# sourceMappingURL=utils.js.map

package/dist/node/versioning/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/versioning/utils.ts"],"names":[],"mappings":";;;AAAA,kCAAsC;AACtC,4DAAwD;AAGxD,uFAAoF;AAEpF;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,KAAa,EACb,OAAiB,EACjB,WAAsB;IAEtB,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;KACjD;IACD,OAAO,4BAAY,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAW,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;AACrE,CAAC;AATD,oCASC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/versioning/utils.ts"],"names":[],"mappings":";;;AAAA,kCAAsC;AACtC,4DAAwD;AAGxD,6CAA0C;AAC1C,uFAAoF;AAEpF;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,KAAa,EACb,OAAiB,EACjB,WAAsB;IAEtB,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;KACjD;IACD,OAAO,4BAAY,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAW,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;AACrE,CAAC;AATD,oCASC;AAOD;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,OAAiB,EACjB,cAAsC;IAEtC,MAAM,QAAQ,GAAG,MAAM,uBAAU,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACnD,OAAO;QACL,OAAO;QACP,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC;AACJ,CAAC;AAXD,oDAWC"}

package/dist/types/versioning/updateVersion.d.ts

@@ -3,9 +3,11 @@ import { IModel } from "../types";
 import { IVersion } from "./types";
 /**
  * Updates the specified version with with the state of the supplied model
+ * throws an exception if the version is stale and force is not true
  * @param model
  * @param version
  * @param requestOptions
+ * @param force
  * @returns
  */
-export declare function updateVersion(model: IModel, version: IVersion, requestOptions: IHubUserRequestOptions): Promise<IVersion>;
+export declare function updateVersion(model: IModel, version: IVersion, requestOptions: IHubUserRequestOptions, force?: boolean): Promise<IVersion>;

package/dist/types/versioning/utils.d.ts

@@ -1,4 +1,4 @@
-import { IModel } from "../types";
+import { IHubUserRequestOptions, IModel } from "../types";
 import { IVersion } from "./types/IVersion";
 /**
  * Applies the versioned data to the model
@@ -8,3 +8,16 @@ import { IVersion } from "./types/IVersion";
  * @returns
  */
 export declare function applyVersion(model: IModel, version: IVersion, includeList?: string[]): IModel;
+interface IStaleVersionResponse {
+    isStale: boolean;
+    updated: number;
+}
+/**
+ * Checks if the upstream version is newer than the passed in version
+ * @param itemId
+ * @param version
+ * @param requestOptions
+ * @returns
+ */
+export declare function checkForStaleVersion(itemId: string, version: IVersion, requestOptions: IHubUserRequestOptions): Promise<IStaleVersionResponse>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "12.12.0",
+  "version": "12.13.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",