@getcronit/pylon 1.2.0-beta.2 → 2.0.0-beta.1

package/dist/app/envelop/use-sentry.d.ts

@@ -0,0 +1,70 @@
+import { isOriginalGraphQLError, TypedExecutionArgs, type Plugin } from '@envelop/core';
+import * as Sentry from '@sentry/node';
+import type { TraceparentData } from '@sentry/types';
+export type SentryPluginOptions<PluginContext extends Record<string, any>> = {
+    /**
+     * Starts a new transaction for every GraphQL Operation.
+     * When disabled, an already existing Transaction will be used.
+     *
+     * @default true
+     */
+    startTransaction?: boolean;
+    /**
+     * Renames Transaction.
+     * @default false
+     */
+    renameTransaction?: boolean;
+    /**
+     * Adds result of each resolver and operation to Span's data (available under "result")
+     * @default false
+     */
+    includeRawResult?: boolean;
+    /**
+     * Adds operation's variables to a Scope (only in case of errors)
+     * @default false
+     */
+    includeExecuteVariables?: boolean;
+    /**
+     * The key of the event id in the error's extension. `null` to disable.
+     * @default sentryEventId
+     */
+    eventIdKey?: string | null;
+    /**
+     * Adds custom tags to every Transaction.
+     */
+    appendTags?: (args: TypedExecutionArgs<PluginContext>) => Record<string, unknown>;
+    /**
+     * Callback to set context information onto the scope.
+     */
+    configureScope?: (args: TypedExecutionArgs<PluginContext>, scope: Sentry.Scope) => void;
+    /**
+     * Produces a name of Transaction (only when "renameTransaction" or "startTransaction" are enabled) and description of created Span.
+     *
+     * @default operation's name or "Anonymous Operation" when missing)
+     */
+    transactionName?: (args: TypedExecutionArgs<PluginContext>) => string;
+    /**
+     * Produces tracing data for Transaction
+     *
+     * @default is empty
+     */
+    traceparentData?: (args: TypedExecutionArgs<PluginContext>) => TraceparentData | undefined;
+    /**
+     * Produces a "op" (operation) of created Span.
+     *
+     * @default execute
+     */
+    operationName?: (args: TypedExecutionArgs<PluginContext>) => string;
+    /**
+     * Indicates whether or not to skip the entire Sentry flow for given GraphQL operation.
+     * By default, no operations are skipped.
+     */
+    skip?: (args: TypedExecutionArgs<PluginContext>) => boolean;
+    /**
+     * Indicates whether or not to skip Sentry exception reporting for a given error.
+     * By default, this plugin skips all `GraphQLError` errors and does not report it to Sentry.
+     */
+    skipError?: (args: Error) => boolean;
+};
+export declare const defaultSkipError: typeof isOriginalGraphQLError;
+export declare const useSentry: <PluginContext extends Record<string, any> = {}>(options?: SentryPluginOptions<PluginContext>) => Plugin<PluginContext>;

package/dist/app/handler/graphql-handler.d.ts

@@ -0,0 +1,9 @@
+import { Context } from '../../context';
+export interface SchemaOptions {
+    typeDefs: string;
+    resolvers: {
+        Query: Record<string, any>;
+        Mutation: Record<string, any>;
+    };
+}
+export declare const graphqlHandler: (c: Context) => ({ typeDefs, resolvers }: SchemaOptions) => import("graphql-yoga").YogaServerInstance<{}, Context>;

package/dist/app/handler/graphql-viewer-handler.d.ts

@@ -0,0 +1,2 @@
+import type { MiddlewareHandler } from 'hono';
+export declare const graphqlViewerHandler: MiddlewareHandler;

package/dist/app/index.d.ts

@@ -0,0 +1,3 @@
+import { Hono } from 'hono';
+import { Env } from '../context';
+export declare const app: Hono<Env, import("hono/types").BlankSchema, "/">;

package/dist/context.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { Context as HonoContext } from 'hono';
+import type { Toucan } from 'toucan-js';
 import { AuthState } from './auth';
 import { AsyncLocalStorage } from 'async_hooks';
 export type Env = {
@@ -8,6 +9,7 @@ export type Env = {
     };
     Variables: {
         auth: AuthState;
+        sentry: Toucan;
     };
 };
 export type Context = HonoContext<Env, string, {}>;

package/dist/define-pylon.d.ts

@@ -1,38 +1,15 @@
-/// <reference types="bun-types" />
 import { GraphQLError, GraphQLErrorExtensions } from 'graphql';
-import { Hono as _Hono } from 'hono';
-import { Server, WebSocketHandler } from 'bun';
-import { Context, Env } from './context';
-export interface Resolvers<Q, M> {
-    Query: Q;
-    Mutation: M;
-}
-type WebSocketHandlerFunction<T extends Record<string, any>> = (server: Server) => WebSocketHandler<T>;
-type Hono = _Hono<Env>;
-export interface PylonAPI {
-    defineService: typeof defineService;
-    configureApp: (app: Hono) => Hono | void | Promise<void> | Promise<Hono>;
-    configureServer: (server: Server) => void;
-    configureWebsocket: WebSocketHandlerFunction<any>;
-}
-type SingleResolver = ((...args: any[]) => any) | object;
-type ReturnTypeOrContext<T> = T extends (...args: any) => any ? ReturnType<T> : Context;
-export declare const defineService: <Q extends Record<string, SingleResolver>, M, Options extends {
-    context: (context: Context) => ReturnTypeOrContext<Options["context"]>;
-}>(plainResolvers: {
-    Query?: Q | undefined;
-    Mutation?: M | undefined;
-}, options?: Options | undefined) => {
-    graphqlResolvers: GraphQLResolvers;
-    plainResolvers: Resolvers<Q & {
-        version: string;
-    }, M>;
-    getContext: () => ReturnType<Options["context"]>;
-};
-type GraphQLResolvers = {
+import { Context } from './context';
+export interface Resolvers {
     Query: Record<string, any>;
     Mutation: Record<string, any>;
-};
+}
+/**
+ * Converts a set of resolvers into a corresponding set of GraphQL resolvers.
+ * @param resolvers The original resolvers.
+ * @returns The converted GraphQL resolvers.
+ */
+export declare const resolversToGraphQLResolvers: (resolvers: Resolvers, configureContext?: ((context: Context) => Context) | undefined) => Resolvers;
 export declare class ServiceError extends GraphQLError {
     extensions: GraphQLErrorExtensions;
     constructor(message: string, extensions: {
@@ -41,4 +18,3 @@ export declare class ServiceError extends GraphQLError {
         details?: Record<string, any>;
     }, error?: Error);
 }
-export {};

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { defineService, ServiceError, PylonAPI } from './define-pylon.js';
-export { logger, getLogger } from './logger/index.js';
+export { ServiceError } from './define-pylon.js';
 export * from './auth/index.js';
 export { Context, Env, asyncContext, getContext, setContext } from './context.js';
+export { app } from './app/index.js';
+export { graphqlHandler } from './app/handler/graphql-handler.js';