@stepzen/sdk 0.44.0 → 0.45.0-experimental.6baaa11

package/src/client.ts

@@ -1,17 +1,17 @@
 // Copyright IBM Corp. 2020, 2024
 
-import accountCommand from './commands/account'
-import deploy from './commands/deploy'
+import accountCommand from './commands/account.js'
+import deploy from './commands/deploy.js'
 import {
   AnonymousClientOptions,
   SDKConfiguration,
   StepZenAccount,
-} from './shared/types'
-import list from './commands/list'
-import upload from './commands/upload'
-import getPublicAccount from './commands/getPublicAccount'
+} from './shared/types.js'
+import list from './commands/list.js'
+import upload from './commands/upload.js'
+import getPublicAccount from './commands/getPublicAccount.js'
 
-export * from './shared/types'
+export * from './shared/types.js'
 
 export const validateCreateClientOptions = async (
   options: StepZenAccount | Required<AnonymousClientOptions>,

package/src/commands/account.ts

@@ -1,11 +1,11 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
+import debug from 'debug'
 import fetch from '@stepzen/fetch'
 
-import {ADMIN_ACCOUNT_URL} from '../shared/constants'
-import {getRequestHeaders} from '../shared/request'
-import {SDKConfiguration, StepZenAccount} from '../shared/types'
+import {ADMIN_ACCOUNT_URL} from '../shared/constants.js'
+import {getRequestHeaders} from '../shared/request.js'
+import {SDKConfiguration, StepZenAccount} from '../shared/types.js'
 
 export default async (
   account: StepZenAccount,

package/src/commands/authenticate.ts

@@ -1,11 +1,11 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
+import debug from 'debug'
 import fetch from '@stepzen/fetch'
 
-import {ADMIN_VERIFY_URL} from '../shared/constants'
-import {getRequestHeaders} from '../shared/request'
-import {SDKConfiguration, StepZenAccount} from '../shared/types'
+import {ADMIN_VERIFY_URL} from '../shared/constants.js'
+import {getRequestHeaders} from '../shared/request.js'
+import {SDKConfiguration, StepZenAccount} from '../shared/types.js'
 
 export default async (
   settings: StepZenAccount,

package/src/commands/deploy.ts

@@ -1,16 +1,16 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
+import debug from 'debug'
 import fetch from '@stepzen/fetch'
 
-import {ADMIN_DEPLOY_URL} from '../shared/constants'
-import {getRequestHeaders} from '../shared/request'
+import {ADMIN_DEPLOY_URL} from '../shared/constants.js'
+import {getRequestHeaders} from '../shared/request.js'
 import {
   SDKConfiguration,
   StepZenAccount,
   StepZenDeploy,
   ZenCtlResponse,
-} from '../shared/types'
+} from '../shared/types.js'
 
 export default async (
   details: StepZenDeploy,

package/src/commands/getPublicAccount.ts

@@ -1,14 +1,16 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
+import type {ExecutionResult} from 'graphql/execution/execute.js'
+
+import debug from 'debug'
 import fetch from '@stepzen/fetch'
 
-import {getUserAgent} from '../shared/request'
+import {getUserAgent} from '../shared/request.js'
 import {
   AnonymousClientOptions,
   SDKConfiguration,
   StepZenCredentials,
-} from '../shared/types'
+} from '../shared/types.js'
 
 export default async (
   options: Required<AnonymousClientOptions>,
@@ -57,12 +59,18 @@ export default async (
         },
       }),
     })
-    const json = await response.json()
+    const json = (await response.json()) as ExecutionResult<{
+      getAccountDetails: {
+        account: string
+        adminkey: string
+        apikey: string
+      }
+    }>
     debug('stepzen:createAnonymousAccount')(json)
     if (json.errors) {
       return {
         success: false,
-        errors: json.errors,
+        errors: json.errors.map(e => e.message),
       }
     }
 

package/src/commands/list.ts

@@ -1,16 +1,16 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
+import debug from 'debug'
 import fetch from '@stepzen/fetch'
 
