postgraphile 4.13.0 → 5.0.0-0.10

package/build/index.d.ts

@@ -1,8 +0,0 @@
-export * from 'graphile-utils';
-export { mixed, Middleware, PostGraphileOptions, CreateRequestHandlerOptions, GraphQLFormattedErrorExtended, GraphQLErrorExtended, HttpRequestHandler, WithPostGraphileContextOptions, } from './interfaces';
-export { Plugin, Build, Context, SchemaBuilder, SchemaListener, Inflection, Options, postGraphileBaseOverrides, postGraphileClassicIdsOverrides, PostGraphileInflectionPlugin, PostGraphileClassicIdsInflectionPlugin, } from 'postgraphile-core';
-export { postgraphile, createPostGraphileSchema, watchPostGraphileSchema, withPostGraphileContext, enhanceHttpServerWithWebSockets, debugPgClient, postgraphile as postgraphql, createPostGraphileSchema as createPostGraphQLSchema, watchPostGraphileSchema as watchPostGraphQLSchema, withPostGraphileContext as withPostGraphQLContext, enhanceHttpServerWithWebSockets as enhanceHttpServerWithSubscriptions, } from './postgraphile';
-export { PostGraphileResponse, PostGraphileResponseNode, PostGraphileResponseKoa, PostGraphileResponseFastify3, } from './postgraphile/http/frameworks';
-export { makePluginHook, PostGraphilePlugin } from './postgraphile/pluginHook';
-import { postgraphile } from './postgraphile';
-export default postgraphile;

