@esri/solutions-components 1.0.0-next.20250415 → 1.0.0-next.20250421

package/README.md

@@ -1,13 +1,50 @@
-# Lumina Starter Package
+# solutions-components
 
-This package is a starter point for creating a web component library powered by
-Lumina.
+solutions-components are shared web components used in Solutions apps.
 
 [See Lumina documentation](https://qawebgis.esri.com/components/lumina/introduction)
 
-## Installation
+## Getting Started
 
-See ["Getting Started"](https://qawebgis.esri.com/components/lumina/get-started)
+This repository is set up to use [Lumina](https://qawebgis.esri.com/components/lumina/introduction) to manage web component development; the project is a `web_component` project type
+
+Set up:
+
+```bash
+yarn install
+```
+
+To build the component for debugging, run:
+
+```bash
+yarn build-dev
+```
+
+To build the component for production, run:
+
+```bash
+yarn build
+```
+
+To start the local server and display ./index.html via `http://localhost:5173/`:
+
+```bash
+yarn start
+```
+
+To run the unit tests for the components run:
+
+```bash
+yarn clean
+yarn test
+```
+
+To publish to npm and GitHub,
+1. Edit package.json to have the new version number
+2. Run `yarn install`
+3. Edit CHANGELOG.md to show the new release number and connect it to previous releases
+4. Commit and push changes to GitHub
+5. Run: `yarn release:publish`
 
 ## Linting
 
@@ -18,6 +55,12 @@ Consider running that as part of pre-commit hook or GitHub Action.
 Documentation on
 [arcgis-web-components' linting setup](https://qawebgis.esri.com/components/monorepo/support-packages/linting) for guidance.
 
+
+## Issues
+
+Find a bug or want to request a new feature?  Please let us know by submitting an issue.
+
+
 ## License
 
 COPYRIGHT © 2025 Esri

package/dist/assets/arcgis-pdf-creator/PDFCreator.d.ts

@@ -0,0 +1,263 @@
+/** @license
+ * Copyright 2022 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare enum EPageType {
+    A4 = "A4",
+    ANSI_A = "ANSI A"
+}
+export interface IFontProperties {
+    fontFullHeightRatio: number;
+    fontResolutionInchesPerPoint: number;
+}
+/**
+ * Properties modifying line drawing.
+ */
+export interface ILineProperties {
+    /**
+     * Color to be applied to line. Consists of a CSS-style RGB color value without "#", e.g., "00ffff".
+     */
+    color?: string;
+    opacity?: number;
+    thickness?: number;
+}
+/**
+ * Properties describing page dimensions in doc units.
+ */
+export interface IPageProperties {
+    /**
+     * Description of page type; string version of EPageType
+     */
+    pageType?: string;
+    /**
+     * Left-side offset to print area of page.
+     */
+    leftMargin?: number;
+    /**
+     * Right-side offset to print area of page.
+     */
+    rightMargin?: number;
+    /**
+     * Top-side offset to print area of page.
+     */
+    topMargin?: number;
+    /**
+     * Bottom-side offset to print area of page.
+     */
+    bottomMargin?: number;
+}
+export interface IPageSize {
+    /**
+     * Full width of the page.
+     */
+    width: number;
+    /**
+     * Full height of the page.
+     */
+    height: number;
+}
+export interface IImageOptions {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface ILineOptions {
+    x1?: number;
+    y1?: number;
+    x2?: number;
+    y2?: number;
+    lineProperties?: ILineProperties;
+}
+export interface IPageOptions {
+    pageType: EPageType;
+    width: number;
+    height: number;
+    leftMargin: number;
+    rightMargin: number;
+    topMargin: number;
+    bottomMargin: number;
+    drawNeatline?: boolean;
+}
+export interface IRectangleOptions {
+    left?: number;
+    top?: number;
+    width?: number;
+    height?: number;
+    lineProperties?: ILineProperties;
+    /**
+     * Color to be applied to fill. Consists of a CSS-style RGB color value without "#", e.g., "00ffff".
+     */
+    fillColor?: string;
+    fillOpacity?: number;
+}
+export interface IRGB {
+    r: number;
+    g: number;
+    b: number;
+}
+export interface ITextOptions {
+    left?: number;
+    top?: number;
+    fontPoints?: number;
+    /**
+     * Color to be applied to text. Consists of a CSS-style RGB color value without "#", e.g., "00ffff".
+     */
+    fontColor?: string;
+}
+export interface ITableOptions {
+    lineProperties?: ILineProperties;
+    textProperties?: ITextOptions;
+}
+export declare class PDFCreator {
+    dataPath: string;
+    lang: string;
+    title: string;
+    fontProps: IFontProperties;
+    imageOptions: IImageOptions;
+    lineOptions: ILineOptions;
+    pageOptions: IPageOptions;
+    rectangleOptions: IRectangleOptions;
+    tableOptions: ITableOptions;
+    textOptions: ITextOptions;
+    /**
+     * @class PDFCreator
+     */
+    static getPageSize(pageType: EPageType | string): IPageSize;
+    /**
+     * Adds a page to the document being created.
+     *
+     * @class PDFCreator
+     */
+    addPage(): void;
+    /**
+     * Calculates a color intensity that emulates an opacity being applied to it.
+     *
+     * @param colorIntensity Color value to start with; range 0..1
+     * @param opacity Opacity to apply; range 0..1
+     *
+     * @return Color intensity emulating the application of opacity. It works by applying the opacity value
+     * to the input colorIntensity and adding the inverse of the opacity. E.g., if opacity is 1, the original
+     * colorIntensity is returned; if opacity is 0, 1 is returned; if opacity is 0.5; colorIntensity/2 + 0.5 is
+     * returned. It's odd, but when applied to an RGB value, it produces the desired effect.
+     *
+     * @class PDFCreator
+     */
+    applyOpacity(colorIntensity: number, opacity: number): number;
+    /**
+     * Draws a PNG image into the page.
+     *
+     * @params imageDataUrl Image to add to page
+     * @params options Position information
+     *
+     * @class PDFCreator
+     */
+    drawImage(imageDataUrl: string, options: IImageOptions): void;
+    /**
+     * @class PDFCreator
+     */
+    drawLine(options: ILineOptions): void;
+    /**
+     * @class PDFCreator
+     */
+    drawNeatline(lineProperties?: ILineProperties): void;
+    /**
+     * @class PDFCreator
+     */
+    drawRectangle(options: IRectangleOptions): void;
+    /**
+     * @class PDFCreator
+     */
+    drawTable(text: string[][], options: ITableOptions): void;
+    /**
+     * @class PDFCreator
+     */
+    drawText(text: string, options: ITextOptions): void;
+    /**
+     * Calculates document units from top of font ascenders to baseline.
+     *
+     * @class PDFCreator
+     */
+    fontAscenderBaselineHeight(fontPoints: number): number;
+    /**
+     * Calculates document units from top of font ascenders to bottom of descenders.
+     *
+     * @class PDFCreator
+     */
+    fontAscenderDescenderHeight(fontPoints: number): number;
+    /**
+     * Returns the name of the font file supporting the specified locale.
+     *
+     * @param lang Locale such as "en" or "zh-tw"
+     * @returns Font name, e.g., "0b7681dc140844ee9f409bdac249fbf0-japanese"
+     *
+     * @class PDFCreator
+     */
+    getFontFileName(lang: string): string;
+    /**
+     * Estimates with width of a string.
+     *
+     * @param text String to estimate
+     * @param fontSize Text size in points
+     * @returns Estimated width of text using (points x 1/72 inches/point) * 0.6;
+     * need to override this generalized function with a specific PDF generator;
+     * the 0.6 width:height ratio comes from https://www.fhwa.dot.gov/publications/research/safety/98057/ch03.cfm#width
+     *
+     * @class PDFCreator
+     */
+    getTextWidth(text: string, fontSize: number): number;
+    /**
+     * @class PDFCreator
+     */
+    hexToRGB(hex: string, opacity?: number): IRGB;
+    /**
+     * @class PDFCreator
+     */
+    initialize(pageProperties?: IPageProperties, dataPath?: string, lang?: string, title?: string, drawNeatline?: boolean): Promise<void>;
+    /**
+     * @class PDFCreator
+     */
+    save(): void;
+    /**
+     * @class PDFCreator
+     */
+    setDrawColor(drawColor: string, // eslint-disable-line @typescript-eslint/no-unused-vars
+    opacity?: number): void;
+    /**
+     * @class PDFCreator
+     */
+    setFillColor(fillColor: string, // eslint-disable-line @typescript-eslint/no-unused-vars
+    opacity?: number): void;
+    /**
+     * @class PDFCreator
+     */
+    setFont(lang: string): Promise<void>;
+    /**
+     * @class PDFCreator
+     */
+    setFontColor(fontColor: string): void;
+    /**
+     * @class PDFCreator
+     */
+    setFontSize(fontPoints: number): void;
+    /**
+     * @class PDFCreator
+     */
+    setLang(lang: string): Promise<void>;
+    /**
+     * @class PDFCreator
+     */
+    setLineWidth(width: number): void;
+    updateLineProperties(updatedProps: ILineProperties): void;
+}

package/dist/assets/arcgis-pdf-creator/PDFCreator_jsPDF.d.ts

@@ -0,0 +1,109 @@
+import { jsPDF } from 'jspdf';
+/** @license
+ * Copyright 2022 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as PDFCreator from "./PDFCreator";
+export declare class PDFCreator_jsPDF extends PDFCreator.PDFCreator {
+    jsDoc: jsPDF;
+    constructor(jspdfToUse?: jsPDF);
+    /**
+     * Adds a page to the document being created.
+     *
+     * @class PDFCreator_jsPDF
+     */
+    addPage(): void;
+    /**
+     * Converts a locale into a jsPDF language code.
+     *
+     * @param lang Locale such as "en" or "en-gb"
+     * @returns jsPDF_lang_code jsPDF language code such as "en" or "en-GB", mapping AGO locales "it-it" & "pt-pt"
+     * into "it" & "pt", respectively, to match jsPDF offering
+     *
+     * @class PDFCreator_jsPDF
+     */
+    convertLocaleToJsPDFLanguageCode(lang: string): jsPDF_lang_code;
+    /**
+     * Draws a PNG image into the page.
+     *
+     * @params imageDataUrl Image to add to page
+     * @params options Position information
+     *
+     * @class PDFCreator
+     */
+    drawImage(imageDataUrl: string, options: PDFCreator.IImageOptions): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    drawLine(options: PDFCreator.ILineOptions): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    drawRectangle(options: PDFCreator.IRectangleOptions): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    drawTable(text: string[][], options: PDFCreator.ITableOptions): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    drawText(text: string, options: PDFCreator.ITextOptions): void;
+    /**
+     * Estimates with width of a string.
+     *
+     * @param {string} text String to estimate
+     * @param fontSize Text size in points
+     * @returns {number} Estimated width of text in doc units
+     *
+     * @class PDFCreator_jsPDF
+     */
+    getTextWidth(text: string, fontSize: number): number;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    initialize(pageProperties?: PDFCreator.IPageProperties, dataPath?: string, lang?: string, title?: string, drawNeatline?: boolean): Promise<void>;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    save(): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    setDrawColor(drawColor: string, opacity?: number): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    setFillColor(fillColor: string, opacity?: number): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    setFont(lang: string): Promise<void>;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    setFontColor(fontColor: string): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    setFontSize(fontPoints: number): void;
+    /**
+     * @class PDFCreator_jsPDF
+     */
+    setLineWidth(width: number): void;
+}
+/**
+ * Enumeration of putatively supported locales in jsPDF copied from jsPDF.
+ */
+type jsPDF_lang_code = "af" | "an" | "ar" | "ar-AE" | "ar-BH" | "ar-DZ" | "ar-EG" | "ar-IQ" | "ar-JO" | "ar-KW" | "ar-LB" | "ar-LY" | "ar-MA" | "ar-OM" | "ar-QA" | "ar-SA" | "ar-SY" | "ar-TN" | "ar-YE" | "as" | "ast" | "az" | "be" | "bg" | "bn" | "br" | "bs" | "ca" | "ce" | "ch" | "co" | "cr" | "cs" | "cv" | "cy" | "da" | "de" | "de-AT" | "de-CH" | "de-DE" | "de-LI" | "de-LU" | "el" | "en" | "en-AU" | "en-BZ" | "en-CA" | "en-GB" | "en-IE" | "en-JM" | "en-NZ" | "en-PH" | "en-TT" | "en-US" | "en-ZA" | "en-ZW" | "eo" | "es" | "es-AR" | "es-BO" | "es-CL" | "es-CO" | "es-CR" | "es-DO" | "es-EC" | "es-ES" | "es-GT" | "es-HN" | "es-MX" | "es-NI" | "es-PA" | "es-PE" | "es-PR" | "es-PY" | "es-SV" | "es-UY" | "es-VE" | "et" | "eu" | "fa" | "fa-IR" | "fi" | "fj" | "fo" | "fr" | "fr-BE" | "fr-CA" | "fr-CH" | "fr-FR" | "fr-LU" | "fr-MC" | "fur" | "fy" | "ga" | "gd" | "gd-IE" | "gl" | "gu" | "he" | "hi" | "hr" | "hsb" | "ht" | "hu" | "hy" | "id" | "is" | "it" | "it-CH" | "iu" | "ja" | "ji" | "ka" | "kk" | "km" | "kn" | "ko" | "ko-KP" | "ko-KR" | "ks" | "ky" | "la" | "lb" | "lt" | "lv" | "mi" | "mk" | "ml" | "mo" | "mr" | "ms" | "mt" | "my" | "nb" | "ne" | "ng" | "nl" | "nl-BE" | "nn" | "no" | "nv" | "oc" | "om" | "or" | "pa" | "pa-IN" | "pa-PK" | "pl" | "pt" | "pt-BR" | "qu" | "rm" | "ro" | "ro-MO" | "ru" | "ru-MO" | "sa" | "sb" | "sc" | "sd" | "sg" | "si" | "sk" | "sl" | "so" | "sq" | "sr" | "sv" | "sv-FI" | "sv-SV" | "sw" | "sx" | "sz" | "ta" | "te" | "th" | "tig" | "tk" | "tlh" | "tn" | "tr" | "ts" | "tt" | "uk" | "ur" | "ve" | "vi" | "vo" | "wa" | "xh" | "zh" | "zh-CN" | "zh-HK" | "zh-SG" | "zh-TW" | "zu";
+export {};

package/dist/assets/arcgis-pdf-creator/PDFLabels.d.ts

@@ -0,0 +1,169 @@
+/* TODO: [MIGRATION] The codemod does not touch the imports in .d.ts files - migrate those manually */
+/* TODO: [MIGRATION] The codemod does not touch the imports in .d.ts files - migrate those manually */
+/**
+ * @license
+ * Copyright 2022 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as PDFCreator from './PDFCreator';
+/** Properties of a page of labels. */
+export interface ILabel {
+  /** User-interface description of label type. */
+  descriptionPDF: ILabelDescription;
+  /** Properties describing page dimensions of labels sheet. */
+  labelSpec: ILabelSpec;
+}
+/** User-interface description of label type. */
+export interface ILabelDescription {
+  /** Width of label for display, e.g., "2-5/8" */
+  labelWidthDisplay: string;
+  /** Height of label for display, e.g., "1" */
+  labelHeightDisplay: string;
+  /** Number of labels on page, e.g., "30" */
+  labelsPerPageDisplay: string;
+  /** Avery® part number, e.g., "*60" */
+  averyPartNumber: string;
+}
+/** Properties describing page dimensions of labels sheet. */
+export interface ILabelSpec {
+  /** Flag indicating the nature of the label product, e.g., "AVERY", "CSV" */
+  type: string;
+  /** Properties describing page dimensions in doc units. */
+  pageProperties: PDFCreator.IPageProperties;
+  /** Count of labels across the width of the page */
+  numLabelsAcross: number;
+  /** Count of labels down the length of the page */
+  numLabelsDown: number;
+  /** Width of a label in doc units */
+  labelWidth: number;
+  /** Height of a label in doc units */
+  labelHeight: number;
+  /** Gap between each column of labels in doc units */
+  horizGapIn: number;
+  /** Gap between each row of labels in doc units */
+  vertGapIn: number;
+  /** Amount of padding within labels in doc units */
+  labelPadding: number;
+  /** Font size for text put in each label in pixels */
+  fontSizePx: number;
+  /** Maximum number of lines that a label is permitted to hold; subsequent lines will not be written */
+  maxNumLabelLines: number;
+}
+/** Function signature for reporting progress in function addLabelsToDoc. */
+export type IAddLabelsToDocProgressCallback = (
+  /** Percent done; range 0..100 */
+  percentDone: number,
+) => void;
+export declare class PDFLabels {
+  PDFCreator: PDFCreator.PDFCreator;
+  labelFormats: ILabel[];
+  /**
+   * Add labels to a PDF doc, starting at the beginning of the specified PDF doc page.
+   *
+   * @param labels Array of labels; each label consists of one or more line strings
+   * @param labelSpec Properties describing page dimensions of labels sheet
+   * @param startingPageNum The 1-based page number to start printing labels into; page is assumed to be blank & to exist
+   * @param heading Line to add at top of label page outside of labels
+   * @param progressCallback Callback with percent done in range 0..100
+   * @returns Promise which, when resolved, returns the 1-based page number of the last page containing labels
+   * @class PDFLabels
+   */
+  addLabelsToDoc(labels: string[][], labelSpec: ILabelSpec, startingPageNum: number, heading?: string, progressCallback?: IAddLabelsToDocProgressCallback): Promise<number>;
+  drawLabelGuidelines(labelSpec: ILabelSpec, labelBoundaryLinesProperties?: PDFCreator.ILineProperties): void;
+  /**
+   * Draws supplemental text such as a heading or footer.
+   *
+   * @param text Text to draw
+   * @param left Offset from left edge of document to left edge of text
+   * @param top Offset from top of document to top of text
+   */
+  drawSupplementalText(text: string, left: number, top: number): void;
+  /**
+   * Returns the UI descriptions of the label formats.
+   *
+   * @returns List of label format descriptions
+   * @class PDFLabels
+   */
+  getAvailableLabelFormats(): ILabelDescription[];
+  /**
+   * Returns the format of the specified label.
+   *
+   * @param averyPartNumber Avery® label base part number, e.g., "*60" (versus actual part numbers "5160", "8160",
+   * "8460", "48160"--all of which are 1" x 2-5/8" rectangular labels)
+   * @returns List of label format descriptions
+   * @class PDFLabels
+   */
+  getLabelFormat(averyPartNumber: string): ILabel;
+  /**
+   * Loads language font file and label formats into a jsPDF `doc` object.
+   *
+   * @param PDFCreator PDF-drawing library
+   * @throws TypeError "startPDFLabelDoc is stomping on labelFormats property" if the `labelFormats` property
+   * is found in doc before the label formats are loaded into the doc.
+   * @class PDFLabels
+   */
+  initialize(PDFCreator: PDFCreator.PDFCreator): Promise<void>;
+  /**
+   * Removes duplicates and empties, trims label lines, and returns a sorted list.
+   *
+   * @class PDFLabels
+   */
+  removeDuplicates(labels: string[][]): string[][];
+  /**
+   * Calculates the baseline position of the first line of text in a label.
+   *
+   * @param labelTop Offset from top of document to top of label
+   * @param labelHeight Height of each label in doc units
+   * @param numLabelLines Number of lines to be drawn in the label
+   * @param fontHeight Height of text in doc units
+   * @param verticalFontGap Spacing between lines of text in doc units
+   * @returns Baseline position
+   * @class PDFLabels
+   * @private
+   */
+  _calculateLabelFirstLineBase(labelTop: number, labelHeight: number, numLabelLines: number, fontHeight: number, verticalFontGap: number): number;
+  /**
+   * Trims a set of text lines to fit within specified bounds.
+   *
+   * @param lines Text lines to be trimmed
+   * @param maxTextWidth The maximum width permitted for the drawing of the text in doc units
+   * @param fontSize Text size in points
+   * @returns A copy of lines trimmed as necessary
+   * @class PDFLabels
+   * @private
+   */
+  _clipOverlongLines(lines: string[], maxTextWidth: number, fontSize: number): string[];
+  /**
+   * Trims a set of text lines to fit within specified bounds.
+   *
+   * @param lines Text lines to be checked
+   * @param maxTextWidth The maximum width permitted for the drawing of the text in doc units
+   * @param preferredFontSize Initial text size in points
+   * @param minimumFontSize The smallest acceptable font size in points
+   * @returns The maximum of `minimumFontSize` and the font size in points that should help all lines
+   * of the label to fit on the label
+   * @class PDFLabels
+   * @private
+   */
+  _getFontSizeForOverlongLines(lines: string[], maxTextWidth: number, preferredFontSize: number, minimumFontSize: number): number;
+  /**
+   * Loads the label formats.
+   *
+   * @param dataPath Path to the library's data files
+   * @returns Promise resolving to the label formats JSON
+   * @class PDFLabels
+   * @private
+   */
+  _loadLabelFormats(dataPath: string): Promise<ILabel[]>;
+}