@esri/hub-common 14.182.0 → 14.184.0

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

@@ -1,3 +1,4 @@
+import { IUserHubSettings } from "../../utils/hubUserAppResources";
 import { IHubEntityBase } from "./IHubEntityBase";
 import { SettableAccessLevel } from "./types";
 /**
@@ -27,6 +28,21 @@ export interface IHubUser extends IHubEntityBase {
      * User's own username
      */
     owner?: string;
+    /**
+     * the user's settings
+     */
+    settings?: IUserHubSettings;
+    /**
+     * the user's org settings that are configurable from hub
+     * IMPT NOTE: this is a TEMPORARY solution and should be used sparingly. We are currently allowing
+     * these settings to live on a user entity to allow for updating these settings in the user workspace
+     * using the entity-editor. In the long term, we'd want these to be updated in an org-specific
+     * workspace, rather than in the user workspace.
+     *
+     * We do NOT EVER want to rely on reading from these props on the user entity to dictate
+     * what an org setting should look like.
+     */
+    hubOrgSettings?: IHubUserOrgSettings;
     /**
      * User configurable tags
      */
@@ -43,3 +59,19 @@ export interface IHubUser extends IHubEntityBase {
      */
     typeKeywords?: string[];
 }
+/**
+ * Defines the properties of a Hub Org's settings stored on a IHubUser.
+ *
+ * IMPT NOTE: this is a TEMPORARY solution and should be used sparingly. We are currently allowing
+ * these settings to live on a user entity to allow for updating these settings in the user workspace
+ * using the entity-editor. In the long term, we'd want these to be updated in an org-specific
+ * workspace, rather than in the user workspace.
+ *
+ * We do NOT EVER want to rely on reading from these props on the user entity to dictate
+ * what an org setting should look like.
+ */
+export interface IHubUserOrgSettings {
+    showInformationalBanner?: boolean;
+    termsAndConditions?: string;
+    signupText?: string;
+}

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

@@ -0,0 +1,65 @@
+import { IEntityEditorContext, IHubUser } from "../core/types";
+import { IArcGISContext } from "../ArcGISContext";
+import { IEditorConfig } from "../core/schemas/types";
+import { IWithEditorBehavior } from "../core/behaviors/IWithEditorBehavior";
+import { UserEditorType } from "./_internal/UserSchema";
+export declare class HubUser implements IWithEditorBehavior {
+    protected context: IArcGISContext;
+    protected entity: IHubUser;
+    protected isDestroyed: boolean;
+    private constructor();
+    /**
+     * Create an instance from a IHubUser object
+     * @param json - JSON object to create a HubProject from
+     * @param context - ArcGIS context
+     * @returns HubUser
+     */
+    static fromJson(json: Partial<IHubUser>, context: IArcGISContext): HubUser;
+    /**
+     * Given a partial user object, apply defaults to it to ensure that a baseline of properties are set
+     * @param partialUser
+     * @returns IHubUser
+     */
+    private static applyDefaults;
+    /**
+     * Method that returns the entity as a JSON object
+     * We have this on the EntityItem class, but we don't implement that here
+     * @returns IHubUser
+     */
+    toJson(): IHubUser;
+    /**
+     * Save the HubUser to the backing store.
+     *
+     * Note that Hub does not currently support the creation of users,
+     * so this function should only be used for updating users.
+     *
+     * @returns
+     */
+    save(): Promise<void>;
+    /**
+     * Delete the HubUser from the store
+     * set a flag to indicate that it is destroyed
+     *
+     * Note that Hub does not currently support the deletion of users,
+     * so this function should not be used as of now.
+     * @returns
+     */
+    delete(): Promise<void>;
+    /**
+     * Get the editor config for the HubUser entity.
+     * @param i18nScope translation scope to be interpolated into the uiSchema
+     * @param type editor type - corresponds to the returned uiSchema
+     */
+    getEditorConfig(i18nScope: string, type: UserEditorType): Promise<IEditorConfig>;
+    /**
+     * Transforms entity values into editor values
+     * @param editorContext
+     * @param include
+     */
+    toEditor(editorContext?: IEntityEditorContext, include?: string[]): Promise<IHubUser>;
+    /**
+     * Transforms editor values into entity values
+     * @param editor
+     */
+    fromEditor(editor: IHubUser): Promise<IHubUser>;
+}

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

