@stepzen/sdk 0.20.1 → 0.21.0-beta.2

package/lib/shared/transpiling.js

@@ -3,28 +3,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transpileConfigurationset = void 0;
 const dotenv = require("dotenv");
+const debug = require("debug");
 const fs = require("fs-extra");
 const os = require("os");
 const path = require("path");
 const transpiler_1 = require("@stepzen/transpiler");
-const transpileConfigurationset = async (file) => {
+async function transpileConfigurationset(file) {
     if (!file) {
         return;
     }
     const source = file.substring(0, file.lastIndexOf('/'));
+    debug('stepzen:dotenv')(`loading .env from ${path.resolve(source)}` +
+        `, at sdk/src/shared/transpiling.ts`);
     dotenv.config({ path: path.resolve(source, '.env') });
     const tmp = path.join(os.tmpdir(), `stepzen-transpiler-${Date.now()}`);
     const configPath = path.join(tmp, 'config.yaml');
     fs.ensureDirSync(tmp);
     fs.copyFileSync(file, configPath);
     const result = await (0, transpiler_1.transpile)(tmp);
-    if (result.transpiled) {
-        fs.emptyDirSync(tmp);
-        fs.writeFileSync(configPath, result.config);
-        return configPath;
-    }
-    fs.removeSync(tmp);
-    return;
-};
+    fs.emptyDirSync(tmp);
+    fs.writeFileSync(configPath, result.config || '');
+    return configPath;
+}
 exports.transpileConfigurationset = transpileConfigurationset;
 //# sourceMappingURL=transpiling.js.map

package/lib/shared/transpiling.js.map

