@streamlayer/feature-gamification 0.29.0 → 0.30.0

package/lib/background.d.ts

@@ -5,11 +5,7 @@ import { ReadableAtom, WritableAtom } from 'nanostores';
 import * as queries from './queries';
 import { detail } from './detail';
 /**
- * get GamificationBackground singleton
- */
-export declare const gamificationBackground: (instance: StreamLayerContext) => GamificationBackground;
-/**
- * Background Singleton class for Gamification and Highlights overlays
+ * Background class for Gamification feature
  */
 export declare class GamificationBackground {
     /** sl event id */

package/lib/background.js

@@ -4,16 +4,7 @@ import '@streamlayer/sdk-web-core/store';
 import * as queries from './queries';
 import { detail } from './detail';
 /**
- * get GamificationBackground singleton
- */
-export const gamificationBackground = (instance) => {
-    if (!instance.gamification) {
-        instance.gamification = new GamificationBackground(instance);
-    }
-    return instance.gamification;
-};
-/**
- * Background Singleton class for Gamification and Highlights overlays
+ * Background class for Gamification feature
  */
 export class GamificationBackground {
     /** sl event id */
@@ -40,9 +31,6 @@ export class GamificationBackground {
     notifications;
     log;
     constructor(instance) {
-        if (instance.gamification) {
-            throw new Error('GamificationBackground Singleton error');
-        }
         this.log = createLogger('gamification-background');
         this.slStreamId = instance.stores.slStreamId.getAtomStore();
         this.organizationId = instance.stores.organizationSettings.getAtomStore();
@@ -83,6 +71,7 @@ export class GamificationBackground {
                 }
             });
         });
