@cedarjs/graphql-server 0.0.4

package/dist/types.d.ts

@@ -0,0 +1,215 @@
+import type { AllowedOperations } from '@envelop/filter-operation-type';
+import type { GraphQLArmorConfig } from '@escape.tech/graphql-armor-types';
+import type { IExecutableSchemaDefinition } from '@graphql-tools/schema';
+import type { APIGatewayProxyEvent, Context as LambdaContext } from 'aws-lambda';
+import type { GraphQLObjectType, GraphQLInterfaceType, DocumentNode } from 'graphql';
+import type { Plugin } from 'graphql-yoga';
+import type { AuthContextPayload, Decoder } from '@cedarjs/api';
+import type { CorsConfig } from '@cedarjs/api';
+import type { RedwoodRealtimeOptions } from '@cedarjs/realtime';
+import type { DirectiveGlobImports } from './directives/makeDirectives';
+import type { useRedwoodDirectiveReturn, DirectivePluginOptions } from './plugins/useRedwoodDirective';
+import type { LoggerConfig } from './plugins/useRedwoodLogger';
+import type { RedwoodTrustedDocumentOptions } from './plugins/useRedwoodTrustedDocuments';
+export type Resolver = (...args: unknown[]) => unknown;
+export type Services = {
+    [funcName: string]: Resolver;
+};
+type ThenArg<T> = T extends PromiseLike<infer U> ? U : T;
+export type ResolverArgs<TRoot> = {
+    root: ThenArg<TRoot>;
+};
+export type SdlGlobImports = {
+    [key: string]: {
+        schema: DocumentNode;
+        resolvers: Record<string, unknown>;
+    };
+};
+export type ServicesGlobImports = {
+    [serviceName: string]: Services;
+};
+export interface MakeServicesInterface {
+    services: ServicesGlobImports;
+}
+export type MakeServices = (args: MakeServicesInterface) => ServicesGlobImports;
+export type GraphQLTypeWithFields = GraphQLObjectType | GraphQLInterfaceType;
+export type { useRedwoodDirectiveReturn, DirectivePluginOptions };
+export type GetCurrentUser = (decoded: AuthContextPayload[0], raw: AuthContextPayload[1], req?: AuthContextPayload[2]) => Promise<null | Record<string, unknown>>;
+export type GenerateGraphiQLHeader = () => string;
+export type Context = Record<string, unknown>;
+export type ContextFunction = (...args: any[]) => Context | Promise<Context>;
+export type ArmorConfig = {
+    logContext?: boolean;
+    logErrors?: boolean;
+} & GraphQLArmorConfig;
+/** This is an interface so you can extend it inside your application when needed */
+export interface RedwoodGraphQLContext {
+    event: APIGatewayProxyEvent;
+    requestContext: LambdaContext;
+    currentUser?: ThenArg<ReturnType<GetCurrentUser>> | AuthContextPayload | null;
+    [index: string]: unknown;
+}
+export interface RedwoodOpenTelemetryConfig {
+    /**
+     * @description Enables the creation of a span for each resolver execution.
+     */
+    resolvers: boolean;
+    /**
+     * @description Includes the execution result in the span attributes.
+     */
+    variables: boolean;
+    /**
+     * @description Includes the variables in the span attributes.
+     */
+    result: boolean;
+}
+export interface RedwoodScalarConfig {
+    File?: boolean;
+}
+/**
+ * GraphQLYogaOptions
+ */
+export type GraphQLYogaOptions = {
+    /**
+     * @description The identifier used in the GraphQL health check response.
+     * It verifies readiness when sent as a header in the readiness check request.
+     *
+     * By default, the identifier is `yoga` as seen in the HTTP response header `x-yoga-id: yoga`
+     */
+    healthCheckId?: string;
+    /**
+     * @description Customize GraphQL Logger
+     *
+     * Collect resolver timings, and exposes trace data for
+     * an individual request under extensions as part of the GraphQL response.
+     */
+    loggerConfig: LoggerConfig;
+    /**
+     * @description Modify the resolver and global context.
+     */
+    context?: Context | ContextFunction;
+    /**
+     * @description An async function that maps the auth token retrieved from the
+     * request headers to an object.
+     * Is it executed when the `auth-provider` contains one of the supported
+     * providers.
+     */
+    getCurrentUser?: GetCurrentUser;
+    /**
+     * @description A callback when an unhandled exception occurs. Use this to disconnect your prisma instance.
+     */
+    onException?: () => void;
+    /**
+     * @description Services passed from the glob import:
+     * import services from 'src/services\/**\/*.{js,ts}'
+     */
+    services: ServicesGlobImports;
+    /**
+     * @description SDLs (schema definitions) passed from the glob import:
+     * import sdls from 'src/graphql\/**\/*.{js,ts}'
+     */
+    sdls: SdlGlobImports;
+    /**
+     * @description Directives passed from the glob import:
+     * import directives from 'src/directives/**\/*.{js,ts}'
+     */
+    directives?: DirectiveGlobImports;
+    /**
+     * @description A list of options passed to [makeExecutableSchema]
+     * (https://www.graphql-tools.com/docs/generate-schema/#makeexecutableschemaoptions).
+     */
+    schemaOptions?: Partial<IExecutableSchemaDefinition>;
+    /**
+     * @description CORS configuration
+     */
+    cors?: CorsConfig;
+    /**
+     *  @description Customize GraphQL Armor plugin configuration
+     *
+     * @see https://escape-technologies.github.io/graphql-armor/docs/configuration/examples
+     */
+    armorConfig?: ArmorConfig;
+    /**
+     * @description Customize the default error message used to mask errors.
+     *
+     * By default, the masked error message is "Something went wrong"
+     *
+     * @see https://github.com/dotansimha/envelop/blob/main/packages/core/docs/use-masked-errors.md
+     */
+    defaultError?: string;
+    /**
+     * @description Only allows the specified operation types (e.g. subscription, query or mutation).
+     *
+     * By default, only allow query and mutation (ie, do not allow subscriptions).
+     *
+     * An array of GraphQL's OperationTypeNode enums:
+     * - OperationTypeNode.SUBSCRIPTION
+     * - OperationTypeNode.QUERY
+     * - OperationTypeNode.MUTATION
+     *
+     * @see https://github.com/dotansimha/envelop/tree/main/packages/plugins/filter-operation-type
+     */
+    allowedOperations?: AllowedOperations;
+    /**
+     * @description Custom Envelop plugins
+     */
+    extraPlugins?: Plugin[];
+    /**
+     * @description Auth-provider specific token decoder
+     */
+    authDecoder?: Decoder | Decoder[];
+    /**
+     * @description Customize the GraphiQL Endpoint that appears in the location bar of the GraphQL Playground
+     *
+     * Defaults to '/graphql' as this value must match the name of the `graphql` function on the api-side.
+     */
+    graphiQLEndpoint?: string;
+    /**
+     * @description Allow GraphiQL playground.
+     * By default, GraphiQL playground is disabled in production. Explicitly set this to true or false to override in all environments.
+     */
+    allowGraphiQL?: boolean;
+    /**
+     * @description Allow schema introspection.
+     * By default, schema introspection is disabled in production. Explicitly set this to true or false to override in all environments.
+     */
+    allowIntrospection?: boolean;
+    /**
+     * @description Function that returns custom headers (as string) for GraphiQL.
+     *
+     * Headers must set auth-provider, Authorization and (if using dbAuth) the encrypted cookie.
+     */
+    generateGraphiQLHeader?: GenerateGraphiQLHeader;
+    /**
+     * @description Configure RedwoodRealtime plugin with subscriptions and live queries
+     *
+     * Only supported in a server deploy and not allowed with GraphQLHandler config
+     */
+    realtime?: RedwoodRealtimeOptions;
+    /**
+     * @description Configure Trusted Documents options
+     *
+     * @see https://benjie.dev/graphql/trusted-documents
+     * @see https://the-guild.dev/graphql/yoga-server/docs/features/persisted-operations
+     */
+    trustedDocuments?: RedwoodTrustedDocumentOptions;
+    /**
+     * @description Configure OpenTelemetry plugin behaviour
+     */
+    openTelemetryOptions?: RedwoodOpenTelemetryConfig;
+    /**
+     * @description Configure which scalars to include in the schema. This should match your
+     * `graphql.includeScalars` configuration in `redwood.toml`.
+     *
+     * The default is to include. You must set to `false` to exclude.
+     */
+    includeScalars?: RedwoodScalarConfig;
+};
+/**
+ * @description Configure GraphQLHandler with options
+ *
+ * Note: RedwoodRealtime is not supported
+ */
+export type GraphQLHandlerOptions = GraphQLYogaOptions;
+export type GraphiQLOptions = Pick<GraphQLYogaOptions, 'allowGraphiQL' | 'generateGraphiQLHeader'>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAC1E,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,uBAAuB,CAAA;AACxE,OAAO,KAAK,EAAE,oBAAoB,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,YAAY,CAAA;AAChF,OAAO,KAAK,EACV,iBAAiB,EACjB,oBAAoB,EACpB,YAAY,EACb,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAE/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AACvE,OAAO,KAAK,EACV,yBAAyB,EACzB,sBAAsB,EACvB,MAAM,+BAA+B,CAAA;AACtC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,sCAAsC,CAAA;AAEzF,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAA;AACtD,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC7B,CAAA;AAED,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAExD,MAAM,MAAM,YAAY,CAAC,KAAK,IAAI;IAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;CAAE,CAAA;AAE1D,MAAM,MAAM,cAAc,GAAG;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,MAAM,EAAE,YAAY,CAAA;QACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,CAAA;CACF,CAAA;AAMD,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,WAAW,EAAE,MAAM,GAAG,QAAQ,CAAA;CAChC,CAAA;AACD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,mBAAmB,CAAA;CAC9B;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,qBAAqB,KAAK,mBAAmB,CAAA;AAE/E,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG,oBAAoB,CAAA;AAE5E,YAAY,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,CAAA;AAEjE,MAAM,MAAM,cAAc,GAAG,CAC3B,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAC9B,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAC1B,GAAG,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,KACxB,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAE5C,MAAM,MAAM,sBAAsB,GAAG,MAAM,MAAM,CAAA;AAEjD,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAC7C,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAE5E,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,GAAG,kBAAkB,CAAA;AAEtB,oFAAoF;AACpF,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,oBAAoB,CAAA;IAC3B,cAAc,EAAE,aAAa,CAAA;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,GAAG,kBAAkB,GAAG,IAAI,CAAA;IAE7E,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,OAAO,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;OAKG;IACH,YAAY,EAAE,YAAY,CAAA;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,eAAe,CAAA;IAEnC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,IAAI,CAAA;IAExB;;;OAGG;IACH,QAAQ,EAAE,mBAAmB,CAAA;IAE7B;;;OAGG;IACH,IAAI,EAAE,cAAc,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,oBAAoB,CAAA;IAEjC;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAA;IAEpD;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAA;IAEjC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,CAAA;IAE/C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAA;IAEjC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,6BAA6B,CAAA;IAEhD;;OAEG;IACH,oBAAoB,CAAC,EAAE,0BAA0B,CAAA;IAEjD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAA;CACrC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,kBAAkB,CAAA;AAEtD,MAAM,MAAM,eAAe,GAAG,IAAI,CAChC,kBAAkB,EAClB,eAAe,GAAG,wBAAwB,CAC3C,CAAA"}

