@esri/hub-common 13.17.2 → 13.17.4

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

@@ -0,0 +1,29 @@
+import { SitePermissions } from "../SiteBusinessRules";
+/**
+ * legacy site capabilities
+ */
+export declare type LegacyCapability = "hideFollow";
+/**
+ * representation of legacy site capabilities as
+ * feature flags
+ */
+export interface ILegacyCapabilityFeatureFlags extends Partial<Record<LegacyCapability, boolean>> {
+}
+/**
+ * capability to feature map entry that provides a
+ * "cross-walk" between a legacy site capability
+ * and site feature (using the new permissions
+ * system)
+ *
+ * This enables us to convert/migrate capabilities
+ * to features when sites are fetched and updated
+ */
+export interface ICapabilityToFeatureMap {
+    capability: LegacyCapability;
+    feature: (typeof SitePermissions)[number];
+    /**
+     * whether to apply a ! when converting between the
+     * capability and feature
+     */
+    negate?: boolean;
+}

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

@@ -0,0 +1,11 @@
+import { IModel } from "../../types";
+/**
+ * Converts the migrated catalog of a site model back into a legacy catalog format.
+ * As the new catalog format is much more flexible than the legacy format, only supported
+ * fields configurations (i.e., group ids) are transferred.
+ *
+ * @param modelToUpdate modified site model with a migrated catalog
+ * @param currentModel currently persisted site model with a legacy catalog
+ * @returns site model with any catalog group changes reflected in a legacy format
+ */
+export declare function convertCatalogToLegacyFormat(modelToUpdate: IModel, currentModel: IModel): IModel;

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

@@ -0,0 +1,11 @@
+import { IModel } from "../../types";
+/**
+ * Reflects changes from a site model's collections to the `site.data.values.searchCategories`
+ * legacy property. This is a needed stop-gap since old search page will coexist for a time with
+ * the new workspaces UI and the old search page (among others) still rely on the `searchCategories`
+ * construct.
+ *
+ * @param model a site item model
+ * @returns a model with the catalog collections and search categories in sync
+ */
+export declare function reflectCollectionsToSearchCategories(model: IModel): IModel;

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

@@ -0,0 +1,8 @@
+export declare enum SearchCategories {
+    DATA = "components.search.category_tabs.data",
+    SITES = "components.search.category_tabs.sites",
+    DOCUMENTS = "components.search.category_tabs.documents",
+    APPS_AND_MAPS = "components.search.category_tabs.apps_and_maps",
+    EVENTS = "components.search.category_tabs.events",
+    INITIATIVES = "components.search.category_tabs.initiatives"
+}

package/dist/types/urls/cacheBustUrl.d.ts

@@ -0,0 +1,5 @@
+/**
+ * artifically update a query param associated with a url to force
+ * the browser to load it from file rather than from cache
+ */
+export declare const cacheBustUrl: (url: string, param?: string) => string;

package/dist/types/urls/getCardModelUrl.d.ts

@@ -0,0 +1,21 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { HubEntity } from "../core/types/HubEntity";
+import { CardModelTarget } from "../core/types/IHubCardViewModel";
+import { IHubSearchResult } from "../search/types/IHubSearchResult";
+/**
+ * returns a gallery card's title url from a hub search result
+ *
+ * @param result hub search result
+ * @param target context the card should redirect to
+ * @param baseUrl base url to work in conjunction with the target
+ */
+export declare function getCardModelUrlFromResult(result: IHubSearchResult, target: CardModelTarget, baseUrl?: string): string;
+/**
+ * returns a gallery card's title url from an entity
+ *
+ * @param entity hub entity
+ * @param context auth & portal information
+ * @param target context the card should redirect to
+ * @param baseUrl base url to work in conjunction with the target
+ */
+export declare function getCardModelUrlFromEntity(entity: HubEntity, context: IArcGISContext, target: CardModelTarget, baseUrl?: string): string;

package/dist/types/users/view.d.ts

@@ -0,0 +1,9 @@
+import { ResultToCardModelFn } from "../core";
+/**
+ * Convert a user hub search result into a card view model that
+ * can be consumed by the suite of hub gallery components
+ *
+ * @param searchResult hub user search result
+ * @param opts view model options
+ */
+export declare const userResultToCardModel: ResultToCardModelFn;

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

@@ -0,0 +1,2 @@
+import { HubEnvironment } from "../permissions";
+export declare function getEnvironmentFromPortalUrl(portalUrl: string): HubEnvironment;

package/package.json

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