@stepzen/sdk 0.9.41 → 0.9.44

package/lib/shared/transpiling.js

@@ -6,13 +6,13 @@ const dotenv = require("dotenv");
 const fs = require("fs-extra");
 const os = require("os");
 const path = require("path");
-const { transpile } = require("@stepzen/transpiler");
+const { transpile } = require('@stepzen/transpiler');
 const transpileConfigurationset = async (file) => {
     if (!file) {
         return;
     }
-    const source = file.substring(0, file.lastIndexOf("/"));
-    dotenv.config({ path: path.resolve(source, ".env") });
+    const source = file.substring(0, file.lastIndexOf('/'));
+    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);
@@ -27,3 +27,4 @@ const transpileConfigurationset = async (file) => {
     return;
 };
 exports.transpileConfigurationset = transpileConfigurationset;
+//# sourceMappingURL=transpiling.js.map

package/lib/shared/transpiling.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transpiling.js","sourceRoot":"","sources":["../../src/shared/transpiling.ts"],"names":[],"mappings":";AAAA,8CAA8C;;;AAE9C,iCAAgC;AAChC,+BAA8B;AAC9B,yBAAwB;AACxB,6BAA4B;AAE5B,MAAM,EAAC,SAAS,EAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAE3C,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,SAAS,CAAC,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"}

package/lib/shared/types.d.ts