package/dist/types.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@cedarjs/graphql-server",
+  "version": "0.0.4",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cedarjs/cedar.git",
+    "directory": "packages/graphql-server"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsx ./build.mts && yarn build:types",
+    "build:pack": "yarn pack -o cedar-graphql-server.tgz",
+    "build:types": "tsc --build --verbose ./tsconfig.json",
+    "build:watch": "nodemon --watch src --ext \"js,jsx,ts,tsx\" --ignore dist --exec \"yarn build\"",
+    "prepublishOnly": "NODE_ENV=production yarn build",
+    "test": "yarn vitest run src/",
+    "test:watch": "yarn test --watch"
+  },
+  "dependencies": {
+    "@babel/runtime-corejs3": "7.26.10",
+    "@cedarjs/api": "0.0.4",
+    "@cedarjs/context": "0.0.4",
+    "@envelop/core": "5.0.2",
+    "@envelop/depth-limit": "4.0.0",
+    "@envelop/disable-introspection": "6.0.0",
+    "@envelop/filter-operation-type": "6.0.0",
+    "@envelop/on-resolve": "4.1.1",
+    "@escape.tech/graphql-armor": "3.0.1",
+    "@graphql-tools/merge": "9.0.7",
+    "@graphql-tools/schema": "10.0.6",
+    "@graphql-tools/utils": "10.5.4",
+    "@graphql-yoga/plugin-persisted-operations": "3.7.0",
+    "@opentelemetry/api": "1.8.0",
+    "core-js": "3.42.0",
+    "graphql": "16.9.0",
+    "graphql-scalars": "1.23.0",
+    "graphql-tag": "2.12.6",
+    "graphql-yoga": "5.7.0",
+    "lodash": "4.17.21",
+    "uuid": "10.0.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.26.4",
+    "@babel/core": "^7.26.10",
+    "@cedarjs/framework-tools": "0.0.4",
+    "@cedarjs/project-config": "0.0.4",
+    "@cedarjs/realtime": "0.0.4",
+    "@envelop/types": "5.0.0",
+    "@types/aws-lambda": "8.10.145",
+    "@types/jsonwebtoken": "9.0.8",
+    "@types/lodash": "4.17.15",
+    "@types/uuid": "10.0.0",
+    "@whatwg-node/fetch": "0.9.21",
+    "@whatwg-node/promise-helpers": "^1.3.0",
+    "jsonwebtoken": "9.0.2",
+    "tsx": "4.19.3",
+    "typescript": "5.6.2",
+    "vitest": "2.1.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "5b4f77f985bd86ee31ee7338312627accf0cb85b"
+}