feat(config): add type guard for if the config object can be written …

…to (#2183)
linz · May 10, 2022 · 0a00e0e · 0a00e0e
1 parent 76b6175
commit 0a00e0e
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 1 deletion.
diff --git a/packages/config/src/base.config.ts b/packages/config/src/base.config.ts
@@ -89,6 +89,20 @@ export abstract class BasemapsConfigObject<T extends BaseConfig> {
   constructor(prefix: ConfigPrefix) {
     this.prefix = prefix;
   }
+
+  /**
+   * Can this config object be written to with this.put()
+   * @example
+   * ```typescript
+   * if (this.isWriteable()) return this.put(obj)
+   * ```
+   *
+   * @returns true if writeable false otherwise
+   */
+  isWriteable(): this is BaseConfigWriteableObject<T> {
+    return false;
+  }
+
   /** Create a prefixed id for a object */
   id(name: string): string {
     if (name.startsWith(`${this.prefix}_`)) return name;
@@ -105,4 +119,8 @@ export abstract class BasemapsConfigObject<T extends BaseConfig> {
   abstract getAll(id: Set<string>): Promise<Map<string, T>>;
 }
 
+export interface BaseConfigWriteableObject<T extends BaseConfig> extends BasemapsConfigObject<T> {
+  put(record: T): Promise<string>;
+}
+
 export const Config = new ConfigInstance();
diff --git a/packages/config/src/dynamo/__tests__/config.imagery.test.ts b/packages/config/src/dynamo/__tests__/config.imagery.test.ts
@@ -28,6 +28,12 @@ o.spec('ConfigProvider.Imagery', () => {
 
   const item: ConfigImagery = { id: 'im_foo', name: 'abc' } as any;
 
+  o('isWriteable', () => {
+    o(provider.Imagery.isWriteable()).equals(true);
+    // Validate the typing works
+    if (Config.Imagery.isWriteable()) o(typeof Config.Imagery.put).equals('function');
+  });
+
   o('prefix', () => {
     o(Config.prefix(ConfigPrefix.Imagery, '1234')).equals('im_1234');
     o(Config.prefix(ConfigPrefix.Imagery, 'im_1234')).equals('im_1234');

diff --git a/packages/config/src/dynamo/dynamo.config.base.ts b/packages/config/src/dynamo/dynamo.config.base.ts
@@ -1,5 +1,5 @@
 import DynamoDB from 'aws-sdk/clients/dynamodb.js';
-import { BasemapsConfigObject } from '../base.config.js';
+import { BaseConfigWriteableObject, BasemapsConfigObject } from '../base.config.js';
 import { BaseConfig } from '../config/base.js';
 import { ConfigPrefix } from '../config/prefix.js';
 import { ConfigProviderDynamo } from './dynamo.config.js';
@@ -20,6 +20,10 @@ export class ConfigDynamoBase<T extends BaseConfig = BaseConfig> extends Basemap
     return this.cfg.dynamo;
   }
 
+  isWriteable(): this is BaseConfigWriteableObject<T> {
+    return true;
+  }
+
   clone(rec: T): T {
     return DynamoDB.Converter.unmarshall(DynamoDB.Converter.marshall(rec)) as T;
   }