@stepzen/sdk 0.20.0 → 0.21.0-beta.1

package/lib/shared/validation.js

@@ -18,7 +18,7 @@ const validateConfigurationset = async (file) => {
     try {
         yaml.parse(content);
     }
-    catch (_a) {
+    catch {
         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,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,MAAM;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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stepzen/sdk",
-  "version": "0.20.0",
+  "version": "0.21.0-beta.1",
   "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.0",
+    "@stepzen/transpiler": "^0.21.0-beta.1",
     "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": "ff448d5486922f3ebd3fe0e4bc6665f2f91060f4"
+  "gitHead": "6dddebabddbbd69adb07b5e7c816125ae5dc3430"
 }

package/src/client-v2.ts

@@ -0,0 +1,104 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import accountCmd from './commands-v2/account'
+import deployCmd from './commands-v2/deploy'
+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: ({
+      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: generateConfigurationPayload(config),
+        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-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_service
+      }
+    }`,
+    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>
+  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: configuration ? configuration : null,
+      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,
+  }
+}

package/src/commands-v2/getPublicAccount.ts

@@ -0,0 +1,67 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import {
+  SDKConfigurationV2,
+  StepZenCredentialsV2,
+  ZenCtlResponseV2,
+} from '../shared/types'
+import {fetchPublicAccountGraphQLQuery} from '../shared/graphql-client'
+
+export default async ({
+  token,
+  deploymentType,
+  sdkConfig,
+}: {
+  token: string
+  deploymentType: string
+  sdkConfig: SDKConfigurationV2
+}): Promise<ZenCtlResponseV2<StepZenCredentialsV2>> => {
+  const url = new URL(sdkConfig.publicAccountApiUrl)
+  // Include the token into the URL so that it is visible in the logs
+  // (allows StepZen to do analytics based on the GCP logs).
+  url.searchParams.set('token', token)
+
+  const {data, errors} = await fetchPublicAccountGraphQLQuery<{
+    account: {
+      account: string
+      adminKey: string
+      apiKey: string
+    }
+  }>({
+    url,
+    query: `query (
+      $token: String!
+    ) {
+      account: getAccountDetails(
+        token: $token
+      ) {
+        account: accountName
+        adminKey
+        apiKey
+      }
+    }`,
+    variables: {
+      token,
+    },
+    sdkConfig,
+  })
+
+  if (errors) {
+    // strip graphql-specific error details, leave only the message
+    const message = errors.map(error => error.message).join('\n')
+    return {
+      data: undefined,
+      error: {message},
+    }
+  }
+
+  return {
+    data: {
+      account: data.account.account,
+      adminKey: data.account.adminKey,
+      apiKeys: [data.account.apiKey],
+      deploymentType,
+    },
+    error: undefined,
+  }
+}

package/src/index.ts

@@ -1,45 +1,10 @@
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 
 import * as path from 'path'
-import authenticate from './commands/authenticate'
-import {createSdkClient} from './client'
-import {
-  AnonymousClientOptions,
-  SDKConfiguration,
-  UserCredentialsClientOptions,
-} from './shared/types'
+import {init, SDK} from './init'
 
-export const init = (sdkConfig: SDKConfiguration) => {
-  const defaults = {
-    domain: process.env.STEPZEN_DOMAIN || 'stepzen.io',
-    server: process.env.STEPZEN_SERVER_URL || 'https://{account}.stepzen.io',
-  }
-
-  return {
-    verify: (account: string, adminkey: string) => {
-      return authenticate(
-        {
-          account,
-          adminkey,
-          server: defaults.server.replace('{account}', account),
-          domain: defaults.domain,
-        },
-        sdkConfig,
-      )
-    },
-    client: async (
-      options: UserCredentialsClientOptions | AnonymousClientOptions,
-    ) => {
-      return createSdkClient({...defaults, ...options}, sdkConfig)
-    },
-  }
-}
-
-// a helper type to unwrap Promise<U> into U
-type PromisedType<T> = T extends Promise<infer U> ? U : T
-
-export type SDK = ReturnType<typeof init>
-export type SDKClient = PromisedType<ReturnType<SDK['client']>>
+export * from './init'
+export * from './init-v2'
 
 /**
  * The default SDK instance that does not know the name of the app using the SDK.

package/src/init-v2.ts

@@ -0,0 +1,40 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import accountCommand from './commands-v2/account'
+import {createSdkClient} from './client-v2'
+import {SDKConfigurationV2} from './shared/types'
+
+export const initV2 = (sdkConfig: SDKConfigurationV2) => {
+  return {
+    verify: async (
+      account: string,
+      adminkey: string,
+      deploymentType: string,
+    ) => {
+      try {
+        const {data} = await accountCommand({
+          account,
+          adminKey: adminkey,
+          deploymentType,
+          sdkConfig,
+        })
+        return Boolean(data)
+      } catch {
+        return false
+      }
+    },
+    client: async (
+      auth:
+        | {account: string; adminKey: string; deploymentType: string}
+        | {publicAccountToken: string; deploymentType: string},
+    ) => {
+      return createSdkClient(auth, sdkConfig)
+    },
+  }
+}
+
+// a helper type to unwrap Promise<U> into U
+type PromisedType<T> = T extends Promise<infer U> ? U : T
+
+export type SDKV2 = ReturnType<typeof initV2>
+export type SDKClientV2 = PromisedType<ReturnType<SDKV2['client']>>

package/src/init.ts

@@ -0,0 +1,41 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import authenticate from './commands/authenticate'
+import {createSdkClient} from './client'
+import {
+  AnonymousClientOptions,
+  SDKConfiguration,
+  UserCredentialsClientOptions,
+} from './shared/types'
+
+export const init = (sdkConfig: SDKConfiguration) => {
+  const defaults = {
+    domain: process.env.STEPZEN_DOMAIN || 'stepzen.io',
+    server: process.env.STEPZEN_SERVER_URL || 'https://{account}.stepzen.io',
+  }
+
+  return {
+    verify: (account: string, adminkey: string) => {
+      return authenticate(
+        {
+          account,
+          adminkey,
+          server: defaults.server.replace('{account}', account),
+          domain: defaults.domain,
+        },
+        sdkConfig,
+      )
+    },
+    client: async (
+      options: UserCredentialsClientOptions | AnonymousClientOptions,
+    ) => {
+      return createSdkClient({...defaults, ...options}, sdkConfig)
+    },
+  }
+}
+
+// a helper type to unwrap Promise<U> into U
+type PromisedType<T> = T extends Promise<infer U> ? U : T
+
+export type SDK = ReturnType<typeof init>
+export type SDKClient = PromisedType<ReturnType<SDK['client']>>

package/src/shared/constants.ts

@@ -5,3 +5,5 @@ export const ADMIN_DEPLOY_URL = '/cli/admin/deploy'
 export const ADMIN_LIST_URL = '/cli/admin/list'
 export const ADMIN_UPLOAD_URL = '/cli/admin/upload'
 export const ADMIN_VERIFY_URL = '/cli/admin/verify'
+
+export const ZENCTL2_URL = '/api/zenctl/__graphql'