@norgate-av/ch5-crcomlib 2.17.2

package/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (C) 2022 to the present, Crestron Electronics, Inc.
+
+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.

package/README.md

@@ -0,0 +1,95 @@
+<p align="center">
+  <img src="https://kenticoprod.azureedge.net/kenticoblob/crestron/media/crestron/generalsiteimages/crestron-logo.png">
+</p>
+
+# @norgate-av/ch5-crcomlib
+
+> This package is a fork of [@crestron/ch5-crcomlib](https://github.com/CrestronEng/CH5ComponentLibrary) by Crestron Electronics, Inc., used under the [Apache 2.0 License](LICENSE.txt).
+> Modifications made by [Norgate AV](https://github.com/Norgate-AV).
+
+## Changes from upstream
+
+- Added proper ESM build output (`build_bundles/esm/`) using [tsup](https://tsup.egoist.dev/)
+- Added correct `exports` field in `package.json` for ESM, CJS, and UMD module resolution
+- Enables compatibility with modern bundlers such as Vite, Rollup, and esbuild
+- Migrated package manager to [pnpm](https://pnpm.io/)
+- Added GitHub Actions CI workflow for automated builds
+
+## Syncing with upstream
+
+This fork tracks the upstream Crestron repository. When Crestron publish a new release, upstream changes are merged and the package is rebuilt and republished to npm.
+
+---
+
+# CH5 - Crestron Components library (CrComLib) - Getting Started
+
+## See Crestron developer website for documentation
+
+https://www.crestron.com/developer
+Search for CRESTRON HTML5 USER INTERFACE
+
+## Generated folders
+
+- build*bundles/\_module_type* - contains files generated by webpack (and the typescript compiler for the esm modules)
+- compiled*bundles/\_module_type* - contains files generated by the typescript compiler (tsc)
+- docs/html
+
+Where _module_type_ is:
+
+- _umd_ - UMD (contains CommonJs, AMD, and also creates a global property in the window object).
+- _cjs_ - CommonJs
+- _esm_ - ES Modules, ES6.
+- _amd_ - Asynchronous Module Definition
+
+## Activating extra information in the browser console
+
+### For ch5 components
+
+Ch5 components will display additional info in the browser console if they have a debug attribute defined. For example:
+`<ch5-button debug label="Btn1"></ch5-button>`
+
+### For ch5 custom attributes (data-ch5-...)
+
+Additional information will be displayed in the browser console if the element has a debug attribute. For example:
+`<div debug data-ch5-show="a_signal">Hello</div>`
+
+### For the bridge-related functions/methods
+
+In order to display additional information, you must first enable this using the methods from Ch5Debug:
+
+- getConfig - Returns the current configuration: all keys that can be set and their current value. A key enables debug info
+  for a method/function
+- loadConfig(cfg) - Loads a new config (replaces the previous one)
+- enableAll() - Enables all keys. Will display all debug info available. (The debug info that uses Ch5Debug, the info
+  from ch5 components, and custom attributes will not be affected)
+- disablesAll() - Disables all keys
+- setConfigKeyValue(key:string, value:boolean) - Changes the value of a key
+
+### Build Dev Universal Module Definition
+
+npm run build:dev:umd
+
+### Run Test web-component-tester
+
+npm run test:wct
+
+### Start
+
+npm run start
+
+### localhost 3000 with parameters IP ID and Host
+
+http://localhost:3000/?ipId=0x99&host=10.0.0.203
+
+## What's New
+
+Updates to the Crestron HTML5 User Interface and documentation are avalilable in the following link
+https://sdkcon78221.crestron.com/sdk/Crestron_HTML5UI/Content/Topics/Whats-New.htm
+
+### npm link
+
+cd crestron-components-lib
+npm link
+
+cd CH5Sandbox\shell-template\
+ npm link @crestron/ch5-crcomlib

package/build_bundles/amd/@types/ch5-animation/ch5-animation.d.ts

@@ -0,0 +1,53 @@
+import { Ch5Common } from "../ch5-common/ch5-common";
+import { Ch5SignalElementAttributeRegistryEntries } from "../ch5-common/ch5-signal-attribute-registry";
+import { TCh5AnimationSize, TCh5AnimationStyle } from './interfaces/t-ch5-animation';
+import { ICh5AnimationAttributes } from './interfaces/i-ch5-animation-attributes';
+import { ICh5PropertySettings } from "../ch5-core/ch5-property";
+export declare class Ch5Animation extends Ch5Common implements ICh5AnimationAttributes {
+    static readonly SIZES: TCh5AnimationSize[];
+    static readonly ANIMATION_STYLES: TCh5AnimationStyle[];
+    static readonly ANIMATION_STYLES_CLASS: string[];
+    static readonly COMPONENT_DATA: any;
+    static readonly SIGNAL_ATTRIBUTE_TYPES: Ch5SignalElementAttributeRegistryEntries;
+    static readonly COMPONENT_PROPERTIES: ICh5PropertySettings[];
+    static readonly ELEMENT_NAME = "ch5-animation";
+    static readonly DEFAULT_FRAMES_PER_SECOND = 1500;
+    static readonly MAX_FRAMES_PER_SECOND = 1;
+    static readonly FRAMES_PER_SECOND_MIN = 3;
+    static readonly FRAMES_PER_SECOND_MAX = 100;
+    primaryCssClass: string;
+    private _ch5Properties;
+    private _elContainer;
+    private _iconContainer;
+    set startAnimating(value: boolean);
+    get startAnimating(): boolean;
+    set size(value: TCh5AnimationSize);
+    get size(): TCh5AnimationSize;
+    set animationStyle(value: TCh5AnimationStyle);
+    get animationStyle(): TCh5AnimationStyle;
+    set receiveStateAnimate(value: string);
+    get receiveStateAnimate(): string;
+    set receiveStateFramesPerSecond(value: string);
+    get receiveStateFramesPerSecond(): string;
+    set receiveStateAnimationStyle(value: string);
+    get receiveStateAnimationStyle(): string;
+    static registerSignalAttributeTypes(): void;
+    static registerCustomElement(): void;
+    constructor();
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldValue: string, newValue: string): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected createInternalHtml(): void;
+    protected initAttributes(): void;
+    protected attachEventListeners(): void;
+    protected removeEventListeners(): void;
+    protected unsubscribeFromSignals(): void;
+    private handleStartAnimating;
+    private handleFramesPerSecond;
+    private handleSize;
+    private handleAnimationStyle;
+    private updateCssClass;
+    protected getTargetElementForCssClassesAndStyle(): HTMLElement;
+    getCssClassDisabled(): string;
+}

package/build_bundles/amd/@types/ch5-animation/index.d.ts

@@ -0,0 +1 @@
+export * from './ch5-animation';

package/build_bundles/amd/@types/ch5-animation/interfaces/i-ch5-animation-attributes.d.ts

@@ -0,0 +1,10 @@
+import { ICh5CommonAttributesAnimation } from "../../ch5-common/interfaces/i-ch5-common-attributes-animation";
+import { TCh5AnimationSize, TCh5AnimationStyle } from './t-ch5-animation';
+export interface ICh5AnimationAttributes extends ICh5CommonAttributesAnimation {
+    startAnimating: boolean;
+    size: TCh5AnimationSize;
+    animationStyle: TCh5AnimationStyle;
+    receiveStateAnimate: string;
+    receiveStateFramesPerSecond: string;
+    receiveStateAnimationStyle: string;
+}

package/build_bundles/amd/@types/ch5-animation/interfaces/t-ch5-animation.d.ts

@@ -0,0 +1,2 @@
+export type TCh5AnimationSize = 'regular' | 'small' | 'large' | 'x-large';
+export type TCh5AnimationStyle = 'ring' | 'spinner' | 'roller';

package/build_bundles/amd/@types/ch5-background/ch5-background.d.ts

@@ -0,0 +1,114 @@
+import { Ch5Common } from './../ch5-common/ch5-common';
+import { ICh5BackgroundAttributes } from './interfaces/i-ch5-background-attributes';
+import { TCh5BackgroundScale, TCh5BackgroundRepeat, TCh5BackgroundTransitionEffect } from './interfaces';
+import { ICh5VideoBackground } from './../ch5-video/interfaces';
+import { Ch5SignalElementAttributeRegistryEntries } from '../ch5-common/ch5-signal-attribute-registry';
+export declare class Ch5Background extends Ch5Common implements ICh5BackgroundAttributes {
+    static readonly ELEMENT_NAME = "ch5-background";
+    static SCALE: TCh5BackgroundScale[];
+    static REPEAT: TCh5BackgroundRepeat[];
+    static REFRESHRATE: number;
+    static IMGBGCOLOR: string;
+    static readonly COMPONENT_DATA: any;
+    static readonly SIGNAL_ATTRIBUTE_TYPES: Ch5SignalElementAttributeRegistryEntries;
+    primaryCssClass: string;
+    parentCssClassPrefix: string;
+    canvasCssClassPrefix: string;
+    isCanvasCreated: boolean;
+    private _elCanvas;
+    private _canvasList;
+    private _prevCanvasList;
+    private _imgUrls;
+    private _elImages;
+    private _elBackupImages;
+    private _bgColors;
+    private _bgIdx;
+    private _interval;
+    private _videoRes;
+    private _isVisible;
+    private _videoDimensions;
+    private _isRefilled;
+    private isInitialized;
+    private readonly VIDEO_ACTION;
+    private MARK_COLORS;
+    private _url;
+    private _backgroundColor;
+    private _repeat;
+    private _scale;
+    private _refreshRate;
+    private _videoCrop;
+    private _imgBackgroundColor;
+    private _transitionEffect;
+    private _transitionDuration;
+    private _receiveStateRefreshRate;
+    private _subReceiveRefreshRate;
+    private _receiveStateUrl;
+    private _sigNameReceiveUrl;
+    private _subReceiveUrl;
+    private _receiveStateBackgroundColor;
+    private _subReceiveBackgroundColor;
+    private _videoSubscriptionId;
+    private _canvasSubscriptionId;
+    static registerSignalAttributeTypes(): void;
+    get url(): string;
+    set url(value: string);
+    get backgroundColor(): string;
+    set backgroundColor(value: string);
+    get repeat(): TCh5BackgroundRepeat | null;
+    set repeat(value: TCh5BackgroundRepeat | null);
+    get scale(): TCh5BackgroundScale;
+    set scale(value: TCh5BackgroundScale);
+    get refreshRate(): number;
+    set refreshRate(value: number);
+    get videoCrop(): string;
+    set videoCrop(value: string);
+    get imgBackgroundColor(): string;
+    set imgBackgroundColor(value: string);
+    get transitionEffect(): TCh5BackgroundTransitionEffect;
+    set transitionEffect(value: TCh5BackgroundTransitionEffect);
+    get transitionDuration(): string;
+    set transitionDuration(value: string);
+    set receiveStateRefreshRate(value: string);
+    get receiveStateRefreshRate(): string;
+    set receiveStateUrl(value: string);
+    get receiveStateUrl(): string;
+    set receiveStateBackgroundColor(value: string);
+    get receiveStateBackgroundColor(): string;
+    constructor();
+    connectedCallback(): void;
+    private isInViewport;
+    videoBGRequest(request: ICh5VideoBackground): void;
+    disconnectedCallback(): void;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(attr: string, oldValue: string, newValue: string): void;
+    unsubscribeFromSignals(): void;
+    protected initAttributes(): void;
+    protected updateBackground(): void;
+    protected updateBackgroundForEachCanvas(canvas: HTMLCanvasElement, idx: number): void;
+    private getBackgroundUrl;
+    private getBackgroundColor;
+    private scaleToFill;
+    private scaleToFit;
+    private scaleToStretch;
+    private updateBgImageScale;
+    private updateBgImageRepeat;
+    private canvasTemplate;
+    private manageVideoInfo;
+    private isScrollBar;
+    private setCanvasDimensions;
+    private updateCanvasDimensions;
+    private createCanvas;
+    private setBgTransition;
+    private setBgImage;
+    private setBgImageByCanvas;
+    private setBgColor;
+    private setBgColorByCanvas;
+    private videoBGUpdateAction;
+    private updateBgColor;
+    private changeBackground;
+    private updateBgImage;
+    refillBackground(): void;
+    refillBackgroundforOneVideo(videoData: any): void;
+    private videoBGAction;
+    private isCanvasListValid;
+}

package/build_bundles/amd/@types/ch5-background/index.d.ts

@@ -0,0 +1 @@
+export * from './ch5-background';

package/build_bundles/amd/@types/ch5-background/interfaces/i-ch5-background-attributes.d.ts

@@ -0,0 +1,15 @@
+import { ICh5CommonAttributes } from '../../ch5-common/interfaces';
+import { TCh5BackgroundScale, TCh5BackgroundRepeat, TCh5BackgroundTransitionEffect } from './index';
+export interface ICh5BackgroundAttributes extends ICh5CommonAttributes {
+    url: string;
+    backgroundColor: string;
+    repeat: TCh5BackgroundRepeat | null;
+    scale: TCh5BackgroundScale;
+    refreshRate: number | string;
+    imgBackgroundColor: string;
+    transitionEffect: TCh5BackgroundTransitionEffect;
+    transitionDuration: string;
+    receiveStateRefreshRate: string;
+    receiveStateUrl: string;
+    receiveStateBackgroundColor: string;
+}

package/build_bundles/amd/@types/ch5-background/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './t-ch5-background';
+export * from "./i-ch5-background-attributes";

package/build_bundles/amd/@types/ch5-background/interfaces/t-ch5-background.d.ts

@@ -0,0 +1,3 @@
+export type TCh5BackgroundRepeat = 'no-repeat' | 'repeat' | 'repeat-x' | 'repeat-y';
+export type TCh5BackgroundScale = 'stretch' | 'fill' | 'fit';
+export type TCh5BackgroundTransitionEffect = 'ease' | 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out';

package/build_bundles/amd/@types/ch5-base/ch5-base-class.d.ts

@@ -0,0 +1,138 @@
+import { Ch5BaseLog } from './ch5-base-log';
+import { ICh5CommonAttributes, TCh5ShowType } from '../ch5-common/interfaces';
+import { Ch5SignalElementAttributeRegistryEntries } from '../ch5-common/ch5-signal-attribute-registry';
+import { ICh5PropertySettings } from '../ch5-core/ch5-property';
+import { Ch5Properties } from '../ch5-core/ch5-properties';
+import * as util from '../ch5-common/utils';
+export interface ICh5CommonProperties {
+    appendClassWhenInViewPort: ICh5PropertySettings;
+    customClass: ICh5PropertySettings;
+    customStyle: ICh5PropertySettings;
+    debug: ICh5PropertySettings;
+    dir: ICh5PropertySettings;
+    disabled: ICh5PropertySettings;
+    id: ICh5PropertySettings;
+    noshowType: ICh5PropertySettings;
+    receiveStateCustomClass: ICh5PropertySettings;
+    receiveStateCustomStyle: ICh5PropertySettings;
+    receiveStateEnable: ICh5PropertySettings;
+    receiveStateShow: ICh5PropertySettings;
+    receiveStateShowPulse: ICh5PropertySettings;
+    receiveStateHidePulse: ICh5PropertySettings;
+    sendEventOnShow: ICh5PropertySettings;
+    show: ICh5PropertySettings;
+    trace: ICh5PropertySettings;
+    swipeGestureEnabled: ICh5PropertySettings;
+}
+export declare abstract class Ch5BaseClass extends HTMLElement implements ICh5CommonAttributes {
+    static readonly DIRECTION: string[];
+    static readonly NO_SHOW_TYPES: TCh5ShowType[];
+    static ELEMENT_NAME: string;
+    protected COMPONENT_NAME: string;
+    primaryCssClass: string;
+    childrenOfCurrentNode: [HTMLElement] | null;
+    protected _isInstantiated: boolean;
+    protected _nextSiblingIndexInParentChildNodes: number;
+    protected _onrelease: {};
+    protected _onpress: {};
+    protected _crId: string;
+    private readonly CSS_CLASS_FOR_HIDE_VISIBILITY;
+    private readonly CSS_CLASS_FOR_HIDE_DISPLAY;
+    protected _cachedParentEl: Node | null;
+    protected _cachedNextSibling: Node | null;
+    protected _isDetachedFromDom: boolean;
+    protected _keepListeningOnSignalsAfterRemoval: boolean;
+    elementIsInViewPort: boolean;
+    elementIntersectionEntry: IntersectionObserverEntry;
+    elementIsVisible: boolean;
+    logger: Ch5BaseLog;
+    private _commonMutationObserver;
+    private _subscribeAppendClassWhenInViewPort;
+    protected _ch5Properties: Ch5Properties;
+    componentProperties: ICh5PropertySettings[];
+    static COMPONENT_PROPERTIES: ICh5PropertySettings[];
+    static readonly BASE_COMPONENT_PROPERTIES: ICh5PropertySettings[];
+    static readonly COMMON_PROPERTIES: ICh5CommonProperties;
+    set appendClassWhenInViewPort(value: string);
+    get appendClassWhenInViewPort(): string;
+    set customClass(value: string);
+    get customClass(): string;
+    set customStyle(value: string);
+    get customStyle(): string;
+    set debug(value: boolean);
+    get debug(): boolean;
+    set dir(value: string);
+    get dir(): string;
+    set disabled(value: boolean);
+    get disabled(): boolean;
+    set id(value: string);
+    get id(): string;
+    set noshowType(value: TCh5ShowType);
+    get noshowType(): TCh5ShowType;
+    set receiveStateCustomClass(value: string);
+    get receiveStateCustomClass(): string;
+    set receiveStateCustomStyle(value: string);
+    get receiveStateCustomStyle(): string;
+    set show(value: boolean);
+    get show(): boolean;
+    set receiveStateEnable(value: string);
+    get receiveStateEnable(): string;
+    set receiveStateHidePulse(value: string);
+    get receiveStateHidePulse(): string;
+    set receiveStateShowPulse(value: string);
+    get receiveStateShowPulse(): string;
+    set receiveStateShow(value: string);
+    get receiveStateShow(): string;
+    set sendEventOnShow(value: string);
+    get sendEventOnShow(): string;
+    set onrelease(callback: {});
+    get onrelease(): {};
+    set onpress(callback: {});
+    get onpress(): {};
+    set trace(value: boolean);
+    get trace(): boolean;
+    set swipeGestureEnabled(value: boolean);
+    get swipeGestureEnabled(): boolean;
+    protected get util(): typeof util;
+    constructor(componentInputProperties: ICh5PropertySettings[]);
+    resolveTemplateChildren(template: HTMLTemplateElement): void;
+    protected static get selectedComponentProperties(): ICh5PropertySettings[];
+    protected static set selectedComponentProperties(value: ICh5PropertySettings[]);
+    static get observedAttributes(): string[];
+    getCrId(): string;
+    private static getCommonProperty;
+    attributeChangedCallback(attr: string, oldValue: string, newValue: string): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected cacheComponentChildrens(): void;
+    protected repaint(): void;
+    protected updateCssClasses(): void;
+    protected updateForChangeInCustomCssClass(_prevAddedCustomClasses: string[]): void;
+    protected updateForChangeInCustomStyle(): void;
+    protected updateForChangeInShowStatus(): void;
+    protected handleHide(targetElement: HTMLElement): void;
+    protected handleShow(targetElement: HTMLElement): void;
+    protected beforeHandlingShow(): void;
+    protected afterHandlingShow(): void;
+    protected beforeHandlingHide(): void;
+    protected afterHandlingHide(): void;
+    protected updateForChangeInDisabledStatus(): void;
+    protected getTargetElementForCssClassesAndStyle(): HTMLElement;
+    protected initAttributes(): void;
+    protected clearStringSignalSubscription(sigName: string | null | undefined, subscriptionKey: string): void;
+    protected clearBooleanSignalSubscription(sigName: string | null | undefined, subscriptionKey: string): void;
+    protected sendShowSignal(value: boolean): void;
+    protected attributeChangeHandler(attr: string, oldValue: string, newValue: string): string;
+    protected applyPreConfiguredAttributes(): void;
+    protected _attributeValueAsString(attrName: string): string;
+    protected contentCleanUp(): void;
+    getCssClassDisabled(): string;
+    protected unsubscribeFromSignals(): void;
+    protected componentLoadedEvent(elementName: string, idValue: string): void;
+    protected updateInViewPortClass(): void;
+    updateElementVisibility(visible: boolean): void;
+    initCommonMutationObserver(element: Ch5BaseClass): void;
+    disconnectCommonMutationObserver(): void;
+    protected convertAnalogValueBasedOnSignalResponse(input: number): number;
+    static getSignalElementAttributeRegistryEntries(customComponentProperties: ICh5PropertySettings[]): Ch5SignalElementAttributeRegistryEntries;
+}

package/build_bundles/amd/@types/ch5-base/ch5-base-log.d.ts

@@ -0,0 +1,12 @@
+export declare class Ch5BaseLog {
+    componentName: string;
+    isDebugEnabled: boolean;
+    isTraceEnabled: boolean;
+    crId: string;
+    constructor(componentName: string, isDebugEnabled: boolean, isTraceEnabled?: boolean, crId?: string);
+    start(message: string): void;
+    log(...message: any[]): void;
+    info(message?: any, ...optionalParams: any[]): void;
+    error(message: any, ...optionalParams: any[]): void;
+    stop(methodName?: string): void;
+}