@esri/hub-common 12.6.1 → 12.7.0

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/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.7.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",