@open-wa/wa-automate-types-only 4.27.9 → 4.28.0

package/dist/api/model/config.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 import { PREPROCESSORS } from '../../structures/preProcessors';
-import { ConfigLogTransport } from '../../utils/logging';
+import { ConfigLogTransport } from '../../logging/logging';
 import { Base64 } from "./aliases";
 import { SimpleListener } from './events';
 /**

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { create } from './controllers/initializer';
 export * from '@open-wa/wa-decrypt';
 export { ev, Spin } from './controllers/events';
 export * from './utils/tools';
+export * from './logging/logging';
 export * from './structures/preProcessors';
 export * from './connect';
 export * from './build/build-postman';

package/dist/logging/logging.d.ts

@@ -0,0 +1,50 @@
+import * as winston from 'winston';
+/**
+ * You can access the log in your code and add your own custom transports
+ * https://github.com/winstonjs/winston#transports
+ * see [Logger](https://github.com/winstonjs/winston#transports) for more details.
+ *
+ * Here is an example of adding the GCP stackdriver transport:
+ *
+ * ```
+ * import { log } from '@open-wa/wa-automate'
+ * import { LoggingWinston } from '@google-cloud/logging-winston';
+ *
+ * const gcpTransport = new LoggingWinston({
+ *     projectId: 'your-project-id',
+ *     keyFilename: '/path/to/keyfile.json'
+ *   });
+ *
+ * ...
+ * log.add(
+ *  gcpTransport
+ * )
+ *
+ * //Congrats! Now all of your session logs will also go to GCP Stackdriver
+ * ```
+ */
+export declare const log: winston.Logger;
+export declare const addRotateFileLogTransport: (options?: any) => void;
+/**
+ * @private
+ */
+export declare const addSysLogTransport: (options?: any) => void;
+export declare type ConfigLogTransport = {
+    /**
+     * The type of winston transport. At the moment only `file`, `console`, `ev` and `syslog` are supported.
+     */
+    type: 'syslog' | 'console' | 'file' | 'ev';
+    /**
+     * The options for the transport. Generally only required for syslog but you can use this to override default options for other types of transports.
+     */
+    options?: any;
+    /**
+     * If the transport has already been added to the logger. The logging set up command handles this for you.
+     * @readonly
+     */
+    done?: boolean;
+};
+/**
+ * @private
+ */
+export declare const setupLogging: (logging: ConfigLogTransport[], sessionId?: string) => ConfigLogTransport[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-wa/wa-automate-types-only",
-    "version": "4.27.9",
+    "version": "4.28.0",
     "description": "Types generated from the @open-wa/wa-automate package",
     "scripts": {
         "build": "tsc",

package/dist/utils/logging.d.ts

@@ -1,18 +0,0 @@
-import * as winston from 'winston';
-/**
- * You can access the log in your code and add your own custom transports
- */
-export declare const log: winston.Logger;
-export declare const addRotateFileLogTransport: (options?: any) => void;
-export declare type ConfigLogTransport = {
-    /**
-     * The type of winston transport. At the moment only file, console, ev and syslog are supported.
-     */
-    type: 'syslog' | 'console' | 'file' | 'ev';
-    /**
-     * The options for the transport. Generally only required for syslog but you can use this to override default options for other types of transports.
-     */
-    options?: any;
-    done?: boolean;
-};
-export declare const setupLogging: (logging: ConfigLogTransport[], sessionId?: string) => ConfigLogTransport[];