@graphql-codegen/plugin-helpers 2.3.1 → 2.4.0-alpha-23d229715.0

package/helpers.d.ts

@@ -2,7 +2,7 @@ import { Types } from './types';
 import { DocumentNode, GraphQLSchema, GraphQLOutputType } from 'graphql';
 export declare function isOutputConfigArray(type: any): type is Types.OutputConfig[];
 export declare function isConfiguredOutput(type: any): type is Types.ConfiguredOutput;
-export declare function normalizeOutputParam(config: Types.OutputConfig | Types.ConfiguredOutput): Types.ConfiguredOutput;
+export declare function normalizeOutputParam(config: Types.OutputConfig | Types.ConfiguredPlugin[] | Types.ConfiguredOutput): Types.ConfiguredOutput;
 export declare function normalizeInstanceOrArray<T>(type: T | T[]): T[];
 export declare function normalizeConfig(config: Types.OutputConfig | Types.OutputConfig[]): Types.ConfiguredPlugin[];
 export declare function hasNullableTypeRecursively(type: GraphQLOutputType): boolean;

package/index.d.ts

@@ -6,3 +6,4 @@ export * from './federation';
 export * from './errors';
 export * from './getCachedDocumentNodeFromSchema';
 export * from './oldVisit';
+export * from './profiler';

package/index.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
 
 const module$1 = require('module');
-const process = require('process');
+const process$1 = require('process');
 const changeCaseAll = require('change-case-all');
 const graphql = require('graphql');
 const merge = _interopDefault(require('lodash/merge.js'));