package/build/index.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.makePluginHook = exports.PostGraphileResponseFastify3 = exports.PostGraphileResponseKoa = exports.PostGraphileResponseNode = exports.PostGraphileResponse = exports.enhanceHttpServerWithSubscriptions = exports.withPostGraphQLContext = exports.watchPostGraphQLSchema = exports.createPostGraphQLSchema = exports.postgraphql = exports.debugPgClient = exports.enhanceHttpServerWithWebSockets = exports.withPostGraphileContext = exports.watchPostGraphileSchema = exports.createPostGraphileSchema = exports.postgraphile = exports.PostGraphileClassicIdsInflectionPlugin = exports.PostGraphileInflectionPlugin = exports.postGraphileClassicIdsOverrides = exports.postGraphileBaseOverrides = exports.SchemaBuilder = void 0;
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("graphile-utils"), exports);
-var postgraphile_core_1 = require("postgraphile-core");
-Object.defineProperty(exports, "SchemaBuilder", { enumerable: true, get: function () { return postgraphile_core_1.SchemaBuilder; } });
-Object.defineProperty(exports, "postGraphileBaseOverrides", { enumerable: true, get: function () { return postgraphile_core_1.postGraphileBaseOverrides; } });
-Object.defineProperty(exports, "postGraphileClassicIdsOverrides", { enumerable: true, get: function () { return postgraphile_core_1.postGraphileClassicIdsOverrides; } });
-Object.defineProperty(exports, "PostGraphileInflectionPlugin", { enumerable: true, get: function () { return postgraphile_core_1.PostGraphileInflectionPlugin; } });
-Object.defineProperty(exports, "PostGraphileClassicIdsInflectionPlugin", { enumerable: true, get: function () { return postgraphile_core_1.PostGraphileClassicIdsInflectionPlugin; } });
-var postgraphile_1 = require("./postgraphile");
-Object.defineProperty(exports, "postgraphile", { enumerable: true, get: function () { return postgraphile_1.postgraphile; } });
-Object.defineProperty(exports, "createPostGraphileSchema", { enumerable: true, get: function () { return postgraphile_1.createPostGraphileSchema; } });
-Object.defineProperty(exports, "watchPostGraphileSchema", { enumerable: true, get: function () { return postgraphile_1.watchPostGraphileSchema; } });
-Object.defineProperty(exports, "withPostGraphileContext", { enumerable: true, get: function () { return postgraphile_1.withPostGraphileContext; } });
-Object.defineProperty(exports, "enhanceHttpServerWithWebSockets", { enumerable: true, get: function () { return postgraphile_1.enhanceHttpServerWithWebSockets; } });
-Object.defineProperty(exports, "debugPgClient", { enumerable: true, get: function () { return postgraphile_1.debugPgClient; } });
-// Backwards compatibility
-Object.defineProperty(exports, "postgraphql", { enumerable: true, get: function () { return postgraphile_1.postgraphile; } });
-Object.defineProperty(exports, "createPostGraphQLSchema", { enumerable: true, get: function () { return postgraphile_1.createPostGraphileSchema; } });
-Object.defineProperty(exports, "watchPostGraphQLSchema", { enumerable: true, get: function () { return postgraphile_1.watchPostGraphileSchema; } });
-Object.defineProperty(exports, "withPostGraphQLContext", { enumerable: true, get: function () { return postgraphile_1.withPostGraphileContext; } });
-Object.defineProperty(exports, "enhanceHttpServerWithSubscriptions", { enumerable: true, get: function () { return postgraphile_1.enhanceHttpServerWithWebSockets; } });
-var frameworks_1 = require("./postgraphile/http/frameworks");
-Object.defineProperty(exports, "PostGraphileResponse", { enumerable: true, get: function () { return frameworks_1.PostGraphileResponse; } });
-Object.defineProperty(exports, "PostGraphileResponseNode", { enumerable: true, get: function () { return frameworks_1.PostGraphileResponseNode; } });
-Object.defineProperty(exports, "PostGraphileResponseKoa", { enumerable: true, get: function () { return frameworks_1.PostGraphileResponseKoa; } });
-Object.defineProperty(exports, "PostGraphileResponseFastify3", { enumerable: true, get: function () { return frameworks_1.PostGraphileResponseFastify3; } });
-var pluginHook_1 = require("./postgraphile/pluginHook");
-Object.defineProperty(exports, "makePluginHook", { enumerable: true, get: function () { return pluginHook_1.makePluginHook; } });
-const postgraphile_2 = require("./postgraphile");
-exports.default = postgraphile_2.postgraphile;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7OztBQUFBLHlEQUErQjtBQWEvQix1REFZMkI7QUFSekIsa0hBQUEsYUFBYSxPQUFBO0FBSWIsOEhBQUEseUJBQXlCLE9BQUE7QUFDekIsb0lBQUEsK0JBQStCLE9BQUE7QUFDL0IsaUlBQUEsNEJBQTRCLE9BQUE7QUFDNUIsMklBQUEsc0NBQXNDLE9BQUE7QUFHeEMsK0NBYXdCO0FBWnRCLDRHQUFBLFlBQVksT0FBQTtBQUNaLHdIQUFBLHdCQUF3QixPQUFBO0FBQ3hCLHVIQUFBLHVCQUF1QixPQUFBO0FBQ3ZCLHVIQUFBLHVCQUF1QixPQUFBO0FBQ3ZCLCtIQUFBLCtCQUErQixPQUFBO0FBQy9CLDZHQUFBLGFBQWEsT0FBQTtBQUNiLDBCQUEwQjtBQUMxQiwyR0FBQSxZQUFZLE9BQWU7QUFDM0IsdUhBQUEsd0JBQXdCLE9BQTJCO0FBQ25ELHNIQUFBLHVCQUF1QixPQUEwQjtBQUNqRCxzSEFBQSx1QkFBdUIsT0FBMEI7QUFDakQsa0lBQUEsK0JBQStCLE9BQXNDO0FBR3ZFLDZEQUt3QztBQUp0QyxrSEFBQSxvQkFBb0IsT0FBQTtBQUNwQixzSEFBQSx3QkFBd0IsT0FBQTtBQUN4QixxSEFBQSx1QkFBdUIsT0FBQTtBQUN2QiwwSEFBQSw0QkFBNEIsT0FBQTtBQUc5Qix3REFBK0U7QUFBdEUsNEdBQUEsY0FBYyxPQUFBO0FBRXZCLGlEQUE4QztBQUM5QyxrQkFBZSwyQkFBWSxDQUFDIn0=

package/build/interfaces.d.ts

