@progress/kendo-angular-filter 0.1.0

package/dist/es2015/filter.component.js

@@ -0,0 +1,298 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { Component, Input, Output, EventEmitter, HostBinding, isDevMode } from '@angular/core';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+import { FilterService } from './filter.service';
+import { isArray } from './util';
+import { ChangeDetectorRef } from '@angular/core';
+import { validatePackage } from '@progress/kendo-licensing';
+import { packageMetadata } from './package-metadata';
+/**
+ * Represents the [Kendo UI Filter component for Angular]({% slug overview_filter %}).
+ * The Filter component can be used to apply any user defined filter criteria.
+ * @example
+ * ```
+ *   @Component({
+ *       selector: 'my-app',
+ *       template: `
+ *          <kendo-filter [filters]="filters" (valueChange)="onValueChange($event)"></kendo-filter>
+ *       `
+ *   })
+ *   export class AppComponent {
+ *
+ *      public filters: FilterExpression[] = [
+ *          {
+ *              name: 'country',
+ *              label: 'Country',
+ *              filter: 'string',
+ *              operators: ['eq', 'neq'],
+ *          },
+ *          {
+ *              name: 'budget',
+ *              filter: 'number'
+ *          }
+ *      ];
+ *
+ *      onValueChange(e: CompositeFilterDescriptor){
+ *          console.log(e)
+ *      }
+ *  }
+ * ```
+ */
+let FilterComponent = class FilterComponent {
+    constructor(filterService, localization, cdr) {
+        this.filterService = filterService;
+        this.localization = localization;
+        this.cdr = cdr;
+        /**
+         * Fires every time the Filter component value is updated.
+         * That is each time a Filter Group or Filter Expression is added, removed, or updated.
+         */
+        this.valueChange = new EventEmitter();
+        validatePackage(packageMetadata);
+        this.direction = localization.rtl ? 'rtl' : 'ltr';
+    }
+    /**
+     * Specifies the available user-defined filters. At least one filter should be provided.
+     */
+    set filters(_filters) {
+        if (isDevMode() && (!isArray(_filters) || _filters.length === 0)) {
+            throw new Error(`Pass at least one user-defined filter through the [filters] input property. See http://www.telerik.com/kendo-angular-ui/components/filter/#data-binding`);
+        }
+        this.filterService.filters = _filters.map(filterExpression => {
+            let clonedFilter = Object.assign({}, filterExpression);
+            if (!clonedFilter.title) {
+                clonedFilter.title = clonedFilter.field;
+            }
+            return clonedFilter;
+        });
+    }
+    get filters() {
+        return this.filterService.filters;
+    }
+    /**
+     * Sets the initial `value` of the Filter component.
+     */
+    set value(value) {
+        const clonedValue = JSON.parse(JSON.stringify(value));
+        this.normalizeValue(clonedValue);
+        this.filterService.value = clonedValue;
+    }
+    get value() {
+        return this.filterService.value;
+    }
+    ngOnInit() {
+        if (this.filters.length === 0) {
+            throw new Error(`Pass at least one user-defined filter through the [filters] input property. See http://www.telerik.com/kendo-angular-ui/components/filter/#data-binding`);
+        }
+        this.localization.changes.subscribe(({ rtl }) => {
+            this.direction = rtl ? 'rtl' : 'ltr';
+            this.cdr.detectChanges();
+        });
+    }
+    ngOnDestroy() {
+        this.localization.changes.unsubscribe();
+    }
+    /**
+     * @hidden
+     */
+    getCurrentFilter() {
+        return this.value;
+    }
+    /**
+     * @hidden
+     */
+    getCurrentFilterChildren() {
+        return this.value.filters;
+    }
+    /**
+     * @hidden
+     */
+    onValueChange() {
+        this.valueChange.emit(this.filterService.value);
+    }
+    normalizeFilter(filterDescriptor) {
+        const foundFilter = this.filterService.filters.find((filter) => filter.field === filterDescriptor.field);
+        if (isDevMode() && !foundFilter) {
+            throw new Error(`There is no user-defined filter with '${filterDescriptor.field}' field provided through the [filters] input property.`);
+        }
+        if (isDevMode() && foundFilter.editor === 'boolean' && (!filterDescriptor.value && filterDescriptor.value !== false)) {
+            console.warn(`Provide a value for the boolean '${filterDescriptor.field}' user-defined filter as the operator is always set to 'eq'.`);
+        }
+        if (foundFilter.editor === 'boolean') {
+            filterDescriptor.operator = 'eq';
+        }
+        if (foundFilter.editor === 'date' && filterDescriptor.value) {
+            filterDescriptor.value = new Date(filterDescriptor.value);
+        }
+        if (!filterDescriptor.value && filterDescriptor.value !== false) {
+            filterDescriptor.value = null;
+        }
+    }
+    normalizeValue(item) {
+        item.filters.forEach((item) => {
+            if (item.filters) {
+                this.normalizeValue(item);
+            }
+            else {
+                this.normalizeFilter(item);
+            }
+        });
+    }
+};
+tslib_1.__decorate([
+    HostBinding('attr.dir'),
+    tslib_1.__metadata("design:type", String)
+], FilterComponent.prototype, "direction", void 0);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Array),
+    tslib_1.__metadata("design:paramtypes", [Array])
+], FilterComponent.prototype, "filters", null);
+tslib_1.__decorate([
+    Input(),
+    tslib_1.__metadata("design:type", Object),
+    tslib_1.__metadata("design:paramtypes", [Object])
+], FilterComponent.prototype, "value", null);
+tslib_1.__decorate([
+    Output(),
+    tslib_1.__metadata("design:type", EventEmitter)
+], FilterComponent.prototype, "valueChange", void 0);
+FilterComponent = tslib_1.__decorate([
+    Component({
+        selector: 'kendo-filter',
+        template: `
+        <ng-container kendoFilterLocalizedMessages
+            i18n-editorDateTodayText="kendo.filter.editorDateTodayText|The text of the Today button of the Date editor"
+            editorDateTodayText="Today"
+
+            i18n-editorDateToggleText="kendo.filter.editorDateToggleText|The title of the Toggle button of the Date editor."
+            editorDateToggleText="Toggle calendar"
+
+            i18n-editorNumericDecrement="kendo.filter.editorNumericDecrement|The title of the Decrement button of the Numeric editor"
+            editorNumericDecrement="Decrement"
+
+            i18n-editorNumericIncrement="kendo.filter.editorNumericIncrement|The title of the Increment button of the Numeric editor"
+            editorNumericIncrement="Increment"
+
+            i18n-filterExpressionOperators="kendo.filter.filterExpressionOperators|The text of the Filter Expression Operators drop down"
+            filterExpressionOperators="Operators"
+
+            i18n-filterExpressionFilters="kendo.filter.filterExpressionFilters|The text of the Filter Expression filters drop down"
+            filterExpressionFilters="Fields"
+
+            i18n-remove="kendo.filter.remove|The text of the Remove button"
+            remove="Remove"
+
+            i18n-addExpression="kendo.filter.addExpression|The text of the Add Expression button"
+            addExpression="Add Expression"
+
+            i18n-addGroup="kendo.filter.addGroup|The text of the Add Group button"
+            addGroup="Add Group"
+
+            i18n-filterAndLogic="kendo.filter.filterAndLogic|The text of the And filter logic"
+            filterAndLogic="And"
+
+            i18n-filterOrLogic="kendo.filter.filterOrLogic|The text of the Or filter logic"
+            filterOrLogic="Or"
+
+            i18n-filterEqOperator="kendo.filter.filterEqOperator|The text of the equal filter operator"
+            filterEqOperator="Is equal to"
+
+            i18n-filterNotEqOperator="kendo.filter.filterNotEqOperator|The text of the not equal filter operator"
+            filterNotEqOperator="Is not equal to"
+
+            i18n-filterIsNullOperator="kendo.filter.filterIsNullOperator|The text of the is null filter operator"
+            filterIsNullOperator="Is null"
+
+            i18n-filterIsNotNullOperator="kendo.filter.filterIsNotNullOperator|The text of the is not null filter operator"
+            filterIsNotNullOperator="Is not null"
+
+            i18n-filterIsEmptyOperator="kendo.filter.filterIsEmptyOperator|The text of the is empty filter operator"
+            filterIsEmptyOperator="Is empty"
+
+            i18n-filterIsNotEmptyOperator="kendo.filter.filterIsNotEmptyOperator|The text of the is not empty filter operator"
+            filterIsNotEmptyOperator="Is not empty"
+
+            i18n-filterStartsWithOperator="kendo.filter.filterStartsWithOperator|The text of the starts with filter operator"
+            filterStartsWithOperator="Starts with"
+
+            i18n-filterContainsOperator="kendo.filter.filterContainsOperator|The text of the contains filter operator"
+            filterContainsOperator="Contains"
+
+            i18n-filterNotContainsOperator="kendo.filter.filterNotContainsOperator|The text of the does not contain filter operator"
+            filterNotContainsOperator="Does not contain"
+
+            i18n-filterEndsWithOperator="kendo.filter.filterEndsWithOperator|The text of the ends with filter operator"
+            filterEndsWithOperator="Ends with"
+
+            i18n-filterGteOperator="kendo.filter.filterGteOperator|The text of the greater than or equal filter operator"
+            filterGteOperator="Is greater than or equal to"
+
+            i18n-filterGtOperator="kendo.filter.filterGtOperator|The text of the greater than filter operator"
+            filterGtOperator="Is greater than"
+
+            i18n-filterLteOperator="kendo.filter.filterLteOperator|The text of the less than or equal filter operator"
+            filterLteOperator="Is less than or equal to"
+
+            i18n-filterLtOperator="kendo.filter.filterLtOperator|The text of the less than filter operator"
+            filterLtOperator="Is less than"
+
+            i18n-filterIsTrue="kendo.filter.filterIsTrue|The text of the IsTrue boolean filter option"
+            filterIsTrue="Is True"
+
+            i18n-filterIsFalse="kendo.filter.filterIsFalse|The text of the IsFalse boolean filter option"
+            filterIsFalse="Is False"
+
+            i18n-filterBooleanAll="kendo.filter.filterBooleanAll|The text of the (All) boolean filter option"
+            filterBooleanAll="(All)"
+
+            i18n-filterAfterOrEqualOperator="kendo.filter.filterAfterOrEqualOperator|The text of the after or equal date filter operator"
+            filterAfterOrEqualOperator="Is after or equal to"
+
+            i18n-filterAfterOperator="kendo.filter.filterAfterOperator|The text of the after date filter operator"
+            filterAfterOperator="Is after"
+
+            i18n-filterBeforeOperator="kendo.filter.filterBeforeOperator|The text of the before date filter operator"
+            filterBeforeOperator="Is before"
+
+            i18n-filterBeforeOrEqualOperator="kendo.filter.filterBeforeOrEqualOperator|The text of the before or equal date filter operator"
+            filterBeforeOrEqualOperator="Is before or equal to"
+
+            i18n-filterFieldAriaLabel="kendo.filter.filterFieldAriaLabel|The text of the filter field aria label"
+            filterFieldAriaLabel="field"
+
+            i18n-filterOperatorAriaLabel="kendo.filter.filterOperatorAriaLabel|The text of the filter operator aria label"
+            filterOperatorAriaLabel="operator"
+
+            i18n-filterValueAriaLabel="kendo.filter.filterValueAriaLabel|The text of the filter value aria label"
+            filterValueAriaLabel="value"
+
+            i18n-filterAriaLabel="kendo.filter.filterAriaLabel|The text of the filter row aria label"
+            filterAriaLabel="filter"
+
+            i18n-filterToolbarAriaLabel="kendo.filter.filterToolbarAriaLabel|The text of the filter toolbar aria label"
+            filterToolbarAriaLabel="filter settings"
+            >
+        </ng-container>
+        <div class="k-widget k-filter" [attr.dir]="direction">
+            <ul class='k-filter-container'>
+                <li class='k-filter-group-main'>
+                    <kendo-filter-group
+                        [currentItem]="getCurrentFilter()"
+                        (valueChange)="onValueChange()"
+                        >
+                    </kendo-filter-group>
+                </li>
+            </ul>
+        </div>
+`
+    }),
+    tslib_1.__metadata("design:paramtypes", [FilterService,
+        LocalizationService,
+        ChangeDetectorRef])
+], FilterComponent);
+export { FilterComponent };

