@theseam/ui-common 0.4.4 → 0.4.6

package/services/preferences/preferences-record.d.ts

@@ -0,0 +1,28 @@
+import { Observable } from 'rxjs';
+import { TheSeamPreferencesAccessor } from './preferences-accessor';
+import { TheSeamPreferencesBase } from './preferences.models';
+export type TheSeamPreferencesRecordStatus = 'pending' | 'loaded';
+export interface TheSeamPreferencesRecordStatusChange {
+    previous: TheSeamPreferencesRecordStatus;
+    current: TheSeamPreferencesRecordStatus;
+}
+export declare class TheSeamPreferencesMapRecord {
+    private readonly _key;
+    private readonly _accessor;
+    private readonly _emptyPrefs;
+    private readonly _refreshSubject;
+    private readonly _statusChangeSubject;
+    private _status;
+    readonly observable: Observable<TheSeamPreferencesBase>;
+    readonly statusChange: Observable<TheSeamPreferencesRecordStatusChange>;
+    constructor(_key: string, _accessor: TheSeamPreferencesAccessor, _emptyPrefs: TheSeamPreferencesBase);
+    private _createObservable;
+    update(value: TheSeamPreferencesBase): void;
+    delete(): void;
+    refresh(): void;
+    isSameAccessor(accessor: TheSeamPreferencesAccessor): boolean;
+    isSameEmptyPrefs(emptyPrefs: TheSeamPreferencesBase): boolean;
+    get status(): TheSeamPreferencesRecordStatus;
+    private _setStatus;
+    private _descerializePreferences;
+}

package/services/preferences/preferences.models.d.ts

@@ -0,0 +1,3 @@
+export interface TheSeamPreferencesBase {
+    version: number;
+}

package/services/public-api.d.ts

@@ -1,3 +1,7 @@
+export * from './preferences/preferences-accessor';
+export * from './preferences/preferences-manager.service';
+export * from './preferences/preferences-record';
+export * from './preferences/preferences.models';
 export * from './asset-loader.service';
 export * from './router-helpers.service';
 export * from './font-loader.service';

package/story-helpers/public-api.d.ts

@@ -11,3 +11,4 @@ export * from './story-modal-container.component';
 export * from './story-toastr.service';
 export * from './on-story-bootstrapped-exec';
 export * from './on-story-bootstrapped-trigger';
+export * from './story-preferences-accessor.service';

package/story-helpers/story-preferences-accessor.service.d.ts

@@ -0,0 +1,19 @@
+import { TheSeamPreferencesAccessor } from '@theseam/ui-common/services';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export declare class StoryPreferencesAccessorService implements TheSeamPreferencesAccessor {
+    /**
+     * Gets a preference.
+     */
+    get(name: string): Observable<string>;
+    /**
+     * Update a preference.
+     */
+    update(name: string, value: string): Observable<string>;
+    /**
+     * Delete a preference.
+     */
+    delete(name: string): Observable<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<StoryPreferencesAccessorService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<StoryPreferencesAccessorService>;
+}

package/widget/preferences/widget-preferences.models.d.ts

@@ -0,0 +1,8 @@
+import { TheSeamPreferencesBase } from '@theseam/ui-common/services';
+export interface TheSeamWidgetPreferences_v1 extends TheSeamPreferencesBase {
+    version: 1;
+    collapsed?: boolean;
+}
+export type TheSeamWidgetPreferences = TheSeamWidgetPreferences_v1;
+export declare const CURRENT_WIDGET_PREFERENCES_VERSION = 1;
+export declare const EMPTY_WIDGET_PREFERENCES: TheSeamWidgetPreferences;

package/widget/preferences/widget-preferences.service.d.ts

