@esri/hub-common 9.39.0 → 9.40.0

package/dist/node/org/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./fetch-org"), exports);
+//# sourceMappingURL=index.js.map

package/dist/node/org/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/org/index.ts"],"names":[],"mappings":";;;AAAA,sDAA4B"}

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

@@ -1,6 +1,6 @@
-import { IItem } from "@esri/arcgis-rest-portal";
-import { ILayerDefinition, ISpatialReference } from "@esri/arcgis-rest-types";
-import { IHubContent } from "../core";
+import { IItem, IPortal } from "@esri/arcgis-rest-portal";
+import { ILayerDefinition, ISpatialReference, IUser } from "@esri/arcgis-rest-types";
+import { IHubContent, PublisherSource } from "../core";
 import { IHubGeography, GeographyProvenance, IHubRequestOptions } from "../types";
 import { IHubAdditionalResource } from "../core/types/IHubAdditionalResource";
 /**
@@ -49,6 +49,14 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     publishedDate: Date;
     publishedDateSource?: string;
     updateFrequency?: string;
+    publisher?: {
+        name?: string;
+        username?: string;
+        nameSource: PublisherSource;
+        organization?: string;
+        orgId?: string;
+        organizationSource: PublisherSource;
+    };
     portalHomeUrl?: string;
     portalApiUrl?: string;
     portalDataUrl?: string;
@@ -85,8 +93,8 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     };
     metadata?: any;
     groupIds?: string[];
-    ownerUser?: import("@esri/arcgis-rest-portal").IUser;
-    org?: Partial<import("@esri/arcgis-rest-portal").IPortal>;
+    ownerUser?: IUser;
+    org?: Partial<IPortal>;
     errors?: import("../types").IEnrichmentErrorInfo[];
     server?: Partial<import("@esri/arcgis-rest-feature-layer").IFeatureServiceDefinition>;
     layers?: Partial<ILayerDefinition>[];
@@ -284,4 +292,45 @@ export declare const getAdditionalResourceUrl: (resource: IAGOAdditionalResource
  * @returns the correct extent in a bbox format, or undefined
  */
 export declare const determineExtent: (item: IItem, extentEnrichment?: any, layer?: ILayerDefinition) => any;
+/**
+ * @private
+ *
+ * Extracts the first contact from a given formal item metadata path.
+ * This is particularly helpful if the contact path is either an object or an array.
+ *
+ * Note: the raw contact object must have the following properties:
+ * - `rpIndName`: name of the individual
+ * - `rpOrgName`: name of the individual's organization
+ *
+ * @param metadata formal item metadata
+ * @param path path to the contact object/array
+ * @returns
+ */
+export declare const extractFirstContact: (metadata: any, path: string) => {
+    individualName: any;
+    organizationName: any;
+};
+/**
+ * Determines the correct orgId for an item.
+ * Note: it's undocumented, but the portal API will return orgId for items... sometimes.
+ *
+ * @param item
+ * @param ownerUser item owner's hydrated user object
+ */
+export declare const getItemOrgId: (item: IItem, ownerUser?: IUser) => any;
+/**
+ * Calculates the Publisher display info for the given item.
+ * Utilizes this fallback pattern:
+ * 1) Formal Item Metadata > Resource > Citation > Contact
+ * 2) Formal Item Metadata > Resource > Contact
+ * 3) Item’s Owner and Org Name
+ * 4) Undefined (Item Owner / Org are private and we can't access additional info)
+ *
+ * @param item
+ * @param metadata
+ * @param org portal info of the item's organization
+ * @param ownerUser the item owner's hydrated user
+ * @returns
+ */
+export declare const getPublisherInfo: (item: IItem, metadata?: any, org?: Partial<IPortal>, ownerUser?: IUser) => any;
 export {};

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

@@ -5,6 +5,12 @@ import { IStructuredLicense } from "../../items/get-structured-license";
 import { IHubItemEntity } from ".";
 import { IHubContentEnrichments } from "./IHubContentEnrichments";
 import { IHubAdditionalResource } from "./IHubAdditionalResource";
+export declare enum PublisherSource {
+    CitationContact = "metadata.resource.citation.contact",
+    ResourceContact = "metadata.resource.contact",
+    ItemOwner = "item.owner",
+    None = "none"
+}
 /**
  * Data model for content
  */
@@ -61,6 +67,21 @@ export interface IHubContent extends IHubItemEntity, IHubContentEnrichments, IIt
     publishedDateSource?: string;
     /** Frequency at which the content is updated */
     updateFrequency?: string;
