@logtape/graphql-yoga 2.3.0-dev.0
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.
- package/LICENSE +20 -0
- package/README.md +106 -0
- package/dist/_virtual/rolldown_runtime.cjs +30 -0
- package/dist/mod.cjs +94 -0
- package/dist/mod.d.cts +84 -0
- package/dist/mod.d.cts.map +1 -0
- package/dist/mod.d.ts +84 -0
- package/dist/mod.d.ts.map +1 -0
- package/dist/mod.js +94 -0
- package/dist/mod.js.map +1 -0
- package/package.json +71 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright 2024–2026 Hong Minhee
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
6
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
7
|
+
the Software without restriction, including without limitation the rights to
|
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
10
|
+
subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
<!-- deno-fmt-ignore-file -->
|
|
2
|
+
|
|
3
|
+
@logtape/graphql-yoga
|
|
4
|
+
=====================
|
|
5
|
+
|
|
6
|
+
[![JSR][JSR badge]][JSR]
|
|
7
|
+
[![npm][npm badge]][npm]
|
|
8
|
+
|
|
9
|
+
*@logtape/graphql-yoga* is a [GraphQL Yoga] logger adapter that allows you to
|
|
10
|
+
use [LogTape] as Yoga's logging backend. This routes Yoga's internal debug,
|
|
11
|
+
info, warning, and error logs through LogTape's structured logging system.
|
|
12
|
+
|
|
13
|
+
[JSR badge]: https://jsr.io/badges/@logtape/graphql-yoga
|
|
14
|
+
[JSR]: https://jsr.io/@logtape/graphql-yoga
|
|
15
|
+
[npm badge]: https://img.shields.io/npm/v/@logtape/graphql-yoga?logo=npm
|
|
16
|
+
[npm]: https://www.npmjs.com/package/@logtape/graphql-yoga
|
|
17
|
+
[GraphQL Yoga]: https://the-guild.dev/graphql/yoga-server
|
|
18
|
+
[LogTape]: https://logtape.org/
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
Installation
|
|
22
|
+
------------
|
|
23
|
+
|
|
24
|
+
~~~~ sh
|
|
25
|
+
deno add jsr:@logtape/graphql-yoga # for Deno
|
|
26
|
+
npm add @logtape/graphql-yoga # for npm
|
|
27
|
+
pnpm add @logtape/graphql-yoga # for pnpm
|
|
28
|
+
yarn add @logtape/graphql-yoga # for Yarn
|
|
29
|
+
bun add @logtape/graphql-yoga # for Bun
|
|
30
|
+
~~~~
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
Usage
|
|
34
|
+
-----
|
|
35
|
+
|
|
36
|
+
~~~~ typescript
|
|
37
|
+
import { configure, getConsoleSink } from "@logtape/logtape";
|
|
38
|
+
import { getYogaLogger } from "@logtape/graphql-yoga";
|
|
39
|
+
import { createSchema, createYoga } from "graphql-yoga";
|
|
40
|
+
|
|
41
|
+
await configure({
|
|
42
|
+
sinks: { console: getConsoleSink() },
|
|
43
|
+
loggers: [
|
|
44
|
+
{ category: ["graphql-yoga"], sinks: ["console"], lowestLevel: "debug" }
|
|
45
|
+
],
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
const yoga = createYoga({
|
|
49
|
+
schema: createSchema({
|
|
50
|
+
typeDefs: /* GraphQL */ `
|
|
51
|
+
type Query {
|
|
52
|
+
hello: String!
|
|
53
|
+
}
|
|
54
|
+
`,
|
|
55
|
+
resolvers: {
|
|
56
|
+
Query: {
|
|
57
|
+
hello: () => "world",
|
|
58
|
+
},
|
|
59
|
+
},
|
|
60
|
+
}),
|
|
61
|
+
logging: getYogaLogger(),
|
|
62
|
+
});
|
|
63
|
+
~~~~
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
Custom category
|
|
67
|
+
---------------
|
|
68
|
+
|
|
69
|
+
You can specify a custom category for the logger:
|
|
70
|
+
|
|
71
|
+
~~~~ typescript
|
|
72
|
+
const yoga = createYoga({
|
|
73
|
+
schema,
|
|
74
|
+
logging: getYogaLogger({
|
|
75
|
+
category: ["myapp", "graphql"],
|
|
76
|
+
}),
|
|
77
|
+
});
|
|
78
|
+
~~~~
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
Custom log levels
|
|
82
|
+
-----------------
|
|
83
|
+
|
|
84
|
+
Yoga exposes `debug`, `info`, `warn`, and `error` logger methods. By default,
|
|
85
|
+
these map to LogTape's `debug`, `info`, `warning`, and `error` levels. You can
|
|
86
|
+
customize the mapping:
|
|
87
|
+
|
|
88
|
+
~~~~ typescript
|
|
89
|
+
const yoga = createYoga({
|
|
90
|
+
schema,
|
|
91
|
+
logging: getYogaLogger({
|
|
92
|
+
levelsMap: {
|
|
93
|
+
debug: "trace",
|
|
94
|
+
warn: "error",
|
|
95
|
+
},
|
|
96
|
+
}),
|
|
97
|
+
});
|
|
98
|
+
~~~~
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
Docs
|
|
102
|
+
----
|
|
103
|
+
|
|
104
|
+
The docs of this package is available at
|
|
105
|
+
<https://logtape.org/manual/integrations#graphql-yoga>.
|
|
106
|
+
For the API references, see <https://jsr.io/@logtape/graphql-yoga/doc>.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
//#region rolldown:runtime
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __copyProps = (to, from, except, desc) => {
|
|
9
|
+
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
10
|
+
key = keys[i];
|
|
11
|
+
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
|
|
12
|
+
get: ((k) => from[k]).bind(null, key),
|
|
13
|
+
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
|
|
19
|
+
value: mod,
|
|
20
|
+
enumerable: true
|
|
21
|
+
}) : target, mod));
|
|
22
|
+
|
|
23
|
+
//#endregion
|
|
24
|
+
|
|
25
|
+
Object.defineProperty(exports, '__toESM', {
|
|
26
|
+
enumerable: true,
|
|
27
|
+
get: function () {
|
|
28
|
+
return __toESM;
|
|
29
|
+
}
|
|
30
|
+
});
|
package/dist/mod.cjs
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
|
|
2
|
+
const __logtape_logtape = require_rolldown_runtime.__toESM(require("@logtape/logtape"));
|
|
3
|
+
|
|
4
|
+
//#region src/mod.ts
|
|
5
|
+
const defaultLevelsMap = {
|
|
6
|
+
debug: "debug",
|
|
7
|
+
info: "info",
|
|
8
|
+
warn: "warning",
|
|
9
|
+
error: "error"
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* Creates a GraphQL Yoga-compatible logger that wraps LogTape.
|
|
13
|
+
*
|
|
14
|
+
* @example Basic usage
|
|
15
|
+
* ```typescript
|
|
16
|
+
* import { configure } from "@logtape/logtape";
|
|
17
|
+
* import { getYogaLogger } from "@logtape/graphql-yoga";
|
|
18
|
+
* import { createYoga } from "graphql-yoga";
|
|
19
|
+
*
|
|
20
|
+
* await configure({
|
|
21
|
+
* // ... LogTape configuration
|
|
22
|
+
* });
|
|
23
|
+
*
|
|
24
|
+
* const yoga = createYoga({
|
|
25
|
+
* schema,
|
|
26
|
+
* logging: getYogaLogger(),
|
|
27
|
+
* });
|
|
28
|
+
* ```
|
|
29
|
+
*
|
|
30
|
+
* @example With custom category and level mapping
|
|
31
|
+
* ```typescript
|
|
32
|
+
* const yoga = createYoga({
|
|
33
|
+
* schema,
|
|
34
|
+
* logging: getYogaLogger({
|
|
35
|
+
* category: ["myapp", "graphql"],
|
|
36
|
+
* levelsMap: { warn: "error" },
|
|
37
|
+
* }),
|
|
38
|
+
* });
|
|
39
|
+
* ```
|
|
40
|
+
*
|
|
41
|
+
* @param options Configuration options for the logger.
|
|
42
|
+
* @returns A GraphQL Yoga-compatible logger wrapping LogTape.
|
|
43
|
+
* @since 2.3.0
|
|
44
|
+
*/
|
|
45
|
+
function getYogaLogger(options = {}) {
|
|
46
|
+
const category = normalizeCategory(options.category ?? ["graphql-yoga"]);
|
|
47
|
+
const logger = (0, __logtape_logtape.getLogger)(category);
|
|
48
|
+
const levelsMap = {
|
|
49
|
+
...defaultLevelsMap,
|
|
50
|
+
...options.levelsMap
|
|
51
|
+
};
|
|
52
|
+
return {
|
|
53
|
+
debug: (...args) => logYogaArgs(logger, levelsMap.debug, args),
|
|
54
|
+
info: (...args) => logYogaArgs(logger, levelsMap.info, args),
|
|
55
|
+
warn: (...args) => logYogaArgs(logger, levelsMap.warn, args),
|
|
56
|
+
error: (...args) => logYogaArgs(logger, levelsMap.error, args)
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
function normalizeCategory(category) {
|
|
60
|
+
return typeof category === "string" ? [category] : category;
|
|
61
|
+
}
|
|
62
|
+
function logYogaArgs(logger, level, args) {
|
|
63
|
+
const [first, ...rest] = args;
|
|
64
|
+
const properties = rest.length > 0 ? { args: rest } : void 0;
|
|
65
|
+
if (args.length < 1) logWithMessage(logger, level, "GraphQL Yoga log");
|
|
66
|
+
else if (first instanceof Error) logError(logger, level, first, properties);
|
|
67
|
+
else if (typeof first === "string") logWithMessage(logger, level, first, properties);
|
|
68
|
+
else if (args.length === 1 && isPlainRecord(first)) logWithMessage(logger, level, "{*}", first);
|
|
69
|
+
else logWithMessage(logger, level, "{*}", { args });
|
|
70
|
+
}
|
|
71
|
+
function logError(logger, level, error, properties) {
|
|
72
|
+
if (level === "warning" || level === "error" || level === "fatal") {
|
|
73
|
+
const logMethod = logger[level].bind(logger);
|
|
74
|
+
logMethod(error, properties);
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
logWithMessage(logger, level, "{error.message}", {
|
|
78
|
+
...properties,
|
|
79
|
+
error
|
|
80
|
+
});
|
|
81
|
+
}
|
|
82
|
+
function logWithMessage(logger, level, message, properties) {
|
|
83
|
+
const logMethod = logger[level].bind(logger);
|
|
84
|
+
logMethod(message, properties);
|
|
85
|
+
}
|
|
86
|
+
function isPlainRecord(value) {
|
|
87
|
+
if (value == null || typeof value !== "object" || Array.isArray(value)) return false;
|
|
88
|
+
if (value instanceof Error) return false;
|
|
89
|
+
const prototype = Object.getPrototypeOf(value);
|
|
90
|
+
return prototype === Object.prototype || prototype === null;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
//#endregion
|
|
94
|
+
exports.getYogaLogger = getYogaLogger;
|
package/dist/mod.d.cts
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { LogLevel, LogLevel as LogLevel$1 } from "@logtape/logtape";
|
|
2
|
+
|
|
3
|
+
//#region src/mod.d.ts
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* GraphQL Yoga log levels.
|
|
7
|
+
* @since 2.3.0
|
|
8
|
+
*/
|
|
9
|
+
type YogaLogLevel = "debug" | "info" | "warn" | "error";
|
|
10
|
+
/**
|
|
11
|
+
* A GraphQL Yoga-compatible logger that wraps LogTape.
|
|
12
|
+
* @since 2.3.0
|
|
13
|
+
*/
|
|
14
|
+
interface YogaLogger {
|
|
15
|
+
/** Log at Yoga's debug level. */
|
|
16
|
+
debug(...args: readonly unknown[]): void;
|
|
17
|
+
/** Log at Yoga's info level. */
|
|
18
|
+
info(...args: readonly unknown[]): void;
|
|
19
|
+
/** Log at Yoga's warning level. */
|
|
20
|
+
warn(...args: readonly unknown[]): void;
|
|
21
|
+
/** Log at Yoga's error level. */
|
|
22
|
+
error(...args: readonly unknown[]): void;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Options for configuring the GraphQL Yoga LogTape logger.
|
|
26
|
+
* @since 2.3.0
|
|
27
|
+
*/
|
|
28
|
+
interface YogaLoggerOptions {
|
|
29
|
+
/**
|
|
30
|
+
* The LogTape category to use for logging.
|
|
31
|
+
* @default ["graphql-yoga"]
|
|
32
|
+
*/
|
|
33
|
+
readonly category?: string | readonly string[];
|
|
34
|
+
/**
|
|
35
|
+
* Mapping between GraphQL Yoga log levels and LogTape log levels.
|
|
36
|
+
*
|
|
37
|
+
* By default, Yoga levels are mapped as follows:
|
|
38
|
+
*
|
|
39
|
+
* - `debug` -> `debug`
|
|
40
|
+
* - `info` -> `info`
|
|
41
|
+
* - `warn` -> `warning`
|
|
42
|
+
* - `error` -> `error`
|
|
43
|
+
*/
|
|
44
|
+
readonly levelsMap?: Partial<Readonly<Record<YogaLogLevel, LogLevel$1>>>;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Creates a GraphQL Yoga-compatible logger that wraps LogTape.
|
|
48
|
+
*
|
|
49
|
+
* @example Basic usage
|
|
50
|
+
* ```typescript
|
|
51
|
+
* import { configure } from "@logtape/logtape";
|
|
52
|
+
* import { getYogaLogger } from "@logtape/graphql-yoga";
|
|
53
|
+
* import { createYoga } from "graphql-yoga";
|
|
54
|
+
*
|
|
55
|
+
* await configure({
|
|
56
|
+
* // ... LogTape configuration
|
|
57
|
+
* });
|
|
58
|
+
*
|
|
59
|
+
* const yoga = createYoga({
|
|
60
|
+
* schema,
|
|
61
|
+
* logging: getYogaLogger(),
|
|
62
|
+
* });
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @example With custom category and level mapping
|
|
66
|
+
* ```typescript
|
|
67
|
+
* const yoga = createYoga({
|
|
68
|
+
* schema,
|
|
69
|
+
* logging: getYogaLogger({
|
|
70
|
+
* category: ["myapp", "graphql"],
|
|
71
|
+
* levelsMap: { warn: "error" },
|
|
72
|
+
* }),
|
|
73
|
+
* });
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* @param options Configuration options for the logger.
|
|
77
|
+
* @returns A GraphQL Yoga-compatible logger wrapping LogTape.
|
|
78
|
+
* @since 2.3.0
|
|
79
|
+
*/
|
|
80
|
+
declare function getYogaLogger(options?: YogaLoggerOptions): YogaLogger;
|
|
81
|
+
//# sourceMappingURL=mod.d.ts.map
|
|
82
|
+
//#endregion
|
|
83
|
+
export { LogLevel, YogaLogLevel, YogaLogger, YogaLoggerOptions, getYogaLogger };
|
|
84
|
+
//# sourceMappingURL=mod.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mod.d.cts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;AAYA;AAMA;AAkBA;AAAkC,KAxBtB,YAAA,GAwBsB,OAAA,GAAA,MAAA,GAAA,MAAA,GAAA,OAAA;;;;;AAiBX,UAnCN,UAAA,CAmCM;EAAO;EA4Cd,KAAA,CAAA,GAAA,IAAA,EAAA,SAAa,OAAA,EAAA,CAAA,EAAA,IAAA;EAAA;EAAA,IAAU,CAAA,GAAA,IAAA,EAAA,SAAA,OAAA,EAAA,CAAA,EAAA,IAAA;EAAsB;EAAa,IAAA,CAAA,GAAA,IAAA,EAAA,SAAA,OAAA,EAAA,CAAA,EAAA,IAAA;;;;;;;;UA7DzD,iBAAA;;;;;;;;;;;;;;;;uBAiBM,QAAQ,SAAS,OAAO,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4C7C,aAAA,WAAuB,oBAAyB"}
|
package/dist/mod.d.ts
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { LogLevel, LogLevel as LogLevel$1 } from "@logtape/logtape";
|
|
2
|
+
|
|
3
|
+
//#region src/mod.d.ts
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* GraphQL Yoga log levels.
|
|
7
|
+
* @since 2.3.0
|
|
8
|
+
*/
|
|
9
|
+
type YogaLogLevel = "debug" | "info" | "warn" | "error";
|
|
10
|
+
/**
|
|
11
|
+
* A GraphQL Yoga-compatible logger that wraps LogTape.
|
|
12
|
+
* @since 2.3.0
|
|
13
|
+
*/
|
|
14
|
+
interface YogaLogger {
|
|
15
|
+
/** Log at Yoga's debug level. */
|
|
16
|
+
debug(...args: readonly unknown[]): void;
|
|
17
|
+
/** Log at Yoga's info level. */
|
|
18
|
+
info(...args: readonly unknown[]): void;
|
|
19
|
+
/** Log at Yoga's warning level. */
|
|
20
|
+
warn(...args: readonly unknown[]): void;
|
|
21
|
+
/** Log at Yoga's error level. */
|
|
22
|
+
error(...args: readonly unknown[]): void;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Options for configuring the GraphQL Yoga LogTape logger.
|
|
26
|
+
* @since 2.3.0
|
|
27
|
+
*/
|
|
28
|
+
interface YogaLoggerOptions {
|
|
29
|
+
/**
|
|
30
|
+
* The LogTape category to use for logging.
|
|
31
|
+
* @default ["graphql-yoga"]
|
|
32
|
+
*/
|
|
33
|
+
readonly category?: string | readonly string[];
|
|
34
|
+
/**
|
|
35
|
+
* Mapping between GraphQL Yoga log levels and LogTape log levels.
|
|
36
|
+
*
|
|
37
|
+
* By default, Yoga levels are mapped as follows:
|
|
38
|
+
*
|
|
39
|
+
* - `debug` -> `debug`
|
|
40
|
+
* - `info` -> `info`
|
|
41
|
+
* - `warn` -> `warning`
|
|
42
|
+
* - `error` -> `error`
|
|
43
|
+
*/
|
|
44
|
+
readonly levelsMap?: Partial<Readonly<Record<YogaLogLevel, LogLevel$1>>>;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Creates a GraphQL Yoga-compatible logger that wraps LogTape.
|
|
48
|
+
*
|
|
49
|
+
* @example Basic usage
|
|
50
|
+
* ```typescript
|
|
51
|
+
* import { configure } from "@logtape/logtape";
|
|
52
|
+
* import { getYogaLogger } from "@logtape/graphql-yoga";
|
|
53
|
+
* import { createYoga } from "graphql-yoga";
|
|
54
|
+
*
|
|
55
|
+
* await configure({
|
|
56
|
+
* // ... LogTape configuration
|
|
57
|
+
* });
|
|
58
|
+
*
|
|
59
|
+
* const yoga = createYoga({
|
|
60
|
+
* schema,
|
|
61
|
+
* logging: getYogaLogger(),
|
|
62
|
+
* });
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @example With custom category and level mapping
|
|
66
|
+
* ```typescript
|
|
67
|
+
* const yoga = createYoga({
|
|
68
|
+
* schema,
|
|
69
|
+
* logging: getYogaLogger({
|
|
70
|
+
* category: ["myapp", "graphql"],
|
|
71
|
+
* levelsMap: { warn: "error" },
|
|
72
|
+
* }),
|
|
73
|
+
* });
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* @param options Configuration options for the logger.
|
|
77
|
+
* @returns A GraphQL Yoga-compatible logger wrapping LogTape.
|
|
78
|
+
* @since 2.3.0
|
|
79
|
+
*/
|
|
80
|
+
declare function getYogaLogger(options?: YogaLoggerOptions): YogaLogger;
|
|
81
|
+
//# sourceMappingURL=mod.d.ts.map
|
|
82
|
+
//#endregion
|
|
83
|
+
export { LogLevel, YogaLogLevel, YogaLogger, YogaLoggerOptions, getYogaLogger };
|
|
84
|
+
//# sourceMappingURL=mod.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mod.d.ts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;AAYA;AAMA;AAkBA;AAAkC,KAxBtB,YAAA,GAwBsB,OAAA,GAAA,MAAA,GAAA,MAAA,GAAA,OAAA;;;;;AAiBX,UAnCN,UAAA,CAmCM;EAAO;EA4Cd,KAAA,CAAA,GAAA,IAAA,EAAA,SAAa,OAAA,EAAA,CAAA,EAAA,IAAA;EAAA;EAAA,IAAU,CAAA,GAAA,IAAA,EAAA,SAAA,OAAA,EAAA,CAAA,EAAA,IAAA;EAAsB;EAAa,IAAA,CAAA,GAAA,IAAA,EAAA,SAAA,OAAA,EAAA,CAAA,EAAA,IAAA;;;;;;;;UA7DzD,iBAAA;;;;;;;;;;;;;;;;uBAiBM,QAAQ,SAAS,OAAO,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4C7C,aAAA,WAAuB,oBAAyB"}
|
package/dist/mod.js
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { getLogger } from "@logtape/logtape";
|
|
2
|
+
|
|
3
|
+
//#region src/mod.ts
|
|
4
|
+
const defaultLevelsMap = {
|
|
5
|
+
debug: "debug",
|
|
6
|
+
info: "info",
|
|
7
|
+
warn: "warning",
|
|
8
|
+
error: "error"
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Creates a GraphQL Yoga-compatible logger that wraps LogTape.
|
|
12
|
+
*
|
|
13
|
+
* @example Basic usage
|
|
14
|
+
* ```typescript
|
|
15
|
+
* import { configure } from "@logtape/logtape";
|
|
16
|
+
* import { getYogaLogger } from "@logtape/graphql-yoga";
|
|
17
|
+
* import { createYoga } from "graphql-yoga";
|
|
18
|
+
*
|
|
19
|
+
* await configure({
|
|
20
|
+
* // ... LogTape configuration
|
|
21
|
+
* });
|
|
22
|
+
*
|
|
23
|
+
* const yoga = createYoga({
|
|
24
|
+
* schema,
|
|
25
|
+
* logging: getYogaLogger(),
|
|
26
|
+
* });
|
|
27
|
+
* ```
|
|
28
|
+
*
|
|
29
|
+
* @example With custom category and level mapping
|
|
30
|
+
* ```typescript
|
|
31
|
+
* const yoga = createYoga({
|
|
32
|
+
* schema,
|
|
33
|
+
* logging: getYogaLogger({
|
|
34
|
+
* category: ["myapp", "graphql"],
|
|
35
|
+
* levelsMap: { warn: "error" },
|
|
36
|
+
* }),
|
|
37
|
+
* });
|
|
38
|
+
* ```
|
|
39
|
+
*
|
|
40
|
+
* @param options Configuration options for the logger.
|
|
41
|
+
* @returns A GraphQL Yoga-compatible logger wrapping LogTape.
|
|
42
|
+
* @since 2.3.0
|
|
43
|
+
*/
|
|
44
|
+
function getYogaLogger(options = {}) {
|
|
45
|
+
const category = normalizeCategory(options.category ?? ["graphql-yoga"]);
|
|
46
|
+
const logger = getLogger(category);
|
|
47
|
+
const levelsMap = {
|
|
48
|
+
...defaultLevelsMap,
|
|
49
|
+
...options.levelsMap
|
|
50
|
+
};
|
|
51
|
+
return {
|
|
52
|
+
debug: (...args) => logYogaArgs(logger, levelsMap.debug, args),
|
|
53
|
+
info: (...args) => logYogaArgs(logger, levelsMap.info, args),
|
|
54
|
+
warn: (...args) => logYogaArgs(logger, levelsMap.warn, args),
|
|
55
|
+
error: (...args) => logYogaArgs(logger, levelsMap.error, args)
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
function normalizeCategory(category) {
|
|
59
|
+
return typeof category === "string" ? [category] : category;
|
|
60
|
+
}
|
|
61
|
+
function logYogaArgs(logger, level, args) {
|
|
62
|
+
const [first, ...rest] = args;
|
|
63
|
+
const properties = rest.length > 0 ? { args: rest } : void 0;
|
|
64
|
+
if (args.length < 1) logWithMessage(logger, level, "GraphQL Yoga log");
|
|
65
|
+
else if (first instanceof Error) logError(logger, level, first, properties);
|
|
66
|
+
else if (typeof first === "string") logWithMessage(logger, level, first, properties);
|
|
67
|
+
else if (args.length === 1 && isPlainRecord(first)) logWithMessage(logger, level, "{*}", first);
|
|
68
|
+
else logWithMessage(logger, level, "{*}", { args });
|
|
69
|
+
}
|
|
70
|
+
function logError(logger, level, error, properties) {
|
|
71
|
+
if (level === "warning" || level === "error" || level === "fatal") {
|
|
72
|
+
const logMethod = logger[level].bind(logger);
|
|
73
|
+
logMethod(error, properties);
|
|
74
|
+
return;
|
|
75
|
+
}
|
|
76
|
+
logWithMessage(logger, level, "{error.message}", {
|
|
77
|
+
...properties,
|
|
78
|
+
error
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
function logWithMessage(logger, level, message, properties) {
|
|
82
|
+
const logMethod = logger[level].bind(logger);
|
|
83
|
+
logMethod(message, properties);
|
|
84
|
+
}
|
|
85
|
+
function isPlainRecord(value) {
|
|
86
|
+
if (value == null || typeof value !== "object" || Array.isArray(value)) return false;
|
|
87
|
+
if (value instanceof Error) return false;
|
|
88
|
+
const prototype = Object.getPrototypeOf(value);
|
|
89
|
+
return prototype === Object.prototype || prototype === null;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
//#endregion
|
|
93
|
+
export { getYogaLogger };
|
|
94
|
+
//# sourceMappingURL=mod.js.map
|
package/dist/mod.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mod.js","names":["defaultLevelsMap: Readonly<Record<YogaLogLevel, LogLevel>>","options: YogaLoggerOptions","category: string | readonly string[]","logger: LogTapeLogger","level: LogLevel","args: readonly unknown[]","error: Error","properties?: Record<string, unknown>","message: string","value: unknown"],"sources":["../src/mod.ts"],"sourcesContent":["import {\n getLogger as getLogTapeLogger,\n type Logger as LogTapeLogger,\n type LogLevel,\n} from \"@logtape/logtape\";\n\nexport type { LogLevel } from \"@logtape/logtape\";\n\n/**\n * GraphQL Yoga log levels.\n * @since 2.3.0\n */\nexport type YogaLogLevel = \"debug\" | \"info\" | \"warn\" | \"error\";\n\n/**\n * A GraphQL Yoga-compatible logger that wraps LogTape.\n * @since 2.3.0\n */\nexport interface YogaLogger {\n /** Log at Yoga's debug level. */\n debug(...args: readonly unknown[]): void;\n\n /** Log at Yoga's info level. */\n info(...args: readonly unknown[]): void;\n\n /** Log at Yoga's warning level. */\n warn(...args: readonly unknown[]): void;\n\n /** Log at Yoga's error level. */\n error(...args: readonly unknown[]): void;\n}\n\n/**\n * Options for configuring the GraphQL Yoga LogTape logger.\n * @since 2.3.0\n */\nexport interface YogaLoggerOptions {\n /**\n * The LogTape category to use for logging.\n * @default [\"graphql-yoga\"]\n */\n readonly category?: string | readonly string[];\n\n /**\n * Mapping between GraphQL Yoga log levels and LogTape log levels.\n *\n * By default, Yoga levels are mapped as follows:\n *\n * - `debug` -> `debug`\n * - `info` -> `info`\n * - `warn` -> `warning`\n * - `error` -> `error`\n */\n readonly levelsMap?: Partial<Readonly<Record<YogaLogLevel, LogLevel>>>;\n}\n\nconst defaultLevelsMap: Readonly<Record<YogaLogLevel, LogLevel>> = {\n debug: \"debug\",\n info: \"info\",\n warn: \"warning\",\n error: \"error\",\n};\n\n/**\n * Creates a GraphQL Yoga-compatible logger that wraps LogTape.\n *\n * @example Basic usage\n * ```typescript\n * import { configure } from \"@logtape/logtape\";\n * import { getYogaLogger } from \"@logtape/graphql-yoga\";\n * import { createYoga } from \"graphql-yoga\";\n *\n * await configure({\n * // ... LogTape configuration\n * });\n *\n * const yoga = createYoga({\n * schema,\n * logging: getYogaLogger(),\n * });\n * ```\n *\n * @example With custom category and level mapping\n * ```typescript\n * const yoga = createYoga({\n * schema,\n * logging: getYogaLogger({\n * category: [\"myapp\", \"graphql\"],\n * levelsMap: { warn: \"error\" },\n * }),\n * });\n * ```\n *\n * @param options Configuration options for the logger.\n * @returns A GraphQL Yoga-compatible logger wrapping LogTape.\n * @since 2.3.0\n */\nexport function getYogaLogger(options: YogaLoggerOptions = {}): YogaLogger {\n const category = normalizeCategory(options.category ?? [\"graphql-yoga\"]);\n const logger = getLogTapeLogger(category);\n const levelsMap = { ...defaultLevelsMap, ...options.levelsMap };\n\n return {\n debug: (...args) => logYogaArgs(logger, levelsMap.debug, args),\n info: (...args) => logYogaArgs(logger, levelsMap.info, args),\n warn: (...args) => logYogaArgs(logger, levelsMap.warn, args),\n error: (...args) => logYogaArgs(logger, levelsMap.error, args),\n };\n}\n\nfunction normalizeCategory(\n category: string | readonly string[],\n): readonly string[] {\n return typeof category === \"string\" ? [category] : category;\n}\n\nfunction logYogaArgs(\n logger: LogTapeLogger,\n level: LogLevel,\n args: readonly unknown[],\n): void {\n const [first, ...rest] = args;\n const properties = rest.length > 0 ? { args: rest } : undefined;\n\n if (args.length < 1) {\n logWithMessage(logger, level, \"GraphQL Yoga log\");\n } else if (first instanceof Error) {\n logError(logger, level, first, properties);\n } else if (typeof first === \"string\") {\n logWithMessage(logger, level, first, properties);\n } else if (args.length === 1 && isPlainRecord(first)) {\n logWithMessage(logger, level, \"{*}\", first);\n } else {\n logWithMessage(logger, level, \"{*}\", { args });\n }\n}\n\nfunction logError(\n logger: LogTapeLogger,\n level: LogLevel,\n error: Error,\n properties?: Record<string, unknown>,\n): void {\n if (level === \"warning\" || level === \"error\" || level === \"fatal\") {\n const logMethod = logger[level].bind(logger) as (\n error: Error,\n properties?: Record<string, unknown>,\n ) => void;\n logMethod(error, properties);\n return;\n }\n\n logWithMessage(logger, level, \"{error.message}\", {\n ...properties,\n error,\n });\n}\n\nfunction logWithMessage(\n logger: LogTapeLogger,\n level: LogLevel,\n message: string,\n properties?: Record<string, unknown>,\n): void {\n const logMethod = logger[level].bind(logger) as (\n message: string,\n properties?: Record<string, unknown>,\n ) => void;\n logMethod(message, properties);\n}\n\nfunction isPlainRecord(value: unknown): value is Record<string, unknown> {\n if (value == null || typeof value !== \"object\" || Array.isArray(value)) {\n return false;\n }\n if (value instanceof Error) return false;\n\n const prototype = Object.getPrototypeOf(value);\n return prototype === Object.prototype || prototype === null;\n}\n"],"mappings":";;;AAwDA,MAAMA,mBAA6D;CACjE,OAAO;CACP,MAAM;CACN,MAAM;CACN,OAAO;AACR;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCD,SAAgB,cAAcC,UAA6B,CAAE,GAAc;CACzE,MAAM,WAAW,kBAAkB,QAAQ,YAAY,CAAC,cAAe,EAAC;CACxE,MAAM,SAAS,UAAiB,SAAS;CACzC,MAAM,YAAY;EAAE,GAAG;EAAkB,GAAG,QAAQ;CAAW;AAE/D,QAAO;EACL,OAAO,CAAC,GAAG,SAAS,YAAY,QAAQ,UAAU,OAAO,KAAK;EAC9D,MAAM,CAAC,GAAG,SAAS,YAAY,QAAQ,UAAU,MAAM,KAAK;EAC5D,MAAM,CAAC,GAAG,SAAS,YAAY,QAAQ,UAAU,MAAM,KAAK;EAC5D,OAAO,CAAC,GAAG,SAAS,YAAY,QAAQ,UAAU,OAAO,KAAK;CAC/D;AACF;AAED,SAAS,kBACPC,UACmB;AACnB,eAAc,aAAa,WAAW,CAAC,QAAS,IAAG;AACpD;AAED,SAAS,YACPC,QACAC,OACAC,MACM;CACN,MAAM,CAAC,OAAO,GAAG,KAAK,GAAG;CACzB,MAAM,aAAa,KAAK,SAAS,IAAI,EAAE,MAAM,KAAM;AAEnD,KAAI,KAAK,SAAS,EAChB,gBAAe,QAAQ,OAAO,mBAAmB;UACxC,iBAAiB,MAC1B,UAAS,QAAQ,OAAO,OAAO,WAAW;iBAC1B,UAAU,SAC1B,gBAAe,QAAQ,OAAO,OAAO,WAAW;UACvC,KAAK,WAAW,KAAK,cAAc,MAAM,CAClD,gBAAe,QAAQ,OAAO,OAAO,MAAM;KAE3C,gBAAe,QAAQ,OAAO,OAAO,EAAE,KAAM,EAAC;AAEjD;AAED,SAAS,SACPF,QACAC,OACAE,OACAC,YACM;AACN,KAAI,UAAU,aAAa,UAAU,WAAW,UAAU,SAAS;EACjE,MAAM,YAAY,OAAO,OAAO,KAAK,OAAO;AAI5C,YAAU,OAAO,WAAW;AAC5B;CACD;AAED,gBAAe,QAAQ,OAAO,mBAAmB;EAC/C,GAAG;EACH;CACD,EAAC;AACH;AAED,SAAS,eACPJ,QACAC,OACAI,SACAD,YACM;CACN,MAAM,YAAY,OAAO,OAAO,KAAK,OAAO;AAI5C,WAAU,SAAS,WAAW;AAC/B;AAED,SAAS,cAAcE,OAAkD;AACvE,KAAI,SAAS,eAAe,UAAU,YAAY,MAAM,QAAQ,MAAM,CACpE,QAAO;AAET,KAAI,iBAAiB,MAAO,QAAO;CAEnC,MAAM,YAAY,OAAO,eAAe,MAAM;AAC9C,QAAO,cAAc,OAAO,aAAa,cAAc;AACxD"}
|
package/package.json
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@logtape/graphql-yoga",
|
|
3
|
+
"version": "2.3.0-dev.0",
|
|
4
|
+
"description": "GraphQL Yoga adapter for LogTape logging library",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"logging",
|
|
7
|
+
"log",
|
|
8
|
+
"logger",
|
|
9
|
+
"graphql",
|
|
10
|
+
"graphql-yoga",
|
|
11
|
+
"yoga",
|
|
12
|
+
"adapter",
|
|
13
|
+
"logtape"
|
|
14
|
+
],
|
|
15
|
+
"license": "MIT",
|
|
16
|
+
"author": {
|
|
17
|
+
"name": "Hong Minhee",
|
|
18
|
+
"email": "hong@minhee.org",
|
|
19
|
+
"url": "https://hongminhee.org/"
|
|
20
|
+
},
|
|
21
|
+
"homepage": "https://logtape.org/",
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "git+https://github.com/dahlia/logtape.git",
|
|
25
|
+
"directory": "packages/graphql-yoga/"
|
|
26
|
+
},
|
|
27
|
+
"bugs": {
|
|
28
|
+
"url": "https://github.com/dahlia/logtape/issues"
|
|
29
|
+
},
|
|
30
|
+
"funding": [
|
|
31
|
+
"https://github.com/sponsors/dahlia"
|
|
32
|
+
],
|
|
33
|
+
"type": "module",
|
|
34
|
+
"module": "./dist/mod.js",
|
|
35
|
+
"main": "./dist/mod.cjs",
|
|
36
|
+
"types": "./dist/mod.d.ts",
|
|
37
|
+
"exports": {
|
|
38
|
+
".": {
|
|
39
|
+
"types": {
|
|
40
|
+
"import": "./dist/mod.d.ts",
|
|
41
|
+
"require": "./dist/mod.d.cts"
|
|
42
|
+
},
|
|
43
|
+
"import": "./dist/mod.js",
|
|
44
|
+
"require": "./dist/mod.cjs"
|
|
45
|
+
},
|
|
46
|
+
"./package.json": "./package.json"
|
|
47
|
+
},
|
|
48
|
+
"sideEffects": false,
|
|
49
|
+
"files": [
|
|
50
|
+
"dist/"
|
|
51
|
+
],
|
|
52
|
+
"peerDependencies": {
|
|
53
|
+
"@logtape/logtape": "^2.3.0"
|
|
54
|
+
},
|
|
55
|
+
"devDependencies": {
|
|
56
|
+
"@alinea/suite": "^0.6.3",
|
|
57
|
+
"@std/assert": "npm:@jsr/std__assert@^1.0.13",
|
|
58
|
+
"graphql": "^16.14.2",
|
|
59
|
+
"graphql-yoga": "^5.21.2",
|
|
60
|
+
"tsdown": "^0.12.7",
|
|
61
|
+
"typescript": "^5.8.3"
|
|
62
|
+
},
|
|
63
|
+
"scripts": {
|
|
64
|
+
"build": "tsdown",
|
|
65
|
+
"prepublish": "tsdown",
|
|
66
|
+
"test": "tsdown && node --experimental-transform-types --test",
|
|
67
|
+
"test:bun": "tsdown && bun test",
|
|
68
|
+
"test:deno": "deno test --allow-env --allow-sys --allow-net",
|
|
69
|
+
"test-all": "tsdown && node --experimental-transform-types --test && bun test && deno test"
|
|
70
|
+
}
|
|
71
|
+
}
|