nestjs-web-console 1.0.1 → 1.0.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Murat
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Murat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,66 +1,66 @@
-# STILL IN DEVELOPMENT
-
-# Web Console for NestJS
-*Command from anywhere.*
-
-The goal is to create a simple web interface to run commands on the server.
-   
-## Installation 
-```sh
-npm install nestjs-web-console --save
-yarn add nestjs-web-console
-```
-
-This library is a NestJs module with express dependency so make sure following libs are also installed.
-```sh
-npm install @nestjs/common @nestjs/core express rxjs --save
-yarn add @nestjs/common @nestjs/core express rxjs
-```
-## Usage
-#### Simple usage
-```javascript
-import {Module} from '@nestjs/common';
-import {WebConsoleModule} from "nestjs-web-console";
-
-@Module({
-    imports: [WebConsoleModule.forRoot({
-        endpoint: 'console',
-        options: {
-            name: 'My App',
-            masterPin: 'very-secure-pin'
-        }
-    })]
-})
-export class AppModule {}
-```
-#### Async usage
-```javascript
-import {Module} from '@nestjs/common';
-import {WebConsoleModule} from "nestjs-web-console";
-
-@Module({
-    imports: [WebConsoleModule.forRootAsync({
-        endpoint: 'console',
-        useFactory: (configService: ConfigService) => ({
-            name: configService.get('SERVICE_NAME'),
-            masterPin: configService.get('MASTER_PIN')
-        }),
-        inject: [ConfigService]
-    })]
-})
-export class AppModule {}
-```
-
-To use csv temp files run
-```sh
-npm install csv-express --save
-```
-and in main.ts file
-```javascript
-import 'csv-express';
-```
-
-## Test 
-```sh
-npm run test
-```
+# STILL IN DEVELOPMENT
+
+# Web Console for NestJS
+*Command from anywhere.*
+
+The goal is to create a simple web interface to run commands on the server.
+   
+## Installation 
+```sh
+npm install nestjs-web-console --save
+yarn add nestjs-web-console
+```
+
+This library is a NestJs module with express dependency so make sure following libs are also installed.
+```sh
+npm install @nestjs/common @nestjs/core express rxjs --save
+yarn add @nestjs/common @nestjs/core express rxjs
+```
+## Usage
+#### Simple usage
+```javascript
+import {Module} from '@nestjs/common';
+import {WebConsoleModule} from "nestjs-web-console";
+
+@Module({
+    imports: [WebConsoleModule.forRoot({
+        endpoint: 'console',
+        options: {
+            name: 'My App',
+            masterPin: 'very-secure-pin'
+        }
+    })]
+})
+export class AppModule {}
+```
+#### Async usage
+```javascript
+import {Module} from '@nestjs/common';
+import {WebConsoleModule} from "nestjs-web-console";
+
+@Module({
+    imports: [WebConsoleModule.forRootAsync({
+        endpoint: 'console',
+        useFactory: (configService: ConfigService) => ({
+            name: configService.get('SERVICE_NAME'),
+            masterPin: configService.get('MASTER_PIN')
+        }),
+        inject: [ConfigService]
+    })]
+})
+export class AppModule {}
+```
+
+To use csv temp files run
+```sh
+npm install csv-express --save
+```
+and in main.ts file
+```javascript
+import 'csv-express';
+```
+
+## Test 
+```sh
+npm run test
+```

package/dist/console.types.d.ts

