@esri/hub-common 11.5.0 → 11.7.0

package/dist/types/core/schemas/internal/getUiSchemaProps.d.ts

@@ -0,0 +1,9 @@
+import { IUiSchema } from "../types";
+/**
+ * Get all the property names from a UI schema.
+ *
+ * Used to subset a json schema to only those properties used in a UI Schema
+ * @param uiSchema
+ * @returns
+ */
+export declare function getUiSchemaProps(uiSchema: IUiSchema): string[];

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

@@ -0,0 +1,4 @@
+export * from "./getUiSchemaProps";
+export * from "./subsetSchema";
+export * from "./filterSchemaToUiSchema";
+export * from "./applyUiSchemaElementOptions";

package/dist/types/core/schemas/internal/subsetSchema.d.ts

@@ -0,0 +1,8 @@
+import { IConfigurationSchema } from "../types";
+/**
+ * Subset a json schema to only those properties specified.
+ * @param schema
+ * @param props
+ * @returns
+ */
+export declare function subsetSchema(schema: IConfigurationSchema, props: string[]): IConfigurationSchema;

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

@@ -0,0 +1,61 @@
+import { JSONSchema } from "json-schema-typed";
+import Ajv from "ajv";
+export declare enum UiSchemaRuleEffects {
+    SHOW = "SHOW",
+    HIDE = "HIDE",
+    DISABLE = "DISABLE",
+    NONE = ""
+}
+export declare enum UiSchemaElementTypes {
+    section = "Section",
+    step = "Step",
+    control = "Control",
+    layout = "Layout",
+    slot = "Slot"
+}
+export declare enum UiSchemaSectionTypes {
+    accordion = "accordion",
+    stepper = "stepper"
+}
+export interface IConfigurationSchema extends JSONSchema {
+    type?: "object";
+}
+export interface IConfigurationValues {
+    [key: string]: unknown;
+}
+export interface IChangeEventDetail {
+    valid: boolean;
+    values?: {
+        [key: string]: any;
+    };
+}
+export interface IValidationResult {
+    valid: boolean;
+    errors?: Ajv.ErrorObject[];
+}
+export interface IUiSchemaRule {
+    effect: UiSchemaRuleEffects;
+    condition: {
+        scope: string;
+        schema: IConfigurationSchema;
+    };
+}
+export interface IUiSchemaElement {
+    type: string;
+    labelKey?: string;
+    label?: string;
+    options?: {
+        [key: string]: any;
+    };
+    scope?: string;
+    rule?: IUiSchemaRule;
+    elements?: IUiSchemaElement[];
+    tooltip?: string;
+}
+export interface IUiSchema extends IUiSchemaElement {
+    elements?: IUiSchema[] | IUiSchemaElement[];
+}
+/**
+ * Run-time configuration for UiSchema Elements
+ */
+export declare type UiSchemaElementOptions = Pick<IUiSchemaElement, "scope" | "options">;

package/dist/types/extent.d.ts

@@ -6,6 +6,13 @@ import { IHubRequestOptions, BBox } from "./types";
  * @returns extent object
  */
 export declare const bBoxToExtent: (bBox: BBox) => IExtent;
+/**
+ * Given a Bbox, convert it to a string. Some api endpoints expect a string
+ *
+ * @param {BBox} extent
+ * @return {*}  {string}
+ */
+export declare const bboxToString: (extent: BBox) => string;
 export declare function createExtent(xmin: number, ymin: number, xmax: number, ymax: number, wkid?: number): IExtent;
 /**
  * Turns an extent object into a bounding box coordinate array

package/dist/types/initiatives/HubInitiative.d.ts

@@ -46,6 +46,12 @@ export declare class HubInitiative extends HubItemEntity<IHubInitiative> impleme
      * @returns
      */
     static fetch(identifier: string, context: IArcGISContext): Promise<HubInitiative>;
+    /**
+     * Static method to get the editor config for for the HubProject entity.
+     * @param i18nScope Translation scope to be interpolated into the schemas
+     * @param type
+     * @param options Optional hash of Element component options
+     */
     private static applyDefaults;
     /**
      * Apply a new state to the instance

package/dist/types/objects/deepGetPropValues.d.ts

@@ -0,0 +1,6 @@
+/**
+ * For a given property name, extract an array of the unique values of that property
+ * This was designed to work with string values, so no promises about other types
+ * @param obj
+ */
+export declare function deepGetPropValues(obj: Record<string, any>, prop: string): string[];

package/dist/types/projects/HubProject.d.ts

@@ -1,7 +1,8 @@
-import { IHubProject, IWithPermissionBehavior, IWithCatalogBehavior, PermissionManager, IWithStoreBehavior, IWithSharingBehavior } from "../core";
+import { IHubProject, IWithPermissionBehavior, IWithCatalogBehavior, PermissionManager, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions } from "../core";
 import { Catalog } from "../search/Catalog";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
+import { EditorConfigType, IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
 /**
  * Hub Project Class
  */
@@ -46,6 +47,16 @@ export declare class HubProject extends HubItemEntity<IHubProject> implements IW
      * @returns
      */
     static fetch(identifier: string, context: IArcGISContext): Promise<HubProject>;
+    /**
+     * Static method to get the editor config for for the HubProject entity.
+     * @param i18nScope Translation scope to be interpolated into the schemas
+     * @param type
+     * @param options Optional hash of uiSchema element option overrides
+     * Note: typescript does not have a means to specify static methods in interfaces
+     * so while this is the implementation of IWithEditorBehavior, it is not enforced
+     * by the compiler.
+     */
+    static getEditorConfig(i18nScope: string, type: EditorConfigType, options?: UiSchemaElementOptions[]): Promise<IEditorConfig>;
     private static applyDefaults;
     /**
      * Apply a new state to the instance

package/dist/types/projects/HubProjects.d.ts

@@ -1,5 +1,5 @@
 import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
-import { IHubRequestOptions } from "../index";
+import { IHubRequestOptions, EditorConfigType, UiSchemaElementOptions, IEditorConfig } from "../index";
 import { IItem } from "@esri/arcgis-rest-portal";
 import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { IHubProject } from "../core/types";
@@ -53,3 +53,11 @@ export declare function convertItemToProject(item: IItem, requestOptions: IReque
  * @returns
  */
 export declare function enrichProjectSearchResult(item: IItem, include: string[], requestOptions: IHubRequestOptions): Promise<IHubSearchResult>;
+/**
+ * Get the editor config for for the HubProject entity.
+ * @param i18nScope Translation scope to be interpolated into the schemas
+ * @param type
+ * @param options Optional hash of Element component options
+ * @returns
+ */
+export declare function getHubProjectEditorConfig(i18nScope: string, type: EditorConfigType, options?: UiSchemaElementOptions[]): Promise<IEditorConfig>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "11.5.0",
+  "version": "11.7.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",
@@ -14,8 +14,10 @@
   "dependencies": {
     "abab": "^2.0.5",
     "adlib": "^3.0.7",
+    "ajv": "^6.12.6",
     "fast-xml-parser": "^3.21.0",
     "jsonapi-typescript": "^0.1.3",
+    "json-schema-typed": "^7.0.3",
     "tslib": "^1.13.0"
   },
   "peerDependencies": {