@esri/hub-common 14.90.0 → 14.91.0

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

@@ -0,0 +1,62 @@
+import { HubEntityType } from "./types/HubEntityType";
+/**
+ * History is a way to track a set of sites/projects/initiatives/pages that a user has visited
+ * Any content can be added to the history, but there will be different limits for different types
+ * Please see the addHistoryEntry function for more details
+ */
+export interface IHubHistory {
+    entries: IHubHistoryEntry[];
+}
+/**
+ * History entry
+ */
+export interface IHubHistoryEntry {
+    /**
+     * Entity Type
+     */
+    type: HubEntityType;
+    /**
+     * What action was last taken on the entity
+     * In the future this can expand to "replied to", "shared with" etc
+     */
+    action: "view" | "workspace";
+    /**
+     * Url the user visited
+     */
+    url: string;
+    /**
+     * Unique identifier for the entity
+     */
+    id: string;
+    /**
+     * Title of the entity
+     */
+    title: string;
+    /**
+     * Owner of the entity
+     */
+    owner?: string;
+    /**
+     * timestamp the entity was last visited
+     */
+    visited?: number;
+    /**
+     * Additional parameters that can be used to rehydrate the entity
+     */
+    params?: any;
+}
+/**
+ * Add an entry to the history. This handles the limits per type,
+ * and ensures that the most recent entry is at the top of the list.
+ * This function does not persist the history, it only updates the object.
+ * @param entry
+ * @param history
+ * @returns
+ */
+export declare function addHistoryEntry(entry: IHubHistoryEntry, history: IHubHistory): IHubHistory;
+/**
+ * Remove a specific entry from the user's history
+ * @param entry
+ * @returns
+ */
+export declare function removeHistoryEntry(entry: IHubHistoryEntry, history: IHubHistory): IHubHistory;

package/dist/types/index.d.ts

@@ -38,6 +38,7 @@ export * from "./core/updateHubEntity";
 export * from "./urls/getCardModelUrl";
 export * from "./core/EntityEditor";
 export * from "./search/explainQueryResult";
+export * from "./core/hubHistory";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 import HubError from "./HubError";

package/dist/types/items/slugs.d.ts

@@ -1,8 +1,8 @@
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IItem } from "@esri/arcgis-rest-types";
 /**
- * Create a slug, namespaced to an org
- * Typically used to lookup items by a human readable name in urls
+ * Create a slug, namespaced to an org and accounting for the 256 character limit
+ * of individual typekeywords. Typically used to lookup items by a human readable name in urls
  *
  * @param title
  * @param orgKey
@@ -12,9 +12,10 @@ export declare function constructSlug(title: string, orgKey: string): string;
 /**
  * Adds/Updates the slug typekeyword
  * Returns a new array of keywords
- * @param typeKeywords
- * @param slug
- * @returns
+ *
+ * @param typeKeywords A collection of typekeywords
+ * @param slug The slug to add/update
+ * @returns An updated collection of typekeywords
  */
 export declare function setSlugKeyword(typeKeywords: string[], slug: string): string[];
 /**

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

@@ -1,4 +1,5 @@
 import { IArcGISContext } from "../ArcGISContext";
+import { IHubHistory } from "../core/hubHistory";
 /**
  * Site Level Settings
  */
@@ -33,6 +34,10 @@ export interface IUserHubSettings {
          */
         workspace: boolean;
     };
+    /**
+     * Optional history of sites/content the user has visited
+     */
+    history?: IHubHistory;
 }
 /**
  * @private

package/package.json

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