@mparticle/aquarium 1.19.3 → 1.19.4-chore-better-types.1

package/dist/index.d.ts

@@ -33,10 +33,12 @@ import { CollapseProps } from 'antd';
 import { ColorPickerProps } from 'antd';
 import { ColumnsType } from 'antd/es/table';
 import { ColumnType } from 'antd/es/table/interface';
-import { CompositeUserPreferences } from '../services/user-preferences/models/user-preferences/composite-user-preferences';
-import { CompositeUserPreferencesService } from '../services/user-preferences/composite-user-preferences-service';
+import { CompositeUserPreferences as CompositeUserPreferences_2 } from '../../../../../../../../src/services/user-preferences/models/user-preferences/composite-user-preferences';
+import { CompositeUserPreferences as CompositeUserPreferences_3 } from '../../../../../../../../../src/services/user-preferences/models/user-preferences/composite-user-preferences';
+import { CompositeUserPreferencesService as CompositeUserPreferencesService_2 } from '../../../../../../../../src/services/user-preferences/composite-user-preferences-service';
 import { ConfigOptions } from 'antd/es/message/interface';
 import { ConfigProvider } from './other/ConfigProvider/ConfigProvider';
+import { CookieOptions } from '../../../../../../../../src/utils/Cookies';
 import { CountdownProps } from 'antd';
 import { CSSProperties } from 'react';
 import { DatePickerProps } from 'antd';
@@ -99,7 +101,6 @@ import { INavigationCreateProps as INavigationCreateProps_2 } from '../../../../
 import { INavigationOrg } from './navigation/GlobalNavigation/WorkspaceSelector/WorkspaceSelectorItems';
 import { INavigationOrg as INavigationOrg_2 } from '../../../../../../../../../src/components';
 import { INavigationWorkspace } from './navigation/GlobalNavigation/WorkspaceSelector/WorkspaceSelectorItems';
-import { INewExperienceReminderOptions } from '../hooks/NewExperienceReminder/useNewExperienceReminder';
 import { INewExperienceReminderOptions as INewExperienceReminderOptions_2 } from '../../../../../../../../../src/components';
 import { Input as Input_2 } from 'antd';
 import { InputNumberProps } from 'antd';
@@ -133,7 +134,6 @@ import { ModalFunc } from 'antd/es/modal/confirm';
 import { modalGlobalConfig } from 'antd/es/modal/confirm';
 import { ModalProps } from 'antd';
 import { NamedExoticComponent } from 'react';
-import { NewExperienceReminderHook } from '../hooks/NewExperienceReminder/useNewExperienceReminder';
 import { NewExperienceReminderHook as NewExperienceReminderHook_2 } from '../../../../../../../../../src/components';
 import { notification } from 'antd';
 import { NotificationArgsProps } from 'antd';
@@ -208,16 +208,12 @@ import { UploadProps } from 'antd';
 import { UploadRef } from 'antd/es/upload/Upload';
 import { useAppProps } from 'antd/es/app/context';
 import { useForm } from 'antd/es/form/Form';
