@livetiles/reach-plugin-types 0.4.140 → 0.4.142

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/lib/index.d.ts +164 -156
  2. package/package.json +1 -1
package/lib/index.d.ts CHANGED
@@ -1513,20 +1513,110 @@ declare module "libs/reach/util/common/src/user/features/WithFeatures" {
1513
1513
  export function useFeatures(): FeatureSet;
1514
1514
  export function getEnabledFeatures(summary: SubscriptionSummary): FeatureSet;
1515
1515
  }
1516
- declare module "libs/reach/util/common/src/user/Member" {
1517
- import { Account } from "libs/reach/util/common/src/user/Account";
1518
- import { GroupRoleNames } from "libs/reach/util/common/src/user/User";
1519
- export default interface Member extends Account {
1520
- roles: GroupRoleNames[];
1521
- }
1516
+ declare module "libs/reach/util/common/src/user/useCurrentUserCache" {
1517
+ import { SubscriptionSummary } from "libs/reach/util/common/src/user/Subscription";
1518
+ import { CurrentUser } from "libs/reach/util/common/src/user/User";
1519
+ export function useCurrentUserCache(): {
1520
+ clear: () => Promise<void>;
1521
+ setEssentials: (user: CurrentUser) => Promise<CurrentUser>;
1522
+ setUser: (user: CurrentUser) => Promise<CurrentUser>;
1523
+ get: () => Promise<{
1524
+ subscription: {
1525
+ logoInfo: {
1526
+ smallUrl: any;
1527
+ largeUrl: string;
1528
+ isLegacyLogo: boolean;
1529
+ };
1530
+ languages: import("@livetiles/reach/util/common").LanguageBase[];
1531
+ featureMask: string;
1532
+ company: string;
1533
+ directories: import("libs/reach/util/common/src/user/Subscription").DirectoryConfiguration[];
1534
+ webPluginDefinitions: import("libs/reach/util/common/src/user/Subscription").WebPluginDefinition[];
1535
+ userPropertyDefinitions: import("libs/reach/util/common/src/user/Subscription").UserPropertyDefinition[];
1536
+ customDomain?: string;
1537
+ allowSelfRegistration?: boolean;
1538
+ brandFolderConfig?: import("libs/reach/util/common/src/user/Subscription").BrandFolderConfig;
1539
+ hideSubscriptionName?: boolean;
1540
+ id: string;
1541
+ subscriptionName: string;
1542
+ subscriptionHandle?: string;
1543
+ contact: import("@livetiles/reach/util/common").Account;
1544
+ theme: import("libs/reach/util/common/src/user/Subscription").Theme;
1545
+ defaultLanguage: string;
1546
+ faviconUrl?: string;
1547
+ navigation: import("libs/reach/util/common/src/user/Subscription").NavigationNode[];
1548
+ regionSettings?: import("libs/reach/util/common/src/user/Subscription").RegionSettings;
1549
+ signInSettings?: import("libs/reach/util/common/src/user/Subscription").SignInSettings;
1550
+ useInAppBrowser?: boolean;
1551
+ hasUnreadItems: boolean;
1552
+ pageTrackingInfo: import("libs/reach/util/common/src/user/Subscription").PageTrackingInfo;
1553
+ termsAndConditionsHash?: string;
1554
+ };
1555
+ isEmailVerificationPending?: boolean;
1556
+ isSubscriptionOwner: boolean;
1557
+ givenName: string;
1558
+ surname: string;
1559
+ preferredUiLanguage: string;
1560
+ preferredContentLanguage?: string;
1561
+ preferredLocale?: string;
1562
+ bookmarks: string[];
1563
+ groups: import("libs/reach/util/common/src/user/User").UserGroup[];
1564
+ availableSubscriptions: SubscriptionSummary[];
1565
+ channels: import("@livetiles/reach/util/common").UserChannelSubscription[];
1566
+ userHash: string;
1567
+ unreadNews: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
1568
+ unreadEvents: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
1569
+ unreadPosts: {
1570
+ groupId: string;
1571
+ itemId: string;
1572
+ }[];
1573
+ unreadFeedItemsCount?: number;
1574
+ mostRecentPostGroups: string[];
1575
+ notificationTypeSettings: import("libs/reach/util/common/src/user/User").NotificationTypeSettings;
1576
+ hasPendingRegistration?: boolean;
1577
+ minRoles: import("libs/reach/util/common/src/user/User").UserMinRoles;
1578
+ hasDirectory: boolean;
1579
+ contacts: import("libs/reach/util/common/src/user/User").UserContact[];
1580
+ termsAndConditionsApprovedHash: string;
1581
+ isPublicUser?: boolean;
1582
+ hasUnreadChats?: boolean;
1583
+ publicSubscriptionIds?: string[];
1584
+ id?: string;
1585
+ type?: import("@livetiles/reach/util/common").AccountType;
1586
+ tenantId?: string;
1587
+ displayName?: string;
1588
+ userPrincipalName?: string;
1589
+ mail?: string;
1590
+ tokenUniqueId?: string;
1591
+ authenticationType?: import("@livetiles/shared/util/authentication").AuthenticationType;
1592
+ created?: string;
1593
+ }>;
1594
+ };
1595
+ export function getUserDetailFields(user: Partial<CurrentUser>): {
1596
+ availableSubscriptions: SubscriptionSummary[];
1597
+ bookmarks: string[];
1598
+ unreadNews: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
1599
+ unreadEvents: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
1600
+ unreadPosts: {
1601
+ groupId: string;
1602
+ itemId: string;
1603
+ }[];
1604
+ hasUnreadChats: boolean;
1605
+ unreadFeedItemsCount: number;
1606
+ mostRecentPostGroups: string[];
1607
+ };
1522
1608
  }
1523
- declare module "libs/reach/util/common/src/user/Organization" {
1524
- export interface Organization {
1525
- country: string;
1526
- countryCode: string;
1527
- displayName: string;
1528
- id?: string;
1529
- }
1609
+ declare module "libs/reach/util/common/src/user/CurrentUserDetailContextProvider" {
1610
+ import { FC } from 'react';
1611
+ import { CurrentUser } from "libs/reach/util/common/src/user/User";
1612
+ export function useRefreshUserDetails(): () => Promise<CurrentUser>;
1613
+ export const CurrentUserDetailContextProvider: FC;
1614
+ }
1615
+ declare module "libs/reach/util/common/src/user/CurrentUserDetailLibContextProvider" {
1616
+ import { FC } from 'react';
1617
+ import { CurrentUser } from "libs/reach/util/common/src/user/User";
1618
+ export function useRefreshLibUserDetails(): () => Promise<CurrentUser>;
1619
+ export const CurrentUserDetailLibContextProvider: FC;
1530
1620
  }
1531
1621
  declare module "libs/reach/util/common/src/user/Group" {
1532
1622
  import { Account } from "libs/reach/util/common/src/user/Account";
@@ -1568,6 +1658,41 @@ declare module "libs/reach/util/common/src/user/Group" {
1568
1658
  adGroups?: Account[];
1569
1659
  }
1570
1660
  }
1661
+ declare module "libs/reach/util/common/src/user/content-languages-util" {
1662
+ export const defaultFallbackContentLanguage = "en";
1663
+ export const contentLanguagesWithoutAutomaticTranslation: string[];
1664
+ export const allAvailableContentLanguages: string[];
1665
+ export const rtlLanguages: string[];
1666
+ }
1667
+ declare module "libs/reach/util/common/src/user/LanguageUtils" {
1668
+ import { CurrentUser } from "libs/reach/util/common/src/index";
1669
+ import { IntlShape } from 'react-intl';
1670
+ import { LanguageSummary } from "libs/reach/util/common/src/index";
1671
+ export function getPreferredContentLanguage(user: CurrentUser): string;
1672
+ export function getLocalizedLanguages(intl: IntlShape, ...languages: LanguageSummary[]): {
1673
+ localizedName: string;
1674
+ name: string;
1675
+ englishName: string;
1676
+ code: string;
1677
+ }[];
1678
+ export function isRtlLanguage(lang: string): boolean;
1679
+ export type LanguageDirection = 'auto' | 'rtl' | 'ltr';
1680
+ }
1681
+ declare module "libs/reach/util/common/src/user/Member" {
1682
+ import { Account } from "libs/reach/util/common/src/user/Account";
1683
+ import { GroupRoleNames } from "libs/reach/util/common/src/user/User";
1684
+ export default interface Member extends Account {
1685
+ roles: GroupRoleNames[];
1686
+ }
1687
+ }
1688
+ declare module "libs/reach/util/common/src/user/Organization" {
1689
+ export interface Organization {
1690
+ country: string;
1691
+ countryCode: string;
1692
+ displayName: string;
1693
+ id?: string;
1694
+ }
1695
+ }
1571
1696
  declare module "libs/reach/util/common/src/user/UserInfo" {
1572
1697
  export interface UserInfo {
1573
1698
  userId?: string;
@@ -1947,6 +2072,12 @@ declare module "libs/reach/util/common/src/user/useAccountApi" {
1947
2072
  clearUserAvatarCache: (upn: string) => void;
1948
2073
  };
1949
2074
  }
2075
+ declare module "libs/reach/util/common/src/user/useCachedCurrentUserApi" {
2076
+ import { CurrentUser } from "libs/reach/util/common/src/user/index";
2077
+ export function useCachedCurrentUserApi(refresh: (updateFunc?: (u?: CurrentUser) => CurrentUser) => Promise<void>): {
2078
+ getCurrentUser: (subscriptionId: string) => Promise<any>;
2079
+ };
2080
+ }
1950
2081
  declare module "libs/reach/util/common/src/user/useCurrentUserApi" {
1951
2082
  import { CurrentUser, UpdatableUserProperties } from "libs/reach/util/common/src/user/User";
1952
2083
  import { Organization } from "libs/reach/util/common/src/user/Organization";
@@ -1958,11 +2089,6 @@ declare module "libs/reach/util/common/src/user/useCurrentUserApi" {
1958
2089
  deleteCurrentUserAvatar: () => Promise<unknown>;
1959
2090
  };
1960
2091
  }
1961
- declare module "libs/reach/util/common/src/user/useCachedCurrentUserApi" {
1962
- export function useCachedCurrentUserApi(): {
1963
- getCurrentUser: (subscriptionId: string) => Promise<import("libs/reach/util/common/src/user").CurrentUser>;
1964
- };
1965
- }
1966
2092
  declare module "libs/reach/util/common/src/content/Attachment" {
1967
2093
  export enum AttachmentType {
1968
2094
  Image = 0,
@@ -2297,26 +2423,6 @@ declare module "libs/reach/util/common/src/keywords/useKeywordsApi" {
2297
2423
  getKeywordGroupsByItemId: (id: string, route?: string) => Promise<KeywordGroup[]>;
2298
2424
  };
2299
2425
  }
2300
- declare module "libs/reach/util/common/src/user/content-languages-util" {
2301
- export const defaultFallbackContentLanguage = "en";
2302
- export const contentLanguagesWithoutAutomaticTranslation: string[];
2303
- export const allAvailableContentLanguages: string[];
2304
- export const rtlLanguages: string[];
2305
- }
2306
- declare module "libs/reach/util/common/src/user/LanguageUtils" {
2307
- import { CurrentUser } from "libs/reach/util/common/src/index";
2308
- import { IntlShape } from 'react-intl';
2309
- import { LanguageSummary } from "libs/reach/util/common/src/index";
2310
- export function getPreferredContentLanguage(user: CurrentUser): string;
2311
- export function getLocalizedLanguages(intl: IntlShape, ...languages: LanguageSummary[]): {
2312
- localizedName: string;
2313
- name: string;
2314
- englishName: string;
2315
- code: string;
2316
- }[];
2317
- export function isRtlLanguage(lang: string): boolean;
2318
- export type LanguageDirection = 'auto' | 'rtl' | 'ltr';
2319
- }
2320
2426
  declare module "libs/reach/util/common/src/content/content-keyword-utils" {
2321
2427
  import { KeywordsByGroupId } from "libs/reach/util/common/src/keywords/useKeywordsApi";
2322
2428
  import { CurrentUser } from "libs/reach/util/common/src/user/User";
@@ -2663,6 +2769,16 @@ declare module "libs/reach/util/common/src/user/useManageCurrentUserApi" {
2663
2769
  deleteAccount: () => Promise<unknown>;
2664
2770
  };
2665
2771
  }
2772
+ declare module "libs/reach/util/common/src/user/useSubscriptionHandlePathBuilder" {
2773
+ export function useSubscriptionHandlePathBuilder(): {
2774
+ buildPath: (initialPath?: string) => string;
2775
+ subscriptionHandle: string;
2776
+ };
2777
+ }
2778
+ declare module "libs/reach/util/common/src/user/useSubscriptionWebAppUrl" {
2779
+ export function useSubscriptionWebAppUrl(): string;
2780
+ export function useSubscriptionWebAppUrls(): string[];
2781
+ }
2666
2782
  declare module "libs/reach/util/common/src/user/useUserAdminApi" {
2667
2783
  import { HashUser, SubscriptionJoinResult, UpdatableUserProperties, UserActivationResult, UserInvitationResult, UserSummary } from "libs/reach/util/common/src/user/User";
2668
2784
  import { Observable } from 'rxjs';
@@ -2708,115 +2824,6 @@ declare module "libs/reach/util/common/src/user/useUserAdminApi" {
2708
2824
  requestApiKey: (email: string, displayName: string, expiryDate: string) => Promise<Response>;
2709
2825
  };
2710
2826
  }
2711
- declare module "libs/reach/util/common/src/user/useCurrentUserCache" {
2712
- import { SubscriptionSummary } from "libs/reach/util/common/src/user/Subscription";
2713
- import { CurrentUser } from "libs/reach/util/common/src/user/User";
2714
- export function useCurrentUserCache(): {
2715
- clear: () => Promise<void>;
2716
- setEssentials: (user: CurrentUser) => Promise<CurrentUser>;
2717
- setUser: (user: CurrentUser) => Promise<CurrentUser>;
2718
- get: () => Promise<{
2719
- subscription: {
2720
- logoInfo: {
2721
- smallUrl: any;
2722
- largeUrl: string;
2723
- isLegacyLogo: boolean;
2724
- };
2725
- languages: import("@livetiles/reach/util/common").LanguageBase[];
2726
- featureMask: string;
2727
- company: string;
2728
- directories: import("libs/reach/util/common/src/user/Subscription").DirectoryConfiguration[];
2729
- webPluginDefinitions: import("libs/reach/util/common/src/user/Subscription").WebPluginDefinition[];
2730
- userPropertyDefinitions: import("libs/reach/util/common/src/user/Subscription").UserPropertyDefinition[];
2731
- customDomain?: string;
2732
- allowSelfRegistration?: boolean;
2733
- brandFolderConfig?: import("libs/reach/util/common/src/user/Subscription").BrandFolderConfig;
2734
- hideSubscriptionName?: boolean;
2735
- id: string;
2736
- subscriptionName: string;
2737
- subscriptionHandle?: string;
2738
- contact: import("@livetiles/reach/util/common").Account;
2739
- theme: import("libs/reach/util/common/src/user/Subscription").Theme;
2740
- defaultLanguage: string;
2741
- faviconUrl?: string;
2742
- navigation: import("libs/reach/util/common/src/user/Subscription").NavigationNode[];
2743
- regionSettings?: import("libs/reach/util/common/src/user/Subscription").RegionSettings;
2744
- signInSettings?: import("libs/reach/util/common/src/user/Subscription").SignInSettings;
2745
- useInAppBrowser?: boolean;
2746
- hasUnreadItems: boolean;
2747
- pageTrackingInfo: import("libs/reach/util/common/src/user/Subscription").PageTrackingInfo;
2748
- termsAndConditionsHash?: string;
2749
- };
2750
- isEmailVerificationPending?: boolean;
2751
- isSubscriptionOwner: boolean;
2752
- givenName: string;
2753
- surname: string;
2754
- preferredUiLanguage: string;
2755
- preferredContentLanguage?: string;
2756
- preferredLocale?: string;
2757
- bookmarks: string[];
2758
- groups: import("libs/reach/util/common/src/user/User").UserGroup[];
2759
- availableSubscriptions: SubscriptionSummary[];
2760
- channels: import("@livetiles/reach/util/common").UserChannelSubscription[];
2761
- userHash: string;
2762
- unreadNews: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
2763
- unreadEvents: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
2764
- unreadPosts: {
2765
- groupId: string;
2766
- itemId: string;
2767
- }[];
2768
- unreadFeedItemsCount?: number;
2769
- mostRecentPostGroups: string[];
2770
- notificationTypeSettings: import("libs/reach/util/common/src/user/User").NotificationTypeSettings;
2771
- hasPendingRegistration?: boolean;
2772
- minRoles: import("libs/reach/util/common/src/user/User").UserMinRoles;
2773
- hasDirectory: boolean;
2774
- contacts: import("libs/reach/util/common/src/user/User").UserContact[];
2775
- termsAndConditionsApprovedHash: string;
2776
- isPublicUser?: boolean;
2777
- hasUnreadChats?: boolean;
2778
- publicSubscriptionIds?: string[];
2779
- id?: string;
2780
- type?: import("@livetiles/reach/util/common").AccountType;
2781
- tenantId?: string;
2782
- displayName?: string;
2783
- userPrincipalName?: string;
2784
- mail?: string;
2785
- tokenUniqueId?: string;
2786
- authenticationType?: import("@livetiles/shared/util/authentication").AuthenticationType;
2787
- created?: string;
2788
- }>;
2789
- };
2790
- export function getUserDetailFields(user: Partial<CurrentUser>): {
2791
- availableSubscriptions: SubscriptionSummary[];
2792
- bookmarks: string[];
2793
- unreadNews: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
2794
- unreadEvents: import("libs/reach/util/common/src/user/User").PublishableItemNotificationSummary[];
2795
- unreadPosts: {
2796
- groupId: string;
2797
- itemId: string;
2798
- }[];
2799
- hasUnreadChats: boolean;
2800
- unreadFeedItemsCount: number;
2801
- mostRecentPostGroups: string[];
2802
- };
2803
- }
2804
- declare module "libs/reach/util/common/src/user/CurrentUserDetailContextProvider" {
2805
- import { FC } from 'react';
2806
- import { CurrentUser } from "libs/reach/util/common/src/user/User";
2807
- export function useRefreshUserDetails(): () => Promise<CurrentUser>;
2808
- export const CurrentUserDetailContextProvider: FC;
2809
- }
2810
- declare module "libs/reach/util/common/src/user/useSubscriptionHandlePathBuilder" {
2811
- export function useSubscriptionHandlePathBuilder(): {
2812
- buildPath: (initialPath?: string) => string;
2813
- subscriptionHandle: string;
2814
- };
2815
- }
2816
- declare module "libs/reach/util/common/src/user/useSubscriptionWebAppUrl" {
2817
- export function useSubscriptionWebAppUrl(): string;
2818
- export function useSubscriptionWebAppUrls(): string[];
2819
- }
2820
2827
  declare module "libs/reach/util/common/src/user/index" {
2821
2828
  export * from "libs/reach/util/common/src/user/features/FeatureSet";
2822
2829
  export * from "libs/reach/util/common/src/user/features/WithFeatures";
@@ -2824,27 +2831,28 @@ declare module "libs/reach/util/common/src/user/index" {
2824
2831
  export * from "libs/reach/util/common/src/user/Audience";
2825
2832
  export * from "libs/reach/util/common/src/user/BasicUserInformation";
2826
2833
  export * from "libs/reach/util/common/src/user/Channel";
2834
+ export * from "libs/reach/util/common/src/user/CurrentUserContext";
2835
+ export * from "libs/reach/util/common/src/user/CurrentUserDetailContextProvider";
2836
+ export * from "libs/reach/util/common/src/user/CurrentUserDetailLibContextProvider";
2837
+ export * from "libs/reach/util/common/src/user/Group";
2838
+ export * from "libs/reach/util/common/src/user/LanguageUtils";
2827
2839
  export * from "libs/reach/util/common/src/user/Member";
2828
2840
  export * from "libs/reach/util/common/src/user/Organization";
2829
2841
  export * from "libs/reach/util/common/src/user/Subscription";
2830
2842
  export * from "libs/reach/util/common/src/user/User";
2831
- export * from "libs/reach/util/common/src/user/Group";
2832
2843
  export * from "libs/reach/util/common/src/user/UserChannelSubscription";
2833
2844
  export * from "libs/reach/util/common/src/user/UserInfo";
2834
2845
  export * from "libs/reach/util/common/src/user/UserUtils";
2846
+ export * from "libs/reach/util/common/src/user/content-languages-util";
2835
2847
  export * from "libs/reach/util/common/src/user/useAccountApi";
2848
+ export * from "libs/reach/util/common/src/user/useCachedCurrentUserApi";
2836
2849
  export * from "libs/reach/util/common/src/user/useCurrentUser";
2837
2850
  export * from "libs/reach/util/common/src/user/useCurrentUserApi";
2838
- export * from "libs/reach/util/common/src/user/useCachedCurrentUserApi";
2839
- export * from "libs/reach/util/common/src/user/useManageCurrentUserApi";
2840
- export * from "libs/reach/util/common/src/user/useUserAdminApi";
2841
- export * from "libs/reach/util/common/src/user/CurrentUserDetailContextProvider";
2842
2851
  export * from "libs/reach/util/common/src/user/useCurrentUserCache";
2852
+ export * from "libs/reach/util/common/src/user/useManageCurrentUserApi";
2843
2853
  export * from "libs/reach/util/common/src/user/useSubscriptionHandlePathBuilder";
2844
- export * from "libs/reach/util/common/src/user/CurrentUserContext";
2845
2854
  export * from "libs/reach/util/common/src/user/useSubscriptionWebAppUrl";
2846
- export * from "libs/reach/util/common/src/user/LanguageUtils";
2847
- export * from "libs/reach/util/common/src/user/content-languages-util";
2855
+ export * from "libs/reach/util/common/src/user/useUserAdminApi";
2848
2856
  }
2849
2857
  declare module "libs/reach/util/common/src/plugins/usePluginDeviceStore" {
2850
2858
  import { Storage } from "libs/reach/util/context/src/index";
@@ -3293,7 +3301,7 @@ declare module "libs/reach/util/common/src/subscription/useSubscriptionApi" {
3293
3301
  }
3294
3302
  declare module "libs/reach/util/common/src/subscription/useCachedEssentialSubscriptionData" {
3295
3303
  export function useCachedEssentialSubscriptionData(): {
3296
- getCachedEssentialSubscriptionData: (subscriptionId: string) => Promise<import("@livetiles/reach/util/common").EssentialSubscriptionData>;
3304
+ getEssentialData: (subscriptionId: string) => Promise<any>;
3297
3305
  };
3298
3306
  }
3299
3307
  declare module "libs/reach/util/common/src/subscription/SubscriptionContext" {
package/package.json CHANGED
@@ -4,6 +4,6 @@
4
4
  "main": "",
5
5
  "types": "./index.d.ts",
6
6
  "license": "ISC",
7
- "version": "0.4.140",
7
+ "version": "0.4.142",
8
8
  "dependencies": {}
9
9
  }