@esri/hub-common 28.5.0 → 28.6.0

package/dist/node/resources/fetchHubEntityResources.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchHubEntityResources = fetchHubEntityResources;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const HubError_1 = require("../HubError");
+/**
+ * Fetches a Hub entity's resources. This util handles
+ * delegating to the correct resource fetching logic
+ * based on the entity type.
+ *
+ * @param type - type of the entity to fetch the resources for
+ * @param identifier - id of the entity to fetch the resources for
+ * @param context - contextual portal and auth information
+ * @returns the fetched resources
+ * @throws {HubError} if there is an error during the fetch process or if fetching is not yet implemented for the entity type
+ */
+async function fetchHubEntityResources(type, identifier, context) {
+    let resources = [];
+    if (type === "event") {
+        // TODO: add logic to fetch event resources
+        throw new HubError_1.default("fetchHubEntityResource", "Fetching event resources is not yet implemented");
+    }
+    else if (type === "group") {
+        // TODO: add logic to fetch group resources once
+        // supported by portal
+        throw new HubError_1.default("fetchHubEntityResource", "Fetching group resources is not yet supported");
+    }
+    else {
+        // default to item-based resource fetching for item-backed entities
+        try {
+            const res = await (0, arcgis_rest_portal_1.getItemResources)(identifier, context.requestOptions);
+            resources = res.resources.map((resource) => (Object.assign(Object.assign({}, resource), { name: resource.resource })));
+        }
+        catch (error) {
+            throw new HubError_1.default("Get Item Resources", `Failed to fetch resources for ${type} with identifier ${identifier}`, error);
+        }
+    }
+    return resources;
+}
+//# sourceMappingURL=fetchHubEntityResources.js.map

package/dist/node/resources/fetchHubEntityResources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchHubEntityResources.js","sourceRoot":"","sources":["../../../src/resources/fetchHubEntityResources.ts"],"names":[],"mappings":";;AAgBA,0DAqCC;AArDD,iEAA4D;AAG5D,0CAAmC;AAEnC;;;;;;;;;;GAUG;AACI,KAAK,UAAU,uBAAuB,CAC3C,IAAmB,EACnB,UAAkB,EAClB,OAAuB;IAEvB,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,2CAA2C;QAC3C,MAAM,IAAI,kBAAQ,CAChB,wBAAwB,EACxB,iDAAiD,CAClD,CAAC;IACJ,CAAC;SAAM,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,gDAAgD;QAChD,sBAAsB;QACtB,MAAM,IAAI,kBAAQ,CAChB,wBAAwB,EACxB,+CAA+C,CAChD,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,mEAAmE;QACnE,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAA,qCAAgB,EAAC,UAAU,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;YACvE,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,iCACvC,QAAQ,KACX,IAAI,EAAE,QAAQ,CAAC,QAAQ,IACvB,CAAC,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,kBAAQ,CAChB,oBAAoB,EACpB,iCAAiC,IAAI,oBAAoB,UAAU,EAAE,EACrE,KAAc,CACf,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/node/resources/removeHubEntityResource.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeHubEntityResource = removeHubEntityResource;
+const HubError_1 = require("../HubError");
+const removeResource_1 = require("./removeResource");
+/**
+ * Removes a Hub entity resource. This util handles delegating
+ * to the correct resource remove logic based on the entity type.
+ *
+ * @param type - type of the entity to remove the resource for
+ * @param identifier - id of the entity to remove the resource for
+ * @param name  - name of the new/existing resource file
+ * @param context - contextual portal and auth information
+ * @param opts.owner - (optional) owner of the resource to add, defaults to the current user if not provided
+ * @param opts.prefix - (optional) folder in which to store the new resource
+ * @throws {HubError} if there is an error during the remove process or if removeing is not yet implemented for the entity type
+ */
+async function removeHubEntityResource(type, identifier, name, context, opts) {
+    var _a;
+    if (type === "event") {
+        // TODO: add logic to remove event resource
+        throw new HubError_1.default("removeHubEntityResource", "removing event resources is not yet implemented");
+    }
+    else if (type === "group") {
+        // TODO: add logic to remove group resource once
+        // supported by portal
+        throw new HubError_1.default("removeHubEntityResource", "removing group resources is not yet supported");
+    }
+    else {
+        // default logic for item-backed entities
+        const owner = (opts === null || opts === void 0 ? void 0 : opts.owner) || ((_a = context === null || context === void 0 ? void 0 : context.currentUser) === null || _a === void 0 ? void 0 : _a.username);
+        const fileName = (opts === null || opts === void 0 ? void 0 : opts.prefix) ? `${opts.prefix}/${name}` : name;
+        await (0, removeResource_1.removeResource)(identifier, fileName, owner, context.userRequestOptions);
+    }
+}
+//# sourceMappingURL=removeHubEntityResource.js.map

