@esri/hub-common 9.10.1 → 9.10.2

package/dist/esm/content/index.js

@@ -0,0 +1,746 @@
+import { __assign, __spreadArrays } from "tslib";
+import { collections } from "../collections";
+import { categories as allCategories, isDownloadable } from "../categories";
+import { isBBox } from "../extent";
+import { includes, isGuid } from "../utils";
+import { getProp } from "../objects";
+import { getStructuredLicense } from "../items/get-structured-license";
+import { getServiceTypeFromUrl } from "../urls";
+import { setContentExtent } from "./_internal";
+function collectionToFamily(collection) {
+    var overrides = {
+        other: "content",
+        solution: "template",
+    };
+    return overrides[collection] || collection;
+}
+var cache = {};
+// TODO: remove this at next breaking version
+/**
+ * ```js
+ * import { getCategory } from "@esri/hub-common";
+ * //
+ * getCategory('Feature Layer')
+ * > 'dataset'
+ * ```
+ * **DEPRECATED: Use getCollection() instead**
+ * returns the Hub category for a given item type
+ * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
+ * @returns the category of a given item type.
+ */
+export function getCategory(itemType) {
+    if (itemType === void 0) { itemType = ""; }
+    /* tslint:disable no-console */
+    console.warn("DEPRECATED: Use getCollection() instead. getCategory will be removed at v10.0.0");
+    /* tslint:enable no-console */
+    var collection = getCollection(itemType);
+    // for backwards compatibility
+    return collection === "feedback" ? "app" : collection;
+}
+/**
+ * ```js
+ * import { getTypes } from "@esri/hub-common";
+ * //
+ * getTypes('site')
+ * > [ 'hub site application' ]
+ * ```
+ * To do.
+ * @param category The ArcGIS Hub category.
+ * @returns all the item types for the given category.
+ *
+ */
+export function getTypes(category) {
+    if (category === void 0) { category = ""; }
+    return allCategories[category.toLowerCase()];
+}
+/**
+ * ```js
+ * import { normalizeItemType } from "@esri/hub-common";
+ * //
+ * normalizeItemType(item)
+ * > [ 'Hub Site Application' ]
+ * ```
+ * @param item Item object.
+ * @returns type of the input item.
+ *
+ */
+export function normalizeItemType(item) {
+    if (item === void 0) { item = {}; }
+    var ret = item.type;
+    var typeKeywords = item.typeKeywords || [];
+    if (item.type === "Site Application" ||
+        (item.type === "Web Mapping Application" &&
+            includes(typeKeywords, "hubSite"))) {
+        ret = "Hub Site Application";
+    }
+    if (item.type === "Site Page" ||
+        (item.type === "Web Mapping Application" &&
+            includes(typeKeywords, "hubPage"))) {
+        ret = "Hub Page";
+    }
+    if (item.type === "Hub Initiative" &&
+        includes(typeKeywords, "hubInitiativeTemplate")) {
+        ret = "Hub Initiative Template";
+    }
+    if (item.type === "Web Mapping Application" &&
+        includes(typeKeywords, "hubSolutionTemplate")) {
+        ret = "Solution";
+    }
+    return ret;
+}
+/**
+ * ```js
+ * import { getTypeCategories } from "@esri/hub-common";
+ * //
+ * getTypeCategories(item)
+ * > [ 'Hub Site Application' ]
+ * ```
+ * @param item Item object.
+ * @returns typeCategory of the input item.
+ *
+ */
+export function getTypeCategories(item) {
+    if (item === void 0) { item = {}; }
+    var type = normalizeItemType(item);
+    var category = getCategory(type);
+    if (category) {
+        // upper case first letter and return as element in array for backwards compatibility
+        var chars = Array.from(category);
+        chars[0] = chars[0].toUpperCase();
+        return [chars.join("")];
+    }
+    else {
+        return ["Other"];
+    }
+}
+/**
+ * ```js
+ * import { getCollection } from "@esri/hub-common";
+ * //
+ * getCollection('Feature Layer')
+ * > 'dataset'
+ * ```
+ * Get the Hub collection for a given item type
+ * @param itemType The ArcGIS [item type](https://developers.arcgis.com/rest/users-groups-and-items/items-and-item-types.htm).
+ * @returns the Hub collection of a given item type.
+ */
+export function getCollection(itemType) {
+    if (itemType === void 0) { itemType = ""; }
+    if (cache[itemType]) {
+        return cache[itemType];
+    }
+    for (var _i = 0, _a = Object.keys(collections); _i < _a.length; _i++) {
+        var collection = _a[_i];
+        for (var _b = 0, _c = collections[collection]; _b < _c.length; _b++) {
+            var type = _c[_b];
+            if (itemType.toLowerCase() === type.toLowerCase()) {
+                cache[itemType] = collection;
+                return collection;
+            }
+        }
+    }
+}
+/**
+ * Case-insensitive check if the type is "Feature Service"
+ * @param {string} type - item's type
+ * @returns {boolean}
+ */
+export var isFeatureService = function (type) {
+    return type && type.toLowerCase() === "feature service";
+};
+/**
+ * parse layer id from a service URL
+ * @param {string} url
+ * @returns {string} layer id
+ */
+export var getLayerIdFromUrl = function (url) {
+    var endsWithNumberSegmentRegEx = /\/\d+$/;
+    var matched = url && url.match(endsWithNumberSegmentRegEx);
+    return matched && matched[0].slice(1);
+};
+/**
+ * return the layerId if we can tell that item is a single layer service
+ * @param {*} item from AGO
+ * @returns {string} layer id
+ */
+export var getItemLayerId = function (item) {
+    // try to parse it from the URL, but failing that we check for
+    // the Singlelayer typeKeyword, which I think is set when you create the item in AGO
+    // but have not verified that, nor that we should alway return '0' in that case
+    return (getLayerIdFromUrl(item.url) ||
+        (isFeatureService(item.type) &&
+            includes(item.typeKeywords, "Singlelayer") &&
+            "0"));
+};
+/**
+ * given an item, get the id to use w/ the Hub API
+ * @param item
+ * @returns Hub API id (hubId)
+ */
+export var getItemHubId = function (item) {
+    if (item.access !== "public") {
+        // the hub only indexes public items
+        return;
+    }
+    var id = item.id;
+    var layerId = getItemLayerId(item);
+    return layerId ? id + "_" + layerId : id;
+};
+/**
+ * ```js
+ * import { getContentIdentifier } from "@esri/hub-common";
+ * //
+ * getContentIdentifier(content, site)
+ * > 'f12hhjk32' // id
+ * // OR
+ * > 'content-slug' // human-readable slug
+ * ```
+ * Returns the preferred identifier for a piece of content (determined by content type):
+ * - Content from the 'template' and 'feedback' families return the standard id field
+ * - Pages that are linked to the site parameter will return the slug defined by the site. Otherwise, the page id will be returned
+ * - All other content will return the highest available item in the following hierarchy:
+ *   1. slug - includes org prefix if the site parameter is a portal or has an orgKey different from the slug prefix
+ *   2. hubId
+ *   3. id
+ * @param content The IHubContent item
+ * @param site The site to compare content against
+ * @returns the preferred id for the given content.
+ */
+export function getContentIdentifier(content, site) {
+    // We don't currently support slugs for hub initiative templates, solutions or surveys
+    if (includes(["template", "feedback"], content.family)) {
+        return content.id;
+    }
+    // If it is a hub page linked to a site, return the page slug at the
+    // site data instead. Because this one is the original one that was used
+    // to create the page url (not mutable once created) and the slug (below)
+    // generated by the hub-indexer could simply change with page name.
+    if (isPageContent(content)) {
+        // check if the page is linked to the current site
+        var pages = getProp(site, "data.values.pages") || [];
+        // if so, return the page slug otherwise the page id
+        var page = pages.find(function (p) { return p.id === content.id; });
+        return page ? page.slug : content.id;
+    }
+    // If a slug is present, always return it
+    if (content.slug) {
+        var slug = void 0;
+        var orgKey = getProp(site, "domainInfo.orgKey");
+        // Use namespaced slug when on the umbrella site
+        if (getProp(site, "data.values.isUmbrella")) {
+            slug = content.slug;
+        }
+        else {
+            // Use shortened slug if the slug's namespace is the same as the orgKey
+            slug = removeContextFromSlug(content.slug, orgKey);
+        }
+        return slug;
+    }
+    return content.hubId || content.id;
+}
+//////////////////////
+// Slug Helpers
+//////////////////////
+/**
+ * Parse item ID and layer ID (if any) from dataset record ID
+ *
+ * @param datasetId Hub API dataset record id ({itemId}_{layerId} or {itemId})
+ * @returns A hash with the `itemId` and `layerId` (if any)
+ */
+export function parseDatasetId(datasetId) {
+    var _a = datasetId ? datasetId.split("_") : [], itemId = _a[0], layerId = _a[1];
+    return { itemId: itemId, layerId: layerId };
+}
+/**
+ * Determine if an identifier is a Hub API slug
+ *
+ * @param identifier Hub API slug ({orgKey}::{title-as-slug} or {title-as-slug})
+ * or record id ((itemId}_{layerId} or {itemId})
+ * @returns true if the identifier is valid _and_ is **not** a record id
+ */
+export function isSlug(identifier) {
+    var itemId = parseDatasetId(identifier).itemId;
+    if (!itemId || isGuid(itemId)) {
+        // it's either invalid, or an item id, or a dataset id
+        return false;
+    }
+    // otherwise assume it's a slug
+    return true;
+}
+/**
+ * Add a context (prefix) to slug if it doesn't already have one
+ *
+ * @param slug Hub API slug (with or without context)
+ * @param context usually a portal's orgKey
+ * @returns slug with context ({context}::{slug})
+ */
+export function addContextToSlug(slug, context) {
+    // the slug has an org key already e.g. dc::crime-incidents
+    if (/.+::.+/.test(slug)) {
+        return slug;
+        // the slug belongs to the org that owns the site e.g. crime-incidents
+    }
+    else {
+        return context + "::" + slug;
+    }
+}
+/**
+ * Remove context (prefix) from a slug
+ *
+ * @param slug Hub API slug with context
+ * @param context usually a portal's orgKey
+ * @returns slug without context
+ */
+export function removeContextFromSlug(slug, context) {
+    if (context && slug.match(context + "::")) {
+        return slug.split(context + "::")[1];
+    }
+    else {
+        return slug;
+    }
+}
+/**
+ * Splits item category strings at slashes and discards the "Categories" keyword
+ *
+ * ```
+ * ["/Categories/Boundaries", "/Categories/Planning and cadastre/Property records", "/Categories/Structure"]
+ * ```
+ * Should end up being
+ * ```
+ * ["Boundaries", "Planning and cadastre", "Property records", "Structure"]
+ * ```
+ *
+ * @param categories - an array of strings
+ * @private
+ */
+export function parseItemCategories(categories) {
+    if (!categories)
+        return categories;
+    var exclude = ["categories", ""];
+    var parsed = categories.map(function (cat) { return cat.split("/"); });
+    var flattened = parsed.reduce(function (acc, arr, _) { return __spreadArrays(acc, arr); }, []);
+    return flattened.filter(function (cat) { return !includes(exclude, cat.toLowerCase()); });
+}
+/**
+ * return the Hub family given an item's type
+ * @param type item type
+ * @returns Hub family
+ */
+export function getFamily(type) {
+    var family;
+    // override default behavior for the rows that are highlighted in yellow here:
+    // https://esriis.sharepoint.com/:x:/r/sites/ArcGISHub/_layouts/15/Doc.aspx?sourcedoc=%7BADA1C9DC-4F6C-4DE4-92C6-693EF9571CFA%7D&file=Hub%20Routes.xlsx&nav=MTBfe0VENEREQzI4LUZFMDctNEI0Ri04NjcyLThCQUE2MTA0MEZGRn1fezIwMTIwMEJFLTA4MEQtNEExRC05QzA4LTE5MTAzOUQwMEE1RH0&action=default&mobileredirect=true&cid=df1c874b-c367-4cea-bc13-7bebfad3f2ac
+    switch ((type || "").toLowerCase()) {
+        case "image service":
+            family = "dataset";
+            break;
+        case "feature service":
+        case "raster layer":
+            // TODO: check if feature service has > 1 layer first?
+            family = "map";
+            break;
+        case "microsoft excel":
+            family = "document";
+            break;
+        case "cad drawing":
+        case "feature collection template":
+        case "report template":
+            family = "content";
+            break;
+        default:
+            // by default derive from collection
+            family = collectionToFamily(getCollection(type));
+    }
+    return family;
+}
+/**
+ * DEPRECATED: Use getFamily() instead.
+ *
+ * get the HubType for a given item or item type
+ *
+ * @param itemOrType an item or item.type
+ */
+export function getItemHubType(itemOrType) {
+    /* tslint:disable no-console */
+    console.warn("DEPRECATED: Use getFamily() instead. getItemHubType() will be removed at v10.0.0");
+    /* tslint:enable no-console */
+    if (typeof itemOrType === "string") {
+        itemOrType = { type: itemOrType };
+    }
+    var itemType = normalizeItemType(itemOrType);
+    // TODO: not all categories are Hub types, may need to validate
+    return getCollection(itemType);
+}
+/**
+ * Convert a Portal item to Hub content
+ *
+ * @param item Portal Item
+ * @returns Hub content
+ * @export
+ */
+export function itemToContent(item) {
+    var createdDate = new Date(item.created);
+    var createdDateSource = "item.created";
+    var properties = item.properties;
+    var content = Object.assign({}, item, {
+        identifier: item.id,
+        // no server errors when fetching the item directly
+        errors: [],
+        // store a reference to the item
+        item: item,
+        // NOTE: this will overwrite any existing item.name, which is
+        // The file name of the item for file types. Read-only.
+        // presumably there to use as the default file name when downloading
+        // we don't store item.name in the Hub API and we use name for title
+        name: item.title,
+        // TODO: hubType is no longer used, remove it at next breaking change
+        hubType: getItemHubType(item),
+        categories: parseItemCategories(item.categories),
+        itemCategories: item.categories,
+        // can we strip HTML from description, and do we need to trim it to a X chars?
+        summary: item.snippet || item.description,
+        publisher: {
+            name: item.owner,
+            username: item.owner,
+        },
+        permissions: {
+            visibility: item.access,
+            control: item.itemControl || "view",
+        },
+        // Hub app configuration metadata from item properties
+        actionLinks: properties && properties.links,
+        hubActions: properties && properties.actions,
+        metrics: properties && properties.metrics,
+        isDownloadable: isDownloadable(item),
+        // default boundary from item.extent
+        license: { name: "Custom License", description: item.accessInformation },
+        // dates and sources we will enrich these later...
+        createdDate: createdDate,
+        createdDateSource: createdDateSource,
+        publishedDate: createdDate,
+        publishedDateSource: createdDateSource,
+        updatedDate: new Date(item.modified),
+        updatedDateSource: "item.modified",
+        structuredLicense: getStructuredLicense(item.licenseInfo),
+    });
+    return setContentExtent(setContentType(content, item.type), item.extent);
+}
+/**
+ * Convert a Hub API dataset resource to Hub Content
+ *
+ * @param {DatasetResource} Dataset resource
+ * @returns {IHubContent} Hub content object
+ * @export
+ */
+export function datasetToContent(dataset) {
+    // extract item from dataset, create content from the item
+    var item = datasetToItem(dataset);
+    var content = itemToContent(item);
+    // We remove these because the indexer doesn't actually
+    // preserve the original item categories so this attribute is invalid
+    delete content.itemCategories;
+    // overwrite or add enrichments from Hub API
+    var hubId = dataset.id, attributes = dataset.attributes;
+    var 
+    // common enrichments
+    errors = attributes.errors, boundary = attributes.boundary, extent = attributes.extent, metadata = attributes.metadata, modified = attributes.modified, modifiedProvenance = attributes.modifiedProvenance, slug = attributes.slug, searchDescription = attributes.searchDescription, groupIds = attributes.groupIds, 
+    // map and feature server enrichments
+    server = attributes.server, layers = attributes.layers, 
+    // NOTE: the Hub API also returns the following server properties
+    // but we should be able to get them from the above server object
+    // currentVersion, capabilities, tileInfo, serviceSpatialReference
+    // maxRecordCount, supportedQueryFormats, etc
+    // feature and raster layer enrichments
+    layer = attributes.layer, recordCount = attributes.recordCount, statistics = attributes.statistics, 
+    // NOTE: the Hub API also returns the following layer properties
+    // but we should be able to get them from the above layer object
+    // supportedQueryFormats, supportsAdvancedQueries, advancedQueryCapabilities, useStandardizedQueries
+    // geometryType, objectIdField, displayField, fields,
+    // org properties?
+    orgId = attributes.orgId, orgName = attributes.orgName, organization = attributes.organization, orgExtent = attributes.orgExtent, 
+    // NOTE: for layers and tables the Hub API returns the layer type
+    // ("Feature Layer", "Table", "Raster Layer") instead of the item type
+    type = attributes.type;
+    // NOTE: we could throw or return if there are errors
+    // to prevent type errors trying to read properties below
+    content.errors = errors;
+    // common enrichments
+    content.boundary = boundary;
+    if (!isBBox(item.extent) && extent && isBBox(extent.coordinates)) {
+        // we fall back to the extent derived by the API
+        // which prefers layer or service extents and ultimately
+        // falls back to the org's extent
+        content.extent = extent.coordinates;
+    }
+    // setting this to null signals to enrichMetadata to skip this
+    content.metadata = metadata || null;
+    if (content.modified !== modified) {
+        // capture the enriched modified date
+        // NOTE: the item modified date is still available on content.item.modified
+        content.modified = modified;
+        content.updatedDate = new Date(modified);
+        content.updatedDateSource = modifiedProvenance;
+    }
+    content.slug = slug;
+    if (searchDescription) {
+        // overwrite default summary (from snippet) w/ search description
+        content.summary = searchDescription;
+    }
+    content.groupIds = groupIds;
+    // server enrichments
+    content.server = server;
+    content.layers = layers;
+    // layer enrichments
+    content.layer = layer;
+    content.recordCount = recordCount;
+    content.statistics = statistics;
+    // org enrichments
+    if (orgId) {
+        content.org = {
+            id: orgId,
+            name: orgName || organization,
+            extent: orgExtent,
+        };
+    }
+    // return a content with updated hubId and type
+    // along w/ related properties like identifier, family, etc
+    return setContentType(setContentHubId(content, hubId), type);
+}
+/**
+ * Convert a Hub API dataset resource to a portal item
+ *
+ * @param {DatasetResource} Dataset resource
+ * @returns {IItem} portal item
+ * @export
+ */
+export function datasetToItem(dataset) {
+    if (!dataset) {
+        return;
+    }
+    var id = dataset.id, attributes = dataset.attributes;
+    if (!attributes) {
+        return;
+    }
+    // parse item id
+    var itemId = parseDatasetId(id).itemId;
+    // read item properties from attributes
+    // NOTE: we attempt to read all item properties
+    // even though some may not be currently returned
+    var 
+    // start w/ item properties from
+    // https://developers.arcgis.com/rest/users-groups-and-items/item.htm
+    owner = attributes.owner, orgId = attributes.orgId, created = attributes.created, 
+    // the Hub API returns item.modified in attributes.itemModified (below)
+    modified = attributes.modified, 
+    // NOTE: we use attributes.name to store the title or the service/layer name
+    // but in Portal name is only used for file types to store the file name (read only)
+    name = attributes.name, title = attributes.title, type = attributes.type, typeKeywords = attributes.typeKeywords, description = attributes.description, snippet = attributes.snippet, tags = attributes.tags, thumbnail = attributes.thumbnail, 
+    // the Hub API returns item.extent in attributes.itemExtent (below)
+    // extent,
+    categories = attributes.categories, contentStatus = attributes.contentStatus, 
+    // the Hub API doesn't currently return spatialReference
+    spatialReference = attributes.spatialReference, 
+    // the Hub API doesn't currently return accessInformation
+    accessInformation = attributes.accessInformation, licenseInfo = attributes.licenseInfo, culture = attributes.culture, url = attributes.url, access = attributes.access, 
+    // the Hub API doesn't currently return proxyFilter
+    proxyFilter = attributes.proxyFilter, properties = attributes.properties, 
+    // the Hub API doesn't currently return appCategories, industries,
+    // languages, largeThumbnail, banner, screenshots, listed, ownerFolder
+    appCategories = attributes.appCategories, industries = attributes.industries, languages = attributes.languages, largeThumbnail = attributes.largeThumbnail, banner = attributes.banner, screenshots = attributes.screenshots, listed = attributes.listed, ownerFolder = attributes.ownerFolder, size = attributes.size, 
+    // the Hub API doesn't currently return protected
+    isProtected = attributes.protected, commentsEnabled = attributes.commentsEnabled, 
+    // the Hub API doesn't currently return numComments, numRatings,
+    // avgRating, numViews, itemControl, scoreCompleteness
+    numComments = attributes.numComments, numRatings = attributes.numRatings, avgRating = attributes.avgRating, numViews = attributes.numViews, itemControl = attributes.itemControl, scoreCompleteness = attributes.scoreCompleteness, 
+    // additional attributes we'll need
+    // to derive the above values when missing
+    itemExtent = attributes.itemExtent, itemModified = attributes.itemModified, modifiedProvenance = attributes.modifiedProvenance, serviceSpatialReference = attributes.serviceSpatialReference;
+    // layer datasets will get their type from the layer
+    // so we will need to derive the item type from the URL
+    var serviceType = url && getServiceTypeFromUrl(url);
+    // build and return an item from properties
+    // NOTE: we currently do NOT provide default values
+    // (i.e. null for scalar attributes, [] for arrays, etc)
+    // for attributes that are not returned by the Hub API
+    // this helps distinguish an item that comes from the API
+    // but forces all consumers to do handle missing properties
+    return {
+        id: itemId,
+        owner: owner,
+        orgId: orgId,
+        created: created,
+        // for feature layers, modified will usually come from the layer so
+        // we prefer itemModified, but fall back to modified if it came from the item
+        modified: (itemModified ||
+            (modifiedProvenance === "item.modified" && modified)),
+        title: (title || name),
+        type: serviceType || type,
+        typeKeywords: typeKeywords,
+        description: description,
+        tags: tags,
+        snippet: snippet,
+        thumbnail: thumbnail,
+        extent: itemExtent ||
+            /* istanbul ignore next: API should always return itemExtent, but we default to [] just in case */ [],
+        categories: categories,
+        contentStatus: contentStatus,
+        spatialReference: spatialReference || serviceSpatialReference,
+        accessInformation: accessInformation,
+        licenseInfo: licenseInfo,
+        culture: culture,
+        url: url,
+        access: access,
+        size: size,
+        protected: isProtected,
+        proxyFilter: proxyFilter,
+        properties: properties,
+        appCategories: appCategories,
+        industries: industries,
+        languages: languages,
+        largeThumbnail: largeThumbnail,
+        banner: banner,
+        screenshots: screenshots,
+        listed: listed,
+        ownerFolder: ownerFolder,
+        commentsEnabled: commentsEnabled,
+        numComments: numComments,
+        numRatings: numRatings,
+        avgRating: avgRating,
+        numViews: numViews,
+        itemControl: itemControl,
+        scoreCompleteness: scoreCompleteness,
+    };
+}
+/**
+ * returns a new content that has the specified type and
+ * and updated related properties like normalizedType, family, etc
+ * @param content orignal content
+ * @param type new type
+ * @returns new content
+ */
+export var setContentType = function (content, type) {
+    // get family and normalized type based on new type
+    var normalizedType = normalizeItemType(__assign(__assign({}, content.item), { type: type }));
+    var family = getFamily(normalizedType);
+    // TODO: don't we need to update content.item.type too?
+    var updated = __assign(__assign({}, content), { type: type, family: family, normalizedType: normalizedType });
+    // update the relative URL to the content
+    // which is based on type and family
+    return appendContentUrls(updated, {
+        relative: getContentRelativeUrl(updated),
+    });
+};
+/**
+ * returns a new content that has the specified hubId and updated identifier
+ * @param content orignal content
+ * @param hubId new hubId
+ * @returns new content
+ */
+export var setContentHubId = function (content, hubId) {
+    var id = content.id, slug = content.slug;
+    // get the identifier which is based on hubId
+    var identifier = slug || hubId || id;
+    var updated = __assign(__assign({}, content), { hubId: hubId, identifier: identifier });
+    // update the relative URL to the content
+    // which is based on identifier
+    return appendContentUrls(updated, {
+        relative: getContentRelativeUrl(updated),
+    });
+};
+/**
+ * Calculates the relative and absolute urls for a given content on a specific site
+ *
+ * @param content
+ * @param siteModel
+ * @returns relative and absolute urls
+ */
+export var getContentSiteUrls = function (content, siteModel) {
+    // compute relative URL using a site specific identifier
+    var siteIdentifier = getContentIdentifier(content, siteModel);
+    var relative = getContentRelativeUrl(content, siteIdentifier);
+    // get the absolute URL to this content on the site
+    var siteUrl = getProp(siteModel, "item.url").replace(/\/$/, "");
+    var absolute = "" + siteUrl + relative;
+    return { relative: relative, absolute: absolute };
+};
+/**
+ * append the absolute URL to the content on the site
+ * also updates the relative URL in case the
+ * @param content
+ * @param siteModel
+ * @returns
+ */
+export var setContentSiteUrls = function (content, siteModel) {
+    var _a = getContentSiteUrls(content, siteModel), relative = _a.relative, site = _a.absolute;
+    // append the updated URLs to a new content
+    return appendContentUrls(content, {
+        relative: relative,
+        site: site,
+    });
+};
+// URL helpers
+var appendContentUrls = function (content, newUrls) {
+    // merge new urls into existing ones and return a new content
+    var urls = __assign(__assign({}, content.urls), newUrls);
+    return __assign(__assign({}, content), { urls: urls });
+};
+var getContentRelativeUrl = function (content, siteIdentifier) {
+    var family = content.family;
+    // prefer site specific identifier if passed in
+    var identifier = siteIdentifier || content.identifier;
+    // solution types have their own logic
+    var contentUrl = getSolutionUrl(content);
+    if (!contentUrl) {
+        var pluralizedFamilies = [
+            "app",
+            "dataset",
+            "document",
+            "map",
+            "template",
+        ];
+        // default to the catchall content route
+        var path = "/content";
+        if (content.family === "feedback") {
+            // exception
+            path = "/feedback/surveys";
+        }
+        else if (isPageContent(content)) {
+            // pages are in the document family,
+            // but instead of showing the page's metadata on /documents/about
+            // but we render the page on the pages route
+            path = "/pages";
+        }
+        else if (pluralizedFamilies.indexOf(family) > -1) {
+            // the rule
+            path = "/" + family + "s";
+        }
+        contentUrl = path + "/" + identifier;
+    }
+    return contentUrl;
+};
+var getSolutionUrl = function (content) {
+    var _a;
+    var hubUrl;
+    var normalizedType = content.normalizedType, identifier = content.identifier;
+    if (normalizedType === "Solution") {
+        // NOTE: as per the above spreadsheet,
+        // solution types are now in the Template family
+        // but we don't send them to the route for initiative templates
+        if (((_a = content.typeKeywords) === null || _a === void 0 ? void 0 : _a.indexOf("Deployed")) > 0) {
+            // deployed solutions go to the generic content route
+            hubUrl = "/content/" + identifier;
+        }
+        // others go to the solution about route
+        hubUrl = "/templates/" + identifier + "/about";
+    }
+    return hubUrl;
+};
+// page helpers
+// TODO: we check both "Hub Page" and "Site Page" because we don't know whether the site is a portal or not
+// In the future, the site object will have a site.isPortal() function that we can leverage
+// instead of hardcoding the types here.
+// TODO: should this be based on normalizedType instead?
+var isPageContent = function (content) {
+    return includes(["Hub Page", "Site Page"], content.type);
+};
+//# sourceMappingURL=index.js.map