@esri/solutions-components 1.2.0-next.98 → 5.0.0

package/dist/components/create-feature/customElement.d.ts

@@ -1,152 +1,212 @@
-/// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { ISearchConfiguration } from '../../utils/interfaces';
-import { PropertyValues } from 'lit';
-import { PublicLitElement as LitElement, TargetedEvent, JsxNode } from '@arcgis/lumina';
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+import type { IImageExtraction, ISearchConfiguration } from "../../utils/interfaces.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
 
-type ICurrentPage = 'drawing' | 'editing' | 'featureForm' | 'templatePicker';
-export declare class CreateFeature extends LitElement {
-    /**
-     * boolean: Set this to true when have a custom submit button in the app.
-     * This will hide the header and footer elements of the editor and user needs to execute the submit method manually.
-     *
-     * @default false
-     */
-    customizeSubmit?: boolean;
-    /**
-     * boolean: When true the Search box will be displayed
-     *
-     * @default false
-     */
-    enableSearch?: boolean;
-    /**
-     * When true the snapping options will be exposed
-     *
-     * @default false
-     */
-    enableSnapping: boolean;
-    /**
-     * string: selected floor level
-     *
-     * @default ''
-     */
-    floorLevel: string;
-    /** string: selected floor level */
-    formElements: any;
-    /**
-     * boolean: When true the application will be in mobile mode, controls the mobile or desktop view
-     *
-     * @default false
-     */
-    isMobile: boolean;
-    /** esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html */
-    mapView: __esri.MapView | undefined;
-    /** ISearchConfiguration: Configuration details for the Search widget */
-    searchConfiguration: ISearchConfiguration | undefined;
-    /**
-     * string: Layer id of the feature layer in which the new feature is to be created
-     *
-     * @default ''
-     */
-    selectedLayerId: string;
-    /**
-     * boolean: When true the notice message with the current state should be shown
-     *
-     * @default true
-     */
-    showGuidingMsg?: boolean;
-    /**
-     * string: Text to be displayed that will allow user to know they can submit new reports
-     *
-     * @default ''
-     */
-    submitNewReportsMessage: string;
-    /**
-     * boolean: When true the map should shown in the editor component in mobile mode (while drawing graphic)
-     *
-     * @default false
-     */
-    updateMapPosition: boolean;
-    /**
-     * boolean: When true reporting area layer should be honored if it exists
-     *
-     * @default false
-     */
-    reportingArea: boolean;
-    /**
-     * string: polygon layer for the reporting feature
-     *
-     * @default ''
-     */
-    reportingAreaLayer?: string | undefined;
-    /**
-     * string: Message to be displayed when feature is outside the reportingAreaLayer
-     *
-     * @default ''
-     */
-    reportingAreaMessage: string;
-    /**
-     * boolean: When true Editor's sketch widgets will be displayed
-     *
-     * @default false
-     */
-    showSketchWidgets: boolean;
-    /**
-     * boolean: When true user can create multiple features
-     *
-     * @default false
-     */
-    allowMultipleCreation: boolean;
-    /**
-     * boolean: When true clicking on a feature on the map will display a popup
-     *
-     * @default false
-     */
-    popupEnabled: boolean;
-    /**
-     * boolean: When true the layer visibility message will be shown
-     *
-     * @default false
-     */
-    showLayerVisibilityMsg?: boolean | undefined;
-    /**
-     * Submit the created feature
-     *
-     * @returns Promise that resolves when the operation is complete
-     */
-    submit(): Promise<void>;
-    /**
-     * Refreshes the editor state, optionally updating the floor level.
-     *
-     * @param floorLevel
-     * @param floorLevel - (Optional) The floor level to set. If provided, the editor updates to this floor level.
-     * @returns A promise that resolves when the refresh operation is complete.
-     */
-    refresh(floorLevel?: string): Promise<void>;
-    /** Shows feature form */
-    showForm(): Promise<void>;
-    /** Emitted on demand when the feature is created successfully */
-    readonly success: TargetedEvent<this, void>;
-    /** Emitted on demand when the feature creation is failed */
-    readonly fail: TargetedEvent<this, Error>;
-    /** Emitted on demand when drawing is completed */
-    readonly drawComplete: TargetedEvent<this, boolean>;
-    /** Emitted on demand when in editing mode */
-    readonly editingLocation: TargetedEvent<this, void>;
-    /** Emitted on demand when editing attachments */
-    readonly editingAttachment: TargetedEvent<this, boolean>;
-    /** Emitted on demand when editor panel changes */
-    readonly progressStatus: TargetedEvent<this, number>;
-    /** Emitted on switched form mobile to desktop or vice versa */
-    readonly modeChanged: TargetedEvent<this, void>;
-    "@eventTypes": {
-        "drawComplete": CreateFeature["drawComplete"]["detail"];
-        "editingAttachment": CreateFeature["editingAttachment"]["detail"];
-        "editingLocation": CreateFeature["editingLocation"]["detail"];
-        "fail": CreateFeature["fail"]["detail"];
-        "modeChanged": CreateFeature["modeChanged"]["detail"];
-        "progressStatus": CreateFeature["progressStatus"]["detail"];
-        "success": CreateFeature["success"]["detail"];
-    };
-}
-export {};
+export abstract class CreateFeature extends LitElement {
+  /**
+   * Contains the translations for this component.
+   * All UI strings should be defined here.
+   *
+   * @internal
+   */
+  protected _translations: {
+      chooseCategoryMsg: string;
+      provideDetailsMsg: string;
+      provideLocationMsg: string;
+      editLocationLabel: string;
+      reportOutsideAreaMessage: string;
+      enableFeatureTemplatesMessage: string;
+      aiImgExtractionLabel: string;
+      aiAssistantDescription: string;
+      fillOutManually: string;
+      startBlank: string;
+      next: string;
+      cancel: string;
+      createReportHeading: string;
+      aiAssistantProcessingHint: string;
+      imageUploadLimitHint: string;
+      replaceImage: string;
+      analyzingImage: string;
+      formReviewMsg: string;
+      skip: string;
+      photo: string;
+      error: string;
+      imageExtractionError: string;
+  } & T9nMeta<{
+      chooseCategoryMsg: string;
+      provideDetailsMsg: string;
+      provideLocationMsg: string;
+      editLocationLabel: string;
+      reportOutsideAreaMessage: string;
+      enableFeatureTemplatesMessage: string;
+      aiImgExtractionLabel: string;
+      aiAssistantDescription: string;
+      fillOutManually: string;
+      startBlank: string;
+      next: string;
+      cancel: string;
+      createReportHeading: string;
+      aiAssistantProcessingHint: string;
+      imageUploadLimitHint: string;
+      replaceImage: string;
+      analyzingImage: string;
+      formReviewMsg: string;
+      skip: string;
+      photo: string;
+      error: string;
+      imageExtractionError: string;
+  }>;
+  /** array: Configured AI image extraction field and prompt for the selected LayerId */
+  accessor aiImageExtraction: IImageExtraction[] | undefined;
+  /**
+   * boolean: When true user can create multiple features
+   *
+   * @default false
+   */
+  accessor allowMultipleCreation: boolean;
+  /** string: The name of Instant Apps application (e.g., "reporter", "manager") used in the request source header */
+  accessor appName: string | undefined;
+  /**
+   * boolean: Set this to true when have a custom submit button in the app.
+   * This will hide the header and footer elements of the editor and user needs to execute the submit method manually.
+   *
+   * @default false
+   */
+  accessor customizeSubmit: boolean | undefined;
+  /**
+   * boolean: When true photo get location from the photo selected for AI image Extraction
+   *
+   * @default false
+   */
+  accessor enablePhotoLocation: boolean | undefined;
+  /**
+   * boolean: When true the Search box will be displayed
+   *
+   * @default false
+   */
+  accessor enableSearch: boolean | undefined;
+  /**
+   * When true the snapping options will be exposed
+   *
+   * @default false
+   */
+  accessor enableSnapping: boolean;
+  /**
+   * string: selected floor level
+   *
+   * @default ''
+   */
+  accessor floorLevel: string;
+  /** string: selected floor level */
+  accessor formElements: any;
+  /**
+   * boolean: When true the application will be in mobile mode, controls the mobile or desktop view
+   *
+   * @default false
+   */
+  accessor isMobile: boolean;
+  /** esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html */
+  accessor mapView: __esri.MapView | undefined;
+  /**
+   * boolean: When true clicking on a feature on the map will display a popup
+   *
+   * @default false
+   */
+  accessor popupEnabled: boolean;
+  /**
+   * boolean: When true reporting area layer should be honored if it exists
+   *
+   * @default false
+   */
+  accessor reportingArea: boolean;
+  /**
+   * string: polygon layer for the reporting feature
+   *
+   * @default ''
+   */
+  accessor reportingAreaLayer: string | undefined;
+  /**
+   * string: Message to be displayed when feature is outside the reportingAreaLayer
+   *
+   * @default ''
+   */
+  accessor reportingAreaMessage: string;
+  /** ISearchConfiguration: Configuration details for the Search widget */
+  accessor searchConfiguration: ISearchConfiguration | undefined;
+  /**
+   * string: Layer id of the feature layer in which the new feature is to be created
+   *
+   * @default ''
+   */
+  accessor selectedLayerId: string;
+  /**
+   * boolean: When true the notice message with the current state should be shown
+   *
+   * @default true
+   */
+  accessor showGuidingMsg: boolean | undefined;
+  /**
+   * boolean: When true the layer visibility message will be shown
+   *
+   * @default false
+   */
+  accessor showLayerVisibilityMsg: boolean | undefined;
+  /**
+   * boolean: When true Editor's sketch widgets will be displayed
+   *
+   * @default false
+   */
+  accessor showSketchWidgets: boolean;
+  /**
+   * string: Text to be displayed that will allow user to know they can submit new reports
+   *
+   * @default ''
+   */
+  accessor submitNewReportsMessage: string;
+  /**
+   * boolean: When true the map should shown in the editor component in mobile mode (while drawing graphic)
+   *
+   * @default false
+   */
+  accessor updateMapPosition: boolean;
+  /**
+   * Refreshes the editor state, optionally updating the floor level.
+   *
+   * @param floorLevel - (Optional) The floor level to set. If provided, the editor updates to this floor level.
+   * @returns A promise that resolves when the refresh operation is complete.
+   */
+  refresh(floorLevel?: string): Promise<void>;
+  /** Shows feature form */
+  showForm(): Promise<void>;
+  /**
+   * Submit the created feature
+   *
+   * @returns Promise that resolves when the operation is complete
+   */
+  submit(): Promise<void>;
+  /** Emitted on demand when drawing is completed */
+  readonly drawComplete: import("@arcgis/lumina").TargetedEvent<this, boolean>;
+  /** Emitted on demand when editing attachments */
+  readonly editingAttachment: import("@arcgis/lumina").TargetedEvent<this, boolean>;
+  /** Emitted on demand when in editing mode */
+  readonly editingLocation: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** Emitted on demand when the feature creation is failed */
+  readonly fail: import("@arcgis/lumina").TargetedEvent<this, Error>;
+  /** Emitted on switched form mobile to desktop or vice versa */
+  readonly modeChanged: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** Emitted on demand when editor panel changes */
+  readonly progressStatus: import("@arcgis/lumina").TargetedEvent<this, number>;
+  /** Emitted on demand when the feature is created successfully */
+  readonly success: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly "@eventTypes": {
+    drawComplete: CreateFeature["drawComplete"]["detail"];
+    editingAttachment: CreateFeature["editingAttachment"]["detail"];
+    editingLocation: CreateFeature["editingLocation"]["detail"];
+    fail: CreateFeature["fail"]["detail"];
+    modeChanged: CreateFeature["modeChanged"]["detail"];
+    progressStatus: CreateFeature["progressStatus"]["detail"];
+    success: CreateFeature["success"]["detail"];
+  };
+}