@esri/hub-common 14.137.0 → 14.139.0

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

@@ -1,2 +1,2 @@
-export declare const HUB_ENTITY_TYPES: readonly ["site", "project", "initiative", "initiativeTemplate", "page", "discussion", "content", "org", "group", "template", "survey", "event"];
+export declare const HUB_ENTITY_TYPES: readonly ["site", "project", "initiative", "initiativeTemplate", "page", "discussion", "content", "org", "group", "template", "survey", "event", "user"];
 export declare type HubEntityType = (typeof HUB_ENTITY_TYPES)[number];

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

@@ -78,6 +78,10 @@ export interface IHubEvent extends IHubItemEntity, IWithPermissions, IWithSlug {
      * True when the event has been removed
      */
     isRemoved: boolean;
+    /**
+     * True when the event takes place in the past
+     */
+    isPast: boolean;
     /**
      * If attendees should be notified of event updates
      */

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

@@ -0,0 +1,45 @@
+import { IHubEntityBase } from "./IHubEntityBase";
+import { SettableAccessLevel } from "./types";
+/**
+ * Defines the properties of a Hub User object
+ *
+ * NOTE: unlike other entities, we do not support
+ * creating, updating, or deleting users due to
+ * the limitations imposed by the platform on those operations
+ *
+ * @internal
+ */
+export interface IHubUser extends IHubEntityBase {
+    /**
+     * Access level of the user
+     * ("private" | "org" | "public")
+     */
+    access: SettableAccessLevel;
+    /**
+     * Description for the item
+     */
+    description?: string;
+    /**
+     * Id of the org that the user belongs to
+     */
+    orgId?: string;
+    /**
+     * User's own username
+     */
+    owner?: string;
+    /**
+     * User configurable tags
+     */
+    tags?: string[];
+    /**
+     * User thumbnail url (read-only)
+     */
+    thumbnail?: string;
+    /**
+     * System configurable typekeywords
+     * NOTE: this will be initialized as an empty array
+     * and is only here for consistency with other entities
+     * and will be ignored otherwise
+     */
+    typeKeywords?: string[];
+}

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

@@ -32,3 +32,4 @@ export * from "./MaybeTranslate";
 export * from "./IHubCardViewModel";
 export * from "./Metrics";
 export * from "./types";
+export * from "./IHubUser";

package/dist/types/permissions/types/Permission.d.ts

@@ -10,6 +10,7 @@ import { InitiativeTemplatePermissions } from "../../initiative-templates/_inter
 import { TemplatePermissions } from "../../templates/_internal/TemplateBusinessRules";
 import { SurveyPermissions } from "../../surveys/_internal/SurveyBusinessRules";
 import { EventPermissions } from "../../events/_internal/EventBusinessRules";
+import { UserPermissions } from "../../users/_internal/UserBusinessRules";
 /**
  * Defines the values for Permissions
  * It's critical that the arrays defined in the modules use `as const`
@@ -20,7 +21,7 @@ declare const SystemPermissions: string[];
 /**
  * Defines the possible values for Permissions
  */
-export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number] | (typeof TemplatePermissions)[number] | (typeof SystemPermissions)[number] | (typeof SurveyPermissions)[number] | (typeof EventPermissions)[number];
+export declare type Permission = (typeof SitePermissions)[number] | (typeof ProjectPermissions)[number] | (typeof InitiativePermissions)[number] | (typeof ContentPermissions)[number] | (typeof GroupPermissions)[number] | (typeof PagePermissions)[number] | (typeof PlatformPermissions)[number] | (typeof TempPermissions)[number] | (typeof DiscussionPermissions)[number] | (typeof InitiativeTemplatePermissions)[number] | (typeof TemplatePermissions)[number] | (typeof SystemPermissions)[number] | (typeof SurveyPermissions)[number] | (typeof EventPermissions)[number] | (typeof UserPermissions)[number];
 /**
  * Validate a Permission
  * @param permission

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

@@ -1,6 +1,8 @@
 import { IUser } from "@esri/arcgis-rest-types";
+import { IHubUser } from "../core/types/IHubUser";
 import { IHubRequestOptions } from "../types";
 import { IHubSearchResult } from "../search/types/IHubSearchResult";
+export declare const convertUserToHubUser: (user: IUser) => IHubUser;
 /**
  * Enrich a User object
  * @param user
@@ -9,3 +11,4 @@ import { IHubSearchResult } from "../search/types/IHubSearchResult";
  * @returns
  */
 export declare function enrichUserSearchResult(user: IUser & Record<string, any>, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;
+export declare const fetchHubUser: (username: string, requestOptions?: IHubRequestOptions) => Promise<IHubUser>;

package/dist/types/users/_internal/UserBusinessRules.d.ts

@@ -0,0 +1,12 @@
+import { IPermissionPolicy } from "../../permissions";
+/**
+ * User Permission Policies
+ * These define the requirements any user must meet to perform related actions
+ * @private
+ */
+export declare const UserPermissions: readonly ["hub:user", "hub:user:view", "hub:user:edit", "hub:user:owner", "hub:user:workspace", "hub:user:workspace:overview", "hub:user:manage"];
+/**
+ * User permission policies
+ * @private
+ */
+export declare const UserPermissionPolicies: IPermissionPolicy[];

package/package.json

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