Merge pull request #46 from ExpressApp/feature/ki/secure-storage

Add client storage methods

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expressms/smartapp-sdk",
-  "version": "1.4.2-alpha.1",
+  "version": "1.5.0-alpha.6",
   "description": "Smartapp SDK",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",

src/index.ts

@@ -1,5 +1,9 @@
 import Bridge from '@expressms/smartapp-bridge'
 import {
+  clientStorageClear,
+  clientStorageGet,
+  clientStorageRemove,
+  clientStorageSet,
   createDeeplink,
   getChats,
   getConnectionStatus,
@@ -62,4 +66,8 @@ export {
   unsubscribeClientEvents,
   createDeeplink,
   openChatMessage,
+  clientStorageGet,
+  clientStorageSet,
+  clientStorageRemove,
+  clientStorageClear,
 }

src/lib/client/index.ts

@@ -2,6 +2,8 @@ import bridge from '@expressms/smartapp-bridge'
 import { EmitterEventPayload } from '@expressms/smartapp-bridge/build/main/types/eventEmitter'
 import { CreateDeeplinkResponse, ERROR_CODES, File, GetConnectionStatusResponse, METHODS } from '../../types'
 export * from './events'
+export * from './storage'
+
 
 const openClientSettings = () => {
   return bridge?.sendClientEvent({

src/lib/client/storage.ts

@@ -0,0 +1,86 @@
+import bridge from '@expressms/smartapp-bridge'
+import { ClientStorageGetResponse, ERROR_CODES, METHODS, StatusResponse, StorageValueType } from '../../types'
+
+/**
+ * Get value for key from client storage
+ * @param key Key
+ * @returns Promise that'll be fullfilled with `payload.value` on success, otherwise rejected with reason
+ */
+const clientStorageGet = ({ key }: { key: string }): Promise<ClientStorageGetResponse> => {
+  if (!bridge) return Promise.reject(ERROR_CODES.NO_BRIDGE)
+
+  return bridge
+    .sendClientEvent({
+      method: METHODS.CLIENT_STORAGE_GET,
+      params: { key },
+    })
+    .then(event => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const { payload }: { payload: any } = event
+
+      const deserializedValue = JSON.parse(payload.value);
+
+      return {
+        ...event,
+        payload: {
+          ...payload,
+          value: deserializedValue,
+        }
+      } as ClientStorageGetResponse
+    })
+}
+
+/**
+ * Save value in client storage
+ * @param key Key
+ * @param value Data to be stored
+ * @returns Promise that'll be fullfilled on success or rejected with reason
+ */
+const clientStorageSet = ({ key, value }: { key: string; value: StorageValueType }): Promise<StatusResponse> => {
+  if (!bridge) return Promise.reject(ERROR_CODES.NO_BRIDGE)
+
+  const serializedValue = JSON.stringify(value)
+
+  return bridge
+    .sendClientEvent({
+      method: METHODS.CLIENT_STORAGE_SET,
+      params: {
+        key,
+        value: serializedValue,
+      },
+    })
+    .then(event => event as StatusResponse)
+}
+
+/**
+ * Remove record from client storage
+ * @param key Key
+ * @returns Promise that'll be fullfilled on success or rejected with reason
+ */
+const clientStorageRemove = ({ key }: { key: string }): Promise<StatusResponse> => {
+  if (!bridge) return Promise.reject(ERROR_CODES.NO_BRIDGE)
+
+  return bridge
+    .sendClientEvent({
+      method: METHODS.CLIENT_STORAGE_REMOVE,
+      params: { key },
+    })
+    .then(event => event as StatusResponse)
+}
+
+/**
+ * Clear all records from client storage
+ * @returns Promise that'll be fullfilled on success or rejected with reason
+ */
+const clientStorageClear = (): Promise<StatusResponse> => {
+  if (!bridge) return Promise.reject(ERROR_CODES.NO_BRIDGE)
+
+  return bridge
+    .sendClientEvent({
+      method: METHODS.CLIENT_STORAGE_CLEAR,
+      params: {},
+    })
+    .then(event => event as StatusResponse)
+}
+
+export { clientStorageGet, clientStorageSet, clientStorageRemove, clientStorageClear }

src/lib/notification/index.ts

@@ -7,6 +7,7 @@ const onNotification = async (handleNotification: Function) => {
     params: {},
   })
 
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   return bridge?.onReceive((event: any) => {
     if (event?.type === METHODS.NOTIFICATION) {
       handleNotification(response)

src/types/bridge.ts

@@ -1,3 +1,6 @@
+import { EmitterEventPayload } from '@expressms/smartapp-bridge/build/main/types/eventEmitter'
+
+
 export enum METHODS {
   READY = 'ready',
   ROUTING_CHANGED = 'routing_changes',
@@ -24,6 +27,10 @@ export enum METHODS {
   GET_CONNECTION_STATUS = 'get_connection_status',
   CREATE_DEEPLINK = 'create_deeplink',
   OPEN_CHAT_MESSAGE = 'open_chat_message',
+  CLIENT_STORAGE_GET = 'client_storage_get',
+  CLIENT_STORAGE_SET = 'client_storage_set',
+  CLIENT_STORAGE_REMOVE = 'client_storage_remove',
+  CLIENT_STORAGE_CLEAR = 'client_storage_clear',
 }
 
 export enum STATUS {
@@ -62,3 +69,10 @@ export interface File {
   fileId: string | null
   key: {} | null
 }
+
+export interface StatusResponse extends EmitterEventPayload {
+  payload: {
+    status: STATUS
+    errorCode?: string | null,
+  }
+}

src/types/index.ts

@@ -2,3 +2,4 @@ export * from "./bridge"
 export * from "./routing"
 export * from "./contacts"
 export * from "./client"
+export * from "./storage"

src/types/storage.ts

@@ -0,0 +1,19 @@
+import { EmitterEventPayload } from '@expressms/smartapp-bridge/build/main/types/eventEmitter'
+import { STATUS } from './bridge'
+
+export enum CLIENT_STORAGE_ERROR_CODES {
+  keyNotFound = 'key_not_found',
+  valueSizeExceeded = 'value_size_exceeded',
+  storageLimitReached = 'storage_limit_reached',
+}
+
+export type StorageValueType = string | number | null | object | boolean | []
+export type StorageErrorType = CLIENT_STORAGE_ERROR_CODES | null
+
+export interface ClientStorageGetResponse extends EmitterEventPayload {
+  payload: {
+    status: STATUS,
+    errorCode?: string | null,
+    value: StorageValueType
+  }
+}