@@ -1,163 +0,0 @@
-/// <reference types="node" />
-import { GraphQLError, GraphQLSchema, SourceLocation, DocumentNode } from 'graphql';
-import { IncomingMessage, ServerResponse } from 'http';
-import { PluginHookFn } from './postgraphile/pluginHook';
-import { Pool } from 'pg';
-import { Plugin, PostGraphileCoreOptions } from 'postgraphile-core';
-import jwt = require('jsonwebtoken');
-import { EventEmitter } from 'events';
-import { PostGraphileResponse } from './postgraphile/http/frameworks';
-import { ShutdownActions } from './postgraphile/shutdownActions';
-import { KeyObject } from 'crypto';
-declare type PromiseOrDirect<T> = T | Promise<T>;
-declare type DirectOrCallback<Request, T> = T | ((req: Request) => PromiseOrDirect<T>);
-/**
- * A narrower type than `any` that won’t swallow errors from assumptions about
- * code.
- *
- * For example `(x as any).anything()` is ok. That function then returns `any`
- * as well so the problem compounds into `(x as any).anything().else()` and the
- * problem just goes from there. `any` is a type black hole that swallows any
- * useful type information and shouldn’t be used unless you know what you’re
- * doing.
- *
- * With `mixed` you must *prove* the type is what you want to use.
- *
- * The `mixed` type is identical to the `mixed` type in Flow.
- *
- * @see https://github.com/Microsoft/TypeScript/issues/9999
- * @see https://flowtype.org/docs/builtins.html#mixed
- */
-export declare type mixed = Record<string, any> | string | number | boolean | undefined | null;
-export declare type Middleware<Request extends IncomingMessage = IncomingMessage, Response extends ServerResponse = ServerResponse> = (req: Request, res: Response, next: (errOrEscape?: any) => void) => void;
-export interface PostGraphileOptions<Request extends IncomingMessage = IncomingMessage, Response extends ServerResponse = ServerResponse> extends PostGraphileCoreOptions {
-    watchPg?: boolean;
-    retryOnInitFail?: boolean | ((error: Error, attempts: number) => boolean | Promise<boolean>);
-    ownerConnectionString?: string;
-    subscriptions?: boolean;
-    live?: boolean;
-    websockets?: ('v0' | 'v1')[];
-    websocketOperations?: 'all' | 'subscriptions';
-    websocketMiddlewares?: Array<Middleware<Request, Response>>;
-    pgDefaultRole?: string;
-    dynamicJson?: boolean;
-    setofFunctionsContainNulls?: boolean;
-    classicIds?: boolean;
-    disableDefaultMutations?: boolean;
-    ignoreRBAC?: boolean;
-    ignoreIndexes?: boolean;
-    includeExtensionResources?: boolean;
-    showErrorStack?: boolean | 'json';
-    extendedErrors?: Array<string>;
-    handleErrors?: (errors: ReadonlyArray<GraphQLError>, req: Request, res: Response) => ReadonlyArray<GraphQLError | GraphQLErrorExtended>;
-    appendPlugins?: Array<Plugin>;
-    prependPlugins?: Array<Plugin>;
-    replaceAllPlugins?: Array<Plugin>;
-    skipPlugins?: Array<Plugin>;
-    readCache?: string | Record<string, any>;
-    writeCache?: string;
-    exportJsonSchemaPath?: string;
-    exportGqlSchemaPath?: string;
-    sortExport?: boolean;
-    graphqlRoute?: string;
-    eventStreamRoute?: string;
-    externalGraphqlRoute?: string;
-    externalEventStreamRoute?: string;
-    graphiqlRoute?: string;
-    externalUrlBase?: string;
-    graphiql?: boolean;
-    graphiqlCredentials?: 'include' | 'omit' | 'same-origin';
-    enhanceGraphiql?: boolean;
-    enableCors?: boolean;
-    bodySizeLimit?: string;
-    enableQueryBatching?: boolean;
-    jwtSecret?: Exclude<jwt.Secret, KeyObject>;
-    jwtPublicKey?: jwt.Secret | jwt.GetPublicKeyOrSecret;
-    jwtVerifyOptions?: jwt.VerifyOptions;
-    jwtSignOptions?: jwt.SignOptions;
-    jwtRole?: Array<string>;
-    jwtPgTypeIdentifier?: string;
-    jwtAudiences?: Array<string>;
-    legacyRelations?: 'only' | 'deprecated' | 'omit';
-    legacyJsonUuid?: boolean;
-    disableQueryLog?: boolean;
-    pgSettings?: DirectOrCallback<Request, {
-        [key: string]: mixed;
-    }>;
-    allowExplain?: DirectOrCallback<Request, boolean>;
-    additionalGraphQLContextFromRequest?: (req: Request, res: Response) => Promise<Record<string, any>>;
-    pluginHook?: PluginHookFn;
-    simpleCollections?: 'omit' | 'both' | 'only';
-    queryCacheMaxSize?: number;
-}
-export interface CreateRequestHandlerOptions extends PostGraphileOptions {
-    getGqlSchema: () => Promise<GraphQLSchema>;
-    pgPool: Pool;
-    _emitter: EventEmitter;
-    shutdownActions: ShutdownActions;
-}
-export interface GraphQLFormattedErrorExtended {
-    message: string;
-    locations: ReadonlyArray<SourceLocation> | void;
-    path: ReadonlyArray<string | number> | void;
-    extensions?: {
-        [s: string]: any;
-    };
-}
-export declare type GraphQLErrorExtended = GraphQLError & {
-    extensions: {
-        exception: {
-            hint?: string;
-            detail?: string;
-            code: string;
-        };
-    };
-};
-/**
- * A request handler for one of many different `http` frameworks.
- */
-export interface HttpRequestHandler<Request extends IncomingMessage = IncomingMessage, Response extends ServerResponse = ServerResponse> {
-    (req: Request, res: Response, next?: (error?: mixed) => void): Promise<void>;
-    (ctx: {
-        req: Request;
-        res: Response;
-    }, next: () => void): Promise<void>;
-    formatError: (e: GraphQLError) => GraphQLFormattedErrorExtended;
-    getGraphQLSchema: () => Promise<GraphQLSchema>;
-    pgPool: Pool;
-    withPostGraphileContextFromReqRes: (req: Request, res: Response, moreOptions: any, fn: (ctx: mixed) => any) => Promise<any>;
-    options: CreateRequestHandlerOptions;
-    handleErrors: (errors: ReadonlyArray<GraphQLError>, req: Request, res: Response) => ReadonlyArray<GraphQLError | GraphQLErrorExtended>;
-    graphqlRoute: string;
-    graphqlRouteHandler: (res: PostGraphileResponse) => Promise<void>;
-    graphiqlRoute: string;
-    graphiqlRouteHandler: ((res: PostGraphileResponse) => Promise<void>) | null;
-    faviconRouteHandler: ((res: PostGraphileResponse) => Promise<void>) | null;
-    eventStreamRoute: string;
-    eventStreamRouteHandler: ((res: PostGraphileResponse) => Promise<void>) | null;
-    /** Experimental! */
-    release: () => Promise<void>;
-}
-/**
- * Options passed to the `withPostGraphileContext` function
- */
-export interface WithPostGraphileContextOptions {
-    pgPool: Pool;
-    jwtToken?: string;
-    jwtSecret?: Exclude<jwt.Secret, KeyObject>;
-    jwtPublicKey?: jwt.Secret | jwt.GetPublicKeyOrSecret;
-    jwtAudiences?: Array<string>;
-    jwtRole?: Array<string>;
-    jwtVerifyOptions?: jwt.VerifyOptions;
-    pgDefaultRole?: string;
-    pgSettings?: {
-        [key: string]: mixed;
-    };
-    explain?: boolean;
-    queryDocumentAst?: DocumentNode;
-    operationName?: string;
-    pgForceTransaction?: boolean;
-    singleStatement?: boolean;
-    variables?: any;
-}
-export {};