package/dist/node/resources/removeHubEntityResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"removeHubEntityResource.js","sourceRoot":"","sources":["../../../src/resources/removeHubEntityResource.ts"],"names":[],"mappings":";;AAiBA,0DAkCC;AAlDD,0CAAmC;AAEnC,qDAAkD;AAElD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,uBAAuB,CAC3C,IAAmB,EACnB,UAAkB,EAClB,IAAY,EACZ,OAAuB,EACvB,IAGC;;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,2CAA2C;QAC3C,MAAM,IAAI,kBAAQ,CAChB,yBAAyB,EACzB,iDAAiD,CAClD,CAAC;IACJ,CAAC;SAAM,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,gDAAgD;QAChD,sBAAsB;QACtB,MAAM,IAAI,kBAAQ,CAChB,yBAAyB,EACzB,+CAA+C,CAChD,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,yCAAyC;QACzC,MAAM,KAAK,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,MAAI,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,0CAAE,QAAQ,CAAA,CAAC;QAC5D,MAAM,QAAQ,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,MAAM,IAAA,+BAAc,EAClB,UAAU,EACV,QAAQ,EACR,KAAK,EACL,OAAO,CAAC,kBAAkB,CAC3B,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/node/resources/upsertHubEntityResource.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertHubEntityResource = upsertHubEntityResource;
+const HubError_1 = require("../HubError");
+const upsertResource_1 = require("./upsertResource");
+/**
+ * Adds or updates a Hub entity resource depending on whether it
+ * already exists. This util handles delegating to the correct
+ * resource upsert logic based on the entity type.
+ *
+ * @param type - type of the entity to upsert the resource for
+ * @param identifier - id of the entity to upsert the resource for
+ * @param resource - the resource to upsert
+ * @param name  - name of the new/existing resource file
+ * @param context - contextual portal and auth information
+ * @param opts.owner - (optional) owner of the resource to add, defaults to the current user if not provided
+ * @param opts.prefix - (optional) folder in which to store the new resource
+ * @throws {HubError} if there is an error during the upsert process or if upserting is not yet implemented for the entity type
+ */
+async function upsertHubEntityResource(type, identifier, resource, name, context, opts) {
+    var _a;
+    if (type === "event") {
+        // TODO: add logic to upsert event resource
+        throw new HubError_1.default("upsertHubEntityResource", "Upserting event resources is not yet implemented");
+    }
+    else if (type === "group") {
+        // TODO: add logic to upsert group resource once
+        // supported by portal
+        throw new HubError_1.default("upsertHubEntityResource", "Upserting group resources is not yet supported");
+    }
+    else {
+        // default logic for item-backed entities
+        const owner = (opts === null || opts === void 0 ? void 0 : opts.owner) || ((_a = context === null || context === void 0 ? void 0 : context.currentUser) === null || _a === void 0 ? void 0 : _a.username);
+        await (0, upsertResource_1.upsertResource)(identifier, owner, resource, name, context.userRequestOptions, opts === null || opts === void 0 ? void 0 : opts.prefix);
+    }
+}
+//# sourceMappingURL=upsertHubEntityResource.js.map

package/dist/node/resources/upsertHubEntityResource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertHubEntityResource.js","sourceRoot":"","sources":["../../../src/resources/upsertHubEntityResource.ts"],"names":[],"mappings":";;AAmBA,0DAoCC;AAtDD,0CAAmC;AAEnC,qDAAkD;AAElD;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,uBAAuB,CAC3C,IAAmB,EACnB,UAAkB,EAClB,QAAiB,EACjB,IAAY,EACZ,OAAuB,EACvB,IAGC;;IAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QACrB,2CAA2C;QAC3C,MAAM,IAAI,kBAAQ,CAChB,yBAAyB,EACzB,kDAAkD,CACnD,CAAC;IACJ,CAAC;SAAM,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,gDAAgD;QAChD,sBAAsB;QACtB,MAAM,IAAI,kBAAQ,CAChB,yBAAyB,EACzB,gDAAgD,CACjD,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,yCAAyC;QACzC,MAAM,KAAK,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,MAAI,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,0CAAE,QAAQ,CAAA,CAAC;QAC5D,MAAM,IAAA,+BAAc,EAClB,UAAU,EACV,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,OAAO,CAAC,kBAAkB,EAC1B,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CACb,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/types/content/_internal/internalContentUtils.d.ts