@@ -28,7 +28,7 @@ function resolveExternalModuleAndFn(pointer) {
     else {
         // we have to use a path to a filename here (it does not need to exist.)
         // https://github.com/dotansimha/graphql-code-generator/issues/6553
-        const cwdRequire = module$1.createRequire(process.cwd() + '/index.js');
+        const cwdRequire = module$1.createRequire(process$1.cwd() + '/index.js');
         loadedModule = cwdRequire(moduleName);
         if (!(functionName in loadedModule) && typeof loadedModule !== 'function') {
             throw new Error(`${functionName} couldn't be found in module ${moduleName}!`);
@@ -517,9 +517,57 @@ function oldVisit(root, { enter: enterVisitors, leave: leaveVisitors, ...newVisi
     return graphql.visit(root, newVisitor);
 }
 
+function createNoopProfiler() {
+    return {
+        run(fn) {
+            return Promise.resolve().then(() => fn());
+        },
+        collect() {
+            return [];
+        },
+    };
+}
+function createProfiler() {
+    const events = [];
+    return {
+        collect() {
+            return events;
+        },
+        run(fn, name, cat) {
+            let startTime;
+            return Promise.resolve()
+                .then(() => {
+                startTime = process.hrtime();
+            })
+                .then(() => fn())
+                .then(value => {
+                const duration = process.hrtime(startTime);
+                // Trace Event Format documentation:
+                // https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview
+                const event = {
+                    name,
+                    cat,
+                    ph: 'X',
+                    ts: hrtimeToMicroseconds(startTime),
+                    pid: 1,
+                    tid: 0,
+                    dur: hrtimeToMicroseconds(duration),
+                };
+                events.push(event);
+                return value;
+            });
+        },
+    };
+}
+function hrtimeToMicroseconds(hrtime) {
+    return (hrtime[0] * 1e9 + hrtime[1]) / 1000;
+}
+
 exports.ApolloFederation = ApolloFederation;
 exports.DetailedError = DetailedError;
 exports.addFederationReferencesToSchema = addFederationReferencesToSchema;
+exports.createNoopProfiler = createNoopProfiler;
+exports.createProfiler = createProfiler;
 exports.federationSpec = federationSpec;
 exports.getBaseType = getBaseType;
 exports.getCachedDocumentNodeFromSchema = getCachedDocumentNodeFromSchema;

package/index.mjs

@@ -511,4 +511,50 @@ function oldVisit(root, { enter: enterVisitors, leave: leaveVisitors, ...newVisi
     return visit(root, newVisitor);
 }
 
-export { ApolloFederation, DetailedError, addFederationReferencesToSchema, federationSpec, getBaseType, getCachedDocumentNodeFromSchema, hasNullableTypeRecursively, isComplexPluginOutput, isConfiguredOutput, isDetailedError, isOutputConfigArray, isUsingTypes, isWrapperType, mergeOutputs, normalizeConfig, normalizeInstanceOrArray, normalizeOutputParam, oldVisit, removeFederation, removeNonNullWrapper, resolveExternalModuleAndFn };
+function createNoopProfiler() {
+    return {
+        run(fn) {
+            return Promise.resolve().then(() => fn());
+        },
+        collect() {
+            return [];
+        },
+    };
+}
+function createProfiler() {
+    const events = [];
+    return {
+        collect() {
+            return events;
+        },
+        run(fn, name, cat) {
+            let startTime;
+            return Promise.resolve()
+                .then(() => {
+                startTime = process.hrtime();
+            })
+                .then(() => fn())
+                .then(value => {
+                const duration = process.hrtime(startTime);
+                // Trace Event Format documentation:
+                // https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview
+                const event = {
+                    name,
+                    cat,
+                    ph: 'X',
+                    ts: hrtimeToMicroseconds(startTime),
+                    pid: 1,
+                    tid: 0,
+                    dur: hrtimeToMicroseconds(duration),
+                };
+                events.push(event);
+                return value;
+            });
+        },
+    };
+}
+function hrtimeToMicroseconds(hrtime) {
+    return (hrtime[0] * 1e9 + hrtime[1]) / 1000;
+}
+
+export { ApolloFederation, DetailedError, addFederationReferencesToSchema, createNoopProfiler, createProfiler, federationSpec, getBaseType, getCachedDocumentNodeFromSchema, hasNullableTypeRecursively, isComplexPluginOutput, isConfiguredOutput, isDetailedError, isOutputConfigArray, isUsingTypes, isWrapperType, mergeOutputs, normalizeConfig, normalizeInstanceOrArray, normalizeOutputParam, oldVisit, removeFederation, removeNonNullWrapper, resolveExternalModuleAndFn };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/plugin-helpers",
-  "version": "2.3.1",
+  "version": "2.4.0-alpha-23d229715.0",
   "description": "GraphQL Code Generator common utils and types",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
@@ -8,7 +8,7 @@
   "dependencies": {
     "@graphql-tools/utils": "^8.5.2",
     "change-case-all": "1.0.14",
-    "common-tags": "1.8.0",
+    "common-tags": "1.8.2",
     "import-from": "4.0.0",
     "lodash": "~4.17.0",
     "tslib": "~2.3.0"
@@ -26,6 +26,7 @@
     "definition": "index.d.ts"
   },
   "exports": {
+    "./package.json": "./package.json",
     ".": {
       "require": "./index.js",
       "import": "./index.mjs"

package/profiler.d.ts

@@ -0,0 +1,28 @@
+export interface ProfilerEvent {
+    /** The name of the event, as displayed in Trace Viewer */
+    name: string;
+    /** The event categories. This is a comma separated list of categories for the event. The categories can be used to hide events in the Trace Viewer UI. */
+    cat: string;
+    /** The event type. This is a single character which changes depending on the type of event being output. The valid values are listed in the table below. We will discuss each phase type below. */
+    ph: string;
+    /** The tracing clock timestamp of the event. The timestamps are provided at microsecond granularity. */
+    ts: number;
+    /** Optional. The thread clock timestamp of the event. The timestamps are provided at microsecond granularity. */
+    tts?: string;
+    /** The process ID for the process that output this event. */
+    pid: number;
+    /** The thread ID for the thread that output this event. */
+    tid: number;
+    /** Any arguments provided for the event. Some of the event types have required argument fields, otherwise, you can put any information you wish in here. The arguments are displayed in Trace Viewer when you view an event in the analysis section. */
+    args?: any;
+    /** duration */
+    dur: number;
+    /** A fixed color name to associate with the event. If provided, cname must be one of the names listed in trace-viewer's base color scheme's reserved color names list */
+    cname?: string;
+}
+export interface Profiler {
+    run<T>(fn: () => Promise<T>, name: string, cat?: string): Promise<T>;
+    collect(): ProfilerEvent[];
+}
+export declare function createNoopProfiler(): Profiler;
+export declare function createProfiler(): Profiler;

package/types.d.ts

@@ -1,5 +1,6 @@
 import { GraphQLSchema, DocumentNode } from 'graphql';
 import { Source } from '@graphql-tools/utils';
+import type { Profiler } from './profiler';
 export declare namespace Types {
     interface GenerateOptions {
         filename: string;
@@ -17,6 +18,7 @@ export declare namespace Types {
         pluginContext?: {
             [key: string]: any;
         };
+        profiler?: Profiler;
     }
     type FileOutput = {
         filename: string;
@@ -293,6 +295,7 @@ export declare namespace Types {
         pluginContext?: {
             [name: string]: any;
         };
+        profiler?: Profiler;
     };
     type OutputPreset<TPresetConfig = any> = {
         buildGeneratesSection: (options: PresetFnArgs<TPresetConfig>) => Promisable<GenerateOptions[]>;
@@ -367,7 +370,7 @@ export declare namespace Types {
          * For more details: https://graphql-code-generator.com/docs/getting-started/codegen-config
          */
         generates: {
-            [outputPath: string]: ConfiguredOutput;
+            [outputPath: string]: ConfiguredOutput | ConfiguredPlugin[];
         };
         /**
          * @description A flag to overwrite files if they already exist when generating code (`true` by default).