@@ -1,8 +1,31 @@
 export interface StepZenAccount {
     account: string;
     adminkey: string;
-    domain: string;
+    /**
+     * ZenCtl base URL, e.g. `https://fakefish.stepzen.io` for production,
+     * or `http://localhost` for local tests.
+     *
+     * Determined by taking the first option that is defined:
+     *  - the `server` config property explicily passed into the `init()` function
+     *  - the `STEPZEN_SERVER_URL` environment variable
+     *  - the `https://{account}.stepzen.io` default value
+     *
+     * The `{account}` placeholder (if present) is replaced by the provided account
+     * name
+     */
     server: string;
+    /**
+     * ZenCtl domain, e.g. `stepzen.io`. This is only relevant for local testing
+     * when ZenCtl is running on localhost. In that case an additional `Host` HTTP
+     * header is added to requests, using a non-localhost host name constructed
+     * from this property.
+     *
+     * Determined by taking the first option that is defined:
+     *  - the `domain` config property explicily passed into the `init()` function
+     *  - the `STEPZEN_DOMAIN` environment variable
+     *  - the `stepzen.io` default value
+     */
+    domain: string;
 }
 export interface StepZenDeploy {
     configurationsets?: string[];
@@ -21,8 +44,8 @@ export interface StepZenUpload {
 export interface ZenCtlRequestHeaders {
     authorization: string;
     host: string;
-    "stepzen-cli-version": string;
-    "user-agent": string;
+    'stepzen-cli-version': string;
+    'user-agent': string;
 }
 export interface ZenCtlResponse {
     errors?: Array<string>;
@@ -30,3 +53,13 @@ export interface ZenCtlResponse {
     results?: Array<string>;
     success: boolean;
 }
+export interface 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;
+}

package/lib/shared/types.js

@@ -1,3 +1,4 @@
 "use strict";
 // Copyright (c) 2020,2021,2022, StepZen, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/shared/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/shared/types.ts"],"names":[],"mappings":";AAAA,8CAA8C"}

package/lib/shared/validation.js

@@ -8,33 +8,34 @@ const yaml = require("yaml");
 // Validate the Configurationset file
 const validateConfigurationset = async (file) => {
     if (!file) {
-        throw new Error("You must provide a file path");
+        throw new Error('You must provide a file path');
     }
     if (!fs.existsSync(file)) {
-        throw new Error("The file does not exist");
+        throw new Error('The file does not exist');
     }
-    const content = fs.readFileSync(file, "utf8");
+    const content = fs.readFileSync(file, 'utf8');
     // Ensure the file is valid YAML
     try {
         yaml.parse(content);
     }
     catch (_a) {
-        throw new Error("The file is not valid YAML");
+        throw new Error('The file is not valid YAML');
     }
 };
 exports.validateConfigurationset = validateConfigurationset;
 // Validate the Schema directory
 const validateSchema = async (directory) => {
     if (!directory) {
-        throw new Error("You must provide a directory path");
+        throw new Error('You must provide a directory path');
     }
     if (!fs.existsSync(directory)) {
-        throw new Error("The directory does not exist");
+        throw new Error('The directory does not exist');
     }
     // Ensure there's a root `index.graphql` file
-    const allSchemaFiles = glob.sync("index.graphql", { cwd: directory });
+    const allSchemaFiles = glob.sync('index.graphql', { cwd: directory });
     if (allSchemaFiles.length === 0) {
-        throw new Error("Schemas must include an `index.graphql` file");
+        throw new Error('Schemas must include an `index.graphql` file');
     }
 };
 exports.validateSchema = validateSchema;
+//# sourceMappingURL=validation.js.map

package/lib/shared/validation.js.map

@@ -0,0 +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"}

package/package.json

@@ -1,31 +1,35 @@
 {
   "name": "@stepzen/sdk",
-  "version": "0.9.41",
+  "version": "0.9.44",
   "license": "MIT",
   "author": "Darren Waddell <darren@stepzen.com>",
   "homepage": "https://stepzen.com",
   "files": [
-    "lib/**/*"
+    "lib/**/*",
+    "src/**/*"
   ],
   "engines": {
     "node": ">=14.0.1",
     "npm": ">=6.14"
   },
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "scripts": {
+    "prepare": "husky install",
     "build": "tsc -b",
     "prepack": "rm -rf lib && tsc -b ",
-    "test": "tsc -b && nyc --extension .ts mocha --config test/mocha.opts.json"
+    "test": "tsc -b && nyc --extension .ts mocha --config test/mocha.opts.json",
+    "posttest": "prettier . --check"
   },
   "dependencies": {
-    "@stepzen/transpiler": "0.0.24",
+    "@stepzen/transpiler": "0.0.36",
     "archiver": "^5.3.0",
-    "debug": "^4.3.2",
+    "debug": "^4.3.3",
     "form-data": "^4.0.0",
     "fs-extra": "^10.0.0",
-    "glob": "^7.1.6",
-    "node-fetch": "^2.6.6",
-    "tslib": "^2.2.0",
+    "glob": "^7.2.0",
+    "is-wsl": "^2.2.0",
+    "node-fetch": "^2.6.7",
     "yaml": "^1.10.2"
   },
   "devDependencies": {
@@ -38,11 +42,16 @@
     "@types/node-fetch": "^2.5.10",
     "chai": "^4.3.4",
     "fancy-test": "^1.4.10",
+    "husky": "^7.0.4",
     "license-checker": "^25.0.1",
+    "lint-staged": "^12.3.4",
     "mocha": "^8.3.2",
-    "node-ts": "^5.1.1",
     "nyc": "^15.1.0",
+    "prettier": "^2.5.1",
     "ts-node": "^9.1.1",
     "typescript": "^4.2.4"
+  },
+  "lint-staged": {
+    "*.{ts,js,css,md,yaml,json}": "prettier --write"
   }
 }

package/src/commands/account.ts

@@ -0,0 +1,54 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import * as debug from 'debug'
+import fetch from 'node-fetch'
+
+import {ADMIN_ACCOUNT_URL} from '../shared/constants'
+import {getRequestHeaders} from '../shared/request'
+import {SDKConfiguration, StepZenAccount} from '../shared/types'
+
+export default async (
+  account: StepZenAccount,
+  sdkConfig: SDKConfiguration,
+): Promise<
+  {account: string; apikey: string} | {success: false; errors: string[]}
+> => {
+  const headers = getRequestHeaders(account, sdkConfig)
+  const url = `${account.server}${ADMIN_ACCOUNT_URL}`
+
+  debug('stepzen:headers')(headers)
+
+  const response = await fetch(url, {
+    headers: headers as any,
+    method: 'POST',
+  })
+
+  debug('stepzen:response')(response)
+
+  if (response.status >= 400 && response.status < 500) {
+    throw new Error(
+      'Could not complete the request. Please check your authentication details are correct.',
+    )
+  }
+
+  if (response.status >= 500) {
+    return {
+      errors: [response.statusText],
+      success: false,
+    }
+  }
+
+  const text = await response.text()
+  let json
+
+  try {
+    json = JSON.parse(text)
+  } catch {
+    return {
+      errors: [`An unexpected error occurred.\n\n${text}`],
+      success: false,
+    }
+  }
+
+  return json
+}

package/src/commands/authenticate.ts

@@ -0,0 +1,30 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import * as debug from 'debug'
+import fetch from 'node-fetch'
+
+import {ADMIN_VERIFY_URL} from '../shared/constants'
+import {getRequestHeaders} from '../shared/request'
+import {SDKConfiguration, StepZenAccount} from '../shared/types'
+
+export default async (
+  settings: StepZenAccount,
+  sdkConfig: SDKConfiguration,
+): Promise<boolean> => {
+  const headers = getRequestHeaders(settings, sdkConfig)
+  const url = `${settings.server}${ADMIN_VERIFY_URL}`
+
+  debug('stepzen:headers')(headers)
+  debug('stepzen:url')(url)
+
+  try {
+    const response = await fetch(url, {
+      headers: headers as any,
+      method: 'POST',
+    })
+    await response.json()
+    return true
+  } catch {
+    return false
+  }
+}

package/src/commands/deploy.ts

@@ -0,0 +1,72 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import * as debug from 'debug'
+import fetch from 'node-fetch'
+
+import {ADMIN_DEPLOY_URL} from '../shared/constants'
+import {getRequestHeaders} from '../shared/request'
+import {
+  SDKConfiguration,
+  StepZenAccount,
+  StepZenDeploy,
+  ZenCtlResponse,
+} from '../shared/types'
+
+export default async (
+  details: StepZenDeploy,
+  account: StepZenAccount,
+  sdkConfig: SDKConfiguration,
+): Promise<ZenCtlResponse> => {
+  const headers = getRequestHeaders(account, sdkConfig)
+
+  const payload: any = {
+    schema: `/workspaces/schemas/${details.schema}`,
+  }
+
+  if (details.configurationsets) {
+    payload.configurationsets = details.configurationsets.map(
+      config => `/workspaces/configurationsets/${config}`,
+    )
+  }
+
+  debug('stepzen:headers')(headers)
+  debug('stepzen:payload')(payload)
+
+  const response = await fetch(
+    `${account.server}${ADMIN_DEPLOY_URL}/${details.destination}`,
+    {
+      body: JSON.stringify(payload),
+      headers: headers as any,
+      method: 'POST',
+    },
+  )
+
+  debug('stepzen:response')(response)
+
+  if (response.status >= 400 && response.status < 500) {
+    throw new Error(
+      'Could not complete the request. Please check your authentication details are correct.',
+    )
+  }
+
+  if (response.status >= 500) {
+    return {
+      errors: [response.statusText],
+      success: false,
+    }
+  }
+
+  const text = await response.text()
+  let json
+
+  try {
+    json = JSON.parse(text)
+  } catch {
+    return {
+      errors: [`An unexpected error occurred.\n\n${text}`],
+      success: false,
+    }
+  }
+
+  return json
+}

package/src/commands/list.ts

@@ -0,0 +1,50 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import * as debug from 'debug'
+import fetch from 'node-fetch'
+
+import {ADMIN_LIST_URL} from '../shared/constants'
+import {getRequestHeaders} from '../shared/request'
+import {
+  SDKConfiguration,
+  StepZenAccount,
+  StepZenList,
+  ZenCtlResponse,
+} from '../shared/types'
+
+export default async (
+  details: StepZenList,
+  account: StepZenAccount,
+  sdkConfig: SDKConfiguration,
+): Promise<ZenCtlResponse> => {
+  const headers = getRequestHeaders(account, sdkConfig)
+
+  debug('stepzen:headers')(headers)
+
+  const response = await fetch(
+    `${account.server}${ADMIN_LIST_URL}/${details.type}`,
+    {
+      headers: headers as any,
+      method: 'GET',
+    },
+  )
+
+  debug('stepzen:response')(response)
+
+  if (response.status >= 400 && response.status < 500) {
+    throw new Error(
+      'Could not complete the request. Please check your authentication details are correct.',
+    )
+  }
+
+  const text = await response.text()
+  let json
+
+  try {
+    json = JSON.parse(text)
+  } catch {
+    throw new Error(`An unexpected error occurred.\n\n${text}`)
+  }
+
+  return json
+}

package/src/commands/upload.ts

@@ -0,0 +1,95 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import * as debug from 'debug'
+import fetch from 'node-fetch'
+
+import {ADMIN_UPLOAD_URL} from '../shared/constants'
+import {generateYamlPayload, generateZipPayload} from '../shared/payloads'
+import {getRequestHeaders} from '../shared/request'
+import {
+  SDKConfiguration,
+  StepZenAccount,
+  StepZenUpload,
+  ZenCtlResponse,
+} from '../shared/types'
+import {transpileConfigurationset} from '../shared/transpiling'
+import {validateConfigurationset, validateSchema} from '../shared/validation'
+
+export default async (
+  details: StepZenUpload,
+  account: StepZenAccount,
+  sdkConfig: SDKConfiguration,
+): Promise<ZenCtlResponse> => {
+  const headers = getRequestHeaders(account, sdkConfig)
+  let payload
+
+  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)
+      }
+      break
+
+    case 'schema':
+      await validateSchema(details.directory)
+      payload = await generateZipPayload(
+        details.directory,
+        {
+          destination: details.destination,
+          stitcherName: 'index.graphql',
+        },
+        [/.*\.graphql$/i],
+      )
+      break
+  }
+
+  debug('stepzen:headers')(headers)
+  debug('stepzen:payload')(payload)
+
+  const response = await fetch(
+    `${account.server}${ADMIN_UPLOAD_URL}/${details.type}/${details.destination}`,
+    {
+      body: payload,
+      headers: headers as any,
+      method: 'POST',
+    },
+  )
+
+  debug('stepzen:response')(response)
+
+  if (response.status >= 400 && response.status < 500) {
+    return {
+      message:
+        'Could not complete the request. Please check your authentication details are correct.',
+      success: false,
+    }
+  }
+
+  if (response.status >= 500) {
+    return {
+      errors: ['Internal Server Error'],
+      message: response.statusText,
+      success: false,
+    }
+  }
+
+  const text = await response.text()
+  let json
+
+  try {
+    json = JSON.parse(text)
+  } catch {
+    return {
+      errors: [`An unexpected error occurred.\n\n${text}`],
+      message: `An unexpected error occurred.\n\n${text}`,
+      success: false,
+    }
+  }
+
+  return json
+}