@@ -221,7 +221,7 @@ export declare function getValueFromMetadata(metadata: any, identifier: keyof IM
  */
 export declare function parseISODateString(isoString: string): {
     date: Date;
-    precision: "year" | "month" | "day" | "time";
+    precision: "time" | "year" | "month" | "day";
 };
 /**
  * Get the spatial reference as an object for an item

package/dist/types/core/traits/IWithVersions.d.ts

@@ -0,0 +1,5 @@
+import { TLayoutType } from "../../layouts/types";
+/** Trait to add versioning properties to an entity */
+export interface IWithVersions {
+    currentVersions?: Partial<Record<TLayoutType, string>>;
+}

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

@@ -10,10 +10,11 @@ import { IWithDiscussions } from "../traits/IWithDiscussions";
 import { IWithViewSettings } from "../traits/IWithViewSettings";
 import { IWithAssistant } from "../traits/IWithAssistant";
 import { ICatalogSetup } from "../../search/types/types";
+import { IWithVersions } from "../traits/IWithVersions";
 /**
  * Properties exposed by Entities that are backed by Items
  */
-export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithDiscussions, IWithFollowers, IWithAssociations, IWithAssistant {
+export interface IHubItemEntity extends IHubEntityBase, IWithPermissions, IWithDiscussions, IWithFollowers, IWithAssociations, IWithAssistant, IWithVersions {
     /**
      * Access level of the item ("private" | "org" | "public")
      */

package/dist/types/index.d.ts

@@ -106,6 +106,7 @@ export { IWithLayout, IWithLayoutStore } from "./core/traits/IWithLayout";
 export { IWithPermissions } from "./core/traits/IWithPermissions";
 export { IWithSlug } from "./core/traits/IWithSlug";
 export { IWithViewSettings } from "./core/traits/IWithViewSettings";
+export { IWithVersions } from "./core/traits/IWithVersions";
 export { HubActionLink, IHubActionLinkSection, IHubContentActionLink, IHubExternalActionLink, IHubWellKnownActionLink, } from "./core/types/ActionLinks";
 export { CountByValue, DynamicAggregation, DynamicValue, DynamicValueDefinition, DynamicValueResult, DynamicValues, DynamicValueType, IDynamicItemQueryDefinition, IDynamicPortalSelfDefinition, IDynamicServiceQueryDefinition, IStaticValueDefinition, } from "./core/types/DynamicValues";
 export { HubEmbed, IHubEmbed, IHubEmbedApp, IHubEmbedExternal, IHubEmbedMap, IHubEmbedSurvey, } from "./core/types/Embeds";
@@ -540,6 +541,8 @@ export { HubError, OperationError, OperationStack };
 export { IMigratableSchema, MigratableSchemaTransformMap, } from "./migrations/types";
 export { Breakpoint, ColumnWidth, HTMLConfigurableLayoutNodeElement, IColumn, IColumnProps, IConfigurableLayoutNode, ITranslationMap, ILayoutNode, ILayoutNodeConfig, IProcessLayoutOptions, IRow, IRowProps, ISection, ISectionProps, LayoutColumnChild, LayoutNodeTag, layoutNodeTags, LayoutEditorTag, LayoutNode, Ref, SectionOrRef, ResponsiveValue, } from "./layouts/layout-system-types";
 export { ILayoutNodeChangeEventDetail, ILayoutPublishEventDetail, ILayoutResetEventDetail, ILayoutNodeRepositionEventDetail, } from "./layouts/layout-event-types";
-export { ILayout, Layout, LayoutUtils } from "./layouts/types";
+export { ILayout, Layout, LayoutUtils, TLayoutType, TLayouts, LAYOUT_SCHEMA_VERSION, } from "./layouts/types";
 export { ILayoutV1 } from "./layouts/migrations/types/ILayoutV1";
 export { ILayoutV2 } from "./layouts/migrations/types/ILayoutV2";
+export { fetchHubEntityLayouts } from "./layouts/fetchHubEntityLayouts";
+export { publishHubEntityLayout } from "./layouts/publishHubEntityLayout";

package/dist/types/layouts/fetchHubEntityLayouts.d.ts

@@ -0,0 +1,16 @@
+import { IArcGISContext } from "../types/IArcGISContext";
+import { Layout, TLayouts } from "./types";
+import { HubEntity } from "../core/types/HubEntity";
+import { IWithVersions } from "../core/traits/IWithVersions";
+/**
+ * Fetches the "current version" layouts for a given Hub entity.
+ *
+ * Note: this function assumes that layout versions are stored
+ * as resources on the underlying entity and that pointers to
+ * these resources are stored somewhere on the entity (e.g.
+ * properties.currentVersions for portal-backed entities).
+ *
+ * @param entity - the Hub entity for which to fetch layouts
+ * @param context - contextual portal and auth information
+ */
+export declare function fetchHubEntityLayouts(entity: HubEntity & IWithVersions, context: IArcGISContext): Promise<TLayouts<Layout>>;

package/dist/types/layouts/internal/upsertLayoutAssetResource.d.ts

@@ -0,0 +1,27 @@
+import { HubEntityType } from "../../core/types/HubEntityType";
+import { IArcGISContext } from "../../types/IArcGISContext";
+/**
+ * Adds or updates a layout asset resource (image, video,
+ * etc.) and returns the URL reference to the resource.
+ *
+ * Note that layout resources are typically stored with:
+ * - an "assets/" prefix (so we can find them)
+ * - a name that starts with the cardId
+ * - and a -{timestamp} suffix (to bust the cache)
+ * Thus, 'update' is not really an update, it is:
+ *    1. upload the new one
+ *    2. find the old one (which has a different suffix)
+ *    and delete it.
+ *
+ * This is why we cannot simply use upsertHubEntityResource
+ *
+ * @param type - type of the entity to upsert the resource for
+ * @param id - id of the entity to upsert the resource for
+ * @param owner - owner of the resource to add/update
+ * @param resource - the resource to add/update
+ * @param name - name of the new/existing resource file
+ * @param extension - file extension of the resource (e.g. 'png', 'json', etc.)
+ * @param context - contextual portal and auth information
+ * @returns a URL reference to the newly added/updated resource
+ */
+export declare function upsertLayoutAssetResource(type: HubEntityType, identifier: string, owner: string, resource: unknown, name: string, extension: string, context: IArcGISContext): Promise<string>;

package/dist/types/layouts/layout-event-types.d.ts

@@ -1,6 +1,6 @@
 import { IChangeEventDetail } from "../core/schemas/types";
 import { ILayoutNodeConfig, LayoutNode } from "./layout-system-types";
-import { ILayout } from "./types";
+import { ILayout, TLayoutType } from "./types";
 /**
  * Interface representing the information emitted when
  * a layout node is changed in the layout editor.
@@ -22,6 +22,7 @@ export interface ILayoutPublishEventDetail {
  * a layout is reset to its default
  */
 export interface ILayoutResetEventDetail {
+    type: TLayoutType;
     successCallback?: () => void | Promise<void>;
 }
 /**

package/dist/types/layouts/migrations/types/ILayoutV2.d.ts

@@ -1,9 +1,12 @@
 import type { IMigratableSchema } from "../../../migrations/types";
 import type { IHistoryEntry, INodeOverrides, ITranslationMap, SectionOrRef } from "../../layout-system-types";
+import { TLayoutType } from "../../types";
 /** Interface representing a V2 layout object. */
 export interface ILayoutV2 extends IMigratableSchema {
     /** Schema version for the layout. */
     schemaVersion: 2;
+    /** The type of layout, e.g. "header", "body", etc.*/
+    type: TLayoutType;
     /** If true, the entire layout is read-only. */
     readOnly?: boolean;
     /** Array of sections in the layout. */

package/dist/types/layouts/publishHubEntityLayout.d.ts

@@ -0,0 +1,29 @@
+import { HubEntity } from "../core/types/HubEntity";
+import { IArcGISContext } from "../types/IArcGISContext";
+import { ILayout } from "./types";
+import { IWithVersions } from "../core/traits/IWithVersions";
+/**
+ * Publishes a Hub entity layout by:
+ * 1. Uploading any layout asset resources and updating the
+ * layout variables to point to the resource urls
+ * 2. Upserting the layout as a resource on the entity
+ * 3. Updating the entity's currentVersions to point to the
+ * new layout resource
+ * 4. Updating the entity
+ *
+ * TODO: in the future, we'll add layout versioning support, so
+ * we'll want this to work with the existing versioning utils.
+ * For now, we'll keep it simple and just directly upsert the
+ * single published version
+ *
+ * @param entity - the Hub entity of the layout to publish
+ * @param layout - the layout to publish
+ * @param versionName - the name of the version to publish
+ * @param context - contextual portal and auth information
+ * @returns the published layout
+ * @throws {HubError} if there is an error during the publish process
+ */
+export declare function publishHubEntityLayout(entity: HubEntity & IWithVersions, layout: ILayout, versionName: string, context: IArcGISContext): Promise<{
+    entity: HubEntity;
+    layout: ILayout;
+}>;

package/dist/types/layouts/types.d.ts

@@ -2,6 +2,7 @@ import type { ILayoutV1 } from "./migrations/types/ILayoutV1";
 import type { ILayoutV2 } from "./migrations/types/ILayoutV2";
 /** Union type of all layout schema versions.  */
 export type Layout = ILayoutV1 | ILayoutV2;
+export declare const LAYOUT_SCHEMA_VERSION = 2;
 /**
  * The latest supported layout schema. This should be
  * updated whenever a new schema version is released.
@@ -14,3 +15,7 @@ export type ILayout = ILayoutV2;
 export type LayoutUtils = {
     processLayout: (layout: ILayout) => Promise<ILayout>;
 };
+/** Type representing the different types of Hub entity layouts */
+export type TLayoutType = "body" | "header" | "footer" | "search" | "404";
+/** Type representing a collection of layouts for different layout types */
+export type TLayouts<T = ILayout> = Partial<Record<TLayoutType, T>>;

package/dist/types/resources/addHubEntityResource.d.ts

@@ -0,0 +1,19 @@
+import { HubEntityType } from "../core/types/HubEntityType";
+import { IArcGISContext } from "../types/IArcGISContext";
+/**
+ * Adds a Hub entity resource. This util handles delegating
+ * to the correct resource add logic based on the entity type.
+ *
+ * @param type - type of the entity to add the resource for
+ * @param identifier - id of the entity to add the resource for
+ * @param resource - the resource to add
+ * @param name  - name of the new resource file
+ * @param context - contextual portal and auth information
+ * @param opts.owner - (optional) owner of the resource to add, defaults to the current user if not provided
+ * @param opts.prefix - (optional) folder in which to store the new resource
+ * @throws {HubError} if there is an error during the add process or if adding is not yet implemented for the entity type
+ */
+export declare function addHubEntityResource(type: HubEntityType, identifier: string, resource: unknown, name: string, context: IArcGISContext, opts?: {
+    owner?: string;
+    prefix?: string;
+}): Promise<void>;

package/dist/types/resources/addResource.d.ts

@@ -0,0 +1,18 @@
+import { IArcGISContext } from "../types/IArcGISContext";
+/**
+ * Thin wrapper around addItemResource to add a resource
+ * to a portal item and provide Hub-specific error
+ * handling.
+ *
+ * @param id - id of the item to add the resource to
+ * @param name - name of the resource file
+ * @param owner - owner of the item to add the resource to
+ * @param context - contextual portal and auth information
+ * @throws {HubError} if there is an error during the add process
+ */
+export declare function addResource(id: string, name: string, resource: unknown, context: IArcGISContext, opts?: {
+    owner?: string;
+    prefix?: string;
+}): Promise<{
+    success: boolean;
+}>;

package/dist/types/resources/fetchHubEntityResource.d.ts

@@ -0,0 +1,15 @@
+import { HubEntityType } from "../core/types/HubEntityType";
+import { IArcGISContext } from "../types/IArcGISContext";
+/**
+ * Fetches a Hub entity resource. This util handles
+ * delegating to the correct resource fetching logic
+ * based on the entity type.
+ *
+ * @param type - type of the entity to fetch the resource for
+ * @param identifier - id of the entity to fetch the resource for
+ * @param fileName - name of the info file (including the optional folder path) to fetch
+ * @param context - contextual portal and auth information
+ * @returns the fetched resource
+ * @throws {HubError} if there is an error during the fetch process or if fetching is not yet implemented for the entity type
+ */
+export declare function fetchHubEntityResource(type: HubEntityType, identifier: string, fileName: string, context: IArcGISContext): Promise<unknown>;

package/dist/types/resources/fetchHubEntityResources.d.ts

@@ -0,0 +1,17 @@
+import { HubEntityType } from "../core/types/HubEntityType";
+import { IArcGISContext } from "../types/IArcGISContext";
+/**
+ * Fetches a Hub entity's resources. This util handles
+ * delegating to the correct resource fetching logic
+ * based on the entity type.
+ *
+ * @param type - type of the entity to fetch the resources for
+ * @param identifier - id of the entity to fetch the resources for
+ * @param context - contextual portal and auth information
+ * @returns the fetched resources
+ * @throws {HubError} if there is an error during the fetch process or if fetching is not yet implemented for the entity type
+ */
+export declare function fetchHubEntityResources(type: HubEntityType, identifier: string, context: IArcGISContext): Promise<{
+    name: string;
+    [key: string]: unknown;
+}[]>;

package/dist/types/resources/removeHubEntityResource.d.ts

@@ -0,0 +1,18 @@
+import { HubEntityType } from "../core/types/HubEntityType";
+import { IArcGISContext } from "../types/IArcGISContext";
+/**
+ * Removes a Hub entity resource. This util handles delegating
+ * to the correct resource remove logic based on the entity type.
+ *
+ * @param type - type of the entity to remove the resource for
+ * @param identifier - id of the entity to remove the resource for
+ * @param name  - name of the new/existing resource file
+ * @param context - contextual portal and auth information
+ * @param opts.owner - (optional) owner of the resource to add, defaults to the current user if not provided
+ * @param opts.prefix - (optional) folder in which to store the new resource
+ * @throws {HubError} if there is an error during the remove process or if removeing is not yet implemented for the entity type
+ */
+export declare function removeHubEntityResource(type: HubEntityType, identifier: string, name: string, context: IArcGISContext, opts?: {
+    owner?: string;
+    prefix?: string;
+}): Promise<void>;

package/dist/types/resources/upsertHubEntityResource.d.ts

@@ -0,0 +1,20 @@
+import { HubEntityType } from "../core/types/HubEntityType";
+import { IArcGISContext } from "../types/IArcGISContext";
+/**
+ * Adds or updates a Hub entity resource depending on whether it
+ * already exists. This util handles delegating to the correct
+ * resource upsert logic based on the entity type.
+ *
+ * @param type - type of the entity to upsert the resource for
+ * @param identifier - id of the entity to upsert the resource for
+ * @param resource - the resource to upsert
+ * @param name  - name of the new/existing resource file
+ * @param context - contextual portal and auth information
+ * @param opts.owner - (optional) owner of the resource to add, defaults to the current user if not provided
+ * @param opts.prefix - (optional) folder in which to store the new resource
+ * @throws {HubError} if there is an error during the upsert process or if upserting is not yet implemented for the entity type
+ */
+export declare function upsertHubEntityResource(type: HubEntityType, identifier: string, resource: unknown, name: string, context: IArcGISContext, opts?: {
+    owner?: string;
+    prefix?: string;
+}): Promise<void>;

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

@@ -3,9 +3,13 @@ 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 {
+export interface IVersion<T = Record<string, any>> extends IVersionMetadata {
     /**
      * The versioned data
      */
-    data: Record<string, any>;
+    data: T;
+    /**
+     * Additional optional properties
+     */
+    [key: string]: any;
 }

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

@@ -43,4 +43,14 @@ export interface IVersionMetadata {
      * The updated timestamp
      */
     updated: number;
+    /**
+     * The username of the last modifier
+     */
+    lastModifiedBy?: string;
+    /**
+     * The type of the version resource. For item-backed
+     * results, this will be item.type. Otherwise, it will
+     * be something like "Group", "User", "Event", etc.
+     */
+    type?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "28.5.0",
+  "version": "28.6.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",
@@ -54,7 +54,7 @@
     "build": "npm run build:node && npm run build:esm",
     "build:esm": "tsc --outDir ./dist/esm  --declaration --declarationDir ./dist/types",
     "build:node": "tsc --module commonjs --outDir ./dist/node",
-    "ci:lint": "npm run lint && npm run madge:circular",
+    "ci:lint": "npm run lint -- --quiet",
     "ci:test:coverage": "npm run test:coverage",
     "clean": "rimraf ./dist ./.turbo ./coverage",
     "dev": "npm run dev:esm",
@@ -62,7 +62,7 @@
     "dev:node": "npm run build:node -- -w",
     "format:fix": "prettier --write './{src,test}/**/*.ts'",
     "format": "prettier --check './{src,test}/**/*.ts'",
-    "lint": "eslint --quiet './src/**/*.ts'",
+    "lint": "eslint './src/**/*.ts'",
     "lint:warnings": "eslint './src/**/*.ts'",
     "lint:fix": "eslint --quiet --fix './src/**/*.ts'",
     "madge:circular": "madge --circular --ts-config ./tsconfig.json --extensions ts ./src",

package/dist/esm/layouts/updateLayout.js

@@ -1,33 +0,0 @@
-import { cloneObject } from "../util.js";
-import { upsertLayoutResource } from "./upsertLayoutResource.js";
-export async function updateLayout(entity, layout, requestOptions) {
-    if (!layout) {
-        return layout;
-    }
-    const updatedLayout = cloneObject(layout);
-    // check the variables and for each one that is of type image and... has a source, a blob?
-    // we need to upload the image as a resource and update the variable.value to point to the resource and remove all other properties except type
-    await Promise.all(Object.entries(updatedLayout.variables || {}).map(async ([key, _variable]) => {
-        const variable = _variable;
-        if (variable.type === "image") {
-            if (variable.source === "upload" && !!variable.blob) {
-                const newVariable = {
-                    type: variable.type,
-                };
-                const resourceUrl = await upsertLayoutResource(entity.id, entity.owner, variable.blob, key, // this is something like <nodeId>-image-card
-                variable.format, requestOptions);
-                // set the value to the resource name
-                newVariable.value = { $ref: resourceUrl };
-                updatedLayout.variables[key] = newVariable;
-            }
-        }
-    }));
-    /*
-      TODO: we will also need to clean up any old resources that are no longer referenced
-            - make sure when we delete it in the ui, we get rid of the variable
-            - then when we save, we delete any resources for which there is no variable
-            - when an image card is changed from an upload to a url, we will handle it similarly
-    */
-    return updatedLayout;
-}
-//# sourceMappingURL=updateLayout.js.map

package/dist/esm/layouts/updateLayout.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"updateLayout.js","sourceRoot":"","sources":["../../../src/layouts/updateLayout.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAsB,EACtB,MAAe,EACf,cAAmC;IAEnC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,aAAa,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAE1C,0FAA0F;IAC1F,+IAA+I;IAC/I,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAC/C,KAAK,EAAE,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAG,SAAoC,CAAC;QACtD,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC9B,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACpD,MAAM,WAAW,GAA4B;oBAC3C,IAAI,EAAE,QAAQ,CAAC,IAAI;iBACpB,CAAC;gBAEF,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAC5C,MAAM,CAAC,EAAE,EACT,MAAM,CAAC,KAAK,EACZ,QAAQ,CAAC,IAAI,EACb,GAAG,EAAE,6CAA6C;gBAClD,QAAQ,CAAC,MAAgB,EACzB,cAAc,CACf,CAAC;gBACF,qCAAqC;gBACrC,WAAW,CAAC,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;gBAC1C,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC,CACF,CACF,CAAC;IAEF;;;;;MAKE;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/dist/esm/layouts/upsertLayoutResource.js

@@ -1,78 +0,0 @@
-import { addItemResource, getItemResources } from "@esri/arcgis-rest-portal";
-import HubError from "../HubError";
-import { objectToJsonBlob } from "../resources/object-to-json-blob";
-import { stringToBlob } from "../resources/string-to-blob";
-import { removeResource } from "../resources/removeResource";
-/**
- * Given an item, and owner, Search for if the resource exists
- * and if does, update it, otherwise add it. Returns a url for the item.
- *
- * Note that layout resources are typically stored with
- * - a "layout/" prefix (so we can find them)
- * - a name that starts with the cardId
- * - and a -{timestamp} suffix (to bust the cache)
- * thus 'update' is not really an update, it is:
- * - upload the new one
- * - then find the old one (which has a different suffix) and delete it.
- *
- * this is why we cannot simply use upsertResource
- 
- *
- * @export
- * @param {string} id
- * @param {string} owner
- * @param {*} resource
- * @param {string} name
- * @param {string} extension
- * @param {IUserRequestOptions} ro
- * @return {*}  {Promise<string>}
- */
-export async function upsertLayoutResource(id, owner, resource, name, extension, ro) {
-    try {
-        const prefix = "layout";
-        // construct resource name
-        // the key is of the form <nodeId>-image-card
-        // we also append a unique timestamp to avoid caching issues
-        const resourceName = `${name}-${Date.now()}.${extension}`;
-        // JSON and text resources have....odd things happen
-        // to them when they are added as resources and NOT
-        // converted to blobs. Thus we convert them to blobs
-        let resourceToUpload = resource;
-        if (extension === "json") {
-            resourceToUpload = objectToJsonBlob(resource);
-        }
-        if (extension === "txt") {
-            resourceToUpload = stringToBlob(resource);
-        }
-        // Add item resource
-        // we do not check for existence first, because
-        // our resource names are unique (timestamped)
-        const response = await addItemResource(Object.assign({ id,
-            owner, resource: resourceToUpload, name: resourceName, prefix }, ro));
-        // if err throw
-        if (!response.success) {
-            throw new HubError("Add Item Resource", `Error adding resource ${name} to item ${id}.`);
-        }
-        // then delete the old one if it exists
-        const resources = await getItemResources(id, ro);
-        const foundResource = resources.resources.find((res) => {
-            return (res.resource.startsWith(`${prefix}/${name}`) &&
-                res.resource !== `${prefix}/${resourceName}`);
-        });
-        if (foundResource) {
-            await removeResource(id, foundResource.resource, owner, ro);
-        }
-        // return url
-        // resourceUrl://:id/:prefix/:filename
-        return `resourceUrl://${id}/${prefix}/${resourceName}`;
-    }
-    catch (err) {
-        if (err instanceof Error) {
-            throw new HubError("Add Item Resource", err.message, err);
-        }
-        else {
-            throw new HubError("Add Item Resource", `Error adding resource ${name} to item ${id}.`);
-        }
-    }
-}
-//# sourceMappingURL=upsertLayoutResource.js.map

package/dist/esm/layouts/upsertLayoutResource.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"upsertLayoutResource.js","sourceRoot":"","sources":["../../../src/layouts/upsertLayoutResource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,QAAQ,MAAM,aAAa,CAAC;AACnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,EAAU,EACV,KAAa,EACb,QAAiB,EACjB,IAAY,EACZ,SAAiB,EACjB,EAAuB;IAEvB,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,QAAQ,CAAC;QACxB,0BAA0B;QAC1B,6CAA6C;QAC7C,4DAA4D;QAC5D,MAAM,YAAY,GAAG,GAAG,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,IAAI,SAAS,EAAE,CAAC;QAC1D,oDAAoD;QACpD,mDAAmD;QACnD,oDAAoD;QACpD,IAAI,gBAAgB,GAAG,QAAQ,CAAC;QAChC,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;YACzB,gBAAgB,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACxB,gBAAgB,GAAG,YAAY,CAAC,QAAkB,CAAC,CAAC;QACtD,CAAC;QACD,oBAAoB;QACpB,+CAA+C;QAC/C,8CAA8C;QAC9C,MAAM,QAAQ,GAAG,MAAM,eAAe,iBACpC,EAAE;YACF,KAAK,EACL,QAAQ,EAAE,gBAAgB,EAC1B,IAAI,EAAE,YAAY,EAClB,MAAM,IACH,EAAE,EACL,CAAC;QACH,eAAe;QACf,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,QAAQ,CAChB,mBAAmB,EACnB,yBAAyB,IAAI,YAAY,EAAE,GAAG,CAC/C,CAAC;QACJ,CAAC;QAED,uCAAuC;QACvC,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QACjD,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC,IAAI,CAC5C,CAAC,GAAyB,EAAE,EAAE;YAC5B,OAAO,CACL,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;gBAC5C,GAAG,CAAC,QAAQ,KAAK,GAAG,MAAM,IAAI,YAAY,EAAE,CAC7C,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,cAAc,CAAC,EAAE,EAAE,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,aAAa;QACb,sCAAsC;QACtC,OAAO,iBAAiB,EAAE,IAAI,MAAM,IAAI,YAAY,EAAE,CAAC;IACzD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,QAAQ,CAAC,mBAAmB,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,QAAQ,CAChB,mBAAmB,EACnB,yBAAyB,IAAI,YAAY,EAAE,GAAG,CAC/C,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}