@@ -1,75 +1,75 @@
-import { Type } from "@nestjs/common";
-import { ConsoleCommand } from "./services/processors/base/console.command";
-export interface SessionObject {
-    logs: string;
-    isLogged: boolean;
-    expires: number;
-    running: boolean;
-    readLineCallback?: (input: string) => any;
-    readLineOpts?: ReadLineOptions;
-    cancel?: boolean;
-    onCancel?: () => any;
-    onCancelSignal?: () => any;
-    joinedConnection?: {
-        name: string;
-        version: string;
-        path: string;
-        result: string;
-        running: boolean;
-        readLine: boolean;
-        readLineOpts: ReadLineOptions;
-        onStream: () => any;
-        command: string;
-    };
-}
-export interface ReadLineOptions {
-    secure?: boolean;
-    select?: string[] | string[][];
-    boolean?: boolean | {
-        positive?: string;
-        negative?: string;
-        reverse?: boolean;
-    };
-}
-export interface ReadArgMap {
-    title: string;
-    expect?: RegExp | 'email';
-    expectDesc?: string;
-    opts?: ReadLineOptions;
-    then?: (input: any) => ReadArgMap[] | Promise<ReadArgMap[]>;
-    default?: string;
-}
-export interface ReadArgOptions {
-    confirm: boolean | {
-        skipTable?: boolean;
-        title?: string;
-    };
-}
-export interface ConsoleOptions {
-    name?: string;
-    masterPin: string;
-    guard?: GuardOptions;
-    session?: SessionOptions;
-}
-export interface GuardOptions {
-    enabled?: boolean;
-    maxTries?: number;
-    cooldown?: number;
-}
-export interface SessionOptions {
-    timeout?: number;
-}
-export interface ConsoleModuleAsyncOptions {
-    endpoint?: string;
-    imports?: any;
-    commands?: (Type<ConsoleCommand>)[];
-    inject?: any;
-    useFactory: (...args: any[]) => Promise<ConsoleOptions> | ConsoleOptions;
-}
-export interface ConsoleModuleOptions {
-    endpoint?: string;
-    imports?: any;
-    commands?: (Type<ConsoleCommand>)[];
-    options: ConsoleOptions;
-}
-export declare const DEFAULT_OPTIONS: ConsoleOptions;
+import { Type } from "@nestjs/common";
+import { ConsoleCommand } from "./services/processors/base/console.command";
+export interface SessionObject {
+    logs: string;
+    isLogged: boolean;
+    expires: number;
+    running: boolean;
+    readLineCallback?: (input: string) => any;
+    readLineOpts?: ReadLineOptions;
+    cancel?: boolean;
+    onCancel?: () => any;
+    onCancelSignal?: () => any;
+    joinedConnection?: {
+        name: string;
+        version: string;
+        path: string;
+        result: string;
+        running: boolean;
+        readLine: boolean;
+        readLineOpts: ReadLineOptions;
+        onStream: () => any;
+        command: string;
+    };
+}
+export interface ReadLineOptions {
+    secure?: boolean;
+    select?: string[] | string[][];
+    boolean?: boolean | {
+        positive?: string;
+        negative?: string;
+        reverse?: boolean;
+    };
+}
+export interface ReadArgMap {
+    title: string;
+    expect?: RegExp | 'email';
+    expectDesc?: string;
+    opts?: ReadLineOptions;
+    then?: (input: any) => ReadArgMap[] | Promise<ReadArgMap[]>;
+    default?: string;
+}
+export interface ReadArgOptions {
+    confirm: boolean | {
+        skipTable?: boolean;
+        title?: string;
+    };
+}
+export interface ConsoleOptions {
+    name?: string;
+    masterPin: string;
+    guard?: GuardOptions;
+    session?: SessionOptions;
+}
+export interface GuardOptions {
+    enabled?: boolean;
+    maxTries?: number;
+    cooldown?: number;
+}
+export interface SessionOptions {
+    timeout?: number;
+}
+export interface ConsoleModuleAsyncOptions {
+    endpoint?: string;
+    imports?: any;
+    commands?: (Type<ConsoleCommand>)[];
+    inject?: any;
+    useFactory: (...args: any[]) => Promise<ConsoleOptions> | ConsoleOptions;
+}
+export interface ConsoleModuleOptions {
+    endpoint?: string;
+    imports?: any;
+    commands?: (Type<ConsoleCommand>)[];
+    options: ConsoleOptions;
+}
+export declare const DEFAULT_OPTIONS: ConsoleOptions;

package/dist/console.types.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_OPTIONS = void 0;
-exports.DEFAULT_OPTIONS = {
-    masterPin: 'must-set',
-    name: 'NestJs App',
-    guard: {
-        enabled: true,
-        cooldown: 60000 * 5,
-        maxTries: 3
-    },
-    session: {
-        timeout: 24 * 60 * 60000
-    }
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_OPTIONS = void 0;
+exports.DEFAULT_OPTIONS = {
+    masterPin: 'must-set',
+    name: 'NestJs App',
+    guard: {
+        enabled: true,
+        cooldown: 60000 * 5,
+        maxTries: 3
+    },
+    session: {
+        timeout: 24 * 60 * 60000
+    }
+};

package/dist/controllers/web.console.controller.d.ts

@@ -1 +1 @@
-export declare function WebConsoleControllerFactory(endpoint: any): any;
+export declare function WebConsoleControllerFactory(endpoint: any): any;