@arcgis/map-components 5.1.0-next.2 → 5.1.0-next.21

package/dist/components/arcgis-paste/commands/PasteCommand.d.ts

@@ -1,14 +1,29 @@
 import type Accessor from "@arcgis/core/core/Accessor.js";
 import type PasteViewModel from "../PasteViewModel.js";
 import type Graphic from "@arcgis/core/Graphic.js";
-import type FeatureLayer from "@arcgis/core/layers/FeatureLayer";
-import type SubtypeGroupLayer from "@arcgis/core/layers/SubtypeGroupLayer";
+import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
+import type SubtypeGroupLayer from "@arcgis/core/layers/SubtypeGroupLayer.js";
 import type { Icon } from "@esri/calcite-components/components/calcite-icon";
 import type { ApplySet } from "@arcgis/core/applications/Components/applySetUtils.js";
-import type { GeometryUnion } from "@arcgis/core/geometry/types";
+import type { GeometryUnion } from "@arcgis/core/geometry/types.js";
 
 export interface PasteCommandProperties extends Partial<Pick<PasteCommand, "viewModel">> {}
 
+/**
+ * The types of supported paste operation
+ * These maybe explicit ones, supported by the component, or user defined (as in string)
+ *
+ * @internal
+ */
+export type SupportedPasteCommand = "paste-append" | "paste-as" | "paste-merge" | "paste-subtract" | "paste" | (string & {});
+
+/**
+ * An interface which is used when a paste operation is run.
+ * It allows the operation to cause the component to raise events or apply behaviour
+ * in response to the operation running
+ *
+ * @internal
+ */
 export type PasteCommandApplyParameters = {
   closeAfterApply: () => void;
   onPasteError: (error: PasteApplyError) => void;
@@ -22,49 +37,290 @@ export type PasteCommandApplyParameters = {
   }>;
 };
 
+/**
+ * The Error type, that is raised when a paste operation fails
+ *
+ * @internal
+ */
 export type PasteApplyError = {
   errorCode: string;
   errorMessage: string;
-  localizedErrorMessage?: keyof Messages;
+  localizedErrorMessage?: keyof {
+      componentLabel: string;
+      noClipboardData: string;
+      noPasteCommandsAvailable: string;
+      pasteMultipleNotSupported: string;
+      mixedGeometriesNotSupported: string;
+      pasteAsMustHaveGeometry: string;
+      clipboardContentsSingle: string;
+      clipboardEmpty: string;
+      clipboardContentsMany: string;
+      clipboardContents: string;
+      clipboardTooltip: string;
+      pasteCommandChoices: string;
+      pasteAsTitle: string;
+      pasteMergeTitle: string;
+      pasteTitle: string;
+      cancel: string;
+      tooManyCreateFeatures: string;
+      tooManyCreateComplexFeatures: string;
+      paste: string;
+      pasteMany: string;
+      attributesNotCopied: string;
+      attributesSubtitle: string;
+      preservethis: string;
+      seeMergeOptions: string;
+      selectionLabel: string;
+      mergeOptionsTitle: string;
+      features: string;
+      mergeOptionsDesc: string;
+      pasteWithAttributesLabel: string;
+      preserved: string;
+      pasteAppendTitle: string;
+      pasteSubtractTitle: string;
+      pasteAsDesc: string;
+      pasteMergeDesc: string;
+      pasteDesc: string;
+      pasteAppendDesc: string;
+      pasteSubtractDesc: string;
+      choosefeature: string;
+      next: string;
+      updating: string;
+      breadcrumb: string;
+      back: string;
+      noPasteItemsError: string;
+      noChangeError: string;
+      noSelectedError: string;
+      noMatchingEditableLayers: string;
+      deletesGeometryError: string;
+      noGeometryError: string;
+      unexpectedError: string;
+      errorNoticeTitle: string;
+      errorNoticeMessage: string;
+      range: string;
+      multipleFeaturesX: string;
+  };
 };
 
+/** @internal */
 export type PasteExecuteResult = {
   success: boolean;
   applySet?: ApplySet;
   userInputRequired: boolean;
 };
 