package/dist/es2015/filter.module.d.ts

@@ -0,0 +1,37 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Represents the [NgModule]({{ site.data.urls.angular['ngmoduleapi'] }})
+ * definition for the Filter component.
+ *
+ * @example
+ *
+ * ```
+ * // Import the Filter module
+ * import { FilterModule } from '@progress/kendo-angular-filter';
+ *
+ * // The browser platform with a compiler
+ * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+ *
+ * import { NgModule } from '@angular/core';
+ *
+ * // Import the app component
+ * import { AppComponent } from './app.component';
+ *
+ * // Define the app module
+ * _@NgModule({
+ *     declarations: [AppComponent], // declare app component
+ *     imports:      [BrowserModule, FilterModule], // import Filter module
+ *     bootstrap:    [AppComponent]
+ * })
+ * export class AppModule { }
+ *
+ * // Compile and launch the module
+ * platformBrowserDynamic().bootstrapModule(AppModule);
+ *
+ * ```
+ */
+export declare class FilterModule {
+}

package/dist/es2015/filter.module.js

@@ -0,0 +1,88 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { NgModule } from '@angular/core';
+import { L10N_PREFIX, LocalizationService } from '@progress/kendo-angular-l10n';
+import { AriaLabelValueDirective } from './aria-label.directive';
+import { FilterBooleanEditorComponent } from './editors/boolean-editor.component';
+import { FilterDateEditorComponent } from './editors/date-editor.component';
+import { FilterNumericEditorComponent } from './editors/numeric-editor.component';
+import { FilterTextEditorComponent } from './editors/text-editor.component';
+import { FilterExpressionOperatorsComponent } from './filter-expression-operators.component';
+import { FilterExpressionComponent } from './filter-expression.component';
+import { FilterGroupComponent } from './filter-group.component';
+import { FilterComponent } from './filter.component';
+import { CustomMessagesComponent } from './localization/custom-messages.component';
+import { LocalizedMessagesDirective } from './localization/localized-messages.directive';
+import { SharedModule } from './shared.module';
+/**
+ * Represents the [NgModule]({{ site.data.urls.angular['ngmoduleapi'] }})
+ * definition for the Filter component.
+ *
+ * @example
+ *
+ * ```
+ * // Import the Filter module
+ * import { FilterModule } from '@progress/kendo-angular-filter';
+ *
+ * // The browser platform with a compiler
+ * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+ *
+ * import { NgModule } from '@angular/core';
+ *
+ * // Import the app component
+ * import { AppComponent } from './app.component';
+ *
+ * // Define the app module
+ * _@NgModule({
+ *     declarations: [AppComponent], // declare app component
+ *     imports:      [BrowserModule, FilterModule], // import Filter module
+ *     bootstrap:    [AppComponent]
+ * })
+ * export class AppModule { }
+ *
+ * // Compile and launch the module
+ * platformBrowserDynamic().bootstrapModule(AppModule);
+ *
+ * ```
+ */
+let FilterModule = class FilterModule {
+};
+FilterModule = tslib_1.__decorate([
+    NgModule({
+        imports: [SharedModule],
+        declarations: [FilterComponent,
+            FilterNumericEditorComponent,
+            FilterTextEditorComponent,
+            FilterExpressionComponent,
+            FilterGroupComponent,
+            FilterExpressionOperatorsComponent,
+            FilterBooleanEditorComponent,
+            FilterDateEditorComponent,
+            LocalizedMessagesDirective,
+            CustomMessagesComponent,
+            AriaLabelValueDirective
+        ],
+        exports: [FilterComponent,
+            FilterNumericEditorComponent,
+            FilterTextEditorComponent,
+            FilterExpressionComponent,
+            FilterGroupComponent,
+            FilterExpressionOperatorsComponent,
+            FilterBooleanEditorComponent,
+            FilterDateEditorComponent,
+            LocalizedMessagesDirective,
+            CustomMessagesComponent,
+            AriaLabelValueDirective],
+        providers: [
+            LocalizationService,
+            {
+                provide: L10N_PREFIX,
+                useValue: 'kendo.filter'
+            }
+        ]
+    })
+], FilterModule);
+export { FilterModule };