+    /**
+     * Info to display about the content's publisher. Follows this fallback pattern:
+     * 1) Formal Item Metadata > Resource > Citation > Contact
+     * 2) Formal Item Metadata > Resource > Contact
+     * 3) Item’s Owner and Org Name
+     * 4) Undefined (Item Owner / Org are private and we can't access additional info)
+     */
+    publisher?: {
+        name?: string;
+        username?: string;
+        nameSource: PublisherSource;
+        organization?: string;
+        orgId?: string;
+        organizationSource: PublisherSource;
+    };
     /** URL of the resource's page in the Portal Home application */
     portalHomeUrl?: string;
     /** URL of the Portal API endpoint for the resource */

package/dist/types/index.d.ts

@@ -25,6 +25,7 @@ export * from "./util";
 export * from "./utils";
 export * from "./Hub";
 export * from "./pages";
+export * from "./org";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 import HubError from "./HubError";

package/dist/types/org/fetch-org.d.ts

@@ -0,0 +1,9 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+/**
+ * Fetches the portal for a given org.
+ *
+ * @param orgId
+ * @param options request options
+ * @returns
+ */
+export declare const fetchOrg: (orgId: string, options?: IRequestOptions) => Promise<import("@esri/arcgis-rest-portal").IPortal>;

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

@@ -0,0 +1 @@
+export * from "./fetch-org";

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.38.0 - Mon Jun 06 2022 22:49:18 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.39.0 - Fri Jun 10 2022 17:25:47 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -6434,6 +6434,14 @@
         return request(cleanUrl(options.url), options);
     }
 
+    exports.PublisherSource = void 0;
+    (function (PublisherSource) {
+        PublisherSource["CitationContact"] = "metadata.resource.citation.contact";
+        PublisherSource["ResourceContact"] = "metadata.resource.contact";
+        PublisherSource["ItemOwner"] = "item.owner";
+        PublisherSource["None"] = "none";
+    })(exports.PublisherSource || (exports.PublisherSource = {}));
+
     /**
      * Turns an bounding box coordinate array into an extent object
      * @param bBox bounding box coordinate array
@@ -7012,6 +7020,90 @@
             : undefined;
         return itemExtent || extentEnrichmentCoordinates || layerExtent;
     };
+    /**
+     * @private
+     *
+     * Extracts the first contact from a given formal item metadata path.
+     * This is particularly helpful if the contact path is either an object or an array.
+     *
+     * Note: the raw contact object must have the following properties:
+     * - `rpIndName`: name of the individual
+     * - `rpOrgName`: name of the individual's organization
+     *
+     * @param metadata formal item metadata
+     * @param path path to the contact object/array
+     * @returns
+     */
+    var extractFirstContact = function (metadata, path) {
+        var rawContacts = getProp(metadata, path) || {};
+        var _a = Array.isArray(rawContacts)
+            ? rawContacts[0]
+            : rawContacts, rpIndName = _a.rpIndName, rpOrgName = _a.rpOrgName;
+        return { individualName: rpIndName, organizationName: rpOrgName };
+    };
+    /**
+     * Determines the correct orgId for an item.
+     * Note: it's undocumented, but the portal API will return orgId for items... sometimes.
+     *
+     * @param item
+     * @param ownerUser item owner's hydrated user object
+     */
+    var getItemOrgId = function (item, ownerUser) {
+        return item.orgId || (ownerUser === null || ownerUser === void 0 ? void 0 : ownerUser.orgId);
+    };
+    /**
+     * Calculates the Publisher display info for the given item.
+     * Utilizes this fallback pattern:
+     * 1) Formal Item Metadata > Resource > Citation > Contact
+     * 2) Formal Item Metadata > Resource > Contact
+     * 3) Item’s Owner and Org Name
+     * 4) Undefined (Item Owner / Org are private and we can't access additional info)
+     *
+     * @param item
+     * @param metadata
+     * @param org portal info of the item's organization
+     * @param ownerUser the item owner's hydrated user
+     * @returns
+     */
+    var getPublisherInfo = function (item, metadata, org, ownerUser) {
+        var result = {
+            nameSource: exports.PublisherSource.None,
+            organizationSource: exports.PublisherSource.None,
+        };
+        var citationContact = extractFirstContact(metadata, "metadata.dataIdInfo.idCitation.citRespParty");
+        var resourceContact = extractFirstContact(metadata, "metadata.mdContact");
+        // Determine publisher name properties
+        var ownerFullName = getProp(ownerUser, "fullName");
+        if (citationContact.individualName) {
+            result.name = citationContact.individualName;
+            result.nameSource = exports.PublisherSource.CitationContact;
+        }
+        else if (resourceContact.individualName) {
+            result.name = resourceContact.individualName;
+            result.nameSource = exports.PublisherSource.ResourceContact;
+        }
+        else if (ownerFullName) {
+            result.name = ownerFullName;
+            result.username = ownerUser.username;
+            result.nameSource = exports.PublisherSource.ItemOwner;
+        }
+        // Determine publisher org properties
+        var orgName = getProp(org, "name");
+        if (citationContact.organizationName) {
+            result.organization = citationContact.organizationName;
+            result.organizationSource = exports.PublisherSource.CitationContact;
+        }
+        else if (resourceContact.organizationName) {
+            result.organization = resourceContact.organizationName;
+            result.organizationSource = exports.PublisherSource.ResourceContact;
+        }
+        else if (orgName) {
+            result.organization = orgName;
+            result.orgId = getItemOrgId(item, ownerUser);
+            result.organizationSource = exports.PublisherSource.ItemOwner;
+        }
+        return result;
+    };
 
     var STANDARD_LICENSES = [
         {
@@ -7919,13 +8011,8 @@
             get metadataUpdateFrequency() {
                 return getUpdateFrequencyFromMetadata(metadata, "metadataUpdateFrequency");
             },
-            // TODO: add the publisher logic outlined here:
-            // https://devtopia.esri.com/dc/hub/issues/2932#issuecomment-3276309
             get publisher() {
-                return {
-                    name: item.owner,
-                    username: item.owner,
-                };
+                return getPublisherInfo(item, metadata, org, ownerUser);
             },
             // TODO: is metrics in use?
             get metrics() {
@@ -7945,11 +8032,10 @@
                     Array.isArray(data.layers) &&
                     data.layers.find(function (_layer) { return _layer.id === layer.id; });
                 return dataLayer ? dataLayer.layerDefinition : undefined;
+            }, get orgId() {
+                return org ? org.id : getItemOrgId(item, ownerUser);
             },
-            get orgId() {
-                // NOTE: it's undocumented, but the portal API will return orgId for items... sometimes
-                return org ? org.id : item.orgId || (ownerUser === null || ownerUser === void 0 ? void 0 : ownerUser.orgId);
-            }, get contentTypeIcon() {
+            get contentTypeIcon() {
                 /* Note: only returns calcite-icons */
                 return getContentTypeIcon(type);
             },
@@ -9882,6 +9968,24 @@
     };
     });
 