+/** @internal */
 export class PasteCommand extends Accessor {
   constructor(properties?: PasteCommandProperties);
+  /** A flag to indicate if the command is currently enabled */
   get commandEnabled(): boolean;
+  /** An icon to represent the command */
   get icon(): Icon["icon"] | undefined;
+  /** A unique ID for the command */
   get id(): SupportedPasteCommand;
+  /** Flag to indicate this command will execute directly */
   get immediate(): boolean;
+  /** Flag to indicate this command only exists on the Commands Page */
   get mustShowOnCommandPage(): boolean;
   accessor viewModel: PasteViewModel;
   /**
+   * A reason why the command is disabled
+   *
    * @param _systemStrings
    * @param _locale
    */
-  commandDisabledReason(_systemStrings: Messages, _locale: string): string;
+  commandDisabledReason(_systemStrings: {
+      componentLabel: string;
+      noClipboardData: string;
+      noPasteCommandsAvailable: string;
+      pasteMultipleNotSupported: string;
+      mixedGeometriesNotSupported: string;
+      pasteAsMustHaveGeometry: string;
+      clipboardContentsSingle: string;
+      clipboardEmpty: string;
+      clipboardContentsMany: string;
+      clipboardContents: string;
+      clipboardTooltip: string;
+      pasteCommandChoices: string;
+      pasteAsTitle: string;
+      pasteMergeTitle: string;
+      pasteTitle: string;
+      cancel: string;
+      tooManyCreateFeatures: string;
+      tooManyCreateComplexFeatures: string;
+      paste: string;
+      pasteMany: string;
+      attributesNotCopied: string;
+      attributesSubtitle: string;
+      preservethis: string;
+      seeMergeOptions: string;
+      selectionLabel: string;
+      mergeOptionsTitle: string;
+      features: string;
+      mergeOptionsDesc: string;
+      pasteWithAttributesLabel: string;
+      preserved: string;
+      pasteAppendTitle: string;
+      pasteSubtractTitle: string;
+      pasteAsDesc: string;
+      pasteMergeDesc: string;
+      pasteDesc: string;
+      pasteAppendDesc: string;
+      pasteSubtractDesc: string;
+      choosefeature: string;
+      next: string;
+      updating: string;
+      breadcrumb: string;
+      back: string;
+      noPasteItemsError: string;
+      noChangeError: string;
+      noSelectedError: string;
+      noMatchingEditableLayers: string;
+      deletesGeometryError: string;
+      noGeometryError: string;
+      unexpectedError: string;
+      errorNoticeTitle: string;
+      errorNoticeMessage: string;
+      range: string;
+      multipleFeaturesX: string;
+  }, _locale: string): string;
   createMergedClipboardGeom(): Promise<GeometryUnion | null>;
   /**
+   * A description for the command
+   *
    * @param _systemStrings
    * @param _locale
    */
-  description(_systemStrings: Messages, _locale: string): string;
+  description(_systemStrings: {
+      componentLabel: string;
+      noClipboardData: string;
+      noPasteCommandsAvailable: string;
+      pasteMultipleNotSupported: string;
+      mixedGeometriesNotSupported: string;
+      pasteAsMustHaveGeometry: string;
+      clipboardContentsSingle: string;
+      clipboardEmpty: string;
+      clipboardContentsMany: string;
+      clipboardContents: string;
+      clipboardTooltip: string;
+      pasteCommandChoices: string;
+      pasteAsTitle: string;
+      pasteMergeTitle: string;
+      pasteTitle: string;
+      cancel: string;
+      tooManyCreateFeatures: string;
+      tooManyCreateComplexFeatures: string;
+      paste: string;
+      pasteMany: string;
+      attributesNotCopied: string;
+      attributesSubtitle: string;
+      preservethis: string;
+      seeMergeOptions: string;
+      selectionLabel: string;
+      mergeOptionsTitle: string;
+      features: string;
+      mergeOptionsDesc: string;
+      pasteWithAttributesLabel: string;
+      preserved: string;
+      pasteAppendTitle: string;
+      pasteSubtractTitle: string;
+      pasteAsDesc: string;
+      pasteMergeDesc: string;
+      pasteDesc: string;
+      pasteAppendDesc: string;
+      pasteSubtractDesc: string;
+      choosefeature: string;
+      next: string;
+      updating: string;
+      breadcrumb: string;
+      back: string;
+      noPasteItemsError: string;
+      noChangeError: string;
+      noSelectedError: string;
+      noMatchingEditableLayers: string;
+      deletesGeometryError: string;
+      noGeometryError: string;
+      unexpectedError: string;
+      errorNoticeTitle: string;
+      errorNoticeMessage: string;
+      range: string;
+      multipleFeaturesX: string;
+  }, _locale: string): string;
+  /** Execute the command silently. Performs the logic of the paste command */
   execute(): Promise<PasteExecuteResult>;
   /**
+   * Initiate the paste command
+   *
    * @param _params
    * @param _options
    */
   initiate(_params: PasteCommandApplyParameters, _options?: { showFeatureForm?: boolean; }): Promise<void>;
   /**
+   * A label for the command
+   *
    * @param _systemStrings
    * @param _locale
    */
-  label(_systemStrings: Messages, _locale: string): string;
-  /** @param activeTool */
+  label(_systemStrings: {
+      componentLabel: string;
+      noClipboardData: string;
+      noPasteCommandsAvailable: string;
+      pasteMultipleNotSupported: string;
+      mixedGeometriesNotSupported: string;
+      pasteAsMustHaveGeometry: string;
+      clipboardContentsSingle: string;
+      clipboardEmpty: string;
+      clipboardContentsMany: string;
+      clipboardContents: string;
+      clipboardTooltip: string;
+      pasteCommandChoices: string;
+      pasteAsTitle: string;
+      pasteMergeTitle: string;
+      pasteTitle: string;
+      cancel: string;
+      tooManyCreateFeatures: string;
+      tooManyCreateComplexFeatures: string;
+      paste: string;
+      pasteMany: string;
+      attributesNotCopied: string;
+      attributesSubtitle: string;
+      preservethis: string;
+      seeMergeOptions: string;
+      selectionLabel: string;
+      mergeOptionsTitle: string;
+      features: string;
+      mergeOptionsDesc: string;
+      pasteWithAttributesLabel: string;
+      preserved: string;
+      pasteAppendTitle: string;
+      pasteSubtractTitle: string;
+      pasteAsDesc: string;
+      pasteMergeDesc: string;
+      pasteDesc: string;
+      pasteAppendDesc: string;
+      pasteSubtractDesc: string;
+      choosefeature: string;
+      next: string;
+      updating: string;
+      breadcrumb: string;
+      back: string;
+      noPasteItemsError: string;
+      noChangeError: string;
+      noSelectedError: string;
+      noMatchingEditableLayers: string;
+      deletesGeometryError: string;
+      noGeometryError: string;
+      unexpectedError: string;
+      errorNoticeTitle: string;
+      errorNoticeMessage: string;
+      range: string;
+      multipleFeaturesX: string;
+  }, _locale: string): string;
+  /**
+   * Builds an ApplySet for the Paste, Paste-as and Paste-merge command
+   *
+   * @param activeTool
+   */
   prepareCopy(activeTool: "paste-as" | "paste-merge" | "paste"): Promise<ApplySet | null>;
   /**
    * @param graphic
@@ -72,123 +328,11 @@ export class PasteCommand extends Accessor {
    */
   removeGraphicIdentifierFields(graphic: Graphic, layer: FeatureLayer | SubtypeGroupLayer): void;
   /**
+   * The logic for the paste, paste-as and paste-merge command
+   *
    * @param params
    * @param tool
    * @param options
    */
   runPasteCommand(params: PasteCommandApplyParameters, tool: "paste-as" | "paste-merge" | "paste", options?: { showFeatureForm?: boolean; }): Promise<void>;
-}
-
-export type Messages = ReturnType<typeof messages>;
-
-export type SupportedPasteCommand = "paste-append" | "paste-as" | "paste-merge" | "paste-subtract" | "paste" | (string & {});
-
-export const messages: (value: {
-    componentLabel: string;
-    noClipboardData: string;
-    noPasteCommandsAvailable: string;
-    pasteMultipleNotSupported: string;
-    mixedGeometriesNotSupported: string;
-    pasteAsMustHaveGeometry: string;
-    clipboardContentsSingle: string;
-    clipboardEmpty: string;
-    clipboardContentsMany: string;
-    clipboardContents: string;
-    clipboardTooltip: string;
-    pasteCommandChoices: string;
-    pasteAsTitle: string;
-    pasteMergeTitle: string;
-    pasteTitle: string;
-    cancel: string;
-    tooManyCreateFeatures: string;
-    tooManyCreateComplexFeatures: string;
-    paste: string;
-    pasteMany: string;
-    attributesNotCopied: string;
-    attributesSubtitle: string;
-    preservethis: string;
-    seeMergeOptions: string;
-    selectionLabel: string;
-    mergeOptionsTitle: string;
-    features: string;
-    mergeOptionsDesc: string;
-    pasteWithAttributesLabel: string;
-    preserved: string;
-    pasteAppendTitle: string;
-    pasteSubtractTitle: string;
-    pasteAsDesc: string;
-    pasteMergeDesc: string;
-    pasteDesc: string;
-    pasteAppendDesc: string;
-    pasteSubtractDesc: string;
-    choosefeature: string;
-    next: string;
-    updating: string;
-    breadcrumb: string;
-    back: string;
-    noPasteItemsError: string;
-    noChangeError: string;
-    noSelectedError: string;
-    noMatchingEditableLayers: string;
-    deletesGeometryError: string;
-    noGeometryError: string;
-    unexpectedError: string;
-    errorNoticeTitle: string;
-    errorNoticeMessage: string;
-    range: string;
-    multipleFeaturesX: string;
-}) => {
-    componentLabel: string;
-    noClipboardData: string;
-    noPasteCommandsAvailable: string;
-    pasteMultipleNotSupported: string;
-    mixedGeometriesNotSupported: string;
-    pasteAsMustHaveGeometry: string;
-    clipboardContentsSingle: string;
-    clipboardEmpty: string;
-    clipboardContentsMany: string;
-    clipboardContents: string;
-    clipboardTooltip: string;
-    pasteCommandChoices: string;
-    pasteAsTitle: string;
-    pasteMergeTitle: string;
-    pasteTitle: string;
-    cancel: string;
-    tooManyCreateFeatures: string;
-    tooManyCreateComplexFeatures: string;
-    paste: string;
-    pasteMany: string;
-    attributesNotCopied: string;
-    attributesSubtitle: string;
-    preservethis: string;
-    seeMergeOptions: string;
-    selectionLabel: string;
-    mergeOptionsTitle: string;
-    features: string;
-    mergeOptionsDesc: string;
-    pasteWithAttributesLabel: string;
-    preserved: string;
-    pasteAppendTitle: string;
-    pasteSubtractTitle: string;
-    pasteAsDesc: string;
-    pasteMergeDesc: string;
-    pasteDesc: string;
-    pasteAppendDesc: string;
-    pasteSubtractDesc: string;
-    choosefeature: string;
-    next: string;
-    updating: string;
-    breadcrumb: string;
-    back: string;
-    noPasteItemsError: string;
-    noChangeError: string;
-    noSelectedError: string;
-    noMatchingEditableLayers: string;
-    deletesGeometryError: string;
-    noGeometryError: string;
-    unexpectedError: string;
-    errorNoticeTitle: string;
-    errorNoticeMessage: string;
-    range: string;
-    multipleFeaturesX: string;
-};
+}