package/build/interfaces.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9pbnRlcmZhY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/build/plugins.d.ts

@@ -1,3 +0,0 @@
-import { Plugin } from 'postgraphile-core';
-export declare const makePgSmartTagsFromFilePlugin: (tagsFile?: string) => Plugin;
-export declare const TagsFilePlugin: Plugin;

package/build/plugins.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TagsFilePlugin = exports.makePgSmartTagsFromFilePlugin = void 0;
-const fs_1 = require("fs");
-const graphile_utils_1 = require("graphile-utils");
-const JSON5 = require("json5");
-const makePgSmartTagsFromFilePlugin = (tagsFile = process.cwd() + '/postgraphile.tags.json5') => {
-    /*
-     * We're wrapping the `smartTagsPlugin` defined below with a plugin wrapper
-     * so that any errors from reading the smart tags file are thrown when the
-     * plugin is *loaded* rather than from when it is defined.
-     */
-    const plugin = (builder, options) => {
-        function handleTagsError(err) {
-            console.error(`Failed to process smart tags file '${tagsFile}': ${err.message}`);
-        }
-        const initialTagsJSON = JSON5.parse(fs_1.readFileSync(tagsFile, 'utf8'));
-        let tagsListener = null;
-        const smartTagsPlugin = graphile_utils_1.makeJSONPgSmartTagsPlugin(initialTagsJSON, updateJSON => {
-            if (tagsListener) {
-                fs_1.unwatchFile(tagsFile, tagsListener);
-                tagsListener = null;
-            }
-            if (updateJSON) {
-                tagsListener = (_current, _previous) => {
-                    fs_1.readFile(tagsFile, 'utf8', (err, data) => {
-                        if (err) {
-                            if (err['code'] === 'ENOENT') {
-                                updateJSON(null);
-                            }
-                            else {
-                                handleTagsError(err);
-                            }
-                            return;
-                        }
-                        try {
-                            updateJSON(JSON5.parse(data));
-                        }
-                        catch (e) {
-                            handleTagsError(e);
-                        }
-                    });
-                };
-                fs_1.watchFile(tagsFile, { interval: 507 }, tagsListener);
-            }
-        });
-        return smartTagsPlugin(builder, options);
-    };
-    return plugin;
-};
-exports.makePgSmartTagsFromFilePlugin = makePgSmartTagsFromFilePlugin;
-exports.TagsFilePlugin = exports.makePgSmartTagsFromFilePlugin();
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDJCQUEyRTtBQUMzRSxtREFBNEU7QUFDNUUsK0JBQStCO0FBR3hCLE1BQU0sNkJBQTZCLEdBQUcsQ0FDM0MsUUFBUSxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsR0FBRywwQkFBMEIsRUFDN0MsRUFBRTtJQUNWOzs7O09BSUc7SUFDSCxNQUFNLE1BQU0sR0FBVyxDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsRUFBRTtRQUMxQyxTQUFTLGVBQWUsQ0FBQyxHQUFVO1lBQ2pDLE9BQU8sQ0FBQyxLQUFLLENBQUMsc0NBQXNDLFFBQVEsTUFBTSxHQUFHLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQztRQUNuRixDQUFDO1FBRUQsTUFBTSxlQUFlLEdBQW9CLEtBQUssQ0FBQyxLQUFLLENBQUMsaUJBQVksQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDLENBQUMsQ0FBQztRQUVyRixJQUFJLFlBQVksR0FBdUQsSUFBSSxDQUFDO1FBQzVFLE1BQU0sZUFBZSxHQUFHLDBDQUF5QixDQUFDLGVBQWUsRUFBRSxVQUFVLENBQUMsRUFBRTtZQUM5RSxJQUFJLFlBQVksRUFBRTtnQkFDaEIsZ0JBQVcsQ0FBQyxRQUFRLEVBQUUsWUFBWSxDQUFDLENBQUM7Z0JBQ3BDLFlBQVksR0FBRyxJQUFJLENBQUM7YUFDckI7WUFDRCxJQUFJLFVBQVUsRUFBRTtnQkFDZCxZQUFZLEdBQUcsQ0FBQyxRQUFRLEVBQUUsU0FBUyxFQUFRLEVBQUU7b0JBQzNDLGFBQVEsQ0FBQyxRQUFRLEVBQUUsTUFBTSxFQUFFLENBQUMsR0FBRyxFQUFFLElBQUksRUFBRSxFQUFFO3dCQUN2QyxJQUFJLEdBQUcsRUFBRTs0QkFDUCxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxRQUFRLEVBQUU7Z0NBQzVCLFVBQVUsQ0FBQyxJQUFJLENBQUMsQ0FBQzs2QkFDbEI7aUNBQU07Z0NBQ0wsZUFBZSxDQUFDLEdBQUcsQ0FBQyxDQUFDOzZCQUN0Qjs0QkFDRCxPQUFPO3lCQUNSO3dCQUNELElBQUk7NEJBQ0YsVUFBVSxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQzt5QkFDL0I7d0JBQUMsT0FBTyxDQUFDLEVBQUU7NEJBQ1YsZUFBZSxDQUFDLENBQUMsQ0FBQyxDQUFDO3lCQUNwQjtvQkFDSCxDQUFDLENBQUMsQ0FBQztnQkFDTCxDQUFDLENBQUM7Z0JBRUYsY0FBUyxDQUFDLFFBQVEsRUFBRSxFQUFFLFFBQVEsRUFBRSxHQUFHLEVBQUUsRUFBRSxZQUFZLENBQUMsQ0FBQzthQUN0RDtRQUNILENBQUMsQ0FBQyxDQUFDO1FBQ0gsT0FBTyxlQUFlLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQzNDLENBQUMsQ0FBQztJQUNGLE9BQU8sTUFBTSxDQUFDO0FBQ2hCLENBQUMsQ0FBQztBQTlDVyxRQUFBLDZCQUE2QixpQ0E4Q3hDO0FBRVcsUUFBQSxjQUFjLEdBQUcscUNBQTZCLEVBQUUsQ0FBQyJ9

package/build/postgraphile/cli.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-import { mixed } from '../interfaces';
-export declare type AddFlagFn = (optionString: string, description: string, parse?: (option: string) => mixed) => AddFlagFn;