@engagently/types 4.7.1 → 4.8.0

package/dist/common/_types/WidgetDefinitions.d.ts

@@ -1,6 +1,6 @@
 import type { VNode } from 'preact';
 import type { ExperienceParticipationFragment } from '../../widgets/src/poll/data/ExperienceFragments.generated';
-import type { PollBarData, PollGridData, ChartData } from '../../ui/core/_types';
+import type { PollBarData, PollGridData, ChartData, PollStats } from '../../ui/core/_types';
 /**
  * Type Definitions for all available entities
  *
@@ -179,7 +179,11 @@ export declare enum PollBarAttributes {
     RESULT_DISPLAY = "result-display",
     RESULT_CTA_ENABLED = "result-cta-enabled",
     RESULT_CTA_MESSAGE = "result-cta-message",
-    DISPLAY_STATS = "display-stats"
+    DISPLAY_STATS = "display-stats",
+    STATS = "stats",
+    SHOW_VIEWS = "show-views",
+    SHOW_CLICKS = "show-clicks",
+    COLOR_SCHEME = "color-scheme"
 }
 export interface PollBarAttributesHTMLElement {
     ['poll-data']?: PollBarData | null;
@@ -196,6 +200,10 @@ export interface PollBarAttributesHTMLElement {
     ['result-cta-enabled']?: boolean | string;
     ['result-cta-message']?: string | null;
     ['display-stats']?: boolean | string;
+    ['stats']?: PollStats | null;
+    ['show-views']?: boolean | string;
+    ['show-clicks']?: boolean | string;
+    ['color-scheme']?: string;
 }
 export interface PollBarAttributesComponent {
     pollData?: PollBarData | null;
@@ -212,6 +220,10 @@ export interface PollBarAttributesComponent {
     resultCtaEnabled?: boolean;
     resultCtaMessage?: string | null;
     displayStats?: boolean;
+    stats?: PollStats | null;
+    showViews?: boolean;
+    showClicks?: boolean;
+    colorScheme?: 'dark' | 'light';
 }
 export interface PollBarWidget {
     name: EgyEntities.EGY_POLL_BAR;
@@ -240,7 +252,11 @@ export declare enum PollGridAttributes {
     RESULT_DISPLAY = "result-display",
     RESULT_CTA_ENABLED = "result-cta-enabled",
     RESULT_CTA_MESSAGE = "result-cta-message",
-    DISPLAY_STATS = "display-stats"
+    DISPLAY_STATS = "display-stats",
+    STATS = "stats",
+    SHOW_VIEWS = "show-views",
+    SHOW_CLICKS = "show-clicks",
+    COLOR_SCHEME = "color-scheme"
 }
 export interface PollGridAttributesHTMLElement {
     ['poll-data']?: PollGridData | null;
@@ -257,6 +273,10 @@ export interface PollGridAttributesHTMLElement {
     ['result-cta-enabled']?: boolean | string;
     ['result-cta-message']?: string | null;
     ['display-stats']?: boolean | string;
+    ['stats']?: PollStats | null;
+    ['show-views']?: boolean | string;
+    ['show-clicks']?: boolean | string;
+    ['color-scheme']?: string;
 }
 export interface PollGridAttributesComponent {
     pollData?: PollGridData | null;
@@ -273,6 +293,10 @@ export interface PollGridAttributesComponent {
     resultCtaEnabled?: boolean;
     resultCtaMessage?: string | null;
     displayStats?: boolean;
+    stats?: PollStats | null;
+    showViews?: boolean;
+    showClicks?: boolean;
+    colorScheme?: 'dark' | 'light';
 }
 export interface PollGridWidget {
     name: EgyEntities.EGY_POLL_GRID;
@@ -300,7 +324,11 @@ export declare enum PollSliderAttributes {
     USER_NAME = "user-name",
     USER_THUMBNAIL_URL = "user-thumbnail-url",
     REFRESH_KEY = "refresh-key",
-    DISPLAY_STATS = "display-stats"
+    DISPLAY_STATS = "display-stats",
+    STATS = "stats",
+    SHOW_VIEWS = "show-views",
+    SHOW_CLICKS = "show-clicks",
+    COLOR_SCHEME = "color-scheme"
 }
 export interface PollSliderAttributesHTMLElement {
     ['poll-data']?: ChartData | null;
@@ -316,6 +344,10 @@ export interface PollSliderAttributesHTMLElement {
     ['user-thumbnail-url']?: string | null;
     ['refresh-key']?: string;
     ['display-stats']?: boolean | string;
+    ['stats']?: PollStats | null;
+    ['show-views']?: boolean | string;
+    ['show-clicks']?: boolean | string;
+    ['color-scheme']?: string;
 }
 export interface PollSliderAttributesComponent {
     pollData?: ChartData | null;
@@ -331,6 +363,10 @@ export interface PollSliderAttributesComponent {
     userThumbnailUrl?: string | null;
     refreshKey?: string;
     displayStats?: boolean;
+    stats?: PollStats | null;
+    showViews?: boolean;
+    showClicks?: boolean;
+    colorScheme?: 'dark' | 'light';
 }
 export interface PollSliderWidget {
     name: EgyEntities.EGY_POLL_SLIDER;

package/dist/i18n/i18n.d.ts

@@ -249,6 +249,11 @@ export declare const defaultResources: {
                 EGY_USERNAME_LOCKED: string;
                 EGY_USERNAME_INVALID: string;
             };
+            login: {
+                assertion_failed: {
+                    NEEDS_VERIFIED_EMAIL: string;
+                };
+            };
         };
         readonly features: {
             COMMENT: {
@@ -321,6 +326,10 @@ export declare const defaultResources: {
         readonly poll: {
             "thank-you-for-vote": string;
             "call-to-action": string;
+            "live-poll": string;
+            viewed: string;
+            vote_one: string;
+            vote_other: string;
         };
     };
     en: {
@@ -568,6 +577,11 @@ export declare const defaultResources: {
                 EGY_USERNAME_LOCKED: string;
                 EGY_USERNAME_INVALID: string;
             };
+            login: {
+                assertion_failed: {
+                    NEEDS_VERIFIED_EMAIL: string;
+                };
+            };
         };
         readonly features: {
             COMMENT: {
@@ -640,6 +654,10 @@ export declare const defaultResources: {
         readonly poll: {
             "thank-you-for-vote": string;
             "call-to-action": string;
+            "live-poll": string;
+            viewed: string;
+            vote_one: string;
+            vote_other: string;
         };
     };
 };
@@ -890,6 +908,11 @@ declare const resources: {
                 EGY_USERNAME_LOCKED: string;
                 EGY_USERNAME_INVALID: string;
             };
+            login: {
+                assertion_failed: {
+                    NEEDS_VERIFIED_EMAIL: string;
+                };
+            };
         };
         readonly features: {
             COMMENT: {
@@ -962,6 +985,10 @@ declare const resources: {
         readonly poll: {
             "thank-you-for-vote": string;
             "call-to-action": string;
+            "live-poll": string;
+            viewed: string;
+            vote_one: string;
+            vote_other: string;
         };
     };
     en: {
@@ -1209,6 +1236,11 @@ declare const resources: {
                 EGY_USERNAME_LOCKED: string;
                 EGY_USERNAME_INVALID: string;
             };
+            login: {
+                assertion_failed: {
+                    NEEDS_VERIFIED_EMAIL: string;
+                };
+            };
         };
         readonly features: {
             COMMENT: {
@@ -1281,6 +1313,10 @@ declare const resources: {
         readonly poll: {
             "thank-you-for-vote": string;
             "call-to-action": string;
+            "live-poll": string;
+            viewed: string;
+            vote_one: string;
+            vote_other: string;
         };
     };
 };

package/dist/main/lib/engagently.d.ts

@@ -1,4 +1,5 @@
 import type { CommunityConfig, EngageConfig, Translations } from '../../common/_types/ConfigDefinition';
+import type { AuthError } from '../../common/lib/api/session';
 import type { Exchange } from '@urql/preact';
 type SignInOptions = Partial<{
     token: string | null;
@@ -19,6 +20,7 @@ export type Engagently = {
     remoteTranslations?: Translations | null;
     core: {
         authExchange?: Exchange;
+        error?: AuthError | null;
         subscriptionExchange?: Exchange;
         canSignOut?: boolean;
         signOut?: (options?: SignOutOptions) => Promise<void>;

package/dist/ui/core/_types.d.ts

@@ -1,6 +1,11 @@
 /**
  * These types will be shared with the ts package
  */
+/** Poll Stats for all poll widgets */
+export type PollStats = {
+    clicks: number;
+    views: number;
+};
 /** Poll Data for the PollBar widget */
 export type PollBarData = {
     question?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@engagently/types",
-  "version": "4.7.1",
+  "version": "4.8.0",
   "main": "./index.ts",
   "types": "dist/types/engagently.d.ts",
   "files": [