package/dist/components/arcgis-paste/commands/PasteCustomCommand.d.ts

@@ -1,123 +1,124 @@
-import type Graphic from "@arcgis/core/Graphic";
+import type Graphic from "@arcgis/core/Graphic.js";
 import type { Icon } from "@esri/calcite-components/components/calcite-icon";
-import type { EsriClipboard } from "@arcgis/core/applications/Components/clipboard";
+import type { EsriClipboard } from "@arcgis/core/applications/Components/clipboard.js";
 
+/**
+ * The definition of a custom paste operation.
+ *
+ * @internal
+ */
 export type CustomPasteCommand = {
   icon?: Icon["icon"];
   id: string;
   commandEnabled: (clipboard: EsriClipboard, selectedFeature?: Graphic | null) => boolean;
-  label: (systemStrings: Messages, locale: string) => string;
-  description: (systemStrings: Messages, locale: string) => string;
-};
-
-export type Messages = ReturnType<typeof messages>;
-
-export const messages: (value: {
-    componentLabel: string;
-    noClipboardData: string;
-    noPasteCommandsAvailable: string;
-    pasteMultipleNotSupported: string;
-    mixedGeometriesNotSupported: string;
-    pasteAsMustHaveGeometry: string;
-    clipboardContentsSingle: string;
-    clipboardEmpty: string;
-    clipboardContentsMany: string;
-    clipboardContents: string;
-    clipboardTooltip: string;
-    pasteCommandChoices: string;
-    pasteAsTitle: string;
-    pasteMergeTitle: string;
-    pasteTitle: string;
-    cancel: string;
-    tooManyCreateFeatures: string;
-    tooManyCreateComplexFeatures: string;
-    paste: string;
-    pasteMany: string;
-    attributesNotCopied: string;
-    attributesSubtitle: string;
-    preservethis: string;
-    seeMergeOptions: string;
-    selectionLabel: string;
-    mergeOptionsTitle: string;
-    features: string;
-    mergeOptionsDesc: string;
-    pasteWithAttributesLabel: string;
-    preserved: string;
-    pasteAppendTitle: string;
-    pasteSubtractTitle: string;
-    pasteAsDesc: string;
-    pasteMergeDesc: string;
-    pasteDesc: string;
-    pasteAppendDesc: string;
-    pasteSubtractDesc: string;
-    choosefeature: string;
-    next: string;
-    updating: string;
-    breadcrumb: string;
-    back: string;
-    noPasteItemsError: string;
-    noChangeError: string;
-    noSelectedError: string;
-    noMatchingEditableLayers: string;
-    deletesGeometryError: string;
-    noGeometryError: string;
-    unexpectedError: string;
-    errorNoticeTitle: string;
-    errorNoticeMessage: string;
-    range: string;
-    multipleFeaturesX: string;
-}) => {
-    componentLabel: string;
-    noClipboardData: string;
-    noPasteCommandsAvailable: string;
-    pasteMultipleNotSupported: string;
-    mixedGeometriesNotSupported: string;
-    pasteAsMustHaveGeometry: string;
-    clipboardContentsSingle: string;
-    clipboardEmpty: string;
-    clipboardContentsMany: string;
-    clipboardContents: string;
-    clipboardTooltip: string;
-    pasteCommandChoices: string;
-    pasteAsTitle: string;
-    pasteMergeTitle: string;
-    pasteTitle: string;
-    cancel: string;
-    tooManyCreateFeatures: string;
-    tooManyCreateComplexFeatures: string;
-    paste: string;
-    pasteMany: string;
-    attributesNotCopied: string;
-    attributesSubtitle: string;
-    preservethis: string;
-    seeMergeOptions: string;
-    selectionLabel: string;
-    mergeOptionsTitle: string;
-    features: string;
-    mergeOptionsDesc: string;
-    pasteWithAttributesLabel: string;
-    preserved: string;
-    pasteAppendTitle: string;
-    pasteSubtractTitle: string;
-    pasteAsDesc: string;
-    pasteMergeDesc: string;
-    pasteDesc: string;
-    pasteAppendDesc: string;
-    pasteSubtractDesc: string;
-    choosefeature: string;
-    next: string;
-    updating: string;
-    breadcrumb: string;
-    back: string;
-    noPasteItemsError: string;
-    noChangeError: string;
-    noSelectedError: string;
-    noMatchingEditableLayers: string;
-    deletesGeometryError: string;
-    noGeometryError: string;
-    unexpectedError: string;
-    errorNoticeTitle: string;
-    errorNoticeMessage: string;
-    range: string;
-    multipleFeaturesX: string;
+  label: (systemStrings: {
+      componentLabel: string;
+      noClipboardData: string;
+      noPasteCommandsAvailable: string;
+      pasteMultipleNotSupported: string;
+      mixedGeometriesNotSupported: string;
+      pasteAsMustHaveGeometry: string;
+      clipboardContentsSingle: string;
+      clipboardEmpty: string;
+      clipboardContentsMany: string;
+      clipboardContents: string;
+      clipboardTooltip: string;
+      pasteCommandChoices: string;
+      pasteAsTitle: string;
+      pasteMergeTitle: string;
+      pasteTitle: string;
+      cancel: string;
+      tooManyCreateFeatures: string;
+      tooManyCreateComplexFeatures: string;
+      paste: string;
+      pasteMany: string;
+      attributesNotCopied: string;
+      attributesSubtitle: string;
+      preservethis: string;
+      seeMergeOptions: string;
+      selectionLabel: string;
+      mergeOptionsTitle: string;
+      features: string;
+      mergeOptionsDesc: string;
+      pasteWithAttributesLabel: string;
+      preserved: string;
+      pasteAppendTitle: string;
+      pasteSubtractTitle: string;
+      pasteAsDesc: string;
+      pasteMergeDesc: string;
+      pasteDesc: string;
+      pasteAppendDesc: string;
+      pasteSubtractDesc: string;
+      choosefeature: string;
+      next: string;
+      updating: string;
+      breadcrumb: string;
+      back: string;
+      noPasteItemsError: string;
+      noChangeError: string;
+      noSelectedError: string;
+      noMatchingEditableLayers: string;
+      deletesGeometryError: string;
+      noGeometryError: string;
+      unexpectedError: string;
+      errorNoticeTitle: string;
+      errorNoticeMessage: string;
+      range: string;
+      multipleFeaturesX: string;
+  }, locale: string) => string;
+  description: (systemStrings: {
+      componentLabel: string;
+      noClipboardData: string;
+      noPasteCommandsAvailable: string;
+      pasteMultipleNotSupported: string;
+      mixedGeometriesNotSupported: string;
+      pasteAsMustHaveGeometry: string;
+      clipboardContentsSingle: string;
+      clipboardEmpty: string;
+      clipboardContentsMany: string;
+      clipboardContents: string;
+      clipboardTooltip: string;
+      pasteCommandChoices: string;
+      pasteAsTitle: string;
+      pasteMergeTitle: string;
+      pasteTitle: string;
+      cancel: string;
+      tooManyCreateFeatures: string;
+      tooManyCreateComplexFeatures: string;
+      paste: string;
+      pasteMany: string;
+      attributesNotCopied: string;
+      attributesSubtitle: string;
+      preservethis: string;
+      seeMergeOptions: string;
+      selectionLabel: string;
+      mergeOptionsTitle: string;
+      features: string;
+      mergeOptionsDesc: string;
+      pasteWithAttributesLabel: string;
+      preserved: string;
+      pasteAppendTitle: string;
+      pasteSubtractTitle: string;
+      pasteAsDesc: string;
+      pasteMergeDesc: string;
+      pasteDesc: string;
+      pasteAppendDesc: string;
+      pasteSubtractDesc: string;
+      choosefeature: string;
+      next: string;
+      updating: string;
+      breadcrumb: string;
+      back: string;
+      noPasteItemsError: string;
+      noChangeError: string;
+      noSelectedError: string;
+      noMatchingEditableLayers: string;
+      deletesGeometryError: string;
+      noGeometryError: string;
+      unexpectedError: string;
+      errorNoticeTitle: string;
+      errorNoticeMessage: string;
+      range: string;
+      multipleFeaturesX: string;
+  }, locale: string) => string;
 };