@engagently/types 4.4.0 → 4.5.0

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.
@@ -340,7 +340,7 @@ export interface PollSliderWidget {
340
340
  /**
341
341
  * Events that can be used by the pub/sub implementation for window.postMessage
342
342
  */
343
- export type MessageEvents = 'EGY_SETUP' | 'EGY_SIGN_IN' | 'EGY_SIGNED_OUT' | 'EGY_AUTHENTICATED' | 'EGY_TOGGLE_COLOR_SCHEME' | 'EGY_CHANGE_LANGUAGE' | 'EGY_CHANGE_VIEW_MODE' | 'EGY_LOAD_MORE_COMMENTS' | 'EGY_LOAD_MORE_REPLIES' | 'EGY_SUBMIT_COMMENTARY' | 'EGY_REINIT';
343
+ export type MessageEvents = 'EGY_SETUP' | 'EGY_SIGN_IN' | 'EGY_SIGNED_OUT' | 'EGY_AUTHENTICATED' | 'EGY_TOGGLE_COLOR_SCHEME' | 'EGY_CHANGE_LANGUAGE' | 'EGY_CHANGE_VIEW_MODE' | 'EGY_LOAD_MORE_COMMENTS' | 'EGY_LOAD_MORE_REPLIES' | 'EGY_SUBMIT_COMMENTARY' | 'EGY_REINIT' | 'EGY_CAN_LOGOUT';
344
344
  export declare const EGY_AUTH = "egy_auth";
345
345
  export type EgyAuth = {
346
346
  accessToken: string;
@@ -44,11 +44,14 @@ export declare const defaultResources: {
44
44
  "load-older-comments": string;
45
45
  "load-newer-replies": string;
46
46
  "load-older-replies": string;
47
+ logout: string;
48
+ "logout-hint": string;
47
49
  options: string;
48
50
  reply: string;
49
51
  reply_other: string;
50
52
  "reply-count": string;
51
53
  "reply-count_other": string;
54
+ session: string;
52
55
  share: string;
53
56
  "shared-comment": string;
54
57
  user: {
@@ -129,6 +132,7 @@ export declare const defaultResources: {
129
132
  share: string;
130
133
  };
131
134
  "commentary-not-available": string;
135
+ feedback: string;
132
136
  filters: {
133
137
  CREATED_AT_ASC: {
134
138
  description: string;
@@ -351,11 +355,14 @@ export declare const defaultResources: {
351
355
  "load-older-comments": string;
352
356
  "load-newer-replies": string;
353
357
  "load-older-replies": string;
358
+ logout: string;
359
+ "logout-hint": string;
354
360
  options: string;
355
361
  reply: string;
356
362
  reply_other: string;
357
363
  "reply-count": string;
358
364
  "reply-count_other": string;
365
+ session: string;
359
366
  share: string;
360
367
  "shared-comment": string;
361
368
  user: {
@@ -436,6 +443,7 @@ export declare const defaultResources: {
436
443
  share: string;
437
444
  };
438
445
  "commentary-not-available": string;
446
+ feedback: string;
439
447
  filters: {
440
448
  CREATED_AT_ASC: {
441
449
  description: string;
@@ -1,9 +1,11 @@
1
1
  import type { CommunityConfig, EngageConfig, Translations } from '../../common/_types/ConfigDefinition';
2
- import type { SignOutOptions } from '../../common/lib/api/session';
3
2
  import type { Exchange } from '@urql/preact';
4
3
  type SignInOptions = Partial<{
5
4
  token: string | null;
6
5
  }>;
6
+ type SignOutOptions = Partial<{
7
+ anonymousSession: boolean;
8
+ }>;
7
9
  export declare const reinit: (partialConfig?: Partial<EngageConfig>) => Promise<void>;
8
10
  export declare const signOut: ({ anonymousSession }?: SignOutOptions) => Promise<void>;
9
11
  export type Engagently = {
@@ -18,6 +20,8 @@ export type Engagently = {
18
20
  core: {
19
21
  authExchange?: Exchange;
20
22
  subscriptionExchange?: Exchange;
23
+ canSignOut?: boolean;
24
+ signOut?: (options?: SignOutOptions) => Promise<void>;
21
25
  };
22
26
  } & {
23
27
  Configuration: (config: EngageConfig) => Promise<EngageConfig>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@engagently/types",
3
- "version": "4.4.0",
3
+ "version": "4.5.0",
4
4
  "main": "./index.ts",
5
5
  "types": "dist/types/engagently.d.ts",
6
6
  "files": [