refactor: Use AccountStore interfaces from CSS

Author: joachimvh

packages/css/package.json

@@ -67,7 +67,7 @@
     "demo:start": "yarn run community-solid-server -m . -c ./config/demo.json -f ./tmp -a http://localhost:4000/ -l debug"
   },
   "dependencies": {
-    "@solid/community-server": "^7.1.6",
+    "@solid/community-server": "^7.1.7",
     "@solidlab/derived-resources-component": "^1.0.2",
     "@solidlab/uma": "workspace:^",
     "@types/n3": "^1.16.4",

packages/css/src/identity/interaction/account/util/AccountSettings.ts

@@ -0,0 +1,31 @@
+import { ACCOUNT_SETTINGS_REMEMBER_LOGIN } from '@solid/community-server';
+
+/**
+ * Settings parameter containing the URL of the user's Authorization Server.
+ */
+export const ACCOUNT_SETTINGS_AUTHZ_SERVER = 'authzServer';
+
+/**
+ * Settings parameter containing the Personal Access Token (PAT) of the user at their AS.
+ */
+export const ACCOUNT_SETTINGS_AS_TOKEN = 'asToken';
+
+/**
+ * Settings parameter containing the private key of the user.
+ */
+export const ACCOUNT_SETTINGS_KEYS = 'keys';
+
+export const UMA_ACCOUNT_STORAGE_DESCRIPTION = {
+  [ACCOUNT_SETTINGS_REMEMBER_LOGIN]: 'boolean?',
+  [ACCOUNT_SETTINGS_AUTHZ_SERVER]: 'string?',
+  [ACCOUNT_SETTINGS_AS_TOKEN]: 'string?',
+  [ACCOUNT_SETTINGS_KEYS]: 'string[]?',
+} as const;
+
+// Duplication but needed to get around Components.js limitations
+export type UMA_ACCOUNT_STORAGE_TYPE = {
+  [ACCOUNT_SETTINGS_REMEMBER_LOGIN]: 'boolean?',
+  [ACCOUNT_SETTINGS_AUTHZ_SERVER]: 'string?',
+  [ACCOUNT_SETTINGS_AS_TOKEN]: 'string?',
+  [ACCOUNT_SETTINGS_KEYS]: 'string[]?',
+}

packages/css/src/identity/interaction/account/util/AccountStore.ts

@@ -1,63 +1,12 @@
-
-import { Initializer, getLoggerFor, createErrorMessage, InternalServerError } from '@solid/community-server';
-import { AccountLoginStorage, ACCOUNT_TYPE } from './LoginStorage';
-import { ACCOUNT_SETTINGS_AS_TOKEN, ACCOUNT_SETTINGS_AUTHZ_SERVER, ACCOUNT_SETTINGS_KEYS,
-  ACCOUNT_SETTINGS_REMEMBER_LOGIN, AccountSettings, AccountStore } from './AccountStore';
-import { ValueType } from '../../../../storage/keyvalue/IndexedStorage';
-
-export const ACCOUNT_STORAGE_DESCRIPTION = {
-  [ACCOUNT_SETTINGS_REMEMBER_LOGIN]: 'boolean?',
-  [ACCOUNT_SETTINGS_AUTHZ_SERVER]: 'string?',
-  [ACCOUNT_SETTINGS_AS_TOKEN]: 'string?',
-  [ACCOUNT_SETTINGS_KEYS]: 'string[]?',
-} as const;
+import { AccountLoginStorage, AccountStore, GenericAccountStore } from '@solid/community-server';
+import { UMA_ACCOUNT_STORAGE_DESCRIPTION, UMA_ACCOUNT_STORAGE_TYPE } from './AccountSettings';
 
 /**
  * A {@link AccountStore} that uses an {@link AccountLoginStorage} to keep track of the accounts.
  * Needs to be initialized before it can be used.
  */
-export class UmaAccountStore extends Initializer implements AccountStore {
-  private readonly logger = getLoggerFor(this);
-
-  private readonly storage: AccountLoginStorage<{ [ACCOUNT_TYPE]: typeof ACCOUNT_STORAGE_DESCRIPTION }>;
-  private initialized = false;
-
-  public constructor(storage: AccountLoginStorage<any>) {
-    super();
-    this.storage = storage as typeof this.storage;
-  }
-
-  // Initialize the type definitions
-  public async handle(): Promise<void> {
-    if (this.initialized) {
-      return;
-    }
-    try {
-      await this.storage.defineType(ACCOUNT_TYPE, ACCOUNT_STORAGE_DESCRIPTION, false);
-      this.initialized = true;
-    } catch (cause: unknown) {
-      throw new InternalServerError(`Error defining account in storage: ${createErrorMessage(cause)}`, { cause });
-    }
-  }
-
-  public async create(): Promise<string> {
-    const { id } = await this.storage.create(ACCOUNT_TYPE, {});
-    this.logger.debug(`Created new account ${id}`);
-
-    return id;
-  }
-
-  public async getSetting<T extends keyof AccountSettings>(id: string, setting: T): Promise<AccountSettings[T]> {
-    const account = await this.storage.get(ACCOUNT_TYPE, id);
-    if (!account) {
-      return;
-    }
-    const { id: unused, ...settings } = account;
-    return settings[setting];
-  }
-
-  public async updateSetting<T extends keyof AccountSettings>(id: string, setting: T, value: AccountSettings[T]):
-  Promise<void> {
-    await this.storage.setField(ACCOUNT_TYPE, id, setting, value as ValueType<typeof ACCOUNT_STORAGE_DESCRIPTION[T]>);
+export class UmaAccountStore extends GenericAccountStore<UMA_ACCOUNT_STORAGE_TYPE> {
+  public constructor(storage: AccountLoginStorage<Record<string, never>>) {
+    super(storage, UMA_ACCOUNT_STORAGE_DESCRIPTION);
   }
 }

packages/css/src/identity/interaction/account/util/LoginStorage.ts

@@ -5,11 +5,7 @@ export * from './authorization/UmaPermissionReader';
 
 export * from './http/output/metadata/UmaTicketMetadataWriter';
 
-// export * from './identity/configuration/JwksKeyHolder';
-// export * from './identity/configuration/InMemoryJwksKeyHolder';
-
-export * from './identity/interaction/account/util/AccountStore';
-export * from './identity/interaction/account/util/LoginStorage';
+export * from './identity/interaction/account/util/AccountSettings';
 export * from './identity/interaction/account/util/UmaAccountStore';
 
 export * from './init/UmaSeededAccountInitializer';
@@ -18,8 +14,6 @@ export * from './server/description/AccountSettingsStorageDescriber';
 
 export * from './server/middleware/JwksHandler';
 
-export * from './storage/keyvalue/IndexedStorage';
-
 export * from './uma/ResourceRegistrar';
 export * from './uma/UmaClient';
 

packages/css/src/identity/interaction/account/util/UmaAccountStore.ts

@@ -1,9 +1,19 @@
+import {
+  AccountStore,
+  createErrorMessage,
+  getLoggerFor,
+  Initializer,
+  PasswordStore,
+  PodCreator,
+  URL_SCHEMA
+} from '@solid/community-server';
 import { readJson } from 'fs-extra';
 import { array, object, string } from 'yup';
-import { PasswordStore, PodCreator, URL_SCHEMA, getLoggerFor,
-  createErrorMessage, Initializer} from '@solid/community-server';
-import { ACCOUNT_SETTINGS_AUTHZ_SERVER, ACCOUNT_SETTINGS_KEYS,
-  type AccountStore } from '../identity/interaction/account/util/AccountStore'
+import {
+  ACCOUNT_SETTINGS_AUTHZ_SERVER,
+  ACCOUNT_SETTINGS_KEYS,
+  UMA_ACCOUNT_STORAGE_TYPE
+} from '../identity/interaction/account/util/AccountSettings';
 
 const inSchema = array().of(object({
   email: string().trim().email().lowercase().required(),
@@ -24,7 +34,7 @@ export interface SeededAccountInitializerArgs {
   /**
    * Creates the accounts.
    */
-  accountStore: AccountStore;
+  accountStore: AccountStore<UMA_ACCOUNT_STORAGE_TYPE>;
   /**
    * Adds the login methods.
    */
@@ -47,7 +57,7 @@ export interface SeededAccountInitializerArgs {
 export class UmaSeededAccountInitializer extends Initializer {
   protected readonly logger = getLoggerFor(this);
 
-  private readonly accountStore: AccountStore;
+  private readonly accountStore: AccountStore<UMA_ACCOUNT_STORAGE_TYPE>;
   private readonly passwordStore: PasswordStore;
   private readonly podCreator: PodCreator;
   private readonly configFilePath?: string;

packages/css/src/index.ts

@@ -1,16 +1,15 @@
 import type { NamedNode, Quad, Quad_Object, Term } from '@rdfjs/types';
+import type { AccountSettings, AccountStore, PodStore, ResourceIdentifier } from '@solid/community-server';
+import { StorageDescriber } from '@solid/community-server';
 import { DataFactory } from 'n3';
 import { stringToTerm } from 'rdf-string';
-import type { PodStore, ResourceIdentifier } from '@solid/community-server';
-import { StorageDescriber } from '@solid/community-server';
-import quad = DataFactory.quad;
 import namedNode = DataFactory.namedNode;
-import type { AccountStore, AccountSettings } from '../../identity/interaction/account/util/AccountStore';
+import quad = DataFactory.quad;
 
 /**
  * Adds triples to the storage description resource, based on the settings of
- * the account that created the storage. 
- * 
+ * the account that created the storage.
+ *
  * The resource identifier of the storage is used as subject.
  */
 export class AccountSettingsStorageDescriber extends StorageDescriber {
@@ -22,15 +21,15 @@ export class AccountSettingsStorageDescriber extends StorageDescriber {
     terms: Record<string, keyof AccountSettings>,
   ) {
     super();
-    
+
     const termMap = new Map<NamedNode, keyof AccountSettings>();
     for (const [ predicate, settingsKey ] of Object.entries(terms)) {
-    
+
       const predTerm = stringToTerm(predicate);
       if (predTerm.termType !== 'NamedNode') {
         throw new Error('Predicate needs to be a named node.');
       }
-      
+
       termMap.set(predTerm, settingsKey);
     }
 
@@ -51,7 +50,7 @@ export class AccountSettingsStorageDescriber extends StorageDescriber {
   }
 
   private async* generateTriples(subject: NamedNode, account: string): AsyncGenerator<Quad> {
-    
+
     for (const [ predicate, settingsKey ] of this.terms.entries()) {
 
       const settingsValue = await this.accountStore.getSetting(account, settingsKey);