package/dist/es2015/filter.service.d.ts

@@ -0,0 +1,43 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+import { CompositeFilterDescriptor, FilterDescriptor } from '@progress/kendo-data-query';
+import { FilterExpression } from './model/filter-expression';
+/**
+ * @hidden
+ */
+export declare const localizeOperators: (operators: any) => (localization: any) => {
+    text: any;
+    value: any;
+}[];
+/**
+ * @hidden
+ */
+export declare class FilterService {
+    private localization;
+    value: CompositeFilterDescriptor;
+    filters: FilterExpression[];
+    isEditorDisabled: boolean;
+    constructor(localization: LocalizationService);
+    readonly defaultNumericOperators: {
+        text: string;
+        value: string;
+    }[];
+    readonly defaultStringOperators: {
+        text: string;
+        value: string;
+    }[];
+    readonly defaultDateOperators: {
+        text: string;
+        value: string;
+    }[];
+    readonly logicOperators: {
+        text: string;
+        value: string;
+    }[];
+    addFilterGroup(item: CompositeFilterDescriptor): void;
+    addFilterExpression(item: CompositeFilterDescriptor): void;
+    remove(item: CompositeFilterDescriptor | FilterDescriptor, positionIndex: number, parentItem?: CompositeFilterDescriptor): void;
+}

