javascript-sdks/packages/javascript/src/StorageManager.ts at main · thunder-id/javascript-sdks · GitHub

History

350 lines (280 loc) · 12.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

// SPDX-License-Identifier: Apache-2.0

import {AuthClientConfig} from './models/config';

import {OIDCDiscoveryApiResponse} from './models/oidc-discovery';

import {SessionData} from './models/session';

import {Stores, Storage, TemporaryStore, HybridStore, TemporaryStoreValue} from './models/store';

import VendorConstants from './constants/VendorConstants';

import logger from './utils/logger';

type PartialData<T> = Partial<

AuthClientConfig<T> | OIDCDiscoveryApiResponse | SessionData | TemporaryStore | HybridStore

class StorageManager<T> {

protected id: string;

protected store: Storage;

protected vendor: string;

public constructor(instanceID: string, store: Storage, vendor: string = VendorConstants.VENDOR_PREFIX) {

this.id = instanceID;

this.store = store;

this.vendor = vendor;

}

protected async setDataInBulk(key: string, data: PartialData<T>): Promise<void> {

const existingDataJSON: string = (await this.store.getData(key)) ?? null;

const existingData: PartialData<T> = existingDataJSON && JSON.parse(existingDataJSON);

const dataToBeSaved: PartialData<T> = {...existingData, ...data};

const dataToBeSavedJSON: string = JSON.stringify(dataToBeSaved);

await this.store.setData(key, dataToBeSavedJSON);

}

protected async setValue(

key: string,

attribute: keyof AuthClientConfig<T> | keyof OIDCDiscoveryApiResponse | keyof SessionData | keyof TemporaryStore,

value: TemporaryStoreValue,

): Promise<void> {

const existingDataJSON: string = (await this.store.getData(key)) ?? null;

const existingData: PartialData<T> = existingDataJSON && JSON.parse(existingDataJSON);

const dataToBeSaved: PartialData<T> = {...existingData, [attribute]: value};

const dataToBeSavedJSON: string = JSON.stringify(dataToBeSaved);

await this.store.setData(key, dataToBeSavedJSON);

}

protected async removeValue(

key: string,

attribute: keyof AuthClientConfig<T> | keyof OIDCDiscoveryApiResponse | keyof SessionData | keyof TemporaryStore,

): Promise<void> {

const existingDataJSON: string = (await this.store.getData(key)) ?? null;

const existingData: PartialData<T> = existingDataJSON && JSON.parse(existingDataJSON);

const dataToBeSaved: PartialData<T> = {...existingData};

delete dataToBeSaved[attribute];

const dataToBeSavedJSON: string = JSON.stringify(dataToBeSaved);

await this.store.setData(key, dataToBeSavedJSON);

}

protected resolveKey(store: Stores | string, userId?: string, instanceId?: string): string {

if (userId && instanceId) {

return `${store}-${instanceId}-${userId}`;

}

if (userId) {

return `${store}-${this.id}-${userId}`;

}

if (instanceId) {

return `${store}-${instanceId}`;

}

return `${store}-${this.id}`;

}

protected static isLocalStorageAvailable(): boolean {

try {

const testValue = '__AUTH_SDK_STORAGE_TEST__';

localStorage.setItem(testValue, testValue);

localStorage.removeItem(testValue);

return true;

} catch (error) {

return false;

}

public async setConfigData(config: Partial<AuthClientConfig<T>>): Promise<void> {

await this.setDataInBulk(this.resolveKey(Stores.ConfigData), config);

}

public async setOIDCProviderMetaData(oidcProviderMetaData: Partial<OIDCDiscoveryApiResponse>): Promise<void> {

this.setDataInBulk(this.resolveKey(Stores.OIDCProviderMetaData), oidcProviderMetaData);

}

public async setTemporaryData(temporaryData: Partial<TemporaryStore>, userId?: string): Promise<void> {

await this.setDataInBulk(this.resolveKey(Stores.TemporaryData, userId), temporaryData);

}

public async setHybridData(hybridData: Partial<HybridStore>, userId?: string): Promise<void> {

const resolvedKey = this.resolveKey(Stores.HybridData, userId);

if (StorageManager.isLocalStorageAvailable()) {

const existingDataJSON = localStorage.getItem(resolvedKey);

const existingData: Partial<HybridStore> = existingDataJSON ? JSON.parse(existingDataJSON) : {};

const dataToBeSaved = {...existingData, ...hybridData};

localStorage.setItem(resolvedKey, JSON.stringify(dataToBeSaved));

} else {

await this.setDataInBulk(resolvedKey, hybridData);

}

public async setSessionData(sessionData: Partial<SessionData>, userId?: string): Promise<void> {

this.setDataInBulk(this.resolveKey(Stores.SessionData, userId), sessionData);

}

public async setCustomData<K>(key: string, customData: Partial<K>, userId?: string): Promise<void> {

this.setDataInBulk(this.resolveKey(key, userId), customData);

}

public async getConfigData(userId?: string): Promise<AuthClientConfig<T>> {

return JSON.parse((await this.store.getData(this.resolveKey(Stores.ConfigData, userId))) ?? null);

}

public async loadOpenIDProviderConfiguration(): Promise<OIDCDiscoveryApiResponse> {

return JSON.parse((await this.store.getData(this.resolveKey(Stores.OIDCProviderMetaData))) ?? null);

}

public async getTemporaryData(userId?: string): Promise<TemporaryStore> {

const data: string = await this.store.getData(this.resolveKey(Stores.TemporaryData, userId));

if (data) {

try {

return JSON.parse(data);

} catch (error) {

logger.error(

`StorageManager: Failed to parse temporary data for key ${this.resolveKey(Stores.TemporaryData, userId)}`,

error,

);

return {};

}

return {};

}

public async getHybridData(userId?: string): Promise<HybridStore> {

const resolvedKey = this.resolveKey(Stores.HybridData, userId);

if (StorageManager.isLocalStorageAvailable()) {

const storeDataJSON = localStorage.getItem(resolvedKey);

if (storeDataJSON) {

try {

return JSON.parse(storeDataJSON);

} catch (error) {

logger.error(`StorageManager: Failed to parse hybrid data from local storage for key ${resolvedKey}`, error);

return {};

}

return {};

}

const storeDataJSON: string | null = (await this.store.getData(resolvedKey)) ?? null;

if (storeDataJSON) {

try {

return JSON.parse(storeDataJSON);

} catch (error) {

logger.error(`StorageManager: Failed to parse hybrid data from store for key ${resolvedKey}`, error);

return {};

}

return {};

}

public async getPersistedData(userId?: string): Promise<TemporaryStore> {

return JSON.parse((await this.store.getData(this.resolveKey(Stores.PersistedData, userId))) ?? null);

}

public async setPersistedData(persistedData: Partial<TemporaryStore>, userId?: string): Promise<void> {

this.setDataInBulk(this.resolveKey(Stores.PersistedData, userId), persistedData);

}

public async getSessionData(userId?: string, instanceId?: string): Promise<SessionData> {

return JSON.parse((await this.store.getData(this.resolveKey(Stores.SessionData, userId, instanceId))) ?? null);

}

public async getCustomData<K>(key: string, userId?: string): Promise<K> {

return JSON.parse((await this.store.getData(this.resolveKey(key, userId))) ?? null);

}

public setSessionStatus(status: string): void {

// Using local storage to store the session status as it is required to be available across tabs.

if (StorageManager.isLocalStorageAvailable()) {

localStorage.setItem(`${this.vendor}-session-active`, status);

}

public getSessionStatus(): string {

return StorageManager.isLocalStorageAvailable()

? (localStorage.getItem(`${this.vendor}-session-active`) ?? '')

: '';

}

public removeSessionStatus(): void {

if (StorageManager.isLocalStorageAvailable()) {

localStorage.removeItem(`${this.vendor}-session-active`);

}

public async removeConfigData(): Promise<void> {

await this.store.removeData(this.resolveKey(Stores.ConfigData));

}

public async removeOIDCProviderMetaData(): Promise<void> {

await this.store.removeData(this.resolveKey(Stores.OIDCProviderMetaData));

}

public async removeTemporaryData(userId?: string): Promise<void> {

await this.store.removeData(this.resolveKey(Stores.TemporaryData, userId));

}

public async removeHybridData(userId?: string): Promise<void> {

const resolvedKey = this.resolveKey(Stores.HybridData, userId);

if (StorageManager.isLocalStorageAvailable()) {

localStorage.removeItem(resolvedKey);

} else {

await this.store.removeData(resolvedKey);

}

public async removeSessionData(userId?: string): Promise<void> {

await this.store.removeData(this.resolveKey(Stores.SessionData, userId));

}

public async getConfigDataParameter(key: keyof AuthClientConfig<T>): Promise<TemporaryStoreValue> {

const data: string = await this.store.getData(this.resolveKey(Stores.ConfigData));

return data && JSON.parse(data)[key];

}

public async getOIDCProviderMetaDataParameter(key: keyof OIDCDiscoveryApiResponse): Promise<TemporaryStoreValue> {

const data: string = await this.store.getData(this.resolveKey(Stores.OIDCProviderMetaData));

return data && JSON.parse(data)[key];

}

public async getTemporaryDataParameter(key: keyof TemporaryStore, userId?: string): Promise<TemporaryStoreValue> {

const data: string = await this.store.getData(this.resolveKey(Stores.TemporaryData, userId));

return data && JSON.parse(data)[key];

}

public async getHybridDataParameter(key: keyof HybridStore, userId?: string): Promise<TemporaryStoreValue> {

const resolvedKey = this.resolveKey(Stores.HybridData, userId);

if (StorageManager.isLocalStorageAvailable()) {

const existingDataJSON = localStorage.getItem(resolvedKey);

const existingData = existingDataJSON ? JSON.parse(existingDataJSON) : {};

return existingData[key];

}

const data: string = await this.store.getData(resolvedKey);

return data && JSON.parse(data)[key];

}

public async getSessionDataParameter(key: keyof SessionData, userId?: string): Promise<TemporaryStoreValue> {

const data: string = await this.store.getData(this.resolveKey(Stores.SessionData, userId));

return data && JSON.parse(data)[key];

}

public async setConfigDataParameter(key: keyof AuthClientConfig<T>, value: TemporaryStoreValue): Promise<void> {

await this.setValue(this.resolveKey(Stores.ConfigData), key, value);

}

public async setOIDCProviderMetaDataParameter(

key: keyof OIDCDiscoveryApiResponse,

value: TemporaryStoreValue,

): Promise<void> {

await this.setValue(this.resolveKey(Stores.OIDCProviderMetaData), key, value);

}

public async setTemporaryDataParameter(

key: keyof TemporaryStore,

value: TemporaryStoreValue,

userId?: string,

): Promise<void> {

await this.setValue(this.resolveKey(Stores.TemporaryData, userId), key, value);

}

public async setHybridDataParameter(

key: keyof HybridStore,

value: TemporaryStoreValue,

userId?: string,

): Promise<void> {

const resolvedKey = this.resolveKey(Stores.HybridData, userId);

if (StorageManager.isLocalStorageAvailable()) {

const existingDataJSON = localStorage.getItem(resolvedKey);

const existingData = existingDataJSON ? JSON.parse(existingDataJSON) : {};

const dataToBeSaved = {...existingData, [key]: value};

localStorage.setItem(resolvedKey, JSON.stringify(dataToBeSaved));

} else {

await this.setValue(resolvedKey, key, value);

}

public async setSessionDataParameter(

key: keyof SessionData,

value: TemporaryStoreValue,

userId?: string,

): Promise<void> {

await this.setValue(this.resolveKey(Stores.SessionData, userId), key, value);

}

public async removeConfigDataParameter(key: keyof AuthClientConfig<T>): Promise<void> {

await this.removeValue(this.resolveKey(Stores.ConfigData), key);

}

public async removeOIDCProviderMetaDataParameter(key: keyof OIDCDiscoveryApiResponse): Promise<void> {

await this.removeValue(this.resolveKey(Stores.OIDCProviderMetaData), key);

}

public async removeTemporaryDataParameter(key: keyof TemporaryStore, userId?: string): Promise<void> {

await this.removeValue(this.resolveKey(Stores.TemporaryData, userId), key);

}

public async removeHybridDataParameter(key: keyof HybridStore, userId?: string): Promise<void> {

const resolvedKey = this.resolveKey(Stores.HybridData, userId);

if (StorageManager.isLocalStorageAvailable()) {

const existingDataJSON = localStorage.getItem(resolvedKey);

const existingData = existingDataJSON ? JSON.parse(existingDataJSON) : {};

delete existingData[key];

localStorage.setItem(resolvedKey, JSON.stringify(existingData));

} else {

await this.removeValue(resolvedKey, key);

}

public async removeSessionDataParameter(key: keyof SessionData, userId?: string): Promise<void> {

await this.removeValue(this.resolveKey(Stores.SessionData, userId), key);

}

export default StorageManager;

javascript-sdks/packages/javascript/src/StorageManager.ts at main · thunder-id/javascript-sdks · GitHub

Uh oh!

Expand file tree

Breadcrumbs

StorageManager.ts

Latest commit

History

Breadcrumbs

StorageManager.ts

File metadata and controls