@esri/hub-common 12.6.1 → 12.8.0

package/dist/node/versioning/updateVersion.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateVersion = void 0;
+const get_prop_1 = require("../objects/get-prop");
+const merge_objects_1 = require("../objects/merge-objects");
+const object_to_json_blob_1 = require("../resources/object-to-json-blob");
+const getPrefix_1 = require("./_internal/getPrefix");
+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");
+/**
+ * Updates the specified version with with the state of the supplied model
+ * @param model
+ * @param version
+ * @param requestOptions
+ * @returns
+ */
+async function updateVersion(model, version, requestOptions) {
+    // 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
+    const includeList = getIncludeListFromItemType_1.getIncludeListFromItemType(model);
+    version.data = getVersionData_1.getVersionData(model, includeList);
+    const prefix = getPrefix_1.getPrefix(version.id);
+    version.updated = Date.now();
+    const versionBlob = object_to_json_blob_1.objectToJsonBlob(version);
+    const properties = merge_objects_1.mergeObjects(version, {}, constants_1.VERSION_RESOURCE_PROPERTIES);
+    await arcgis_rest_portal_1.updateItemResource(Object.assign(Object.assign({}, requestOptions), { id: get_prop_1.getProp(model, "item.id"), name: constants_1.VERSION_RESOURCE_NAME, owner: get_prop_1.getProp(model, "item.owner"), params: { properties }, prefix, private: true, resource: versionBlob }));
+    return version;
+}
+exports.updateVersion = updateVersion;
+//# sourceMappingURL=updateVersion.js.map

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

@@ -0,0 +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"}

package/dist/node/versioning/utils.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyVersion = void 0;
+const util_1 = require("../util");
+const merge_objects_1 = require("../objects/merge-objects");
+const getIncludeListFromItemType_1 = require("./_internal/getIncludeListFromItemType");
+/**
+ * Applies the versioned data to the model
+ * @param model
+ * @param version
+ * @param includeList
+ * @returns
+ */
+function applyVersion(model, version, includeList) {
+    if (!includeList) {
+        includeList = getIncludeListFromItemType_1.getIncludeListFromItemType(model);
+    }
+    return merge_objects_1.mergeObjects(version.data, util_1.cloneObject(model), includeList);
+}
+exports.applyVersion = applyVersion;
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +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"}

package/dist/types/core/behaviors/IWithVersioningBehavior.d.ts

@@ -0,0 +1,36 @@
+import { ICreateVersionOptions, IVersion, IVersionMetadata } from "../../versioning";
+/**
+ * Composable behavior that adds versioning to an entity
+ */
+export interface IWithVersioningBehavior {
+    /**
+     * Gets all the versions of the entity
+     * @returns
+     */
+    searchVersions(): Promise<IVersionMetadata[]>;
+    /**
+     * Gets the specified version of the entity
+     * @param versionId
+     * @returns
+     */
+    getVersion(versionId: string): Promise<IVersion>;
+    /**
+     * Creates a new version of the entity
+     * @param options
+     * @returns
+     */
+    createVersion(options?: ICreateVersionOptions): Promise<IVersion>;
+    /**
+     * Updates the specified version of the entity
+     * @param version
+     * @returns
+     */
+    updateVersion(version: IVersion): Promise<IVersion>;
+    /**
+     * Deletes the specified version of the entity
+     * @returns
+     */
+    deleteVersion(versionId: string): Promise<{
+        success: boolean;
+    }>;
+}

package/dist/types/core/behaviors/index.d.ts

@@ -4,3 +4,4 @@ export * from "./IWithStoreBehavior";
 export * from "./IWithSharingBehavior";
 export * from "./IWithEditorBehavior";
 export * from "./IWithFeaturedImageBehavior";
+export * from "./IWithVersioningBehavior";

package/dist/types/core/types/IHubSite.d.ts

@@ -1,11 +1,12 @@
 import { IExtent } from "@esri/arcgis-rest-feature-layer";
+import { IWithVersioningBehavior } from "../behaviors";
 import { IWithCatalog, IWithLayout, IWithPermissions, IWithSlug } from "../traits/index";
 import { IHubItemEntity } from "./IHubItemEntity";
 /**
  * DRAFT: Under development and more properties will likely be added
  * @internal
  */