@@ -2,13 +2,26 @@ import { IUser } from "@esri/arcgis-rest-types";
 import { IHubUser } from "../core/types/IHubUser";
 import { IHubRequestOptions } from "../types";
 import { IHubSearchResult } from "../search/types/IHubSearchResult";
+import { IArcGISContext } from "../ArcGISContext";
+/**
+ * Converts a IUser object into an IHubUser.
+ *
+ * @param user
+ * @returns IHubUser
+ */
 export declare const convertUserToHubUser: (user: IUser) => IHubUser;
 /**
- * Enrich a User object
+ * Enriches an IUser object search result.
  * @param user
  * @param includes
  * @param requestOptions
  * @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>;
+/**
+ * Fetches a hub user by username
+ * @param username - hub username. can also be "self"
+ * @param context
+ * @returns
+ */
+export declare const fetchHubUser: (username: string, context?: IArcGISContext) => Promise<IHubUser>;

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

@@ -4,7 +4,7 @@ import { IPermissionPolicy } from "../../permissions";
  * 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"];
+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:workspace:settings", "hub:user:manage"];
 /**
  * User permission policies
  * @private

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

@@ -0,0 +1,7 @@
+import { IConfigurationSchema } from "../../core/schemas/types";
+export declare type UserEditorType = (typeof UserEditorTypes)[number];
+export declare const UserEditorTypes: readonly ["hub:user:settings"];
+/**
+ * Defines the JSON schema for a Hub User's editable fields.
+ */
+export declare const UserSchema: IConfigurationSchema;

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

@@ -0,0 +1,13 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { IUiSchema } from "../../core/schemas/types";
+/**
+ * @private
+ * constructs the settings uiSchema for Hub Users.
+ * This defines how the schema should be rendered in the
+ * user workspace settings pane
+ * @param i18nScope - translation scope to be interpolated into the uiSchema
+ * @param options - additional options to customize the uiSchema
+ * @param context - contextual auth and portal information
+ * @returns
+ */
+export declare const buildUiSchema: (i18nScope: string, options: any, context: IArcGISContext) => Promise<IUiSchema>;

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

@@ -0,0 +1,20 @@
+import { IUser } from "@esri/arcgis-rest-types";
+import { IArcGISContext } from "../../ArcGISContext";
+import { IHubUser } from "../../core/types";
+/**
+ * Given a model and a user, sets various computed properties that can't be directly mapped.
+ * @param model
+ * @param user
+ * @param context
+ * @returns
+ */
+export declare function computeProps(model: IUser, user: IHubUser, context: IArcGISContext): Promise<IHubUser>;
+/**
+ * Fetches the portal's signin settings by making a request to the
+ * ${portalUrl}/portals/self/signinSettings endpoint.
+ *
+ * Returns a promise that resolves with the signin settings object.
+ *
+ * @param context
+ */
+export declare function getPortalSignInSettings(context: IArcGISContext): Promise<any>;

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

@@ -11,6 +11,9 @@ export interface IUserEnrichments {
      */
     errors?: IEnrichmentErrorInfo[];
 }
+/**
+ * Available enrichments for Users
+ */
 export declare type UserEnrichment = keyof IUserEnrichments;
 /**
  * Merging of the Enrichment and the User

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

@@ -0,0 +1,6 @@
+/**
+ * Default user properties
+ *
+ * TODO: add default user properties as we need them
+ */
+export declare const DEFAULT_USER: {};

package/package.json

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