-import {ADMIN_LIST_URL} from '../shared/constants'
-import {getRequestHeaders} from '../shared/request'
+import {ADMIN_LIST_URL} from '../shared/constants.js'
+import {getRequestHeaders} from '../shared/request.js'
 import {
   SDKConfiguration,
   StepZenAccount,
   StepZenList,
   ZenCtlResponse,
-} from '../shared/types'
+} from '../shared/types.js'
 
 export default async (
   details: StepZenList,

package/src/commands/upload.ts

@@ -1,21 +1,21 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
-import * as path from 'path'
+import debug from 'debug'
+import path from 'node:path'
 import fetch from '@stepzen/fetch'
 
-import {ADMIN_UPLOAD_URL} from '../shared/constants'
-import {generateYamlPayload, generateZipPayload} from '../shared/payloads'
-import {getRequestHeaders} from '../shared/request'
+import {ADMIN_UPLOAD_URL} from '../shared/constants.js'
+import {generateYamlPayload, generateZipPayload} from '../shared/payloads.js'
+import {getRequestHeaders} from '../shared/request.js'
 import {
   SDKConfiguration,
   StepZenAccount,
   StepZenUpload,
   ZenCtlResponse,
-} from '../shared/types'
-import {transpileConfigurationset} from '../shared/transpiling'
-import {validateConfigurationset, validateSchema} from '../shared/validation'
-import {rmtemp} from '../shared/rmtemp'
+} from '../shared/types.js'
+import {transpileConfigurationset} from '../shared/transpiling.js'
+import {validateConfigurationset, validateSchema} from '../shared/validation.js'
+import {rmtemp} from '../shared/rmtemp.js'
 
 export default async (
   details: StepZenUpload,

package/src/commands-v2/account.ts

@@ -4,8 +4,8 @@ import {
   SDKConfigurationV2,
   StepZenAccountV2,
   ZenCtlResponseV2,
-} from '../shared/types'
-import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client'
+} from '../shared/types.js'
+import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client.js'
 
 export default async ({
   account,

package/src/commands-v2/delete.ts

@@ -1,12 +1,12 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
+import debug from 'debug'
 import {
   SDKConfigurationV2,
   StepZenDeleteV2,
   ZenCtlResponseV2,
-} from '../shared/types'
-import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client'
+} from '../shared/types.js'
+import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client.js'
 
 export default async ({
   account,

package/src/commands-v2/deploy.ts

@@ -6,8 +6,8 @@ import {
   SDKConfigurationV2,
   StepZenEndpointV2,
   ZenCtlResponseV2,
-} from '../shared/types'
-import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client'
+} from '../shared/types.js'
+import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client.js'
 
 export default async ({
   account,

package/src/commands-v2/getPublicAccount.ts

@@ -4,8 +4,8 @@ import {
   SDKConfigurationV2,
   StepZenCredentialsV2,
   ZenCtlResponseV2,
-} from '../shared/types'
-import {fetchPublicAccountGraphQLQuery} from '../shared/graphql-client'
+} from '../shared/types.js'
+import {fetchPublicAccountGraphQLQuery} from '../shared/graphql-client.js'
 
 export default async ({
   token,

package/src/commands-v2/list.ts

@@ -4,8 +4,8 @@ import type {
   SDKConfigurationV2,
   ZenCtlResponseV2,
   StepZenEndpointV2,
-} from '../shared/types'
-import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client'
+} from '../shared/types.js'
+import {fetchZenCtlGraphQLQuery} from '../shared/graphql-client.js'
 
 export default async ({
   account,

package/src/index.ts

@@ -1,29 +1,6 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as path from 'path'
-import {init, SDK} from './init'
-
-export * from './init'
-export * from './init-v2'
-export * from './shared/types'
-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`
- *
- * @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}
+export * from './init.js'
+export * from './init-v2.js'
+export * from './shared/types.js'
+export {fetchGraphQLQuery} from './shared/graphql-client.js'

package/src/init-v2.ts

@@ -1,9 +1,9 @@
 // Copyright IBM Corp. 2020, 2024
 
-import accountCommand from './commands-v2/account'
-import {createSdkClient} from './client-v2'
-import {getUserAgent} from './shared/request'
-import {SDKConfigurationV2} from './shared/types'
+import accountCommand from './commands-v2/account.js'
+import {createSdkClient} from './client-v2.js'
+import {getUserAgent} from './shared/request.js'
+import {SDKConfigurationV2} from './shared/types.js'
 
 export const initV2 = (sdkConfig: SDKConfigurationV2) => {
   return {

package/src/init.ts

@@ -1,13 +1,13 @@
 // Copyright IBM Corp. 2020, 2024
 
-import authenticate from './commands/authenticate'
-import {createSdkClient} from './client'
-import {getUserAgent} from './shared/request'
+import authenticate from './commands/authenticate.js'
+import {createSdkClient} from './client.js'
+import {getUserAgent} from './shared/request.js'
 import {
   AnonymousClientOptions,
   SDKConfiguration,
   UserCredentialsClientOptions,
-} from './shared/types'
+} from './shared/types.js'
 
 export const init = (sdkConfig: SDKConfiguration) => {
   const defaults = {

package/src/shared/graphql-client.ts

@@ -1,11 +1,12 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
+import debug from 'debug'
 import fetch from '@stepzen/fetch'
 import type {ExecutionResult} from 'graphql'
+import type {ObjMap} from 'graphql/jsutils/ObjMap.js'
 
-import {SDKConfigurationV2} from './types'
-import {getUserAgent} from './request'
+import {SDKConfigurationV2} from './types.js'
+import {getUserAgent} from './request.js'
 
 // The StepZen's ZenCtl GraphQL API offers stronger guarantees than defined in
 // the GraphQL standard:
@@ -14,14 +15,14 @@ export type GraphQLResponse<TData = Record<string, any>> =
   | GraphQLErrorResponse<TData>
 
 // 1. a successful response would always have a non-null `data` property and no `errors`.
-type GraphQLSuccessResponse<TData> = ExecutionResult<TData> & {
+type GraphQLSuccessResponse<TData> = ExecutionResult<TData, ObjMap<unknown>> & {
   data: TData
   errors: undefined
 }
 
 // 2. an error response would always have a non-null `errors` property.
-type GraphQLErrorResponse<TData> = ExecutionResult<TData> &
-  Required<Pick<ExecutionResult<TData>, 'errors'>>
+type GraphQLErrorResponse<TData> = ExecutionResult<TData, ObjMap<unknown>> &
+  Required<Pick<ExecutionResult<TData, ObjMap<unknown>>, 'errors'>>
 
 export const fetchGraphQLQuery = async <T = Record<string, any>>({
   url,
@@ -35,7 +36,7 @@ export const fetchGraphQLQuery = async <T = Record<string, any>>({
   variables?: Record<string, any>
   operationName?: string
   headers?: Record<string, any>
-}): Promise<ExecutionResult<T>> => {
+}): Promise<ExecutionResult<T, ObjMap<unknown>>> => {
   debug('stepzen:sdk:url')(url)
   debug('stepzen:sdk:headers')(headers)
   debug('stepzen:sdk:query')(query)
@@ -68,7 +69,7 @@ export const fetchGraphQLQuery = async <T = Record<string, any>>({
       )
     }
 
-    const json = await response.json()
+    const json = (await response.json()) as GraphQLResponse<T>
     debug('stepzen:sdk:response')(JSON.stringify(json))
     // trace is a JSON readable summation in a single line; eventually allow stepzen request to return this directly?
     debug('stepzen:sdk:trace')(

package/src/shared/payloads.ts

@@ -2,18 +2,38 @@
 
 // This file contains helpers that zip a file or directory
 
-import * as archiver from 'archiver'
-import * as debug from 'debug'
-import * as FormData from 'form-data'
-import * as fs from 'fs'
-import * as glob from 'glob'
-import * as os from 'os'
-import * as path from 'path'
-import * as yaml from 'yaml'
-import {transpileConfigurationset} from './transpiling'
-import {validateConfigurationset} from './validation'
-import {Configuration, SchemaFiles} from './types'
-import {rmtemp} from './rmtemp'
+import archiver from 'archiver'
+import debug from 'debug'
+import {FormData} from 'formdata-node'
+import fs from 'node:fs'
+import glob from 'glob'
+import os from 'node:os'
+import path from 'node:path'
+import {Readable} from 'node:stream'
+import yaml from 'yaml'
+import {transpileConfigurationset} from './transpiling.js'
+import {validateConfigurationset} from './validation.js'
+import {Configuration, SchemaFiles} from './types.js'
+import {rmtemp} from './rmtemp.js'
+
+// https://www.npmjs.com/package/formdata-node#usage
+class BlobFromStream {
+  _stream: Readable
+  _size: number
+
+  constructor(stream: Readable, size: number) {
+    this._stream = stream
+    this._size = size
+  }
+
+  stream() {
+    return this._stream
+  }
+
+  get [Symbol.toStringTag]() {
+    return 'Blob'
+  }
+}
 
 type YamlPayload = FormData
 type ZipPayload = FormData
@@ -100,7 +120,8 @@ export const generateZipPayload = async (
     // Once we're done, append a ReadStream to the tmp file
     output.on('close', () => {
       const stream = fs.createReadStream(filepath)
-      payload.append('zip', stream)
+      const {size} = fs.statSync(filepath)
+      payload.append('zip', new BlobFromStream(stream, size))
       // Remove the temporary zip
       stream.on('close', () => {
         fs.unlinkSync(filepath)

package/src/shared/request.ts

@@ -1,10 +1,15 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as os from 'os'
+import os from 'node:os'
 import * as isWsl from 'is-wsl'
-import {SDKConfiguration, StepZenAccount, ZenCtlRequestHeaders} from './types'
+import {createRequire} from 'node:module'
+import {
+  SDKConfiguration,
+  StepZenAccount,
+  ZenCtlRequestHeaders,
+} from './types.js'
 
-const {version} = require('../../package.json')
+const {version} = createRequire(import.meta.url)('../../package.json')
 
 // mimics the logic from @oclif/config
 // https://github.com/oclif/core/blob/d7067d13c7d80c9e0064455c27ac1ebb6ee53fd2/src/config/config.ts#L128

package/src/shared/rmtemp.ts

@@ -1,9 +1,9 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as fs from 'fs'
-import * as path from 'path'
-import * as os from 'os'
-import * as debug from 'debug'
+import fs from 'node:fs'
+import path from 'node:path'
+import os from 'node:os'
+import debug from 'debug'
 
 // ----------------------------------------------------------------------------
 //      THIS ENTIRE FILE IS COPIED FROM packages/cli/src/shared/rmtemp.ts

package/src/shared/transpiling.ts

@@ -1,12 +1,12 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as dotenv from 'dotenv'
-import * as debug from 'debug'
-import * as fsx from 'fs-extra'
-import * as os from 'os'
-import * as path from 'path'
+import dotenv from 'dotenv'
+import debug from 'debug'
+import fsx from 'fs-extra'
+import os from 'node:os'
+import path from 'node:path'
 import {transpile} from '@stepzen/transpiler'
-import {rmtemp} from './rmtemp'
+import {rmtemp} from './rmtemp.js'
 
 /**
  * @returns `undefined` when called without arguments

package/src/shared/validation.ts

@@ -1,9 +1,9 @@
 // Copyright IBM Corp. 2020, 2024
 
-import * as debug from 'debug'
-import * as fs from 'fs'
-import * as glob from 'glob'
-import * as yaml from 'yaml'
+import debug from 'debug'
+import fs from 'node:fs'
+import glob from 'glob'
+import yaml from 'yaml'
 
 // Validate the Configurationset file
 export const validateConfigurationset = async (file: string | undefined) => {