@esri/hub-common 14.182.0 → 14.183.0

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.183.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",