@ni/nimble-angular 12.1.1 → 13.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ni/nimble-angular",
-  "version": "12.1.1",
+  "version": "13.0.0",
   "description": "Angular components for the NI Nimble Design System",
   "repository": {
     "type": "git",
@@ -14,21 +14,37 @@
     "url": "https://github.com/ni/nimble/issues"
   },
   "homepage": "https://github.com/ni/nimble#readme",
+  "exports": {
+    "./styles/*": {
+      "sass": "./styles/*.scss"
+    },
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./ni-nimble-angular.d.ts",
+      "esm2020": "./esm2020/ni-nimble-angular.mjs",
+      "es2020": "./fesm2020/ni-nimble-angular.mjs",
+      "es2015": "./fesm2015/ni-nimble-angular.mjs",
+      "node": "./fesm2015/ni-nimble-angular.mjs",
+      "default": "./fesm2020/ni-nimble-angular.mjs"
+    }
+  },
   "peerDependencies": {
-    "@angular/common": "^12.1.0",
-    "@angular/core": "^12.1.0",
-    "@angular/forms": "^12.1.0",
-    "@angular/router": "^12.1.0",
+    "@angular/common": "^13.3.11",
+    "@angular/core": "^13.3.11",
+    "@angular/forms": "^13.3.11",
+    "@angular/router": "^13.3.11",
     "@ni/nimble-components": "^15.1.1"
   },
   "dependencies": {
     "tslib": "^2.2.0"
   },
-  "main": "bundles/ni-nimble-angular.umd.js",
-  "module": "fesm2015/ni-nimble-angular.js",
-  "es2015": "fesm2015/ni-nimble-angular.js",
-  "esm2015": "esm2015/ni-nimble-angular.js",
-  "fesm2015": "fesm2015/ni-nimble-angular.js",
+  "module": "fesm2015/ni-nimble-angular.mjs",
+  "es2020": "fesm2020/ni-nimble-angular.mjs",
+  "esm2020": "esm2020/ni-nimble-angular.mjs",
+  "fesm2020": "fesm2020/ni-nimble-angular.mjs",
+  "fesm2015": "fesm2015/ni-nimble-angular.mjs",
   "typings": "ni-nimble-angular.d.ts",
   "sideEffects": false
 }

package/src/thirdparty/README.md

