@ar.io/sdk 3.20.0 → 3.21.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -31,6 +31,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
31
31
  */
32
32
  __exportStar(require("./error.js"), exports);
33
33
  __exportStar(require("./logger.js"), exports);
34
+ __exportStar(require("./loggers/winston.js"), exports);
34
35
  __exportStar(require("./ant.js"), exports);
35
36
  __exportStar(require("./ant-registry.js"), exports);
36
37
  __exportStar(require("./ant-versions.js"), exports);
@@ -16,66 +16,68 @@ exports.Logger = void 0;
16
16
  * See the License for the specific language governing permissions and
17
17
  * limitations under the License.
18
18
  */
19
- const winston_1 = require("winston");
20
19
  const version_js_1 = require("../version.js");
21
20
  class Logger {
22
- logger;
23
- silent = false;
21
+ level = 'info';
22
+ levels = {
23
+ debug: 0,
24
+ info: 1,
25
+ warn: 2,
26
+ error: 3,
27
+ none: 999,
28
+ };
24
29
  static default = new Logger();
25
30
  constructor({ level = 'info', } = {}) {
26
- if (level === 'none') {
27
- this.silent = true;
31
+ this.level = level;
32
+ }
33
+ formatMessage(level, message, ...args) {
34
+ const timestamp = new Date().toISOString();
35
+ const meta = {
36
+ timestamp,
37
+ level,
38
+ message,
39
+ name: 'ar-io-sdk',
40
+ version: version_js_1.version,
41
+ };
42
+ if (args.length > 0) {
43
+ return JSON.stringify({ ...meta, args });
28
44
  }
29
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
30
- // @ts-ignore
31
- if (typeof window !== 'undefined') {
32
- this.logger = console;
45
+ return JSON.stringify(meta);
46
+ }
47
+ log(level, message, ...args) {
48
+ if (this.levels[level] < this.levels[this.level]) {
49
+ return;
33
50
  }
34
- else {
35
- this.logger = (0, winston_1.createLogger)({
36
- level,
37
- silent: this.silent,
38
- defaultMeta: {
39
- name: 'ar-io-sdk',
40
- version: version_js_1.version,
41
- },
42
- format: winston_1.format.combine(winston_1.format.timestamp(), winston_1.format.json()),
43
- transports: [
44
- new winston_1.transports.Console({
45
- format: winston_1.format.combine(winston_1.format.timestamp(), winston_1.format.json()),
46
- }),
47
- ],
48
- });
51
+ const formattedMessage = this.formatMessage(level, message, ...args);
52
+ switch (level) {
53
+ case 'debug':
54
+ console.debug(formattedMessage);
55
+ break;
56
+ case 'info':
57
+ console.info(formattedMessage);
58
+ break;
59
+ case 'warn':
60
+ console.warn(formattedMessage);
61
+ break;
62
+ case 'error':
63
+ console.error(formattedMessage);
64
+ break;
49
65
  }
50
66
  }
51
67
  info(message, ...args) {
52
- if (this.silent)
53
- return;
54
- this.logger.info(message, ...args);
68
+ this.log('info', message, ...args);
55
69
  }
56
70
  warn(message, ...args) {
57
- if (this.silent)
58
- return;
59
- this.logger.warn(message, ...args);
71
+ this.log('warn', message, ...args);
60
72
  }
61
73
  error(message, ...args) {
62
- if (this.silent)
63
- return;
64
- this.logger.error(message, ...args);
74
+ this.log('error', message, ...args);
65
75
  }
66
76
  debug(message, ...args) {
67
- if (this.silent)
68
- return;
69
- this.logger.debug(message, ...args);
77
+ this.log('debug', message, ...args);
70
78
  }
71
79
  setLogLevel(level) {
72
- this.silent = level === 'none';
73
- if ('silent' in this.logger) {
74
- this.logger.silent = level === 'none';
75
- }
76
- if ('level' in this.logger) {
77
- this.logger.level = level;
78
- }
80
+ this.level = level;
79
81
  }
80
82
  }
81
83
  exports.Logger = Logger;
@@ -0,0 +1,68 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.WinstonLogger = void 0;
4
+ /**
5
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
6
+ *
7
+ * Licensed under the Apache License, Version 2.0 (the "License");
8
+ * you may not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing, software
14
+ * distributed under the License is distributed on an "AS IS" BASIS,
15
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ * See the License for the specific language governing permissions and
17
+ * limitations under the License.
18
+ */
19
+ const version_js_1 = require("../../version.js");
20
+ class WinstonLogger {
21
+ logger;
22
+ winston;
23
+ constructor({ level = 'info', } = {}) {
24
+ try {
25
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
26
+ this.winston = require('winston');
27
+ }
28
+ catch (error) {
29
+ throw new Error('Winston is not installed. Install it with: npm install winston');
30
+ }
31
+ this.logger = this.winston.createLogger({
32
+ level: level === 'none' ? 'error' : level,
33
+ silent: level === 'none',
34
+ defaultMeta: {
35
+ name: 'ar-io-sdk',
36
+ version: version_js_1.version,
37
+ },
38
+ format: this.winston.format.combine(this.winston.format.timestamp(), this.winston.format.json()),
39
+ transports: [
40
+ new this.winston.transports.Console({
41
+ format: this.winston.format.combine(this.winston.format.timestamp(), this.winston.format.json()),
42
+ }),
43
+ ],
44
+ });
45
+ }
46
+ info(message, ...args) {
47
+ this.logger.info(message, ...args);
48
+ }
49
+ warn(message, ...args) {
50
+ this.logger.warn(message, ...args);
51
+ }
52
+ error(message, ...args) {
53
+ this.logger.error(message, ...args);
54
+ }
55
+ debug(message, ...args) {
56
+ this.logger.debug(message, ...args);
57
+ }
58
+ setLogLevel(level) {
59
+ if (level === 'none') {
60
+ this.logger.silent = true;
61
+ }
62
+ else {
63
+ this.logger.silent = false;
64
+ this.logger.level = level;
65
+ }
66
+ }
67
+ }
68
+ exports.WinstonLogger = WinstonLogger;
@@ -17,4 +17,4 @@
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  exports.version = void 0;
19
19
  // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
20
- exports.version = '3.20.0';
20
+ exports.version = '3.21.0-alpha.1';
@@ -15,6 +15,7 @@
15
15
  */
16
16
  export * from './error.js';
17
17
  export * from './logger.js';
18
+ export * from './loggers/winston.js';
18
19
  export * from './ant.js';
19
20
  export * from './ant-registry.js';
20
21
  export * from './ant-versions.js';
@@ -13,65 +13,67 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { createLogger, format, transports, } from 'winston';
17
16
  import { version } from '../version.js';
18
17
  export class Logger {
19
- logger;
20
- silent = false;
18
+ level = 'info';
19
+ levels = {
20
+ debug: 0,
21
+ info: 1,
22
+ warn: 2,
23
+ error: 3,
24
+ none: 999,
25
+ };
21
26
  static default = new Logger();
22
27
  constructor({ level = 'info', } = {}) {
23
- if (level === 'none') {
24
- this.silent = true;
28
+ this.level = level;
29
+ }
30
+ formatMessage(level, message, ...args) {
31
+ const timestamp = new Date().toISOString();
32
+ const meta = {
33
+ timestamp,
34
+ level,
35
+ message,
36
+ name: 'ar-io-sdk',
37
+ version,
38
+ };
39
+ if (args.length > 0) {
40
+ return JSON.stringify({ ...meta, args });
25
41
  }
26
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
27
- // @ts-ignore
28
- if (typeof window !== 'undefined') {
29
- this.logger = console;
42
+ return JSON.stringify(meta);
43
+ }
44
+ log(level, message, ...args) {
45
+ if (this.levels[level] < this.levels[this.level]) {
46
+ return;
30
47
  }
31
- else {
32
- this.logger = createLogger({
33
- level,
34
- silent: this.silent,
35
- defaultMeta: {
36
- name: 'ar-io-sdk',
37
- version,
38
- },
39
- format: format.combine(format.timestamp(), format.json()),
40
- transports: [
41
- new transports.Console({
42
- format: format.combine(format.timestamp(), format.json()),
43
- }),
44
- ],
45
- });
48
+ const formattedMessage = this.formatMessage(level, message, ...args);
49
+ switch (level) {
50
+ case 'debug':
51
+ console.debug(formattedMessage);
52
+ break;
53
+ case 'info':
54
+ console.info(formattedMessage);
55
+ break;
56
+ case 'warn':
57
+ console.warn(formattedMessage);
58
+ break;
59
+ case 'error':
60
+ console.error(formattedMessage);
61
+ break;
46
62
  }
47
63
  }
48
64
  info(message, ...args) {
49
- if (this.silent)
50
- return;
51
- this.logger.info(message, ...args);
65
+ this.log('info', message, ...args);
52
66
  }
53
67
  warn(message, ...args) {
54
- if (this.silent)
55
- return;
56
- this.logger.warn(message, ...args);
68
+ this.log('warn', message, ...args);
57
69
  }
58
70
  error(message, ...args) {
59
- if (this.silent)
60
- return;
61
- this.logger.error(message, ...args);
71
+ this.log('error', message, ...args);
62
72
  }
63
73
  debug(message, ...args) {
64
- if (this.silent)
65
- return;
66
- this.logger.debug(message, ...args);
74
+ this.log('debug', message, ...args);
67
75
  }
68
76
  setLogLevel(level) {
69
- this.silent = level === 'none';
70
- if ('silent' in this.logger) {
71
- this.logger.silent = level === 'none';
72
- }
73
- if ('level' in this.logger) {
74
- this.logger.level = level;
75
- }
77
+ this.level = level;
76
78
  }
77
79
  }
@@ -0,0 +1,64 @@
1
+ /**
2
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { version } from '../../version.js';
17
+ export class WinstonLogger {
18
+ logger;
19
+ winston;
20
+ constructor({ level = 'info', } = {}) {
21
+ try {
22
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
23
+ this.winston = require('winston');
24
+ }
25
+ catch (error) {
26
+ throw new Error('Winston is not installed. Install it with: npm install winston');
27
+ }
28
+ this.logger = this.winston.createLogger({
29
+ level: level === 'none' ? 'error' : level,
30
+ silent: level === 'none',
31
+ defaultMeta: {
32
+ name: 'ar-io-sdk',
33
+ version,
34
+ },
35
+ format: this.winston.format.combine(this.winston.format.timestamp(), this.winston.format.json()),
36
+ transports: [
37
+ new this.winston.transports.Console({
38
+ format: this.winston.format.combine(this.winston.format.timestamp(), this.winston.format.json()),
39
+ }),
40
+ ],
41
+ });
42
+ }
43
+ info(message, ...args) {
44
+ this.logger.info(message, ...args);
45
+ }
46
+ warn(message, ...args) {
47
+ this.logger.warn(message, ...args);
48
+ }
49
+ error(message, ...args) {
50
+ this.logger.error(message, ...args);
51
+ }
52
+ debug(message, ...args) {
53
+ this.logger.debug(message, ...args);
54
+ }
55
+ setLogLevel(level) {
56
+ if (level === 'none') {
57
+ this.logger.silent = true;
58
+ }
59
+ else {
60
+ this.logger.silent = false;
61
+ this.logger.level = level;
62
+ }
63
+ }
64
+ }
@@ -14,4 +14,4 @@
14
14
  * limitations under the License.
15
15
  */
16
16
  // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
17
- export const version = '3.20.0';
17
+ export const version = '3.21.0-alpha.1';
@@ -15,6 +15,7 @@
15
15
  */
16
16
  export * from './error.js';
17
17
  export * from './logger.js';
18
+ export * from './loggers/winston.js';
18
19
  export * from './ant.js';
19
20
  export * from './ant-registry.js';
20
21
  export * from './ant-versions.js';
@@ -1,20 +1,23 @@
1
+ export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
1
2
  export interface ILogger {
2
- setLogLevel: (level: 'info' | 'debug' | 'error' | 'warn' | 'none') => void;
3
+ setLogLevel: (level: LogLevel) => void;
3
4
  info: (message: string, ...args: unknown[]) => void;
4
5
  warn: (message: string, ...args: unknown[]) => void;
5
6
  error: (message: string, ...args: unknown[]) => void;
6
7
  debug: (message: string, ...args: unknown[]) => void;
7
8
  }
8
9
  export declare class Logger implements ILogger {
9
- private logger;
10
- private silent;
10
+ private level;
11
+ private levels;
11
12
  static default: Logger;
12
13
  constructor({ level, }?: {
13
- level?: 'info' | 'debug' | 'error' | 'warn' | 'none';
14
+ level?: LogLevel;
14
15
  });
16
+ private formatMessage;
17
+ private log;
15
18
  info(message: string, ...args: unknown[]): void;
16
19
  warn(message: string, ...args: unknown[]): void;
17
20
  error(message: string, ...args: unknown[]): void;
18
21
  debug(message: string, ...args: unknown[]): void;
19
- setLogLevel(level: 'info' | 'debug' | 'error' | 'warn' | 'none'): void;
22
+ setLogLevel(level: LogLevel): void;
20
23
  }
@@ -0,0 +1,13 @@
1
+ import { ILogger, LogLevel } from '../logger.js';
2
+ export declare class WinstonLogger implements ILogger {
3
+ private logger;
4
+ private winston;
5
+ constructor({ level, }?: {
6
+ level?: LogLevel;
7
+ });
8
+ info(message: string, ...args: unknown[]): void;
9
+ warn(message: string, ...args: unknown[]): void;
10
+ error(message: string, ...args: unknown[]): void;
11
+ debug(message: string, ...args: unknown[]): void;
12
+ setLogLevel(level: LogLevel): void;
13
+ }
@@ -13,4 +13,4 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- export declare const version = "3.20.0-alpha.1";
16
+ export declare const version = "3.20.0";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ar.io/sdk",
3
- "version": "3.20.0",
3
+ "version": "3.21.0-alpha.1",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -138,9 +138,16 @@
138
138
  "plimit-lit": "^3.0.1",
139
139
  "prompts": "^2.4.2",
140
140
  "uuid": "^11.1.0",
141
- "winston": "^3.13.0",
142
141
  "zod": "^3.23.8"
143
142
  },
143
+ "peerDependencies": {
144
+ "winston": "^3.13.0"
145
+ },
146
+ "peerDependenciesMeta": {
147
+ "winston": {
148
+ "optional": true
149
+ }
150
+ },
144
151
  "lint-staged": {
145
152
  "**/*.{ts,js,mjs,cjs,md,json}": [
146
153
  "prettier --write ."