Merge pull request #97 from vodyani/beta

Beta

Author: ChoGathK

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [8.6.6-beta.1](https://github.com/vodyani/core/compare/v8.6.5...v8.6.6-beta.1) (2022-09-02)
+
+
+### Bug Fixes
+
+* centralize common top-level interfaces ([0b20742](https://github.com/vodyani/core/commit/0b207424e320aa7093ef2ee7afad8c6b92d4c530))
+
 ## [8.6.5](https://github.com/vodyani/core/compare/v8.6.4...v8.6.5) (2022-09-01)
 
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@vodyani/core",
   "license": "MIT",
-  "version": "8.6.5",
+  "version": "8.6.6-beta.1",
   "author": "ChoGathK",
   "description": "👩🏻‍🚀 core is the top-level design package for vodyani scaffolding, providing a single responsibility module registrar for the different tiers.",
   "homepage": "https://github.com/vodyani/core#readme",

package.json

@@ -1,2 +1,2 @@
-export * from './declare';
 export * from './interface';
+export * from './declare';

src/common/index.ts

@@ -0,0 +1,17 @@
+import { FactoryProvider } from '../declare';
+
+/**
+ * Asynchronous provider factory for creating
+ *
+ * @see: [factory provider objects](https://docs.nestjs.com/fundamentals/custom-providers#factory-providers-usefactory)
+ */
+export interface AsyncProviderFactory {
+  /**
+   * Create a factory provider by specifying the creation parameters externally.
+   *
+   * @returns FactoryProvider
+   *
+   * @publicApi
+   */
+  create: (...args: any[]) => FactoryProvider;
+}

src/common/interface/async-provider.ts

@@ -0,0 +1,19 @@
+export interface Client<T = any> {
+  getInstance: () => T;
+  close: (...args: any[]) => void;
+}
+
+export interface AsyncClient<T = any> {
+  getInstance: () => T;
+  close: (...args: any[]) => Promise<void>;
+}
+
+export interface ClientAdapter<T = any, O = any> {
+  getClient: (key: string) => Client<T>;
+  create: (options: O) => Client<T>;
+}
+
+export interface AsyncClientAdapter<T = any, O = any> {
+  getClient: (key: string) => AsyncClient<T>;
+  create: (options: O) => Promise<AsyncClient<T>>;
+}

src/common/interface/client.ts

@@ -0,0 +1,4 @@
+export * from './async-provider';
+export * from './client';
+export * from './module';
+export * from './remote-config';

src/common/interface/index.ts

@@ -1,4 +1,4 @@
-import { FactoryProvider, ModuleMetadata } from './declare';
+import { ModuleMetadata } from '../declare';
 
 /**
  * Infrastructure module registration options.
@@ -88,18 +88,3 @@ export interface ContainerRegisterOptions {
    */
   aop?: ModuleMetadata['providers'];
 }
-/**
- * Asynchronous provider factory for creating
- *
- * @see: [factory provider objects](https://docs.nestjs.com/fundamentals/custom-providers#factory-providers-usefactory)
- */
-export interface AsyncProviderFactory {
-  /**
-   * Create a factory provider by specifying the creation parameters externally.
-   *
-   * @returns FactoryProvider
-   *
-   * @publicApi
-   */
-  create: (...args: any[]) => FactoryProvider;
-}

src/common/interface.ts src/common/interface/module.tssrc/common/interface.ts renamed to src/common/interface/module.ts

@@ -0,0 +1,11 @@
+export interface RemoteConfigClient {
+  init: (...args: any[]) => Promise<any>;
+  close: (...args: any[]) => Promise<void>;
+  sync: (...args: any[]) => Promise<any>;
+  subscribe?: (key: string, callback: (value: any) => any) => Promise<void>;
+}
+
+export interface RemoteConfigInfo<T = any> {
+  key: string;
+  value?: T;
+}