package/src/index.ts

@@ -0,0 +1,121 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+import * as path from 'path'
+import accountCommand from './commands/account'
+import authenticate from './commands/authenticate'
+import deploy from './commands/deploy'
+import {SDKConfiguration, StepZenAccount} from './shared/types'
+import list from './commands/list'
+import upload from './commands/upload'
+
+export * 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: Pick<StepZenAccount, 'account' | 'adminkey'> &
+        Partial<StepZenAccount>,
+    ) => {
+      if (!options.account) {
+        throw new Error('You must provide an account.')
+      }
+
+      if (!options.adminkey) {
+        throw new Error('You must provide an admin key.')
+      }
+
+      const account: StepZenAccount = {
+        ...defaults,
+        ...options,
+      }
+
+      account.server = account.server.replace('{account}', options.account)
+      const authorised = await authenticate(account, sdkConfig)
+
+      if (!authorised) {
+        throw new Error('Your credentials are invalid.')
+      }
+
+      return {
+        account: () => {
+          return accountCommand(account, sdkConfig)
+        },
+        deploy: (
+          destination: string,
+          properties: {
+            configurationsets?: string[]
+            schema: string
+          },
+        ) => {
+          return deploy({destination, ...properties}, account, sdkConfig)
+        },
+        list: {
+          configurationsets: async () => {
+            return list({type: 'configurationsets'}, account, sdkConfig)
+          },
+          schemas: async () => {
+            return list({type: 'schemas'}, account, sdkConfig)
+          },
+        },
+        upload: {
+          configurationset: async (destination: string, file: string) => {
+            return upload(
+              {type: 'configurationset', destination, file},
+              account,
+              sdkConfig,
+            )
+          },
+          schema: async (destination: string, directory: string) => {
+            return upload(
+              {type: 'schema', destination, directory},
+              account,
+              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']>>
+
+/**
+ * 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`
+ *
+ * @deprecated use the init({appName: 'my-app/1.2.3'}) method to initialis an SDK instance
+ */
+const stepzen: SDK = init({
+  // For legacy apps use the script name (e.g. `index.js` as the app name)
+  // Fallback to `node` if this file is imported into an interactive node shell
+  appName: path.basename(process.argv[1] || process.argv[0]),
+})
+
+export default stepzen
+
+// Hack: support both ESM-style imports: `import stepzen from '@stepzen/sdk'`
+// and keep the backwards-compat with CJS-style imports: `const stepzen = require('@stepzen/sdk')`
+// NOTE: if at any point in the future there is a name collision between `stepzen` and ES exports
+// this hack will break
+module.exports = {...module.exports, ...stepzen}

package/src/shared/constants.ts

@@ -0,0 +1,7 @@
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+export const ADMIN_ACCOUNT_URL = '/cli/admin/account'
+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'