@@ -0,0 +1,10 @@
+This folder contains forked third-party source.
+
+- Each file in this folder should begin with a comment explaining where the file comes from and listing any modifications from the original.
+- All comments made by Nimble developers should be prefixed with the tag "`[Nimble]`".
+
+The `directives` folder corresponds to the [`packages/forms/src/directives` folder](https://github.com/angular/angular/tree/14.2.6/packages/forms/src/directives) of the Angular repo. **When updating the version of Angular** used by the `nimble-angular` package:
+1. Examine the versions of the files in the `directives` folder. The first comment in each file should contain a link with the release version in it. If the file's version is less than the version of Angular being upgraded to, continue with the following steps to update the files.
+2. Copy the upgrade version of the files on top of the existing ones, and migrate diffs as necessary.
+3. Update the link in the comment at the top of the file.
+4. Update the list of diffs in the comment at the top of the file. (I.e. if you made additional changes.)

package/thirdparty/directives/control_value_accessor.d.ts

@@ -0,0 +1,87 @@
+/**
+ * [Nimble]
+ * Copied from https://github.com/angular/angular/blob/14.2.6/packages/forms/src/directives/control_value_accessor.ts
+ * with the following modifications:
+ * - Commented out ControlValueAccessor which is exported from @angular/forms
+ * - Commented out NG_VALUE_ACCESSOR which is exported from @angular/forms
+ */
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import { ElementRef, Renderer2 } from '@angular/core';
+import * as i0 from "@angular/core";
+/**
+ * @description
+ * Defines an interface that acts as a bridge between the Angular forms API and a
+ * native element in the DOM.
+ *
+ * Implement this interface to create a custom form control directive
+ * that integrates with Angular forms.
+ *
+ * @see DefaultValueAccessor
+ *
+ * @publicApi
+ */
+/**
+ * Base class for all ControlValueAccessor classes defined in Forms package.
+ * Contains common logic and utility functions.
+ *
+ * Note: this is an *internal-only* class and should not be extended or used directly in
+ * applications code.
+ */
+export declare class BaseControlValueAccessor {
+    private _renderer;
+    private _elementRef;
+    /**
+     * The registered callback function called when a change or input event occurs on the input
+     * element.
+     * @nodoc
+     */
+    onChange: (_: any) => void;
+    /**
+     * The registered callback function called when a blur event occurs on the input element.
+     * @nodoc
+     */
+    onTouched: () => void;
+    constructor(_renderer: Renderer2, _elementRef: ElementRef);
+    /**
+     * Helper method that sets a property on a target element using the current Renderer
+     * implementation.
+     * @nodoc
+     */
+    protected setProperty(key: string, value: any): void;
+    /**
+     * Registers a function called when the control is touched.
+     * @nodoc
+     */
+    registerOnTouched(fn: () => void): void;
+    /**
+     * Registers a function called when the control value changes.
+     * @nodoc
+     */
+    registerOnChange(fn: (_: any) => {}): void;
+    /**
+     * Sets the "disabled" property on the range input element.
+     * @nodoc
+     */
+    setDisabledState(isDisabled: boolean): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<BaseControlValueAccessor, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<BaseControlValueAccessor, never, never, {}, {}, never>;
+}
+/**
+ * Base class for all built-in ControlValueAccessor classes (except DefaultValueAccessor, which is
+ * used in case no other CVAs can be found). We use this class to distinguish between default CVA,
+ * built-in CVAs and custom CVAs, so that Forms logic can recognize built-in CVAs and treat custom
+ * ones with higher priority (when both built-in and custom CVAs are present).
+ *
+ * Note: this is an *internal-only* class and should not be extended or used directly in
+ * applications code.
+ */
+export declare class BuiltInControlValueAccessor extends BaseControlValueAccessor {
+    static ɵfac: i0.ɵɵFactoryDeclaration<BuiltInControlValueAccessor, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<BuiltInControlValueAccessor, never, never, {}, {}, never>;
+}

package/thirdparty/directives/radio_control_value_accessor.d.ts

@@ -0,0 +1,134 @@
+/**
+ * [Nimble]
+ * Copied from https://github.com/angular/angular/blob/14.2.6/packages/forms/src/directives/radio_control_value_accessor.ts
+ * with the following modifications:
+ * - Changed throwNameError() to throw Error instead of RuntimeError. This makes the file compile with Angular version 12.
+ * - Removed now-unused import for RuntimeErrorCode and RuntimeError
+ * - Updated import of ControlValueAccessor, NgControl, and NG_VALUE_ACCESSOR to pull from package export
+ */
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import { ElementRef, Injector, OnDestroy, OnInit, Renderer2 } from '@angular/core';
+import { BuiltInControlValueAccessor } from './control_value_accessor';
+import { ControlValueAccessor, NgControl } from '@angular/forms';
+import * as i0 from "@angular/core";
+export declare const RADIO_VALUE_ACCESSOR: any;
+/**
+ * Internal-only NgModule that works as a host for the `RadioControlRegistry` tree-shakable
+ * provider. Note: the `InternalFormsSharedModule` can not be used here directly, since it's
+ * declared *after* the `RadioControlRegistry` class and the `providedIn` doesn't support
+ * `forwardRef` logic.
+ */
+export declare class RadioControlRegistryModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<RadioControlRegistryModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<RadioControlRegistryModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<RadioControlRegistryModule>;
+}
+/**
+ * @description
+ * Class used by Angular to track radio buttons. For internal use only.
+ */
+export declare class RadioControlRegistry {
+    private _accessors;
+    /**
+     * @description
+     * Adds a control to the internal registry. For internal use only.
+     */
+    add(control: NgControl, accessor: RadioControlValueAccessor): void;
+    /**
+     * @description
+     * Removes a control from the internal registry. For internal use only.
+     */
+    remove(accessor: RadioControlValueAccessor): void;
+    /**
+     * @description
+     * Selects a radio button. For internal use only.
+     */
+    select(accessor: RadioControlValueAccessor): void;
+    private _isSameGroup;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RadioControlRegistry, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<RadioControlRegistry>;
+}
+/**
+ * @description
+ * The `ControlValueAccessor` for writing radio control values and listening to radio control
+ * changes. The value accessor is used by the `FormControlDirective`, `FormControlName`, and
+ * `NgModel` directives.
+ *
+ * @usageNotes
+ *
+ * ### Using radio buttons with reactive form directives
+ *
+ * The follow example shows how to use radio buttons in a reactive form. When using radio buttons in
+ * a reactive form, radio buttons in the same group should have the same `formControlName`.
+ * Providing a `name` attribute is optional.
+ *
+ * {@example forms/ts/reactiveRadioButtons/reactive_radio_button_example.ts region='Reactive'}
+ *
+ * @ngModule ReactiveFormsModule
+ * @ngModule FormsModule
+ * @publicApi
+ */
+export declare class RadioControlValueAccessor extends BuiltInControlValueAccessor implements ControlValueAccessor, OnDestroy, OnInit {
+    private _registry;
+    private _injector;
+    /** @internal */
+    _state: boolean;
+    /** @internal */
+    _control: NgControl;
+    /** @internal */
+    _fn: Function;
+    /**
+     * The registered callback function called when a change event occurs on the input element.
+     * Note: we declare `onChange` here (also used as host listener) as a function with no arguments
+     * to override the `onChange` function (which expects 1 argument) in the parent
+     * `BaseControlValueAccessor` class.
+     * @nodoc
+     */
+    onChange: () => void;
+    /**
+     * @description
+     * Tracks the name of the radio input element.
+     */
+    name: string;
+    /**
+     * @description
+     * Tracks the name of the `FormControl` bound to the directive. The name corresponds
+     * to a key in the parent `FormGroup` or `FormArray`.
+     */
+    formControlName: string;
+    /**
+     * @description
+     * Tracks the value of the radio input element
+     */
+    value: any;
+    constructor(renderer: Renderer2, elementRef: ElementRef, _registry: RadioControlRegistry, _injector: Injector);
+    /** @nodoc */
+    ngOnInit(): void;
+    /** @nodoc */
+    ngOnDestroy(): void;
+    /**
+     * Sets the "checked" property value on the radio input element.
+     * @nodoc
+     */
+    writeValue(value: any): void;
+    /**
+     * Registers a function called when the control value changes.
+     * @nodoc
+     */
+    registerOnChange(fn: (_: any) => {}): void;
+    /**
+     * Sets the "value" on the radio input element and unchecks it.
+     *
+     * @param value
+     */
+    fireUncheck(value: any): void;
+    private _checkName;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RadioControlValueAccessor, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<RadioControlValueAccessor, "input[type=radio][formControlName],input[type=radio][formControl],input[type=radio][ngModel]", never, { "name": "name"; "formControlName": "formControlName"; "value": "value"; }, {}, never>;
+}