feat(js): js sdk preferences #5701

LetItRock · 2024-06-10T09:26:07Z

What changed? Why was the change needed?

The Preferences module for JS SDK.

Screenshots

Expand for optional sections

Related enterprise PR

Special notes for your reviewer

linear · 2024-06-10T09:26:10Z

COM-30 Implement Preferences

LetItRock · 2024-06-10T09:27:08Z

packages/client/src/api/api.service.ts

+  async getPreferences({
+    level = PreferenceLevelEnum.TEMPLATE,
+  }: {
+    level?: `${PreferenceLevelEnum}`;
+  }): Promise<Array<IUserPreferenceSettings | IUserGlobalPreferenceSettings>> {
+    return this.httpClient.get(`/widgets/preferences/${level}`);
+  }
+


We provide newer APIs but it wasn't exposed with this ApiService class.

LetItRock · 2024-06-10T09:28:12Z

packages/js/src/preferences/helpers.ts

+export const mapPreference = (apiPreference: {
+  template?: TODO;
+  preference: {
+    enabled: boolean;
+    channels: {
+      email?: boolean;
+      sms?: boolean;
+      in_app?: boolean;
+      chat?: boolean;
+      push?: boolean;
+    };
+    overrides?: ChannelPreferenceOverride[];
+  };
+}): Preference => {
+  const { template: workflow, preference } = apiPreference;
+  const hasWorkflow = workflow !== undefined;
+  const level = hasWorkflow ? PreferenceLevel.TEMPLATE : PreferenceLevel.GLOBAL;
+
+  return new Preference({
+    level,
+    enabled: preference.enabled,
+    channels: preference.channels,
+    workflow,
+    overrides: preference.overrides,
+  });
+};


Map server preference to the one that we use in the module with a better interface.

packages/js/src/preferences/helpers.ts

netlify · 2024-06-10T09:39:17Z

❌ Deploy Preview for novu-design failed. Why did it fail? →

Name	Link
🔨 Latest commit	`8c6464a`
🔍 Latest deploy log	https://app.netlify.com/sites/novu-design/deploys/667435350e72b90008652b89

packages/js/src/feeds/notification.ts

SokratisVidros · 2024-06-10T10:49:06Z

packages/js/src/feeds/notification.ts

-  payload: Record<string, unknown>;
-  overrides: Record<string, unknown>;
+  readonly _id: string;
+  readonly _feedId?: string | null;


We can remove this, notifications will always belong to a feed array.

but you might want to know to which feed it belongs when using individually

packages/js/src/feeds/notification.ts

packages/js/src/types.ts

SokratisVidros · 2024-06-10T10:57:51Z

packages/js/src/types.ts

+  name: string;
+  critical: boolean;
+  tags?: string[];
+  identifier: string;


What's the difference between an identifier and the _id?

identifier is used for the trigger, _id is internal Mongo id

packages/js/src/types.ts

SokratisVidros · 2024-06-10T10:58:04Z

packages/js/src/types.ts