+    /**
+     * Fetches the portal for a given org.
+     *
+     * @param orgId
+     * @param options request options
+     * @returns
+     */
+    var fetchOrg = function (orgId, options) {
+        var orgPortalUrl = getProp(options, "portal") ||
+            getProp(options, "authentication.portal") ||
+            "www.arcgis.com";
+        // In order to get the correct response, we must pass options.portal
+        // as a base portal url (e.g., www.arcgis.com, qaext.arcgis.com, etc)
+        // **not** an org portal (i.e. org.maps.arcgis.com).
+        var basePortalUrl = getPortalBaseFromOrgUrl(orgPortalUrl) + "/sharing/rest";
+        return getPortal(orgId, __assign(__assign({}, options), { portal: basePortalUrl }));
+    };
+
     /**
      * Parse metadataxml into json object
      * @param metadataXml
@@ -9962,6 +10066,24 @@
         })
             .catch(function (error) { return handleEnrichmentError$1(error, input, opId); });
     };
+    // Note, this MUST be run after `enrichOwnerUser` to access the correct orgId during
+    // processing. `item.orgId` is only SOMETIMES returned by Portal, so we need to have
+    // the ownerUser's orgId as a backup.
+    var enrichOrg = function (input) {
+        var data = input.data, stack = input.stack, requestOptions = input.requestOptions;
+        var opId = stack.start("enrichOrg");
+        var orgId = getItemOrgId(data.item, data.ownerUser);
+        return fetchOrg(orgId, requestOptions)
+            .then(function (org) {
+            stack.finish(opId);
+            return {
+                data: __assign(__assign({}, data), { org: org }),
+                stack: stack,
+                requestOptions: requestOptions,
+            };
+        })
+            .catch(function (error) { return handleEnrichmentError$1(error, input, opId); });
+    };
     var enrichData = function (input) {
         var data = input.data, stack = input.stack, requestOptions = input.requestOptions;
         var opId = stack.start("enrichData");
@@ -10018,6 +10140,7 @@
         groupIds: enrichGroupIds,
         metadata: enrichMetadata,
         ownerUser: enrichOwnerUser,
+        org: enrichOrg,
         data: enrichData,
         server: enrichServer,
         layers: enrichLayers,
@@ -19724,6 +19847,7 @@
     exports.fetchHubTranslation = fetchHubTranslation;
     exports.fetchImageAsBlob = fetchImageAsBlob;
     exports.fetchModelFromItem = fetchModelFromItem;
+    exports.fetchOrg = fetchOrg;
     exports.fetchProject = fetchProject;
     exports.fetchSite = fetchSite;
     exports.fetchSiteModel = fetchSiteModel;