@@ -1 +1 @@
-{"version":3,"file":"transpiling.js","sourceRoot":"","sources":["../../src/shared/transpiling.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,iCAAgC;AAChC,+BAA8B;AAC9B,yBAAwB;AACxB,6BAA4B;AAC5B,oDAA6C;AAEtC,MAAM,yBAAyB,GAAG,KAAK,EAC5C,IAAwB,EACK,EAAE;IAC/B,IAAI,CAAC,IAAI,EAAE;QACT,OAAM;KACP;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;IACvD,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,EAAC,CAAC,CAAA;IAEnD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;IAEhD,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;IACrB,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAEjC,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAS,EAAC,GAAG,CAAC,CAAA;IAEnC,IAAI,MAAM,CAAC,UAAU,EAAE;QACrB,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QACpB,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;QAC3C,OAAO,UAAU,CAAA;KAClB;IAED,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IAClB,OAAM;AACR,CAAC,CAAA;AA1BY,QAAA,yBAAyB,6BA0BrC"}
+{"version":3,"file":"transpiling.js","sourceRoot":"","sources":["../../src/shared/transpiling.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,iCAAgC;AAChC,+BAA8B;AAC9B,+BAA8B;AAC9B,yBAAwB;AACxB,6BAA4B;AAC5B,oDAA6C;AAkBtC,KAAK,UAAU,yBAAyB,CAAC,IAAa;IAC3D,IAAI,CAAC,IAAI,EAAE;QACT,OAAM;KACP;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAA;IACvD,KAAK,CAAC,gBAAgB,CAAC,CACrB,qBAAqB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzC,oCAAoC,CACvC,CAAA;IACD,MAAM,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,EAAC,CAAC,CAAA;IAEnD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAA;IAEhD,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;IACrB,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;IAEjC,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAS,EAAC,GAAG,CAAC,CAAA;IAEnC,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;IACpB,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAA;IACjD,OAAO,UAAU,CAAA;AACnB,CAAC;AAvBD,8DAuBC"}

package/lib/shared/types.d.ts

@@ -74,4 +74,121 @@ export interface SDKConfiguration {
      */
     appName: string;
 }
+export interface SDKConfigurationV2 extends SDKConfiguration {
+    /**
+     * The name and version of that app that uses the SDK,
+     * e.g. `stepzen-cli/0.9.32`
+     *
+     * It is appended to the user-agent string in all requests made to StepZen
+     * through the SDK and becomes availabe in the log analytics.
+     */
+    appName: string;
+    /**
+     * Version of ZenCtl API to use:
+     *  - `undefined`, `v1`: implies the v1 REST API at /ctl/admin/
+     *  - `v2`: implies the v2 GraphQL API
+     */
+    apiVersion: string;
+    /**
+     * URL of the ZenCtl GraphQL API,
+     * e.g. https://stepzen.stepzen.net/api/zenctl2/__graphql
+     */
+    zenctlApiUrl: string;
+    /**
+     * URL of the StepZen getPublicAccount GraphQL API,
+     * e.g. https://stepzen.stepzen.net/api/publicaccount/__graphql
+     */
+    publicAccountApiUrl: string;
+}
+export interface ZenCtlSuccessResponseV2<T> {
+    data: T;
+    error: undefined;
+}
+export interface ZenCtlErrorResponseV2 {
+    data: undefined;
+    error: {
+        message: string;
+    };
+}
+export declare type ZenCtlResponseV2<T> = ZenCtlSuccessResponseV2<T> | ZenCtlErrorResponseV2;
+export interface StepZenCredentialsV2 {
+    account: string;
+    adminKey: string;
+    apiKeys: string[];
+    deploymentType: string;
+}
+export interface StepZenAccountV2 {
+    account: string;
+    ownerEmail: string;
+    adminKey: string;
+    apiKeys: string[];
+    deploymentType: string;
+}
+export interface StepZenEndpointV2 {
+    account: string;
+    deploymentType: string;
+    folderName: string;
+    endpointName: string;
+    public: boolean;
+    endpointType: string;
+}
+export interface SchemaFiles {
+    files: SchemaFile[];
+    entryPoint?: String;
+}
+export interface SchemaFile {
+    name: string;
+    content: string;
+}
+export interface Configuration {
+    configurationset?: ConfigurationSet[];
+    ruleset?: QueryRule[];
+    access?: Policies;
+    deployment?: DeploymentSettings;
+}
+export interface ConfigurationSet {
+    configuration?: Record<string, any>;
+}
+export interface QueryRule {
+    query: string;
+    disabled?: boolean;
+    rules?: Rule[];
+}
+export interface Rule {
+    predicate: string;
+    action: string;
+}
+export interface Policies {
+    policies?: Policy[];
+}
+export interface Policy {
+    type?: string;
+    rules?: FieldRule[];
+    policyDefault?: FieldCondition;
+}
+export interface FieldRule {
+    name?: string;
+    description?: string;
+    condition: string;
+    fields?: string[];
+}
+export interface FieldCondition {
+    condition: string;
+}
+export interface DeploymentSettings {
+    identity?: IdentitySettings;
+}
+export interface IdentitySettings {
+    keys?: JWTKey[];
+    issuer?: string;
+    subject?: string;
+    audience?: string;
+    claims?: string[];
+    jwksendpoint?: string;
+}
+export interface JWTKey {
+    algorithm?: string;
+    keyid?: string;
+    key?: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/lib/shared/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;;;;;;OAUG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,oBAAY,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,oBAAY,4BAA4B,GAAG,IAAI,CAC7C,cAAc,EACd,SAAS,GAAG,UAAU,CACvB,GACC,OAAO,CAAC,cAAc,CAAC,CAAA;AAEzB,oBAAY,sBAAsB,GAAG;IACnC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;IACjC,MAAM,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,WAAW,aAAa;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,aAAa,GAAG,SAAS,GAAG,mBAAmB,CAAA;CACtD;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,qBAAqB,EAAE,MAAM,CAAA;IAC7B,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;;;;;;;OAUG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,oBAAY,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,oBAAY,4BAA4B,GAAG,IAAI,CAC7C,cAAc,EACd,SAAS,GAAG,UAAU,CACvB,GACC,OAAO,CAAC,cAAc,CAAC,CAAA;AAEzB,oBAAY,sBAAsB,GAAG;IACnC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;IACjC,MAAM,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,WAAW,aAAa;IAC5B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,aAAa,GAAG,SAAS,GAAG,mBAAmB,CAAA;CACtD;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,qBAAqB,EAAE,MAAM,CAAA;IAC7B,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACtB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,mBAAmB,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,IAAI,EAAE,CAAC,CAAA;IACP,KAAK,EAAE,SAAS,CAAA;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,SAAS,CAAA;IACf,KAAK,EAAE;QACL,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED,oBAAY,gBAAgB,CAAC,CAAC,IAC1B,uBAAuB,CAAC,CAAC,CAAC,GAC1B,qBAAqB,CAAA;AAEzB,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,OAAO,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAA;IACrC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAA;IACrB,MAAM,CAAC,EAAE,QAAQ,CAAA;IACjB,UAAU,CAAC,EAAE,kBAAkB,CAAA;CAChC;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACpC;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;CACf;AAED,MAAM,WAAW,IAAI;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,SAAS,EAAE,CAAA;IACnB,aAAa,CAAC,EAAE,cAAc,CAAA;CAC/B;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,gBAAgB,CAAA;CAC5B;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,MAAM;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACb"}

package/lib/shared/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/shared/validation.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,wBAAwB,SAAgB,MAAM,GAAG,SAAS,kBAiBtE,CAAA;AAGD,eAAO,MAAM,cAAc,cAAqB,MAAM,GAAG,SAAS,kBAcjE,CAAA"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/shared/validation.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,wBAAwB,SAAgB,MAAM,GAAG,SAAS,kBA0BtE,CAAA;AAGD,eAAO,MAAM,cAAc,cAAqB,MAAM,GAAG,SAAS,kBAcjE,CAAA"}

package/lib/shared/validation.js

@@ -2,15 +2,19 @@
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateSchema = exports.validateConfigurationset = void 0;
+const debug = require("debug");
 const fs = require("fs");
 const glob = require("glob");
 const yaml = require("yaml");
 // Validate the Configurationset file
 const validateConfigurationset = async (file) => {
     if (!file) {
+        debug('stepzen:sdk')(`validateConfigurationset() expected 'file' to be a` +
+            ` non-empty string but got ${file}`);
         throw new Error('You must provide a file path');
     }
     if (!fs.existsSync(file)) {
+        debug('stepzen:sdk')(`validateConfigurationset() expected ${file} to exist`);
         throw new Error('The file does not exist');
     }
     const content = fs.readFileSync(file, 'utf8');
@@ -18,7 +22,9 @@ const validateConfigurationset = async (file) => {
     try {
         yaml.parse(content);
     }
-    catch (_a) {
+    catch (error) {
+        debug('stepzen:sdk')(`validateConfigurationset() expected ${file} to parse as YAML,` +
+            ` but got an error ${error}`);
         throw new Error('The file is not valid YAML');
     }
 };

package/lib/shared/validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/shared/validation.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,yBAAwB;AACxB,6BAA4B;AAC5B,6BAA4B;AAE5B,qCAAqC;AAC9B,MAAM,wBAAwB,GAAG,KAAK,EAAE,IAAwB,EAAE,EAAE;IACzE,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;KAC3C;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAE7C,gCAAgC;IAChC,IAAI;QACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;KACpB;IAAC,WAAM;QACN,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;KAC9C;AACH,CAAC,CAAA;AAjBY,QAAA,wBAAwB,4BAiBpC;AAED,gCAAgC;AACzB,MAAM,cAAc,GAAG,KAAK,EAAE,SAA6B,EAAE,EAAE;IACpE,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;KACrD;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,6CAA6C;IAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAC,GAAG,EAAE,SAAS,EAAC,CAAC,CAAA;IACnE,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;AACH,CAAC,CAAA;AAdY,QAAA,cAAc,kBAc1B"}
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/shared/validation.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,+BAA8B;AAC9B,yBAAwB;AACxB,6BAA4B;AAC5B,6BAA4B;AAE5B,qCAAqC;AAC9B,MAAM,wBAAwB,GAAG,KAAK,EAAE,IAAwB,EAAE,EAAE;IACzE,IAAI,CAAC,IAAI,EAAE;QACT,KAAK,CAAC,aAAa,CAAC,CAClB,oDAAoD;YAClD,6BAA6B,IAAI,EAAE,CACtC,CAAA;QACD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxB,KAAK,CAAC,aAAa,CAAC,CAAC,uCAAuC,IAAI,WAAW,CAAC,CAAA;QAC5E,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;KAC3C;IAED,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAE7C,gCAAgC;IAChC,IAAI;QACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;KACpB;IAAC,OAAO,KAAK,EAAE;QACd,KAAK,CAAC,aAAa,CAAC,CAClB,uCAAuC,IAAI,oBAAoB;YAC7D,qBAAqB,KAAK,EAAE,CAC/B,CAAA;QACD,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;KAC9C;AACH,CAAC,CAAA;AA1BY,QAAA,wBAAwB,4BA0BpC;AAED,gCAAgC;AACzB,MAAM,cAAc,GAAG,KAAK,EAAE,SAA6B,EAAE,EAAE;IACpE,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;KACrD;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;KAChD;IAED,6CAA6C;IAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAC,GAAG,EAAE,SAAS,EAAC,CAAC,CAAA;IACnE,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;KAChE;AACH,CAAC,CAAA;AAdY,QAAA,cAAc,kBAc1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stepzen/sdk",
-  "version": "0.20.1",
+  "version": "0.21.0-beta.2",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "homepage": "https://stepzen.com",
@@ -18,10 +18,11 @@
     "clean": "rm -rf lib tsconfig.tsbuildinfo",
     "build": "../../node_modules/.bin/tsc -b",
     "test": "npm run build && nyc --extension .ts mocha --config test/mocha.opts.json",
+    "test:single": "npm run build && mocha --config test/mocha.opts.json",
     "posttest": "prettier . --check"
   },
   "dependencies": {
-    "@stepzen/transpiler": "^0.20.1",
+    "@stepzen/transpiler": "^0.21.0-beta.2",
     "archiver": "^5.3.0",
     "debug": "^4.3.4",
     "dotenv": "^16.0.1",
@@ -48,5 +49,5 @@
     "prettier": "^2.5.1",
     "ts-node": "^10.8.2"
   },
-  "gitHead": "08ab10b35669b20016025078c4e79f58fc5b52b3"
+  "gitHead": "58b85cc37fa990639bf7170d4224cf51cc1f7ad1"
 }

package/src/client-v2.ts

@@ -0,0 +1,120 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import accountCmd from './commands-v2/account'
+import deployCmd from './commands-v2/deploy'
+import listEndpointsCmd from './commands-v2/list'
+import getPublicAccount from './commands-v2/getPublicAccount'
+import {
+  generateConfigurationPayload,
+  generateSchemaFilesPayload,
+} from './shared/payloads'
+import {SDKConfigurationV2} from './shared/types'
+
+export const ensureValidCredentials = async (
+  auth:
+    | {account: string; adminKey: string; deploymentType: string}
+    | {publicAccountToken: string; deploymentType: string},
+  sdkConfig: SDKConfigurationV2,
+) => {
+  let credentials
+
+  if ('publicAccountToken' in auth) {
+    // create an anonymous account and use it to initialize an SDK client instance
+    const {data, error} = await getPublicAccount({
+      token: auth.publicAccountToken,
+      deploymentType: auth.deploymentType,
+      sdkConfig,
+    })
+
+    if (error) {
+      throw new Error(`An unexpected error occurred: ${error.message}`)
+    }
+
+    credentials = data
+  } else {
+    // use the provided account to initialize an SDK client instance
+    const {data, error} = await accountCmd({
+      account: auth.account,
+      adminKey: auth.adminKey,
+      deploymentType: auth.deploymentType,
+      sdkConfig,
+    })
+
+    if (error) {
+      throw new Error(error.message)
+    }
+
+    credentials = data
+  }
+
+  return credentials
+}
+
+export const createSdkClient = async (
+  auth:
+    | {account: string; adminKey: string; deploymentType: string}
+    | {publicAccountToken: string; deploymentType: string},
+  sdkConfig: SDKConfigurationV2,
+) => {
+  const credentials = await ensureValidCredentials(auth, sdkConfig)
+
+  return {
+    get credentials(): typeof credentials {
+      // always return a copy to avoid accidential modification by the caller
+      return {...credentials}
+    },
+    /**
+     * Create or update a GraphQL endpoint at StepZen.
+     * The URL of the endpoint is formed as {StepZen instance URL}/{folder}/{name}/__graphql
+     * e.g. https://account.stepzen.net/api/users/__graphql
+     *
+     * @param folder - folder name (e.g. `api`); will be a part of the endpoint URL
+     * @param name - endpoint name (e.g. `users`); will be a part of the endpoint URL
+     * @param directory - full path to a GraphQL schema directory (should have `index.graphql` in it)
+     * @param config - full path to a config `.yml` file
+     * @param public - whether or not to allow public access to the endpoint (`false` by default)
+     * @returns details of the created / updated endpoint
+     */
+    deploy: async ({
+      folder,
+      name,
+      directory,
+      config,
+      public: _public = false,
+    }: {
+      folder: string
+      name: string
+      directory: string
+      config?: string
+      public?: boolean
+    }) => {
+      return deployCmd({
+        account: credentials.account,
+        adminKey: credentials.adminKey,
+        deploymentType: credentials.deploymentType,
+        endpointName: name,
+        endpointType: 'dev',
+        folderName: folder,
+        public: _public,
+        schemaFiles: generateSchemaFilesPayload(directory),
+        configuration: await generateConfigurationPayload(config),
+        sdkConfig,
+      })
+    },
+    list: {
+      /**
+       * List deployed endpoints.
+       *
+       * @returns list of deployed endpoints
+       */
+      endpoints: () => {
+        return listEndpointsCmd({
+          account: credentials.account,
+          adminKey: credentials.adminKey,
+          deploymentType: credentials.deploymentType,
+          sdkConfig,
+        })
+      },
+    },
+  }
+}

package/src/client.ts

@@ -6,7 +6,6 @@ import {
   AnonymousClientOptions,
   SDKConfiguration,
   StepZenAccount,
-  StepZenCredentials,
 } from './shared/types'
 import list from './commands/list'
 import upload from './commands/upload'
@@ -18,8 +17,8 @@ export const validateCreateClientOptions = async (
   options: StepZenAccount | Required<AnonymousClientOptions>,
   sdkConfig: SDKConfiguration,
 ) => {
-  let credentials: StepZenCredentials
-  let account: StepZenAccount
+  let credentials
+  let account
 
   if ('publicAccountToken' in options) {
     // create an anonymous account and use it to initialize an SDK client instance
@@ -84,7 +83,7 @@ export const createSdkClient = async (
   )
 
   return {
-    get credentials() {
+    get credentials(): typeof credentials {
       // always return a copy to avoid accidential modification by the caller
       return {...credentials}
     },

package/src/commands/upload.ts

@@ -26,13 +26,9 @@ export default async (
   switch (details.type) {
     case 'configurationset':
       await validateConfigurationset(details.file)
-      const transpiled = await transpileConfigurationset(details.file)
-      debug('stepzen:transpiler')(transpiled)
-      if (transpiled) {
-        payload = await generateYamlPayload(transpiled)
-      } else {
-        payload = await generateYamlPayload(details.file)
-      }
+      const transpiled = await transpileConfigurationset(details.file!)
+      debug('stepzen:sdk')(`effective config written to ${transpiled}`)
+      payload = await generateYamlPayload(transpiled)
       break
 
     case 'schema':

package/src/commands-v2/account.ts

@@ -0,0 +1,98 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import {
+  SDKConfigurationV2,
+  StepZenAccountV2,
+  ZenCtlResponseV2,
+} from '../shared/types'
+import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client'
+
+export default async ({
+  account,
+  adminKey,
+  deploymentType,
+  sdkConfig,
+}: {
+  account: string
+  adminKey: string
+  deploymentType: string
+  sdkConfig: SDKConfigurationV2
+}): Promise<ZenCtlResponseV2<StepZenAccountV2>> => {
+  const {data, errors} = await fetchZenCtlGraphQLQuery<{
+    accounts: Array<{
+      deploymentType: string
+      account: string
+      ownerEmail: string
+      adminKey: string
+      apiKeysAsJsonArray: string
+    }>
+  }>({
+    account,
+    adminKey,
+    deploymentType,
+    query: `query (
+      $account: String!
+      $adminKey: String!
+      $deploymentType: String!
+    ) {
+      accounts: account(
+        account: $account
+        adminkey: $adminKey
+        deploymentType: $deploymentType
+      ) {
+        deploymentType: account_deployment_type
+        account: account_name
+        ownerEmail: account_owner_email
+        adminKey: key_value_admin
+        apiKeysAsJsonArray: key_value_api
+      }
+    }`,
+    variables: {
+      account,
+      adminKey,
+      deploymentType,
+    },
+    sdkConfig,
+  })
+
+  if (errors) {
+    // strip graphql-specific error details, leave only the message
+    const message = errors
+      .map(({message}) =>
+        message.startsWith(
+          'ERROR: invalid input value for enum zenctl.deployment_type',
+        )
+          ? `Invalid deployment type: ${deploymentType}`
+          : message,
+      )
+      .join('\n')
+
+    return {
+      data: undefined,
+      error: {
+        message,
+      },
+    }
+  }
+
+  const accounts = data.accounts.filter(Boolean)
+  if (!accounts.length) {
+    return {
+      data: undefined,
+      error: {
+        message: 'Invalid credentials',
+      },
+    }
+  }
+
+  return {
+    data: {
+      account: accounts[0].account,
+      deploymentType: accounts[0].deploymentType,
+      ownerEmail: accounts[0].ownerEmail,
+      adminKey: accounts[0].adminKey,
+      apiKeys: JSON.parse(accounts[0].apiKeysAsJsonArray),
+    },
+    error: undefined,
+  }
+}

package/src/commands-v2/deploy.ts

@@ -0,0 +1,145 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import {
+  Configuration,
+  SchemaFiles,
+  SDKConfigurationV2,
+  StepZenEndpointV2,
+  ZenCtlResponseV2,
+} from '../shared/types'
+import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client'
+
+export default async ({
+  account,
+  deploymentType,
+  folderName,
+  endpointName,
+  public: _public,
+  endpointType,
+  schemaFiles,
+  configuration,
+  adminKey,
+  sdkConfig,
+}: {
+  account: string
+  deploymentType: string
+  folderName: string
+  endpointName: string
+  public: boolean
+  endpointType: string
+  schemaFiles: Readonly<SchemaFiles>
+  configuration: Readonly<Configuration> | null
+  adminKey: string
+  sdkConfig: SDKConfigurationV2
+}): Promise<ZenCtlResponseV2<StepZenEndpointV2>> => {
+  const {data, errors} = await fetchZenCtlGraphQLQuery<{
+    endpoints: Array<{
+      account: string
+      deploymentType: string
+      folderName: string
+      endpointName: string
+      public: boolean
+      endpointType: string
+    }>
+  }>({
+    account,
+    adminKey,
+    deploymentType,
+    query: /* GraphQL */ `
+      mutation (
+        $account: String!
+        $deploymentType: String!
+        $folderName: String!
+        $endpointName: String!
+        $public: Boolean!
+        $endpointType: String!
+        $schemaFiles: SchemaFilesInput!
+        $configuration: Configuration
+        $adminKey: String!
+      ) {
+        endpoints: addEndpoint(
+          account: $account
+          deploymentType: $deploymentType
+          folderName: $folderName
+          endpointName: $endpointName
+          public: $public
+          endpointType: $endpointType
+          schemaFiles: $schemaFiles
+          configuration: $configuration
+          adminkey: $adminKey
+        ) {
+          account: account_name
+          deploymentType: deployment_type
+          folderName: folder_name
+          endpointName: endpoint_name
+          public: endpoint_public
+          endpointType: endpoint_type
+        }
+      }
+    `,
+    variables: {
+      account,
+      deploymentType,
+      folderName,
+      endpointName,
+      public: _public,
+      endpointType,
+      schemaFiles,
+      configuration,
+      adminKey,
+    },
+    sdkConfig,
+  })
+
+  if (errors) {
+    // strip graphql-specific error details, leave only the message
+    const message = errors
+      .map(({message}) => {
+        if (
+          message.startsWith(
+            'ERROR: invalid input value for enum zenctl.deployment_type',
+          )
+        ) {
+          return (
+            `Invalid deployment type: ${deploymentType}.` +
+            ` Please check the 'deploymentType' parameter.`
+          )
+        }
+
+        if (
+          message.startsWith(
+            'ERROR: invalid input value for enum zenctl.endpoint_type',
+          )
+        ) {
+          return (
+            `Invalid endpoint type: ${endpointType}.` +
+            ` Please check the 'endpointType' parameter.`
+          )
+        }
+
+        return message
+      })
+      .join('\n')
+
+    return {
+      data: undefined,
+      error: {
+        message,
+      },
+    }
+  }
+
+  if (!data.endpoints.length) {
+    return {
+      data: undefined,
+      error: {
+        message: 'Invalid credentials',
+      },
+    }
+  }
+
+  return {
+    data: data.endpoints[0],
+    error: undefined,
+  }
+}