-import { useNewExperienceReminder } from '../hooks/NewExperienceReminder/useNewExperienceReminder';
-import { USER_PREFERENCE_SCOPE_SEPARATOR } from '../services/user-preferences/models/storage-models';
-import { UserPreference } from '../services/user-preferences/models/storage-models';
-import { UserPreferenceDefinition } from '../services/user-preferences/models/definitions';
-import { UserPreferenceDefinitions } from '../services/user-preferences/models/definitions';
-import { UserPreferenceGlobalScope } from '../services/user-preferences/models/storage-models';
-import { UserPreferences } from '../services/user-preferences/models/storage-models';
-import { UserPreferenceScope } from '../services/user-preferences/models/storage-models';
-import { UserPreferenceScopeType } from '../services/user-preferences/models/definitions';
-import { UserPreferencesService } from '../services/user-preferences/user-preferences';
+import { UserPreferenceDefinitions as UserPreferenceDefinitions_2 } from '../../../../../../../../src/services/user-preferences/models/definitions/user-preference-definitions';
+import { UserPreferenceDefinitions as UserPreferenceDefinitions_3 } from '../../../../../../../../../src/services/user-preferences/models/definitions/user-preference-definitions';
+import { UserPreferences as UserPreferences_2 } from '../../../../../../../../../src/services/user-preferences/models/storage-models/user-preferences';
+import { UserPreferenceScope as UserPreferenceScope_2 } from '../../../../../../../../src/services/user-preferences/models/storage-models/user-preference-scope';
+import { UserPreferenceScope as UserPreferenceScope_3 } from '../../../../../../../../../src/services/user-preferences/models/storage-models/user-preference-scope';
+import { UserPreferenceScopeType as UserPreferenceScopeType_2 } from '../../../../../../../../../src/services/user-preferences/models/definitions/user-preference-scope-type';
 import { WatermarkProps } from 'antd';
 
 export declare const Affix: (props: IAffixProps) => JSX_2.Element;
@@ -303,9 +299,18 @@ export { ColumnsType }
 
 export { ColumnType }
 
-export { CompositeUserPreferences }
+export declare type CompositeUserPreferences<UserPreferenceId extends PropertyKey> = {
+    [Id in UserPreferenceId]: UserPreference;
+};
 