+export type ChannelPreference = {
+  email?: boolean;
+  sms?: boolean;
+  in_app?: boolean;


Suggested change

in_app?: boolean;

inApp?: boolean;

this is due to internal implementation and will require changes across the stack :(

SokratisVidros · 2024-06-10T11:00:00Z

packages/js/src/types.ts

+  push?: boolean;
+};
+
+export type ChannelPreferenceOverride = {


This seems overly complicated for the current frontend needs and is driven by the current state of the API. Let's build the DX on an ideal scenario and hide the API tech-debt with internal helper methods. Then we will update the API.

I think that we can remove it from the new Preference class for now, not even sure if that is used often by clients.

packages/js/src/event-emitter/novu-event-emitter.ts

…uild

netlify · 2024-06-20T13:55:00Z

✅ Deploy Preview for dev-web-novu ready!

Name	Link
🔨 Latest commit	`8c6464a`
🔍 Latest deploy log	https://app.netlify.com/sites/dev-web-novu/deploys/66743535850bb00008b5cfb8
😎 Deploy Preview	https://deploy-preview-5701--dev-web-novu.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

* feat(js): js sdk feeds module (#5688) * feat(js): improve the package json exports and tsup config * feat(js): lazy session initialization and interface fixes * feat(js): js sdk feeds module * feat(js): js sdk preferences (#5701) * feat(js): js sdk preferences * feat(js): handling the web socket connection and events (#5704) * feat(js): handling the web socket connection and events * feat: ui solid --------- Co-authored-by: Biswajeet Das <[email protected]> * fix: caching for session initialize * fix: worker --------- Co-authored-by: Paweł Tymczuk <[email protected]> Co-authored-by: Biswajeet Das <[email protected]> Co-authored-by: Dima Grossman <[email protected]>

LetItRock requested review from SokratisVidros and BiswaViraj June 10, 2024 09:26

LetItRock self-assigned this Jun 10, 2024

LetItRock had a problem deploying to Linting June 10, 2024 09:26 — with GitHub Actions Failure

LetItRock temporarily deployed to Linting June 10, 2024 09:26 — with GitHub Actions Inactive

LetItRock commented Jun 10, 2024

View reviewed changes

SokratisVidros requested changes Jun 10, 2024

View reviewed changes

LetItRock force-pushed the com-29-js-sdk-feeds branch from 9448d67 to e62dd85 Compare June 11, 2024 08:28

LetItRock force-pushed the com-30-js-sdk-preferences branch from 713d403 to 708b237 Compare June 11, 2024 08:43

LetItRock temporarily deployed to Linting June 11, 2024 08:43 — with GitHub Actions Inactive

LetItRock had a problem deploying to Linting June 11, 2024 08:43 — with GitHub Actions Failure

LetItRock had a problem deploying to Linting June 11, 2024 09:02 — with GitHub Actions Failure

LetItRock temporarily deployed to Linting June 11, 2024 09:02 — with GitHub Actions Inactive

LetItRock force-pushed the com-30-js-sdk-preferences branch from b57c777 to 9b0473d Compare June 11, 2024 10:28

LetItRock temporarily deployed to Linting June 11, 2024 10:28 — with GitHub Actions Inactive

LetItRock had a problem deploying to Linting June 11, 2024 10:28 — with GitHub Actions Failure

LetItRock temporarily deployed to Linting June 11, 2024 11:02 — with GitHub Actions Inactive

LetItRock had a problem deploying to Linting June 11, 2024 11:02 — with GitHub Actions Failure

LetItRock temporarily deployed to Linting June 11, 2024 11:24 — with GitHub Actions Inactive

LetItRock requested a review from SokratisVidros June 11, 2024 11:24

LetItRock temporarily deployed to Linting June 12, 2024 10:48 — with GitHub Actions Inactive

LetItRock force-pushed the com-29-js-sdk-feeds branch from 69aa508 to 4fd00de Compare June 13, 2024 09:53

BiswaViraj reviewed Jun 14, 2024

View reviewed changes

packages/js/src/event-emitter/novu-event-emitter.ts Outdated Show resolved Hide resolved

BiswaViraj approved these changes Jun 14, 2024

View reviewed changes

LetItRock force-pushed the com-29-js-sdk-feeds branch from 4fd00de to ab164a5 Compare June 20, 2024 12:19

Base automatically changed from com-29-js-sdk-feeds to next June 20, 2024 13:47

LetItRock added 13 commits June 20, 2024 15:48

feat(js): the base js sdk package scaffolding

348b4fd

feat(js): improve the package json exports and tsup config

9a85fb5

feat(js): lazy session initialization and interface fixes

a2627c6

feat(js): renamed the *.spec.ts to *.test.ts

c753c57

feat(js): js sdk feeds module

438661f

chore(js): spell check fix

dc66186

feat(js): the base js sdk package scaffolding

d035e6f

feat(js): set the dist file size limits and run the check after the b…

9d75acc

…uild

feat(js): lazy session initialization and interface fixes

b19f98f

feat(js): renamed the *.spec.ts to *.test.ts

cc21e68

feat(js): js sdk feeds module

bd17c58

feat(js): js sdk preferences

a22b888

chore(js): simplified the notification and preference classes

68987c2

LetItRock force-pushed the com-30-js-sdk-preferences branch from 4ede520 to 68987c2 Compare June 20, 2024 13:51

LetItRock temporarily deployed to Linting June 20, 2024 13:51 — with GitHub Actions Inactive

feat(js): temporarily increased bundle size limits

8c6464a

LetItRock temporarily deployed to Linting June 20, 2024 13:57 — with GitHub Actions Inactive

LetItRock merged commit fad83fa into next Jun 20, 2024
28 checks passed

LetItRock deleted the com-30-js-sdk-preferences branch June 20, 2024 14:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(js): js sdk preferences #5701

feat(js): js sdk preferences #5701

LetItRock commented Jun 10, 2024

linear bot commented Jun 10, 2024

LetItRock Jun 10, 2024

LetItRock Jun 10, 2024

netlify bot commented Jun 10, 2024 •

edited

Loading

SokratisVidros Jun 10, 2024

LetItRock Jun 11, 2024

SokratisVidros Jun 10, 2024

LetItRock Jun 11, 2024

SokratisVidros Jun 10, 2024

LetItRock Jun 11, 2024

SokratisVidros Jun 10, 2024

LetItRock Jun 11, 2024

netlify bot commented Jun 20, 2024 •

edited

Loading

feat(js): js sdk preferences #5701

feat(js): js sdk preferences #5701

Conversation

LetItRock commented Jun 10, 2024

What changed? Why was the change needed?

Screenshots

Related enterprise PR

Special notes for your reviewer

linear bot commented Jun 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Jun 10, 2024 • edited Loading

❌ Deploy Preview for novu-design failed. Why did it fail? →

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Jun 20, 2024 • edited Loading

✅ Deploy Preview for dev-web-novu ready!

netlify bot commented Jun 10, 2024 •

edited

Loading

netlify bot commented Jun 20, 2024 •

edited

Loading