+        this.feedSubscription.connect();
     }
     /**
      * Get id for notifications and link with current session

package/lib/gamification.js

@@ -7,8 +7,8 @@ import * as actions from './queries/actions';
 import { GamificationStorage } from './storage';
 import { leaderboard } from './leaderboard';
 import { deepLink } from './deepLink';
-import { onboarding } from './onboarding';
-import { gamificationBackground } from './';
+import { OnboardingStatus, onboarding } from './onboarding';
+import { GamificationBackground } from './';
 const GamificationQuestionTypes = new Set([QuestionType.POLL, QuestionType.PREDICTION, QuestionType.TRIVIA]);
 /**
  * Gamification (Games) Overlay
@@ -47,7 +47,7 @@ export class Gamification extends AbstractFeature {
     storage;
     constructor(config, source, instance) {
         super(config, source);
-        this.background = gamificationBackground(instance);
+        this.background = new GamificationBackground(instance);
         this.storage = new GamificationStorage();
         this.userSummary = new ApiStore(queries.$userSummary(this.background.slStreamId, this.background.userId, instance.transport), 'gamification:userSummary');
         this.feedList = this.background.feedList;
@@ -57,7 +57,7 @@ export class Gamification extends AbstractFeature {
         this.onboardingStatus = onboarding(this, this.background, instance.transport, instance.notifications);
         this.notifications = instance.notifications;
         this.transport = instance.transport;
-        this.closeFeature = instance.sdk.closeFeature;
+        this.closeFeature = () => instance.sdk.closeFeature(true);
         this.openFeature = () => instance.sdk.openFeature(FeatureType.GAMES);
         this.openedQuestion = this.background.openedQuestion;
         this.deepLink = deepLink(this.transport, this.background.slStreamId, this.background.userId);
@@ -74,25 +74,35 @@ export class Gamification extends AbstractFeature {
          * listen for active question and show in-app notification
          */
         this.background.activeQuestionId.listen((question) => {
-            if (question && question.data && this.onboardingStatus.$store.get()) {
+            const onboardingStatus = this.onboardingStatus.$store.get();
+            if (question && question.data && onboardingStatus) {
                 if (question.data.question?.id !== undefined &&
                     question.data.question.notification !== undefined &&
-                    question.data.moderation?.bypassNotifications?.inAppSilence !== SilenceSetting.ON &&
+                    question.data.question?.bypassNotifications?.inAppSilence !== SilenceSetting.ON &&
                     question.data.question.status === QuestionStatus.ACTIVE) {
                     if (GamificationQuestionTypes.has(question.data.question.type)) {
-                        this.notifications.add({
-                            type: NotificationType.QUESTION,
-                            action: () => question.data?.question && this.openQuestion(question.data.question.id),
-                            close: () => question.data?.question && this.closeQuestion(question.data.question.id),
-                            autoHideDuration: 1000 * 60,
-                            id: this.background.getCurrentSessionId({ prefix: 'notification', entity: question.data.question.id }),
-                            data: {
-                                questionType: question.data.question.type,
-                                question: {
-                                    title: question.data.question.notification.title,
-                                },
-                            },
-                        });
+                        const optInEnabled = this.settings.getValues().inplayGame?.titleCard?.optIn;
+                        const onboardingCompleted = onboardingStatus === OnboardingStatus.Completed;
+                        if (optInEnabled !== undefined) {
+                            if (!optInEnabled || onboardingCompleted) {
+                                this.notifications.add({
+                                    type: NotificationType.QUESTION,
+                                    action: () => question.data?.question && this.openQuestion(question.data.question.id),
+                                    close: () => question.data?.question && this.closeQuestion(question.data.question.id),
+                                    autoHideDuration: 1000 * 60,
+                                    id: this.background.getCurrentSessionId({
+                                        prefix: 'notification',
+                                        entity: question.data.question.id,
+                                    }),
+                                    data: {
+                                        questionType: question.data.question.type,
+                                        question: {
+                                            title: question.data.question.notification.title,
+                                        },
+                                    },
+                                });
+                            }
+                        }
                     }
                     else if (question.data.question.type === QuestionType.FACTOID) {
                         const optionsValue = question.data.question.options?.options.value;

package/lib/index.d.ts

@@ -1,6 +1,5 @@
-export { GamificationBackground, gamificationBackground } from './background';
+export { GamificationBackground } from './background';
 export { Gamification } from './gamification';
-export { Highlights } from './highlights';
 declare module '@streamlayer/sdk-web-interfaces' {
     interface StreamLayerContext {
         gamification: import('./background').GamificationBackground;

package/lib/index.js

@@ -1,3 +1,2 @@
-export { GamificationBackground, gamificationBackground } from './background';
+export { GamificationBackground } from './background';
 export { Gamification } from './gamification';
-export { Highlights } from './highlights';

package/lib/queries/index.d.ts

@@ -108,7 +108,7 @@ export declare const feedSubscription: ($slStreamId: ReadableAtom<string | undef
             readonly kind: import("@bufbuild/protobuf").MethodKind.ServerStreaming;
         };
     };
-}, SubscriptionRequest, SubscriptionResponse, "subscription" | "votingSubscription" | "questionSubscription" | "feedSubscription", ((request: import("@bufbuild/protobuf").PartialMessage<SubscriptionRequest>, messageCallback: (response: SubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<VotingSubscriptionRequest>, messageCallback: (response: VotingSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<QuestionSubscriptionRequest>, messageCallback: (response: QuestionSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionRequest>, messageCallback: (response: import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void)>;
+}, SubscriptionRequest, SubscriptionResponse, "subscription" | "votingSubscription" | "questionSubscription" | "feedSubscription", ((request: import("@bufbuild/protobuf").PartialMessage<SubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<SubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<VotingSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<VotingSubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<QuestionSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<QuestionSubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionResponse>)>;
 export declare const votingSubscription: (params: {
     questionId: string;
     feedId: string;
@@ -218,7 +218,7 @@ export declare const votingSubscription: (params: {
             readonly kind: import("@bufbuild/protobuf").MethodKind.ServerStreaming;
         };
     };
-}, VotingSubscriptionRequest, VotingSubscriptionResponse, "subscription" | "votingSubscription" | "questionSubscription" | "feedSubscription", ((request: import("@bufbuild/protobuf").PartialMessage<SubscriptionRequest>, messageCallback: (response: SubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<VotingSubscriptionRequest>, messageCallback: (response: VotingSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<QuestionSubscriptionRequest>, messageCallback: (response: QuestionSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionRequest>, messageCallback: (response: import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void)>;
+}, VotingSubscriptionRequest, VotingSubscriptionResponse, "subscription" | "votingSubscription" | "questionSubscription" | "feedSubscription", ((request: import("@bufbuild/protobuf").PartialMessage<SubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<SubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<VotingSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<VotingSubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<QuestionSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<QuestionSubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionResponse>)>;
 export declare const questionSubscription: (questionId: string, transport: Transport) => import("packages/sdk-web-api/lib/grpc/subscription").ServerStreamSubscription<import("@bufbuild/protobuf").ServiceType, import("@bufbuild/protobuf").Message<import("@bufbuild/protobuf").AnyMessage>, import("@bufbuild/protobuf").Message<import("@bufbuild/protobuf").AnyMessage>, never, never> | import("packages/sdk-web-api/lib/grpc/subscription").ServerStreamSubscription<{
     readonly typeName: "streamlayer.interactive.feed.Feed";
     readonly methods: {
@@ -325,7 +325,7 @@ export declare const questionSubscription: (questionId: string, transport: Trans
             readonly kind: import("@bufbuild/protobuf").MethodKind.ServerStreaming;
         };
     };
-}, QuestionSubscriptionRequest, QuestionSubscriptionResponse, "subscription" | "votingSubscription" | "questionSubscription" | "feedSubscription", ((request: import("@bufbuild/protobuf").PartialMessage<SubscriptionRequest>, messageCallback: (response: SubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<VotingSubscriptionRequest>, messageCallback: (response: VotingSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<QuestionSubscriptionRequest>, messageCallback: (response: QuestionSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void) | ((request: import("@bufbuild/protobuf").PartialMessage<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionRequest>, messageCallback: (response: import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionResponse) => void, closeCallback: (error: import("@connectrpc/connect").ConnectError | undefined) => void, options?: import("@connectrpc/connect").CallOptions | undefined) => () => void)>;
+}, QuestionSubscriptionRequest, QuestionSubscriptionResponse, "subscription" | "votingSubscription" | "questionSubscription" | "feedSubscription", ((request: import("@bufbuild/protobuf").PartialMessage<SubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<SubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<VotingSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<VotingSubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<QuestionSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<QuestionSubscriptionResponse>) | ((request: import("@bufbuild/protobuf").PartialMessage<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionRequest>, options?: import("@connectrpc/connect").CallOptions | undefined) => AsyncIterable<import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").FeedSubscriptionResponse>)>;
 export declare const getQuestionByUser: (questionId: string, transport: Transport) => Promise<import("@streamlayer/sdk-web-types").ExtendedQuestion | undefined>;
 export declare const $questionByUser: ($questionId: ReadableAtom<string | undefined>, transport: Transport) => import("@nanostores/query").FetcherStore<import("@streamlayer/sdk-web-types").ExtendedQuestion | undefined, any>;
 export declare const $pickHistory: (slStreamId: ReadableAtom<string | undefined>, transport: Transport) => import("@nanostores/query").FetcherStore<(import("@streamlayer/sl-eslib/interactive/feed/interactive.feed_pb").PickHistory | undefined)[], any>;

package/lib/queries/index.js

@@ -18,7 +18,7 @@ export const $activeQuestion = (slStreamId, transport) => {
     });
 };
 export const feedSubscription = ($slStreamId, transport) => {
-    const { client } = transport.createCallbackClient(Feed);
+    const { client } = transport.createStreamClient(Feed);
     const params = atom({ eventId: $slStreamId.get() || '', feedId: '' });
     $slStreamId.subscribe((eventId = '') => {
         params.set({ eventId, feedId: '' });
@@ -27,12 +27,12 @@ export const feedSubscription = ($slStreamId, transport) => {
     return subscription;
 };
 export const votingSubscription = (params, transport) => {
-    const { client } = transport.createCallbackClient(Feed);
+    const { client } = transport.createStreamClient(Feed);
     const subscription = transport.addSubscription(client.votingSubscription, params, { name: 'votingSubscription', withStore: true });
     return subscription;
 };
 export const questionSubscription = (questionId, transport) => {
-    const { client } = transport.createCallbackClient(Feed);
+    const { client } = transport.createStreamClient(Feed);
     const subscription = transport.addSubscription(client.questionSubscription, { questionId }, { name: 'questionSubscription' });
     return subscription;
 };

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@streamlayer/feature-gamification",
-  "version": "0.29.0",
+  "version": "0.30.0",
   "peerDependencies": {
     "@bufbuild/protobuf": "^1.4.2",
     "@streamlayer/sl-eslib": "^5.53.6",
     "@fastify/deepmerge": "*",
     "nanostores": "^0.9.5",
     "@streamlayer/sdk-web-api": "^0.1.0",
-    "@streamlayer/sdk-web-core": "^0.0.7",
-    "@streamlayer/sdk-web-interfaces": "^0.0.1",
+    "@streamlayer/sdk-web-core": "^0.1.0",
+    "@streamlayer/sdk-web-interfaces": "^0.1.0",
     "@streamlayer/sdk-web-logger": "^0.0.1",
     "@streamlayer/sdk-web-notifications": "^0.1.0",
-    "@streamlayer/sdk-web-types": "^0.1.0",
-    "@streamlayer/sdk-web-storage": "^0.0.4"
+    "@streamlayer/sdk-web-storage": "^0.0.4",
+    "@streamlayer/sdk-web-types": "^0.1.0"
   },
   "devDependencies": {
     "tslib": "^2.6.2"

package/lib/highlights.d.ts

@@ -1,19 +0,0 @@
-import { AbstractFeature, ApiStore, FeatureSource, type FeatureProps, type StreamLayerContext } from '@streamlayer/sdk-web-interfaces';
-import type { GetApiResponseType } from '@streamlayer/sdk-web-api';
-import '@streamlayer/sdk-web-core/store';
-import * as queries from './queries';
-import { GamificationBackground } from './';
-export declare class Highlights extends AbstractFeature<undefined> {
-    insights?: ApiStore<GetApiResponseType<typeof queries.$insightHistory>>;
-    closeFeature: () => void;
-    openFeature: () => void;
-    openedInsight: GamificationBackground['openedQuestion'];
-    private notifications;
-    private transport;
-    private background;
-    constructor(config: FeatureProps, source: FeatureSource, instance: StreamLayerContext);
-    connect: () => void;
-    disconnect: () => void;
-    openHighlight: (questionId: string) => void;
-    closeHighlight: (questionId?: string) => void;
-}

package/lib/highlights.js

@@ -1,76 +0,0 @@
-import { AbstractFeature, ApiStore, FeatureStatus, } from '@streamlayer/sdk-web-interfaces';
-import { QuestionStatus, QuestionType, FeatureType, SilenceSetting } from '@streamlayer/sdk-web-types';
-import { NotificationType } from '@streamlayer/sdk-web-notifications';
-import '@streamlayer/sdk-web-core/store';
-import * as queries from './queries';
-import { gamificationBackground } from './';
-export class Highlights extends AbstractFeature {
-    insights;
-    closeFeature;
-    openFeature;
-    openedInsight;
-    notifications;
-    transport;
-    background;
-    constructor(config, source, instance) {
-        super(config, source);
-        this.background = gamificationBackground(instance);
-        this.notifications = instance.notifications;
-        this.transport = instance.transport;
-        this.closeFeature = instance.sdk.closeFeature;
-        this.openFeature = () => instance.sdk.openFeature(FeatureType.HIGHLIGHTS);
-        this.status.subscribe((status) => {
-            if (status === FeatureStatus.Ready) {
-                this.connect();
-            }
-            else {
-                this.disconnect();
-            }
-        });
-        this.background.activeQuestionId.listen((question) => {
-            if (question?.data?.question?.id &&
-                question?.data?.question?.notification &&
-                question.data.moderation?.bypassNotifications?.inAppSilence !== SilenceSetting.ON &&
-                question.data.question.type === QuestionType.FACTOID &&
-                question.data.question.status === QuestionStatus.ACTIVE) {
-                this.notifications.add({
-                    type: NotificationType.QUESTION,
-                    action: () => question.data?.question && this.openHighlight(question.data.question.id),
-                    close: () => question.data?.question && this.closeHighlight(question.data.question.id),
-                    autoHideDuration: 1000 * +(question.data.question?.appearance?.autoHideInterval || '5'),
-                    id: this.background.getCurrentSessionId({ prefix: 'notification', entity: question.data.question.id }),
-                    data: {
-                        questionType: question.data.question.type,
-                        question: {
-                            title: question.data.question.notification.title,
-                        },
-                    },
-                });
-            }
-        });
-        this.openedInsight = this.background.openedQuestion;
-    }
-    connect = () => {
-        if (!this.insights) {
-            this.insights = new ApiStore(queries.$insightHistory(this.background.slStreamId, this.transport), 'gamification:insights');
-        }
-        else {
-            this.insights.invalidate();
-        }
-        this.background.feedSubscription.addListener('feed-subscription-insights-list', () => {
-            window.requestAnimationFrame(() => {
-                this.insights?.invalidate();
-            });
-        });
-    };
-    disconnect = () => {
-        this.background.feedSubscription.removeListener('feed-subscription-insights-list');
-    };
-    openHighlight = (questionId) => {
-        this.openFeature();
-        return this.background.openQuestion(questionId);
-    };
-    closeHighlight = (questionId) => {
-        return this.background.closeQuestion(questionId);
-    };
-}