package/dist/es2015/filter.service.js

@@ -0,0 +1,66 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as tslib_1 from "tslib";
+import { Injectable } from '@angular/core';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+import { defaultDateOperators, defaultNumericOperators, defaultStringOperators, logicOperators } from './util';
+/**
+ * @hidden
+ */
+export const localizeOperators = operators => localization => Object.keys(operators).map(key => ({
+    text: localization.get(key),
+    value: operators[key]
+}));
+/**
+ * @hidden
+ */
+let FilterService = class FilterService {
+    constructor(localization) {
+        this.localization = localization;
+        this.value = { filters: [], logic: 'or' };
+        this.filters = [];
+        this.isEditorDisabled = false;
+    }
+    get defaultNumericOperators() {
+        return localizeOperators(defaultNumericOperators)(this.localization);
+    }
+    get defaultStringOperators() {
+        return localizeOperators(defaultStringOperators)(this.localization);
+    }
+    get defaultDateOperators() {
+        return localizeOperators(defaultDateOperators)(this.localization);
+    }
+    get logicOperators() {
+        return localizeOperators(logicOperators)(this.localization);
+    }
+    addFilterGroup(item) {
+        let filterGroup = { logic: 'or', filters: [] };
+        item.filters.push(filterGroup);
+    }
+    addFilterExpression(item) {
+        let filterExpression = { operator: 'eq', value: null, field: null };
+        item.filters.push(filterExpression);
+    }
+    remove(item, positionIndex, parentItem) {
+        if (!parentItem) {
+            parentItem = this.value;
+        }
+        if (item === parentItem) {
+            parentItem.filters = [];
+            return;
+        }
+        let index = parentItem.filters.indexOf(item);
+        if (index >= 0 && index === positionIndex) {
+            parentItem.filters = parentItem.filters.filter((i) => i !== item);
+            return;
+        }
+        parentItem.filters.forEach((filter) => filter.filters && this.remove(item, positionIndex, filter));
+    }
+};
+FilterService = tslib_1.__decorate([
+    Injectable(),
+    tslib_1.__metadata("design:paramtypes", [LocalizationService])
+], FilterService);
+export { FilterService };

