@dereekb/dbx-form 12.6.21 → 13.0.0

package/types/dereekb-dbx-form-mapbox.d.ts

@@ -0,0 +1,216 @@
+import { LabeledFieldConfig, DescriptionFieldConfig, FieldConfig } from '@dereekb/dbx-form';
+import * as i2 from '@ngx-formly/core';
+import { FormlyFieldProps, FieldTypeConfig, FormlyFieldConfig } from '@ngx-formly/core';
+import * as i0 from '@angular/core';
+import { OnInit, OnDestroy, Injector } from '@angular/core';
+import { AbstractControl, FormGroup } from '@angular/forms';
+import { CompactContextStore } from '@dereekb/dbx-web';
+import { FieldType } from '@ngx-formly/material';
+import { Observable, BehaviorSubject } from 'rxjs';
+import { ObservableFactoryWithRequiredInput } from '@dereekb/rxjs';
+import { Milliseconds, LatLngPointFunctionConfig, Maybe, LatLngPoint, ZoomLevel } from '@dereekb/util';
+import { Marker } from 'mapbox-gl';
+import { DbxMapboxMarkerDisplayConfig, MapboxZoomLevel, DbxMapboxInjectionStore, DbxMapboxMapStore, DbxMapboxMarker, DbxMapboxService } from '@dereekb/dbx-web/mapbox';
+
+declare const DEFAULT_DBX_FORM_MAPBOX_LAT_LNG_FIELD_INJECTION_KEY = "DbxFormMapboxLatLngFieldComponent";
+declare const DEFAULT_DBX_FORM_MAPBOX_LAT_LNG_MARKER_CONFIG: DbxMapboxMarkerDisplayConfig;
+interface DbxFormMapboxLatLngComponentFieldProps extends FormlyFieldProps {
+    /**
+     * (Optional) Whether or not the show the map. If the map is not shown, relies on the center of the parent map to determine position.
+     *
+     * Defaults to true.
+     *
+     * Cases where this would be set false is if another map is being used.
+     */
+    readonly showMap?: boolean;
+    /**
+     * Whether or not to display the center button. Is set to false if selectLocationOnMapDrag is true.
+     */
+    readonly showCenterButton?: boolean;
+    /**
+     * Whether or not to set the center of the map on the location when set. Defaults to true.
+     */
+    readonly setCenterOnLocationSet?: boolean;
+    /**
+     * Whether or not to enable dragging the map to select the location. Defaults to true.
+     *
+     * Only applicable when showMap is false.
+     */
+    readonly selectLocationOnMapDrag?: boolean;
+    /**
+     * Whether or not to enable clicking the map to select the location. Defaults to false.
+     *
+     * Only applicable when showMap is false.
+     */
+    readonly selectLocationOnMapClick?: boolean;
+    /**
+     * (Optional) Zoom to start the map at. Ignored if the showMap is false.
+     */
+    readonly zoom?: MapboxZoomLevel;
+    /**
+     * Time until recentering on the marker. If the time is 0 then the recentering is disabled.
+     */
+    readonly recenterTime?: Milliseconds;
+    readonly latLngConfig?: LatLngPointFunctionConfig;
+    /**
+     * Unique injection key.
+     *
+     * If not defined, the default key will be used.
+     *
+     * If false is passed, the marker will not be configured in the injection store.
+     */
+    readonly mapInjectionKey?: Maybe<string | false>;
+    /**
+     * Marker configuration or factory. If false is passed, the marker will not be displayed.
+     */
+    readonly markerConfig?: false | ObservableFactoryWithRequiredInput<DbxMapboxMarkerDisplayConfig | false, DbxFormMapboxLatLngFieldComponent>;
+}
+declare class DbxFormMapboxLatLngFieldComponent<T extends DbxFormMapboxLatLngComponentFieldProps = DbxFormMapboxLatLngComponentFieldProps> extends FieldType<FieldTypeConfig<T>> implements OnInit, OnDestroy {
+    private readonly _geolocationService;
+    readonly compact: CompactContextStore | null;
+    readonly dbxMapboxInjectionStore: DbxMapboxInjectionStore | null;
+    readonly dbxMapboxMapStore: DbxMapboxMapStore;
+    readonly injector: Injector;
+    private readonly _sub;
+    private readonly _geoSub;
+    private readonly _centerSub;
+    private readonly _flyToCenterSub;
+    private readonly _clickSub;
+    private readonly _zoom;
+    private readonly _markerConfig;
+    private _latLngStringFunction;
+    private _latLngPointFunction;
+    readonly compactClass$: Observable<string>;
+    private readonly _useCurrentLocationDisabled;
+    readonly useCurrentLocationDisabled$: Observable<boolean>;
+    private readonly _formControlObs;
+    readonly formControl$: Observable<AbstractControl<any, any, any>>;
+    readonly value$: Observable<any>;
+    readonly latLng$: Observable<LatLngPoint>;
+    readonly nonZeroLatLng$: Observable<LatLngPoint>;
+    readonly zoom$: Observable<number>;
+    readonly markerConfig$: Observable<false | DbxMapboxMarkerDisplayConfig>;
+    readonly useCurrentLocationDisabledSignal: i0.Signal<boolean>;
+    readonly compactClassSignal: i0.Signal<string>;
+    readonly latLngSignal: i0.Signal<LatLngPoint>;
+    get zoom(): MapboxZoomLevel;
+    get formGroupName(): string;
+    get formGroup(): FormGroup;
+    get label(): Maybe<string>;
+    get description(): Maybe<string>;
+    get isReadonlyOrDisabled(): boolean;
+    get showMap(): boolean;
+    get selectLocationOnMapDrag(): boolean;
+    get selectLocationOnMapClick(): boolean;
+    get setCenterOnLocationSet(): boolean;
+    get showCenterButton(): boolean;
+    get recenterTime(): Milliseconds;
+    get useCurrentLocationDisabled(): BehaviorSubject<boolean>;
+    get mapInjectionKey(): Maybe<string | false>;
+    get markerConfig(): false | ObservableFactoryWithRequiredInput<false | DbxMapboxMarkerDisplayConfig, DbxFormMapboxLatLngFieldComponent<DbxFormMapboxLatLngComponentFieldProps>> | undefined;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    flyToMarker(): void;
+    useCurrentLocation(): void;
+    onMarkerDragEnd(marker: Marker): void;
+    setValue(latLng?: Maybe<LatLngPoint>): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormMapboxLatLngFieldComponent<any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFormMapboxLatLngFieldComponent<any>, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
+interface MapboxLatLngFieldConfig extends Omit<LabeledFieldConfig, 'key'>, DescriptionFieldConfig, Partial<FieldConfig>, Pick<DbxFormMapboxLatLngComponentFieldProps, 'showMap' | 'zoom' | 'latLngConfig' | 'recenterTime' | 'setCenterOnLocationSet' | 'showCenterButton' | 'selectLocationOnMapDrag' | 'selectLocationOnMapClick' | 'markerConfig'> {
+}
+declare function mapboxLatLngField(config?: MapboxLatLngFieldConfig): FormlyFieldConfig;
+
+declare class DbxFormMapboxLatLngFieldMarkerComponent {
+    readonly fieldComponent: DbxFormMapboxLatLngFieldComponent<any>;
+    readonly marker$: Observable<Maybe<DbxMapboxMarker>>;
+    readonly markerSignal: i0.Signal<Maybe<DbxMapboxMarker>>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormMapboxLatLngFieldMarkerComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFormMapboxLatLngFieldMarkerComponent, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
+declare class DbxFormMapboxLatLngModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormMapboxLatLngModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormMapboxLatLngModule, never, [typeof DbxFormMapboxLatLngFieldComponent, typeof i2.FormlyModule], [typeof DbxFormMapboxLatLngFieldComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DbxFormMapboxLatLngModule>;
+}
+
+interface DbxFormMapboxZoomComponentFieldProps extends Omit<FormlyFieldProps, 'min' | 'max'> {
+    /**
+     * (Optional) Whether or not the show the map. Cases where this would be set false is if another map is being used.
+     *
+     * Defaults to true.
+     */
+    readonly showMap?: boolean;
+    /**
+     * Default center
+     */
+    readonly center?: LatLngPoint;
+    /**
+     * Whether or not to lock the map itself to the min and max zoom levels.
+     */
+    readonly lockMapToZoomLevels?: boolean;
+    /**
+     * Min zoom level allowed
+     */
+    readonly minZoom?: MapboxZoomLevel;
+    /**
+     * Max zoom level allowed.
+     */
+    readonly maxZoom?: MapboxZoomLevel;
+    /**
+     * Step size when using arrow keys.
+     */
+    readonly zoomStep?: number;
+}
+declare class DbxFormMapboxZoomFieldComponent<T extends DbxFormMapboxZoomComponentFieldProps = DbxFormMapboxZoomComponentFieldProps> extends FieldType<FieldTypeConfig<T>> implements OnInit, OnDestroy {
+    readonly compact: CompactContextStore | null;
+    readonly dbxMapboxService: DbxMapboxService;
+    readonly dbxMapboxMapStore: DbxMapboxMapStore;
+    private _undoZoomLimit;
+    readonly compactClass$: Observable<string>;
+    readonly compactClassSignal: i0.Signal<string>;
+    private readonly _sub;
+    private readonly _center;
+    private readonly _formControlObs;
+    readonly formControl$: Observable<AbstractControl<any, any, any>>;
+    readonly value$: Observable<any>;
+    readonly zoom$: Observable<MapboxZoomLevel>;
+    readonly center$: Observable<LatLngPoint>;
+    get center(): LatLngPoint;
+    get formGroupName(): string;
+    get formGroup(): FormGroup;
+    get label(): Maybe<string>;
+    get description(): Maybe<string>;
+    get isReadonlyOrDisabled(): boolean;
+    get showMap(): boolean;
+    get lockMapToZoomLevels(): boolean;
+    get minZoom(): MapboxZoomLevel;
+    get maxZoom(): MapboxZoomLevel;
+    get zoomStep(): number;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    setValue(zoom?: Maybe<ZoomLevel>): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormMapboxZoomFieldComponent<any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DbxFormMapboxZoomFieldComponent<any>, "ng-component", never, {}, {}, never, never, true, never>;
+}
+
+interface MapboxZoomFieldConfig extends Omit<LabeledFieldConfig, 'key'>, DescriptionFieldConfig, Partial<FieldConfig>, Pick<DbxFormMapboxZoomComponentFieldProps, 'showMap' | 'center' | 'minZoom' | 'maxZoom' | 'zoomStep'> {
+}
+declare function mapboxZoomField(config?: MapboxZoomFieldConfig): FormlyFieldConfig;
+
+declare class DbxFormMapboxZoomModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormMapboxZoomModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormMapboxZoomModule, never, [typeof DbxFormMapboxZoomFieldComponent, typeof i2.FormlyModule], [typeof DbxFormMapboxZoomFieldComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DbxFormMapboxZoomModule>;
+}
+
+declare class DbxFormMapboxModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormMapboxModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormMapboxModule, never, never, [typeof DbxFormMapboxLatLngModule, typeof DbxFormMapboxZoomModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<DbxFormMapboxModule>;
+}
+
+export { DEFAULT_DBX_FORM_MAPBOX_LAT_LNG_FIELD_INJECTION_KEY, DEFAULT_DBX_FORM_MAPBOX_LAT_LNG_MARKER_CONFIG, DbxFormMapboxLatLngFieldComponent, DbxFormMapboxLatLngFieldMarkerComponent, DbxFormMapboxLatLngModule, DbxFormMapboxModule, DbxFormMapboxZoomFieldComponent, DbxFormMapboxZoomModule, mapboxLatLngField, mapboxZoomField };
+export type { DbxFormMapboxLatLngComponentFieldProps, DbxFormMapboxZoomComponentFieldProps, MapboxLatLngFieldConfig, MapboxZoomFieldConfig };