feat: updated the Metadata type to allow for custom properties (#975)

## This PR - Updates the `Metadata` type to a `Record` so that Providers can provide more than just the `name` property as part of the `metadata`. ### Notes Conversation [here](https://cloud-native.slack.com/archives/C03J36ZP020/p1721747906370629). --------- Signed-off-by: Juan Bernal <[email protected]>
open-feature · Aug 23, 2024 · 16b0d74 · 16b0d74
1 parent 964d65b
commit 16b0d74
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 9 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/shared/src/client/client.ts b/packages/shared/src/client/client.ts
@@ -1,7 +1,6 @@
-import { Metadata } from '../types';
 import { ProviderMetadata } from '../provider/provider';
 
-export interface ClientMetadata extends Metadata {
+export interface ClientMetadata {
   /**
    * @deprecated alias of "domain", use domain instead
    */

diff --git a/packages/shared/src/provider/provider.ts b/packages/shared/src/provider/provider.ts
@@ -82,7 +82,7 @@ export { ClientProviderStatus as AllProviderStatus };
 /**
  * Static data about the provider.
  */
-export interface ProviderMetadata extends Metadata {
+export interface ProviderMetadata extends Readonly<Metadata> {
   readonly name: string;
 }
 
@@ -99,7 +99,7 @@ export interface CommonProvider<S extends ClientProviderStatus | ServerProviderS
   /**
    * @deprecated the SDK now maintains the provider's state; there's no need for providers to implement this field.
    * Returns a representation of the current readiness of the provider.
-   * 
+   *
    * _Providers which do not implement this method are assumed to be ready immediately._
    */
   readonly status?: S;
@@ -125,4 +125,4 @@ export interface CommonProvider<S extends ClientProviderStatus | ServerProviderS
    * @param context
    */
   initialize?(context?: EvaluationContext): Promise<void>;
-}
+}
diff --git a/packages/shared/src/types/metadata.ts b/packages/shared/src/types/metadata.ts
@@ -1,2 +1 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface Metadata {}
+export type Metadata = Record<string, string>;