@stepzen/sdk 0.24.0 → 0.25.0-beta.1

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import { SDK } from './init';
 export * from './init';
 export * from './init-v2';
+export { fetchGraphQLQuery } from './shared/graphql-client';
 /**
  * The default SDK instance that does not know the name of the app using the SDK.
  * It tries to guess the app name from `process.argv`

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAO,GAAG,EAAC,MAAM,QAAQ,CAAA;AAEhC,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AAEzB;;;;;GAKG;AACH,QAAA,MAAM,OAAO,EAAE,GAIb,CAAA;AAEF,eAAe,OAAO,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAO,GAAG,EAAC,MAAM,QAAQ,CAAA;AAEhC,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AACzB,OAAO,EAAC,iBAAiB,EAAC,MAAM,yBAAyB,CAAA;AAEzD;;;;;GAKG;AACH,QAAA,MAAM,OAAO,EAAE,GAIb,CAAA;AAEF,eAAe,OAAO,CAAA"}

package/lib/index.js

@@ -1,11 +1,14 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchGraphQLQuery = void 0;
 const tslib_1 = require("tslib");
 const path = require("path");
 const init_1 = require("./init");
 tslib_1.__exportStar(require("./init"), exports);
 tslib_1.__exportStar(require("./init-v2"), exports);
+var graphql_client_1 = require("./shared/graphql-client");
+Object.defineProperty(exports, "fetchGraphQLQuery", { enumerable: true, get: function () { return graphql_client_1.fetchGraphQLQuery; } });
 /**
  * The default SDK instance that does not know the name of the app using the SDK.
  * It tries to guess the app name from `process.argv`

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,6BAA4B;AAC5B,iCAAgC;AAEhC,iDAAsB;AACtB,oDAAyB;AAEzB;;;;;GAKG;AACH,MAAM,OAAO,GAAQ,IAAA,WAAI,EAAC;IACxB,wEAAwE;IACxE,6EAA6E;IAC7E,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC3D,CAAC,CAAA;AAEF,kBAAe,OAAO,CAAA;AAEtB,6EAA6E;AAC7E,kGAAkG;AAClG,iGAAiG;AACjG,uBAAuB;AACvB,MAAM,CAAC,OAAO,GAAG,EAAC,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,OAAO,EAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;;AAE9C,6BAA4B;AAC5B,iCAAgC;AAEhC,iDAAsB;AACtB,oDAAyB;AACzB,0DAAyD;AAAjD,mHAAA,iBAAiB,OAAA;AAEzB;;;;;GAKG;AACH,MAAM,OAAO,GAAQ,IAAA,WAAI,EAAC;IACxB,wEAAwE;IACxE,6EAA6E;IAC7E,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CAC3D,CAAC,CAAA;AAEF,kBAAe,OAAO,CAAA;AAEtB,6EAA6E;AAC7E,kGAAkG;AAClG,iGAAiG;AACjG,uBAAuB;AACvB,MAAM,CAAC,OAAO,GAAG,EAAC,GAAG,MAAM,CAAC,OAAO,EAAE,GAAG,OAAO,EAAC,CAAA"}

package/lib/shared/graphql-client.d.ts

@@ -1,38 +1,32 @@
+import type { ExecutionResult } from 'graphql';
 import { SDKConfigurationV2 } from './types';
-export declare type GraphQLSuccessResponse<T> = {
-    data: T;
+export declare type GraphQLResponse<TData = Record<string, any>> = GraphQLSuccessResponse<TData> | GraphQLErrorResponse<TData>;
+declare type GraphQLSuccessResponse<TData> = ExecutionResult<TData> & {
+    data: TData;
     errors: undefined;
 };
-export declare type GraphQLErrorResponse<T> = {
-    data: T | null;
-    errors: Array<{
-        message: string;
-        locations?: Array<{
-            line: number;
-            column: number;
-        }>;
-        path?: Array<string | number>;
-    }>;
-};
-export declare type GraphQLResponse<T> = GraphQLSuccessResponse<T> | GraphQLErrorResponse<T>;
-export declare const fetchGraphQLQuery: <T>({ url, query, variables, headers, }: {
+declare type GraphQLErrorResponse<TData> = ExecutionResult<TData> & Required<Pick<ExecutionResult<TData>, 'errors'>>;
+export declare const fetchGraphQLQuery: <T = Record<string, any>>({ url, query, variables, headers, }: {
     url: URL | string;
     query: string;
-    variables: Record<string, any>;
-    headers: Record<string, any>;
-}) => Promise<GraphQLResponse<T>>;
-export declare const fetchZenCtlGraphQLQuery: <T>({ account, adminKey, deploymentType, query, variables, sdkConfig, }: {
+    variables?: Record<string, any> | undefined;
+    headers?: Record<string, any> | undefined;
+}) => Promise<ExecutionResult<T, {
+    [key: string]: any;
+}>>;
+export declare const fetchZenCtlGraphQLQuery: <T = Record<string, any>>({ account, adminKey, deploymentType, query, variables, sdkConfig, }: {
     account: string;
     adminKey: string;
     deploymentType: string;
     query: string;
-    variables: Record<string, any>;
+    variables?: Record<string, any> | undefined;
     sdkConfig: SDKConfigurationV2;
 }) => Promise<GraphQLResponse<T>>;
-export declare const fetchPublicAccountGraphQLQuery: <T>({ url, query, variables, sdkConfig, }: {
+export declare const fetchPublicAccountGraphQLQuery: <T = Record<string, any>>({ url, query, variables, sdkConfig, }: {
     url: URL | string;
     query: string;
-    variables: Record<string, any>;
+    variables?: Record<string, any> | undefined;
     sdkConfig: SDKConfigurationV2;
 }) => Promise<GraphQLResponse<T>>;
+export {};
 //# sourceMappingURL=graphql-client.d.ts.map

package/lib/shared/graphql-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"graphql-client.d.ts","sourceRoot":"","sources":["../../src/shared/graphql-client.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,kBAAkB,EAAC,MAAM,SAAS,CAAA;AAG1C,oBAAY,sBAAsB,CAAC,CAAC,IAAI;IACtC,IAAI,EAAE,CAAC,CAAA;IACP,MAAM,EAAE,SAAS,CAAA;CAClB,CAAA;AAED,oBAAY,oBAAoB,CAAC,CAAC,IAAI;IACpC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAA;IACd,MAAM,EAAE,KAAK,CAAC;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,SAAS,CAAC,EAAE,KAAK,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAC,CAAC,CAAA;QACjD,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;KAC9B,CAAC,CAAA;CACH,CAAA;AAED,oBAAY,eAAe,CAAC,CAAC,IACzB,sBAAsB,CAAC,CAAC,CAAC,GACzB,oBAAoB,CAAC,CAAC,CAAC,CAAA;AAE3B,eAAO,MAAM,iBAAiB;SAMvB,GAAG,GAAG,MAAM;WACV,MAAM;eACF,OAAO,MAAM,EAAE,GAAG,CAAC;aACrB,OAAO,MAAM,EAAE,GAAG,CAAC;iCA6C7B,CAAA;AAED,eAAO,MAAM,uBAAuB;aAQzB,MAAM;cACL,MAAM;oBACA,MAAM;WACf,MAAM;eACF,OAAO,MAAM,EAAE,GAAG,CAAC;eACnB,kBAAkB;iCAe9B,CAAA;AAED,eAAO,MAAM,8BAA8B;SAMpC,GAAG,GAAG,MAAM;WACV,MAAM;eACF,OAAO,MAAM,EAAE,GAAG,CAAC;eACnB,kBAAkB;iCAc9B,CAAA"}
+{"version":3,"file":"graphql-client.d.ts","sourceRoot":"","sources":["../../src/shared/graphql-client.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,SAAS,CAAA;AAE5C,OAAO,EAAC,kBAAkB,EAAC,MAAM,SAAS,CAAA;AAK1C,oBAAY,eAAe,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IACnD,sBAAsB,CAAC,KAAK,CAAC,GAC7B,oBAAoB,CAAC,KAAK,CAAC,CAAA;AAG/B,aAAK,sBAAsB,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,GAAG;IAC5D,IAAI,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,SAAS,CAAA;CAClB,CAAA;AAGD,aAAK,oBAAoB,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,GACvD,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAA;AAElD,eAAO,MAAM,iBAAiB;SAMvB,GAAG,GAAG,MAAM;WACV,MAAM;;;;;GA+Cd,CAAA;AAED,eAAO,MAAM,uBAAuB;aAQzB,MAAM;cACL,MAAM;oBACA,MAAM;WACf,MAAM;;eAEF,kBAAkB;iCAe9B,CAAA;AAED,eAAO,MAAM,8BAA8B;SAMpC,GAAG,GAAG,MAAM;WACV,MAAM;;eAEF,kBAAkB;iCAc9B,CAAA"}

package/lib/shared/graphql-client.js

@@ -28,12 +28,12 @@ const fetchGraphQLQuery = async ({ url, query, variables = {}, headers = {}, })
         }
         const json = await response.json();
         debug('stepzen:sdk:response')(json);
-        const { data, errors } = json;
+        const { data, errors, extensions } = json;
         if (errors) {
-            return { data, errors };
+            return { data, errors, extensions };
         }
         else if (data) {
-            return { data, errors: undefined };
+            return { data, errors: undefined, extensions };
         }
         throw new Error(`Unexpected response structure from the GraphQL endpoint '${url}'` +
             ` (expected {data, errors}, recieved ${JSON.stringify(json)})`);
@@ -46,7 +46,7 @@ const fetchGraphQLQuery = async ({ url, query, variables = {}, headers = {}, })
 exports.fetchGraphQLQuery = fetchGraphQLQuery;
 const fetchZenCtlGraphQLQuery = async ({ account, adminKey, deploymentType, query, variables = {}, sdkConfig, }) => {
     try {
-        return await (0, exports.fetchGraphQLQuery)({
+        return (await (0, exports.fetchGraphQLQuery)({
             url: sdkConfig.zenctlApiUrl,
             query,
             variables,
@@ -54,7 +54,7 @@ const fetchZenCtlGraphQLQuery = async ({ account, adminKey, deploymentType, quer
                 'user-agent': (0, request_1.getUserAgent)(sdkConfig),
                 host: `stepzen.${deploymentType}.net`,
             },
-        });
+        }));
     }
     catch (error) {
         throw new Error(`Failed to connect to ZenCtl API. ${error}`);
@@ -63,14 +63,14 @@ const fetchZenCtlGraphQLQuery = async ({ account, adminKey, deploymentType, quer
 exports.fetchZenCtlGraphQLQuery = fetchZenCtlGraphQLQuery;
 const fetchPublicAccountGraphQLQuery = async ({ url, query, variables = {}, sdkConfig, }) => {
     try {
-        return await (0, exports.fetchGraphQLQuery)({
+        return (await (0, exports.fetchGraphQLQuery)({
             url,
             query,
             variables,
             headers: {
                 'user-agent': (0, request_1.getUserAgent)(sdkConfig),
             },
-        });
+        }));
     }
     catch (error) {
         throw new Error(`Failed to connect to Public Account API. ${error}`);

package/lib/shared/graphql-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"graphql-client.js","sourceRoot":"","sources":["../../src/shared/graphql-client.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,+BAA8B;AAC9B,0CAAkC;AAGlC,uCAAsC;AAoB/B,MAAM,iBAAiB,GAAG,KAAK,EAAK,EACzC,GAAG,EACH,KAAK,EACL,SAAS,GAAG,EAAE,EACd,OAAO,GAAG,EAAE,GAMb,EAA+B,EAAE;IAChC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAA;IAC7B,KAAK,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,CAAA;IACrC,KAAK,CAAC,mBAAmB,CAAC,CAAC,KAAK,CAAC,CAAA;IACjC,KAAK,CAAC,uBAAuB,CAAC,CAAC,SAAS,CAAC,CAAA;IAEzC,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,IAAA,eAAK,EAAC,GAAG,EAAE;YAChC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,GAAG,OAAO;aACX;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,KAAK;gBACL,SAAS;aACV,CAAC;SACH,CAAC,CAAA;QAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,CAAC,MAAM,EAAE;gBACzC,+BAA+B,GAAG,kBAAkB,CACvD,CAAA;SACF;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClC,KAAK,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,CAAA;QAEnC,MAAM,EAAC,IAAI,EAAE,MAAM,EAAC,GAAG,IAAI,CAAA;QAC3B,IAAI,MAAM,EAAE;YACV,OAAO,EAAC,IAAI,EAAE,MAAM,EAAC,CAAA;SACtB;aAAM,IAAI,IAAI,EAAE;YACf,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAC,CAAA;SACjC;QAED,MAAM,IAAI,KAAK,CACb,4DAA4D,GAAG,GAAG;YAChE,uCAAuC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CACjE,CAAA;KACF;IAAC,OAAO,KAAK,EAAE;QACd,KAAK,CAAC,sBAAsB,CAAC,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAA;QAC1E,MAAM,KAAK,CAAA;KACZ;AACH,CAAC,CAAA;AAtDY,QAAA,iBAAiB,qBAsD7B;AAEM,MAAM,uBAAuB,GAAG,KAAK,EAAK,EAC/C,OAAO,EACP,QAAQ,EACR,cAAc,EACd,KAAK,EACL,SAAS,GAAG,EAAE,EACd,SAAS,GAQV,EAA+B,EAAE;IAChC,IAAI;QACF,OAAO,MAAM,IAAA,yBAAiB,EAAC;YAC7B,GAAG,EAAE,SAAS,CAAC,YAAY;YAC3B,KAAK;YACL,SAAS;YACT,OAAO,EAAE;gBACP,YAAY,EAAE,IAAA,sBAAY,EAAC,SAAS,CAAC;gBACrC,IAAI,EAAE,WAAW,cAAc,MAAM;aACtC;SACF,CAAC,CAAA;KACH;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAA;KAC7D;AACH,CAAC,CAAA;AA5BY,QAAA,uBAAuB,2BA4BnC;AAEM,MAAM,8BAA8B,GAAG,KAAK,EAAK,EACtD,GAAG,EACH,KAAK,EACL,SAAS,GAAG,EAAE,EACd,SAAS,GAMV,EAA+B,EAAE;IAChC,IAAI;QACF,OAAO,MAAM,IAAA,yBAAiB,EAAC;YAC7B,GAAG;YACH,KAAK;YACL,SAAS;YACT,OAAO,EAAE;gBACP,YAAY,EAAE,IAAA,sBAAY,EAAC,SAAS,CAAC;aACtC;SACF,CAAC,CAAA;KACH;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,KAAK,EAAE,CAAC,CAAA;KACrE;AACH,CAAC,CAAA;AAvBY,QAAA,8BAA8B,kCAuB1C"}
+{"version":3,"file":"graphql-client.js","sourceRoot":"","sources":["../../src/shared/graphql-client.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,+BAA8B;AAC9B,0CAAkC;AAIlC,uCAAsC;AAkB/B,MAAM,iBAAiB,GAAG,KAAK,EAA2B,EAC/D,GAAG,EACH,KAAK,EACL,SAAS,GAAG,EAAE,EACd,OAAO,GAAG,EAAE,GAMb,EAA+B,EAAE;IAChC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAA;IAC7B,KAAK,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC,CAAA;IACrC,KAAK,CAAC,mBAAmB,CAAC,CAAC,KAAK,CAAC,CAAA;IACjC,KAAK,CAAC,uBAAuB,CAAC,CAAC,SAAS,CAAC,CAAA;IAEzC,IAAI;QACF,MAAM,QAAQ,GAAG,MAAM,IAAA,eAAK,EAAC,GAAG,EAAE;YAChC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,GAAG,OAAO;aACX;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,KAAK;gBACL,SAAS;aACV,CAAC;SACH,CAAC,CAAA;QAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;YAC3B,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,CAAC,MAAM,EAAE;gBACzC,+BAA+B,GAAG,kBAAkB,CACvD,CAAA;SACF;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAClC,KAAK,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,CAAA;QAEnC,MAAM,EAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAC,GAAG,IAAI,CAAA;QACvC,IAAI,MAAM,EAAE;YACV,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAC,CAAA;SAClC;aAAM,IAAI,IAAI,EAAE;YACf,OAAO,EAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAC,CAAA;SAC7C;QAED,MAAM,IAAI,KAAK,CACb,4DAA4D,GAAG,GAAG;YAChE,uCAAuC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CACjE,CAAA;KACF;IAAC,OAAO,KAAK,EAAE;QACd,KAAK,CAAC,sBAAsB,CAAC,CAAC,oCAAoC,EAAE,KAAK,CAAC,CAAA;QAC1E,MAAM,KAAK,CAAA;KACZ;AACH,CAAC,CAAA;AAtDY,QAAA,iBAAiB,qBAsD7B;AAEM,MAAM,uBAAuB,GAAG,KAAK,EAA2B,EACrE,OAAO,EACP,QAAQ,EACR,cAAc,EACd,KAAK,EACL,SAAS,GAAG,EAAE,EACd,SAAS,GAQV,EAA+B,EAAE;IAChC,IAAI;QACF,OAAO,CAAC,MAAM,IAAA,yBAAiB,EAAC;YAC9B,GAAG,EAAE,SAAS,CAAC,YAAY;YAC3B,KAAK;YACL,SAAS;YACT,OAAO,EAAE;gBACP,YAAY,EAAE,IAAA,sBAAY,EAAC,SAAS,CAAC;gBACrC,IAAI,EAAE,WAAW,cAAc,MAAM;aACtC;SACF,CAAC,CAAuB,CAAA;KAC1B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAA;KAC7D;AACH,CAAC,CAAA;AA5BY,QAAA,uBAAuB,2BA4BnC;AAEM,MAAM,8BAA8B,GAAG,KAAK,EAA2B,EAC5E,GAAG,EACH,KAAK,EACL,SAAS,GAAG,EAAE,EACd,SAAS,GAMV,EAA+B,EAAE;IAChC,IAAI;QACF,OAAO,CAAC,MAAM,IAAA,yBAAiB,EAAC;YAC9B,GAAG;YACH,KAAK;YACL,SAAS;YACT,OAAO,EAAE;gBACP,YAAY,EAAE,IAAA,sBAAY,EAAC,SAAS,CAAC;aACtC;SACF,CAAC,CAAuB,CAAA;KAC1B;IAAC,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,4CAA4C,KAAK,EAAE,CAAC,CAAA;KACrE;AACH,CAAC,CAAA;AAvBY,QAAA,8BAA8B,kCAuB1C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stepzen/sdk",
-  "version": "0.24.0",
+  "version": "0.25.0-beta.1",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "homepage": "https://stepzen.com",
@@ -22,14 +22,15 @@
     "posttest": "prettier . --check"
   },
   "dependencies": {
-    "@stepzen/fetch": "^0.24.0",
-    "@stepzen/transpiler": "^0.24.0",
+    "@stepzen/fetch": "^0.25.0-beta.1",
+    "@stepzen/transpiler": "^0.25.0-beta.1",
     "archiver": "^5.3.0",
     "debug": "^4.3.4",
     "dotenv": "^16.0.1",
     "form-data": "^4.0.0",
     "fs-extra": "^10.0.1",
     "glob": "^7.2.0",
+    "graphql": "^15.8.0",
     "is-wsl": "^2.2.0",
     "yaml": "^1.10.2"
   },
@@ -48,5 +49,5 @@
     "prettier": "^2.5.1",
     "ts-node": "^10.8.2"
   },
-  "gitHead": "a238c1d7f45de56f9f8fb015347deba058229661"
+  "gitHead": "95638ca98959d5ced0be3811acf30d7a91449d1a"
 }

package/src/index.ts

@@ -5,6 +5,7 @@ import {init, SDK} from './init'
 
 export * from './init'
 export * from './init-v2'
+export {fetchGraphQLQuery} from './shared/graphql-client'
 
 /**
  * The default SDK instance that does not know the name of the app using the SDK.

package/src/shared/graphql-client.ts

@@ -2,29 +2,28 @@
 
 import * as debug from 'debug'
 import fetch from '@stepzen/fetch'
+import type {ExecutionResult} from 'graphql'
 
 import {SDKConfigurationV2} from './types'
 import {getUserAgent} from './request'
 
-export type GraphQLSuccessResponse<T> = {
-  data: T
-  errors: undefined
-}
+// The StepZen's ZenCtl GraphQL API offers stronger guarantees than defined in
+// the GraphQL standard:
+export type GraphQLResponse<TData = Record<string, any>> =
+  | GraphQLSuccessResponse<TData>
+  | GraphQLErrorResponse<TData>
 
-export type GraphQLErrorResponse<T> = {
-  data: T | null
-  errors: Array<{
-    message: string
-    locations?: Array<{line: number; column: number}>
-    path?: Array<string | number>
-  }>
+// 1. a successful response would always have a non-null `data` property and no `errors`.
+type GraphQLSuccessResponse<TData> = ExecutionResult<TData> & {
+  data: TData
+  errors: undefined
 }
 
-export type GraphQLResponse<T> =
-  | GraphQLSuccessResponse<T>
-  | GraphQLErrorResponse<T>
+// 2. an error response would always have a non-null `errors` property.
+type GraphQLErrorResponse<TData> = ExecutionResult<TData> &
+  Required<Pick<ExecutionResult<TData>, 'errors'>>
 
-export const fetchGraphQLQuery = async <T>({
+export const fetchGraphQLQuery = async <T = Record<string, any>>({
   url,
   query,
   variables = {},
@@ -32,9 +31,9 @@ export const fetchGraphQLQuery = async <T>({
 }: {
   url: URL | string
   query: string
-  variables: Record<string, any>
-  headers: Record<string, any>
-}): Promise<GraphQLResponse<T>> => {
+  variables?: Record<string, any>
+  headers?: Record<string, any>
+}): Promise<ExecutionResult<T>> => {
   debug('stepzen:sdk:url')(url)
   debug('stepzen:sdk:headers')(headers)
   debug('stepzen:sdk:query')(query)
@@ -63,11 +62,11 @@ export const fetchGraphQLQuery = async <T>({
     const json = await response.json()
     debug('stepzen:sdk:response')(json)
 
-    const {data, errors} = json
+    const {data, errors, extensions} = json
     if (errors) {
-      return {data, errors}
+      return {data, errors, extensions}
     } else if (data) {
-      return {data, errors: undefined}
+      return {data, errors: undefined, extensions}
     }
 
     throw new Error(
@@ -80,7 +79,7 @@ export const fetchGraphQLQuery = async <T>({
   }
 }
 
-export const fetchZenCtlGraphQLQuery = async <T>({
+export const fetchZenCtlGraphQLQuery = async <T = Record<string, any>>({
   account,
   adminKey,
   deploymentType,
@@ -92,11 +91,11 @@ export const fetchZenCtlGraphQLQuery = async <T>({
   adminKey: string
   deploymentType: string
   query: string
-  variables: Record<string, any>
+  variables?: Record<string, any>
   sdkConfig: SDKConfigurationV2
 }): Promise<GraphQLResponse<T>> => {
   try {
-    return await fetchGraphQLQuery({
+    return (await fetchGraphQLQuery({
       url: sdkConfig.zenctlApiUrl,
       query,
       variables,
@@ -104,13 +103,13 @@ export const fetchZenCtlGraphQLQuery = async <T>({
         'user-agent': getUserAgent(sdkConfig),
         host: `stepzen.${deploymentType}.net`,
       },
-    })
+    })) as GraphQLResponse<T>
   } catch (error) {
     throw new Error(`Failed to connect to ZenCtl API. ${error}`)
   }
 }
 
-export const fetchPublicAccountGraphQLQuery = async <T>({
+export const fetchPublicAccountGraphQLQuery = async <T = Record<string, any>>({
   url,
   query,
   variables = {},
@@ -118,18 +117,18 @@ export const fetchPublicAccountGraphQLQuery = async <T>({
 }: {
   url: URL | string
   query: string
-  variables: Record<string, any>
+  variables?: Record<string, any>
   sdkConfig: SDKConfigurationV2
 }): Promise<GraphQLResponse<T>> => {
   try {
-    return await fetchGraphQLQuery({
+    return (await fetchGraphQLQuery({
       url,
       query,
       variables,
       headers: {
         'user-agent': getUserAgent(sdkConfig),
       },
-    })
+    })) as GraphQLResponse<T>
   } catch (error) {
     throw new Error(`Failed to connect to Public Account API. ${error}`)
   }