@sqb/nestjs 4.10.0 → 4.10.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sqb/nestjs",
   "description": "Nestjs module for data connection using SQB",
-  "version": "4.10.0",
+  "version": "4.10.2",
   "author": "Panates",
   "contributors": [
     "Eray Hanoglu <e.hanoglu@panates.com>",
@@ -47,8 +47,8 @@
   "peerDependencies": {
     "@nestjs/common": ">=7.4.0",
     "@nestjs/core": ">=7.4.0",
-    "@sqb/builder": "^4.10.0",
-    "@sqb/connect": "^4.10.0",
+    "@sqb/builder": "^4.10.2",
+    "@sqb/connect": "^4.10.2",
     "rxjs": ">=6.6.0"
   },
   "engines": {
@@ -59,6 +59,7 @@
     "bin/",
     "cjs/",
     "esm/",
+    "types/",
     "LICENSE",
     "README.md"
   ],

package/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './sqb.decorators.js';
+export * from './sqb.interface.js';
+export * from './sqb.module.js';
+export * from './sqb.utils.js';
+export { SqbClient } from '@sqb/connect';

package/types/sqb-core.module.d.ts

@@ -0,0 +1,14 @@
+import { DynamicModule, OnApplicationShutdown } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { SqbModuleAsyncOptions, SqbModuleOptions } from './sqb.interface.js';
+export declare class SqbCoreModule implements OnApplicationShutdown {
+    private readonly options;
+    private readonly moduleRef;
+    constructor(options: SqbModuleOptions, moduleRef: ModuleRef);
+    static forRoot(options?: SqbModuleOptions): DynamicModule;
+    static forRootAsync(options: SqbModuleAsyncOptions): DynamicModule;
+    onApplicationShutdown(): Promise<void>;
+    private static createAsyncProviders;
+    private static createAsyncOptionsProvider;
+    private static createConnection;
+}

package/types/sqb.constants.d.ts

@@ -0,0 +1,2 @@
+export declare const SQB_MODULE_OPTIONS: unique symbol;
+export declare const SQB_MODULE_ID: unique symbol;

package/types/sqb.decorators.d.ts

@@ -0,0 +1 @@
+export declare const InjectSQB: (name?: string) => ParameterDecorator;

package/types/sqb.interface.d.ts

@@ -0,0 +1,50 @@
+import { Type } from '@nestjs/common';
+import { ModuleMetadata } from '@nestjs/common/interfaces';
+import { ClientConfiguration } from '@sqb/connect';
+export type SqbModuleOptions = {
+    /**
+     * Connection name
+     */
+    name?: string;
+    /**
+     * Number of times to retry connecting
+     * Default: 10
+     */
+    retryAttempts?: number;
+    /**
+     * Delay between connection retry attempts (ms)
+     * Default: 3000
+     */
+    retryDelay?: number;
+    /**
+     * Function that determines whether the module should
+     * attempt to connect upon failure.
+     *
+     * @param err error that was thrown
+     * @returns whether to retry connection or not
+     */
+    toRetry?: (err: any) => boolean;
+    /**
+     * If `true`, connection will not be closed on application shutdown.
+     */
+    keepConnectionAlive?: boolean;
+    /**
+     * If `true`, will show verbose error messages on each connection retry.
+     */
+    verboseRetryLog?: boolean;
+    /**
+     * Number of ms to wait closing connection on shutdown
+     * Default: 10
+     */
+    shutdownWaitMs?: number;
+} & ClientConfiguration;
+export interface SqbOptionsFactory {
+    createSqbOptions(connectionName?: string): Promise<SqbModuleOptions> | SqbModuleOptions;
+}
+export interface SqbModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    name?: string;
+    useExisting?: Type<SqbOptionsFactory>;
+    useClass?: Type<SqbOptionsFactory>;
+    useFactory?: (...args: any[]) => Promise<SqbModuleOptions> | SqbModuleOptions;
+    inject?: any[];
+}

package/types/sqb.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from '@nestjs/common';
+import { SqbModuleAsyncOptions, SqbModuleOptions } from './sqb.interface.js';
+export declare class SqbModule {
+    static forRoot(options?: SqbModuleOptions): DynamicModule;
+    static forRootAsync(options: SqbModuleAsyncOptions): DynamicModule;
+}

package/types/sqb.utils.d.ts

@@ -0,0 +1,11 @@
+import { Observable } from 'rxjs';
+import { Type } from '@nestjs/common';
+import { SqbClient } from '@sqb/connect';
+/**
+ * This function returns a Connection injection token for the given connection name.
+ * @param {string | symbol} [name=SQB_DEFAULT_CONNECTION] This optional parameter is either
+ * a SqbClient, or a ConnectionOptions or a string.
+ * @returns {string | symbol} The Connection injection token.
+ */
+export declare function getSQBToken(name?: string | symbol | Type<SqbClient>): string | symbol | Type<SqbClient>;
+export declare function handleRetry(connectionName?: string | symbol | Type<SqbClient>, retryAttempts?: number, retryDelay?: number, verboseRetryLog?: boolean, toRetry?: (err: any) => boolean): <T>(source: Observable<T>) => Observable<T>;