-export { CompositeUserPreferencesService }
+export declare class CompositeUserPreferencesService<TPreferenceIds extends PropertyKey> {
+    getScopedUserPreferences(storedPreferences: UserPreferences_2<TPreferenceIds>, currentScope: UserPreferenceScope_3, definitions: UserPreferenceDefinitions_3<TPreferenceIds>): CompositeUserPreferences_3<TPreferenceIds>;
+    getUpdatedUserPreferenceStorageObject(preferenceId: TPreferenceIds, isOptedIn: boolean, currentScope: UserPreferenceScope_3, currentPreferences: UserPreferences_2<TPreferenceIds>, allowedScope: UserPreferenceScopeType_2): UserPreferences_2<TPreferenceIds>;
+    private createUserPreferenceEntryFromDefinition;
+    private getEffectiveScope;
+    private createPreferenceEntry;
+    private createCompositePreferencesFromEntries;
+}
 
 declare type CompoundedComponent = ForwardRefExoticComponent<IInputProps & RefAttributes<InputRef>> & {
     Group: typeof Input_2.Group;
@@ -316,6 +321,8 @@ declare type CompoundedComponent = ForwardRefExoticComponent<IInputProps & RefAt
 
 export { ConfigProvider }
 
+declare type ContextHolder = ReactNode;
+
 export declare const DatePicker: {
     (props: IDatePickerProps): JSX_2.Element;
     generatePicker: typeof default_4;
@@ -603,7 +610,14 @@ export { INavigationOrg }
 
 export { INavigationWorkspace }
 
-export { INewExperienceReminderOptions }
+export declare interface INewExperienceReminderOptions {
+    onClose: () => void;
+    onRemindMeLater: () => void;
+    onTakeMeThere: () => void;
+    duration?: number;
+    title?: string;
+    message?: string;
+}
 
 export declare interface INotificationProps extends NotificationArgsProps {
     children: React.ReactNode;
@@ -798,7 +812,7 @@ export declare const Modal: {
     useModal: typeof default_10;
 };
 
-export { NewExperienceReminderHook }
+export declare type NewExperienceReminderHook = [OpenNotificationFn, ContextHolder];
 
 export { notification }
 
@@ -815,6 +829,8 @@ declare const Notification_2: {
 };
 export { Notification_2 as Notification }
 
+declare type OpenNotificationFn = () => void;
+
 export declare const Pagination: (props: IPaginationProps) => JSX_2.Element;
 
 export declare const Popconfirm: (props: IPopconfirmProps) => JSX_2.Element;
@@ -968,25 +984,64 @@ export declare const Upload: {
     LIST_IGNORE: string;
 };
 
-export { useNewExperienceReminder }
+export declare const useNewExperienceReminder: (options: INewExperienceReminderOptions) => NewExperienceReminderHook;
 
-export { USER_PREFERENCE_SCOPE_SEPARATOR }
+export declare const USER_PREFERENCE_SCOPE_SEPARATOR = "-";
 
-export { UserPreference }
+export declare interface UserPreference {
+    optedIn: boolean;
+}
 
-export { UserPreferenceDefinition }
+export declare interface UserPreferenceDefinition {
+    isOptedInByDefault: boolean;
+    allowedScope: UserPreferenceScopeType;
+}
 
-export { UserPreferenceDefinitions }
+export declare type UserPreferenceDefinitions<UserPreferenceId extends PropertyKey> = {
+    [Id in UserPreferenceId]?: UserPreferenceDefinition;
+};
+
+export declare const UserPreferenceGlobalScope: "global";
+
+declare type UserPreferenceGlobalScopeType = `global`;
 
-export { UserPreferenceGlobalScope }
+declare type UserPreferenceLevelOneScopeType = `${number}`;
 
-export { UserPreferences }
+declare type UserPreferenceLevelThreeScopeType = `${number}-${number}-${number}`;
 
-export { UserPreferenceScope }
+declare type UserPreferenceLevelTwoScopeType = `${number}-${number}`;
 
-export { UserPreferenceScopeType }
+export declare type UserPreferences<UserPreferenceId extends PropertyKey> = {
+    [K in UserPreferenceScope]?: {
+        [Id in UserPreferenceId]: UserPreference;
+    };
+};
 
-export { UserPreferencesService }
+export declare type UserPreferenceScope = UserPreferenceLevelOneScopeType | UserPreferenceLevelTwoScopeType | UserPreferenceLevelThreeScopeType | UserPreferenceGlobalScopeType;
+
+export declare enum UserPreferenceScopeType {
+    Global = 0,
+    LevelOneScope = 1,
+    LevelTwoScope = 2,
+    LevelThreeScope = 3
+}
+
+export declare class UserPreferencesService<TUserPreferenceId extends PropertyKey> {
+    private readonly definitions;
+    private readonly compositeUserPreferencesService;
+    private readonly currentScope;
+    private readonly cookieOptions;
+    private readonly onUpdate?;
+    preferences: CompositeUserPreferences_2<TUserPreferenceId>;
+    constructor(definitions: UserPreferenceDefinitions_2<TUserPreferenceId>, compositeUserPreferencesService: CompositeUserPreferencesService_2<TUserPreferenceId>, currentScope: UserPreferenceScope_2, cookieOptions: CookieOptions & {
+        key: string;
+    }, onUpdate?: ((resolvedPreferences: CompositeUserPreferences_2<TUserPreferenceId>) => void) | undefined);
+    init(): Promise<void>;
+    isOptedIn(userPreferenceId: TUserPreferenceId): Promise<boolean | undefined>;
+    setPreference(userPreferenceId: TUserPreferenceId, isOptedIn: boolean): Promise<void>;
+    private getStoredPreferences;
+    private setStoredPreferences;
+}
 
 export declare const Watermark: (props: IWatermarkProps) => JSX_2.Element;
 

package/dist/style.ts

@@ -326,7 +326,7 @@ export const SizeXl = "32px";
 export const SizeLg = "24px";
 export const SizeMd = "20px";
 export const SizeMs = "16px";
-export const Size = "16rem";
+export const Size = "16px";
 export const SizeSm = "12px";
 export const SizeXs = "8px";
 export const SizeXxs = "4px";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mparticle/aquarium",
-  "version": "1.19.3",
+  "version": "1.19.4-chore-better-types.1",
   "description": "mParticle Component Library",
   "license": "Apache-2.0",
   "keywords": [