@stepzen/sdk 0.11.1 → 1.0.0-alpha.1

package/src/shared/graphql-client.ts

@@ -0,0 +1,108 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import * as debug from 'debug'
+import fetch from 'node-fetch'
+
+import {SDKConfigurationV2} from './types'
+import {getUserAgent} from './request'
+
+export type GraphQLSuccessResponse<T> = {
+  data: T
+  errors: undefined
+}
+
+export type GraphQLErrorResponse<T> = {
+  data: T | null
+  errors: Array<{
+    message: string
+    locations?: Array<{line: number; column: number}>
+    path?: Array<string | number>
+  }>
+}
+
+export type GraphQLResponse<T> =
+  | GraphQLSuccessResponse<T>
+  | GraphQLErrorResponse<T>
+
+export const fetchGraphQLQuery = async <T>({
+  url,
+  query,
+  variables = {},
+  headers = {},
+}: {
+  url: URL | string
+  query: string
+  variables: Record<string, any>
+  headers: Record<string, any>
+}): Promise<GraphQLResponse<T>> => {
+  debug('stepzen:sdk:url')(url)
+  debug('stepzen:sdk:headers')(headers)
+  debug('stepzen:sdk:query')(query)
+  debug('stepzen:sdk:variables')(variables)
+
+  try {
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'content-type': 'application/json',
+        ...headers,
+      },
+      body: JSON.stringify({
+        query,
+        variables,
+      }),
+    })
+    const json = await response.json()
+    debug('stepzen:sdk:response')(json)
+
+    const {data, errors} = json
+    if (errors) {
+      return {data, errors}
+    } else {
+      return {data, errors: undefined}
+    }
+  } catch (error) {
+    debug('stepzen:sdk:response')(`Failed to fetch from a GraphQL API`, error)
+    throw error
+  }
+}
+
+export const fetchZenCtlGraphQLQuery = async <T>({
+  query,
+  variables = {},
+  sdkConfig,
+}: {
+  query: string
+  variables: Record<string, any>
+  sdkConfig: SDKConfigurationV2
+}): Promise<GraphQLResponse<T>> => {
+  return fetchGraphQLQuery({
+    url: sdkConfig.zenctlApiUrl,
+    query,
+    variables,
+    headers: {
+      'user-agent': getUserAgent(sdkConfig),
+    },
+  })
+}
+
+export const fetchPublicAccountGraphQLQuery = async <T>({
+  url,
+  query,
+  variables = {},
+  sdkConfig,
+}: {
+  url: URL | string
+  query: string
+  variables: Record<string, any>
+  sdkConfig: SDKConfigurationV2
+}): Promise<GraphQLResponse<T>> => {
+  return fetchGraphQLQuery({
+    url,
+    query,
+    variables,
+    headers: {
+      'user-agent': getUserAgent(sdkConfig),
+    },
+  })
+}

package/src/shared/request.ts

@@ -11,8 +11,8 @@ const {version} = require('../../package.json')
 const arch = os.arch() === 'ia32' ? 'x86' : (os.arch() as any)
 const platform = isWsl ? 'wsl' : (os.platform() as any)
 
-export const getUserAgent = (sdkConfig: SDKConfiguration): string => {
-  return `${sdkConfig.appName} stepzen-sdk/${version} (${platform}; ${arch}; node-${process.version})`
+export const getUserAgent = ({appName}: {appName: string}): string => {
+  return `${appName} stepzen-sdk/${version} (${platform}; ${arch}; node-${process.version})`
 }
 
 export const getRequestHeaders = (

package/src/shared/transpiling.ts

@@ -4,8 +4,7 @@ import * as dotenv from 'dotenv'
 import * as fs from 'fs-extra'
 import * as os from 'os'
 import * as path from 'path'
-
-const {transpile} = require('@stepzen/transpiler')
+import {transpile} from '@stepzen/transpiler'
 
 export const transpileConfigurationset = async (
   file: string | undefined,

package/src/shared/types.ts

@@ -90,4 +90,81 @@ export interface SDKConfiguration {
    * 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
+}
+
+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://braselton.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 type ZenCtlResponseV2<T> =
+  | ZenCtlSuccessResponseV2<T>
+  | ZenCtlErrorResponseV2
+
+export interface StepZenCredentialsV2 {
+  account: string
+  adminKey: string
+  serviceKey: string
+  deploymentType: string
+}
+
+export interface StepZenAccountV2 {
+  account: string
+  ownerEmail: string
+  adminKey: string
+  serviceKey: string
+  deploymentType: string
+}
+
+export interface StepZenEndpointV2 {
+  account: string
+  deploymentType: string
+  folderName: string
+  endpointName: string
+  public: boolean
+  endpointType: string
 }