@@ -0,0 +1,21 @@
+import { Observable } from 'rxjs';
+import { TheSeamPreferencesAccessor, TheSeamPreferencesManagerService } from '@theseam/ui-common/services';
+import { TheSeamWidgetPreferences } from './widget-preferences.models';
+import * as i0 from "@angular/core";
+type TheSeamWidgetPreferencesPatch = Omit<TheSeamWidgetPreferences, 'version'>;
+export declare class WidgetPreferencesService {
+    private readonly _preferencesManager;
+    private _prefsAccessor?;
+    private _pendingPatches;
+    constructor(_preferencesManager: TheSeamPreferencesManagerService, _prefsAccessor?: TheSeamPreferencesAccessor | undefined);
+    isPatchPending(preferenceKey: string): boolean;
+    isPending(preferenceKey: string): boolean;
+    isLoaded(preferenceKey: string): boolean;
+    preferences(preferenceKey: string): Observable<TheSeamWidgetPreferences>;
+    refresh(preferenceKey: string): void;
+    patchPreferences(preferenceKey: string, preferences: TheSeamWidgetPreferencesPatch): void;
+    private _isValidPreferences;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WidgetPreferencesService, [null, { optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<WidgetPreferencesService>;
+}
+export {};

package/widget/preferences/widget-preferences.token.d.ts

@@ -0,0 +1,3 @@
+import { InjectionToken } from '@angular/core';
+import { TheSeamPreferencesAccessor } from '@theseam/ui-common/services';
+export declare const THESEAM_WIDGET_PREFERENCES_ACCESSOR: InjectionToken<TheSeamPreferencesAccessor>;

package/widget/public-api.d.ts

@@ -35,3 +35,4 @@ export * from './widget-registry.models';
 export * from './widget-registry.service';
 export * from './widget-token';
 export * from './widget.module';
+export * from './widget.models';

package/widget/widget/widget.component.d.ts

@@ -1,8 +1,11 @@
 import { BooleanInput } from '@angular/cdk/coercion';
+import { OnDestroy } from '@angular/core';
 import { IconProp } from '@fortawesome/fontawesome-svg-core';
 import { SeamIcon } from '@theseam/ui-common/icon';
 import { WidgetIconTplDirective } from '../directives/widget-icon-tpl.directive';
 import { WidgetTitleTplDirective } from '../directives/widget-title-tpl.directive';
+import { WidgetPreferencesService } from '../preferences/widget-preferences.service';
+import { TheSeamWidgetData, TheSeamWidgetDefaults } from '../widget.models';
 import * as i0 from "@angular/core";
 /**
  * Widget
@@ -15,13 +18,18 @@ import * as i0 from "@angular/core";
  * style for our widgets. If a case requiring non widget content components is
  * used then the situation should be considered for becoming a widget component.
  */
-export declare class WidgetComponent {
+export declare class WidgetComponent implements OnDestroy {
+    private readonly _widgetPreferences;
+    private readonly _defaults?;
+    private readonly _data?;
     static ngAcceptInputType_hasHeader: BooleanInput;
     static ngAcceptInputType_loading: BooleanInput;
     static ngAcceptInputType_hasConfig: BooleanInput;
     static ngAcceptInputType_canCollapse: BooleanInput;
     readonly configIcon: import("@fortawesome/fontawesome-common-types").IconDefinition;
     readonly collapseIcon: import("@fortawesome/fontawesome-common-types").IconDefinition;
+    private readonly _ngUnsubscribe;
+    private _preferencesKey?;
     /**
      * Toggles the collapsed state of a widget.
      */
@@ -65,11 +73,13 @@ export declare class WidgetComponent {
     canCollapse: boolean;
     iconTpl?: WidgetIconTplDirective;
     titleTpl?: WidgetTitleTplDirective;
+    constructor(_widgetPreferences: WidgetPreferencesService, _defaults?: TheSeamWidgetDefaults | undefined, _data?: TheSeamWidgetData | undefined);
+    ngOnDestroy(): void;
     /**
      * Toggles a widget's collapsed state.
      */
     collapse(): void;
     get collapseState(): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WidgetComponent, never>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WidgetComponent, [null, { optional: true; }, { optional: true; }]>;
     static ɵcmp: i0.ɵɵComponentDeclaration<WidgetComponent, "seam-widget", never, { "collapsed": "collapsed"; "hasHeader": "hasHeader"; "titleText": "titleText"; "icon": "icon"; "iconClass": "iconClass"; "loading": "loading"; "hasConfig": "hasConfig"; "canCollapse": "canCollapse"; }, {}, ["iconTpl", "titleTpl"], ["*", "seam-widget-footer"], false, never>;
 }

package/widget/widget-token.d.ts

@@ -1,3 +1,6 @@
 import { InjectionToken } from '@angular/core';
 import { IWidgetRegistryRecord } from './widget-registry.models';
+import { TheSeamWidgetData, TheSeamWidgetDefaults } from './widget.models';
 export declare const THESEAM_WIDGETS: InjectionToken<IWidgetRegistryRecord<any, any>>;
+export declare const THESEAM_WIDGET_DATA: InjectionToken<TheSeamWidgetData>;
+export declare const THESEAM_WIDGET_DEFAULTS: InjectionToken<TheSeamWidgetDefaults>;

package/widget/widget.models.d.ts

@@ -0,0 +1,7 @@
+export interface TheSeamWidgetData {
+    widgetId?: string;
+}
+export interface TheSeamWidgetDefaults {
+    canCollapse?: boolean;
+    collapsed?: boolean;
+}