package/dist/es2015/index.d.ts

@@ -0,0 +1,21 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Generated bundle index. Do not edit.
+ */
+export * from './main';
+export { AriaLabelValueDirective } from './aria-label.directive';
+export { FilterBooleanEditorComponent } from './editors/boolean-editor.component';
+export { FilterDateEditorComponent } from './editors/date-editor.component';
+export { FilterNumericEditorComponent } from './editors/numeric-editor.component';
+export { FilterTextEditorComponent } from './editors/text-editor.component';
+export { FilterExpressionOperatorsComponent } from './filter-expression-operators.component';
+export { FilterExpressionComponent } from './filter-expression.component';
+export { FilterGroupComponent } from './filter-group.component';
+export { FilterService } from './filter.service';
+export { CustomMessagesComponent } from './localization/custom-messages.component';
+export { LocalizedMessagesDirective } from './localization/localized-messages.directive';
+export { Messages } from './localization/messages';
+export { SharedModule } from './shared.module';

package/dist/es2015/index.js

@@ -0,0 +1,21 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Generated bundle index. Do not edit.
+ */
+export * from './main';
+export { AriaLabelValueDirective } from './aria-label.directive';
+export { FilterBooleanEditorComponent } from './editors/boolean-editor.component';
+export { FilterDateEditorComponent } from './editors/date-editor.component';
+export { FilterNumericEditorComponent } from './editors/numeric-editor.component';
+export { FilterTextEditorComponent } from './editors/text-editor.component';
+export { FilterExpressionOperatorsComponent } from './filter-expression-operators.component';
+export { FilterExpressionComponent } from './filter-expression.component';
+export { FilterGroupComponent } from './filter-group.component';
+export { FilterService } from './filter.service';
+export { CustomMessagesComponent } from './localization/custom-messages.component';
+export { LocalizedMessagesDirective } from './localization/localized-messages.directive';
+export { Messages } from './localization/messages';
+export { SharedModule } from './shared.module';