Merge pull request #24 from notificationapi-com/s2K4mDqS/3325-slack-library-updates

S2K4mDqS/3325-slack-library-updates

Author: sahandseifi

README.md

@@ -1,7 +1,7 @@
 # notificationapi-js-core
 
 With [NotificationAPI](https://www.notificationapi.com), software developers can implement any kind of notifications into their app in a matter of minutes.
-notificationapi-js-core focuses on providing headless UI support to Vanilla JavaScript users looking to use our infrastructure within their own designs.  
+notificationapi-js-core focuses on providing headless UI support to Vanilla JavaScript users looking to use our infrastructure within their own designs.
 
 # Docs
 
@@ -22,3 +22,15 @@ npm run test
 ```
 
 100% code coverage required.
+
+Update the version:
+
+```
+npm version major|minor|patch
+```
+
+Major: for breaking changes
+Minor: for new features
+Patch: for bug fixes
+
+The pipeline will automatically build and publish the package to npm.

lib/client.ts

@@ -7,6 +7,7 @@ import {
   DeliveryOptionsForEmail,
   DeliveryOptionsForInappWeb,
   PostUserRequest,
+  User,
   UserAccountMetadata,
   WS_REGION
 } from './interfaces';
@@ -33,6 +34,9 @@ type NotificationAPIClientSDKConfig = {
 
   // Debug mode:
   debug: boolean;
+
+  // SDK Dev Mode:
+  sdkDevMode: boolean;
 };
 
 const defaultConfig: NotificationAPIClientSDKConfig = {
@@ -47,7 +51,8 @@ const defaultConfig: NotificationAPIClientSDKConfig = {
   ).toISOString(),
   onNewInAppNotifications: undefined,
   keepWebSocketAliveForSeconds: 24 * 60 * 60, // 24 hours
-  debug: false
+  debug: false,
+  sdkDevMode: false
 };
 
 type NotificationAPIClientSDK = {
@@ -119,6 +124,19 @@ type NotificationAPIClientSDK = {
   getUserAccountMetadata(): Promise<{
     userAccountMetadata: UserAccountMetadata;
   }>;
+  user: {
+    get: () => Promise<User>;
+  };
+  slack: {
+    getOAuthUrl: (props?: { destinationUrl?: string }) => string;
+    getChannels: () => Promise<{
+      channels: {
+        id: string;
+        name: string;
+      }[];
+    }>;
+    setChannel: (channelId: string) => Promise<void>;
+  };
 };
 
 export const NotificationAPIClientSDK: NotificationAPIClientSDK = {
@@ -395,5 +413,51 @@ export const NotificationAPIClientSDK: NotificationAPIClientSDK = {
   },
   getUserAccountMetadata: async () => {
     return NotificationAPIClientSDK.rest.getUserAccountMetadata();
+  },
+
+  user: {
+    get: async () => {
+      return NotificationAPIClientSDK.rest.generic('GET', '') as Promise<User>;
+    }
+  },
+
+  slack: {
+    getOAuthUrl: (props?: { destinationUrl?: string }) => {
+      const sdkDevMode = NotificationAPIClientSDK.config.sdkDevMode;
+      const domain = sdkDevMode
+        ? 'localhost:3001'
+        : NotificationAPIClientSDK.config.host.replace('api.', 'app.');
+      // if no redirectUri is provided, use the current page's URL
+      const destination = props?.destinationUrl || window.location.href;
+
+      const state = encodeURIComponent(
+        JSON.stringify({
+          destination,
+          userId: NotificationAPIClientSDK.config.userId,
+          clientId: NotificationAPIClientSDK.config.clientId,
+          hashedUserId: NotificationAPIClientSDK.config.hashedUserId
+        })
+      );
+
+      const url =
+        'https://slack.com/oauth/v2/authorize?' +
+        'client_id=1146598856352.8825220259395' +
+        '&scope=chat:write,channels:read,channels:join,chat:write.customize,chat:write.public,groups:read,im:read,users:read' +
+        `&redirect_uri=https://${domain}/slack/oauth/callback` +
+        `&state=${state}`;
+      return url;
+    },
+    getChannels: async () => {
+      const response = await NotificationAPIClientSDK.rest.generic(
+        'GET',
+        'slack/channels'
+      );
+      return response;
+    },
+    setChannel: async (channelId: string) => {
+      return NotificationAPIClientSDK.identify({
+        slackChannel: channelId
+      });
+    }
   }
 };

lib/interfaces.ts

@@ -178,8 +178,64 @@ export interface User {
   lastSeenTime?: string;
   createdAt?: string;
   updatedAt?: string;
+  slackChannel?: string;
+  slackToken?: OauthV2AccessResponse;
 }
 
+interface WebAPICallResult {
+  ok: boolean;
+  error?: string;
+  response_metadata?: {
+    warnings?: string[];
+    next_cursor?: string;
+    scopes?: string[];
+    acceptedScopes?: string[];
+    retryAfter?: number;
+    messages?: string[];
+  };
+}
+
+interface AuthedUser {
+  access_token?: string;
+  expires_in?: number;
+  id?: string;
+  refresh_token?: string;
+  scope?: string;
+  token_type?: string;
+}
+
+interface Enterprise {
+  id?: string;
+  name?: string;
+}
+
+export interface IncomingWebhook {
+  channel?: string;
+  channel_id?: string;
+  configuration_url?: string;
+  url?: string;
+}
+
+type OauthV2AccessResponse = WebAPICallResult & {
+  access_token?: string;
+  app_id?: string;
+  authed_user?: AuthedUser;
+  bot_user_id?: string;
+  enterprise?: Enterprise;
+  error?: string;
+  expires_in?: number;
+  incoming_webhook?: IncomingWebhook;
+  is_enterprise_install?: boolean;
+  needed?: string;
+  ok?: boolean;
+  provided?: string;
+  refresh_token?: string;
+  scope?: string;
+  team?: Enterprise;
+  token_type?: string;
+  warning?: string;
+};
+
 export type PostUserRequest = Omit<
   Partial<User>,
   'lastSeenTime' | 'createdAt' | 'updatedAt'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@notificationapi/core",
-  "version": "0.0.17",
+  "version": "1.0.0",
   "type": "module",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",