-export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissions {
+export interface IHubSite extends IHubItemEntity, IWithSlug, IWithCatalog, IWithLayout, IWithPermissions, IWithVersioningBehavior {
     /**
      * Array of minimal page objects
      */

package/dist/types/index.d.ts

@@ -29,6 +29,7 @@ export * from "./urls";
 export * from "./users";
 export * from "./util";
 export * from "./utils";
+export * from "./versioning";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 import HubError from "./HubError";

package/dist/types/pages/_internal/PageBusinessRules.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Page versioning include list
+ */
+export declare const PageVersionIncludeList: string[];

package/dist/types/sites/HubSite.d.ts

@@ -1,13 +1,14 @@
-import { IHubSite, IWithPermissionBehavior, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior } from "../core";
+import { IHubSite, IWithPermissionBehavior, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, IWithVersioningBehavior } from "../core";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
 import { IContainsResponse, IDeepCatalogInfo } from "../search";
+import { ICreateVersionOptions, IVersion, IVersionMetadata } from "../versioning";
 /**
  * Hub Site Class
  * NOTE: This is a minimal implementation. Create operations are not supported at this time
  */
-export declare class HubSite extends HubItemEntity<IHubSite> implements IWithStoreBehavior<IHubSite>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior {
+export declare class HubSite extends HubItemEntity<IHubSite> implements IWithStoreBehavior<IHubSite>, IWithPermissionBehavior, IWithCatalogBehavior, IWithSharingBehavior, IWithVersioningBehavior {
     private _catalog;
     private _catalogCache;
     /**
@@ -94,4 +95,34 @@ export declare class HubSite extends HubItemEntity<IHubSite> implements IWithSto
      * @returns
      */
     contains(identifier: string, hierarchy?: IDeepCatalogInfo[]): Promise<IContainsResponse>;
+    /**
+     * Gets all the versions of the site
+     * @returns
+     */
+    searchVersions(): Promise<IVersionMetadata[]>;
+    /**
+     * Gets the specified version of the site
+     * @param versionId
+     * @returns
+     */
+    getVersion(versionId: string): Promise<IVersion>;
+    /**
+     * Creates a new version of the site
+     * @param options
+     * @returns
+     */
+    createVersion(options?: ICreateVersionOptions): Promise<IVersion>;
+    /**
+     * Updates the specified version of the site
+     * @param version
+     * @returns
+     */
+    updateVersion(version: IVersion): Promise<IVersion>;
+    /**
+     * Deletes the specified version of the entity
+     * @returns
+     */
+    deleteVersion(versionId: string): Promise<{
+        success: boolean;
+    }>;
 }

package/dist/types/sites/_internal/SiteBusinessRules.d.ts

@@ -23,3 +23,7 @@ export declare const SitePermissions: readonly ["hub:site:create", "hub:site:del
  * @private
  */
 export declare const SitesPermissionPolicies: IPermissionPolicy[];
+/**
+ * Site versioning include list
+ */
+export declare const SiteVersionIncludeList: string[];

package/dist/types/sites/_internal/_migrate-event-list-card-configs.d.ts

@@ -0,0 +1,8 @@
+import { IModel, IDraft } from "../../types";
+/**
+ * Reconfigure event list card properties
+ * @private
+ * @param {object} model Site Model
+ * @returns {object}
+ */
+export declare function _migrateEventListCardConfigs<T extends IModel | IDraft>(model: T): T;

package/dist/types/sites/site-schema-version.d.ts

@@ -1 +1 @@
-export declare const SITE_SCHEMA_VERSION = 1.5;
+export declare const SITE_SCHEMA_VERSION = 1.6;

package/dist/types/versioning/_internal/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION_RESOURCE_NAME = "version.json";
+export declare const VERSION_RESOURCE_PROPERTIES: string[];

package/dist/types/versioning/_internal/getIncludeListFromItemType.d.ts

@@ -0,0 +1,7 @@
+import { IModel } from "../../types";
+/**
+ * Gets the include list for the model type
+ * @param model
+ * @returns
+ */
+export declare function getIncludeListFromItemType(model: IModel): string[];

package/dist/types/versioning/_internal/getPrefix.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns the prefix (the "folder" name)
+ * @param versionId
+ * @private
+ */
+export declare function getPrefix(versionId: string): string;

package/dist/types/versioning/_internal/getResourceNameFromVersionId.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns the resource name
+ * @param versionId
+ * @private
+ */
+export declare function getResourceNameFromVersionId(versionId: string): string;

package/dist/types/versioning/_internal/getVersionData.d.ts

@@ -0,0 +1,8 @@
+import { IModel } from "../../types";
+/**
+ * Returns the version data (ie the part of the model that gets versioned) from the model
+ * @param model
+ * @param includeList
+ * @private
+ */
+export declare function getVersionData(model: IModel, includeList: string[]): Record<string, any>;

package/dist/types/versioning/_internal/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./getPrefix";
+export * from "./getResourceNameFromVersionId";
+export * from "./getVersionData";
+export * from "./versionMetadataFromResource";

package/dist/types/versioning/_internal/versionMetadataFromResource.d.ts

@@ -0,0 +1,7 @@
+import { IVersionMetadata } from "../types";
+/**
+ * Returns an IVersionMetadata from the resource search result item
+ * @param resource
+ * @private
+ */
+export declare function versionMetadataFromResource(resource: Record<string, any>): IVersionMetadata;

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

@@ -0,0 +1,10 @@
+import { IHubUserRequestOptions } from "../types";
+import { ICreateVersionOptions, IVersion } from "./types";
+import { IModel } from "../types";
+/**
+ * Creates and returns a new version of the entity
+ * @param entity
+ * @param requestOptions
+ * @returns
+ */
+export declare function createVersion(model: IModel, requestOptions: IHubUserRequestOptions, options?: ICreateVersionOptions): Promise<IVersion>;

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

@@ -0,0 +1,12 @@
+import { IHubUserRequestOptions } from "../types";
+/**
+ * Deletes the version specified by the entity id and versionId
+ * @param id
+ * @param versionId
+ * @param owner
+ * @param requestOptions
+ * @returns
+ */
+export declare function deleteVersion(id: string, versionId: string, owner: string, requestOptions: IHubUserRequestOptions): Promise<{
+    success: boolean;
+}>;

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

@@ -0,0 +1,10 @@
+import { IHubUserRequestOptions } from "../types";
+import { IVersion } from "./types";
+/**
+ * Returns an IVersion object for the specified entity id and versionId
+ * @param id
+ * @param versionId
+ * @param requestOptions
+ * @returns
+ */
+export declare function getVersion(id: string, versionId: string, requestOptions: IHubUserRequestOptions): Promise<IVersion>;

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

@@ -0,0 +1,7 @@
+export * from "./createVersion";
+export * from "./deleteVersion";
+export * from "./getVersion";
+export * from "./types";
+export * from "./searchVersions";
+export * from "./updateVersion";
+export * from "./utils";

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

@@ -0,0 +1,9 @@
+import { IHubUserRequestOptions } from "../types";
+import { IVersionMetadata } from "./types";
+/**
+ * Returns an array containing the versions of the specified item
+ * @param id
+ * @param requestOptions
+ * @returns
+ */
+export declare function searchVersions(id: string, requestOptions: IHubUserRequestOptions): Promise<IVersionMetadata[]>;

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

@@ -0,0 +1,13 @@
+/**
+ * Options for creating a new version of an entity
+ */
+export interface ICreateVersionOptions {
+    /**
+     * Optional name of the version
+     */
+    name?: string;
+    /**
+     * Optional parentId (the versionId of the parent version)
+     */
+    parentId?: string;
+}

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

@@ -0,0 +1,11 @@
+import { IVersionMetadata } from "./IVersionMetadata";
+/**
+ * The version of the entity.
+ * This contains the metadata about the version and the versioned data itself.
+ */
+export interface IVersion extends IVersionMetadata {
+    /**
+     * The versioned data
+     */
+    data: Record<string, any>;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * Metadata pertaining to the version
+ * This is what we get back when we search for versions of an entity.
+ */
+export interface IVersionMetadata {
+    /**
+     * The access level of the version resource
+     */
+    access?: string;
+    /**
+     * The created timestamp
+     */
+    created: number;
+    /**
+     * The username of the creator
+     */
+    creator: string;
+    /**
+     * The id of the version
+     */
+    id: string;
+    /**
+     * The name of the version
+     */
+    name?: string;
+    /**
+     * The parent version id
+     */
+    parent?: string;
+    /**
+     * The full path to the version
+     */
+    path: string;
+    /**
+     * The size of the version resource
+     */
+    size?: number;
+    /**
+     * The updated timestamp
+     */
+    updated: number;
+}

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

@@ -0,0 +1,3 @@
+export * from "./ICreateVersionOptions";
+export * from "./IVersion";
+export * from "./IVersionMetadata";

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

@@ -0,0 +1,11 @@
+import { IHubUserRequestOptions } from "../types";
+import { IModel } from "../types";
+import { IVersion } from "./types";
+/**
+ * Updates the specified version with with the state of the supplied model
+ * @param model
+ * @param version
+ * @param requestOptions
+ * @returns
+ */
+export declare function updateVersion(model: IModel, version: IVersion, requestOptions: IHubUserRequestOptions): Promise<IVersion>;

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

@@ -0,0 +1,10 @@
+import { IModel } from "../types";
+import { IVersion } from "./types/IVersion";
+/**
+ * Applies the versioned data to the model
+ * @param model
+ * @param version
+ * @param includeList
+ * @returns
+ */
+export declare function applyVersion(model: IModel, version: IVersion, includeList?: string[]): IModel;

package/package.json

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