stepzen 0.0.0-experimental-94cb99b-20220608

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020,2021,2022, StepZen, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,229 @@
+# StepZen CLI
+
+The StepZen Command Line Interface (CLI) tool enables you to set up and manage StepZen using commands in your command-line shell. 
+
+After you have written or imported your GraphQL schema in the form of a Schema Definition Language (SDL) file, and defined your "configuration" in a YAML files, you can upload and deploy them to StepZen using the StepZen CLI - resulting in a live GraphQL endpoint.
+
+# Installing
+
+`npm install -g stepzen`
+
+# Verifying your installation
+To verify your  CLI installation, use the `stepzen --version` command:
+
+`$ stepzen (-v|--version|version)`
+
+----------------------------------------
+
+<!-- toc -->
+* [StepZen CLI](#stepzen-cli)
+* [Installing](#installing)
+* [Verifying your installation](#verifying-your-installation)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g stepzen
+$ stepzen COMMAND
+running command...
+$ stepzen (-v|--version|version)
+stepzen/0.0.0-experimental-94cb99b-20220608 darwin-x64 node-v14.19.3
+$ stepzen --help [COMMAND]
+USAGE
+  $ stepzen COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`stepzen deploy DESTINATION`](#stepzen-deploy-destination)
+* [`stepzen help [COMMAND]`](#stepzen-help-command)
+* [`stepzen import SCHEMA`](#stepzen-import-schema)
+* [`stepzen list TYPE`](#stepzen-list-type)
+* [`stepzen login`](#stepzen-login)
+* [`stepzen logout`](#stepzen-logout)
+* [`stepzen start`](#stepzen-start)
+* [`stepzen upload TYPE DESTINATION`](#stepzen-upload-type-destination)
+
+## `stepzen deploy DESTINATION`
+
+deploy to stepzen
+
+```
+USAGE
+  $ stepzen deploy DESTINATION
+
+ARGUMENTS
+  DESTINATION  destination
+
+OPTIONS
+  -h, --help                             show CLI help
+  --configurationsets=configurationsets  Configurationsets to use
+  --schema=schema                        (required) Schema to use
+  --silent
+```
+
+## `stepzen help [COMMAND]`
+
+Display help for stepzen.
+
+```
+USAGE
+  $ stepzen help [COMMAND]
+
+ARGUMENTS
+  COMMAND  Command to show help for.
+
+OPTIONS
+  -n, --nested-commands  Include all nested commands in the output.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
+
+## `stepzen import SCHEMA`
+
+import a schema for an external data source or a API endpoint to your GraphQL API
+
+```
+USAGE
+  $ stepzen import SCHEMA
+
+OPTIONS
+  -H, --header=header
+      [curl, graphql] specifies a request header to pass
+
+      Example:
+      stepzen import curl https://example.com/api/customers \
+      -H "Authorization: apikey SecretAPIKeyValue"
+
+  -h, --help
+      show CLI help
+
+  --db-database=db-database
+      [mysql, postgresql] name of database to import
+
+  --db-host=db-host
+      [mysql, postgresql] database host
+
+  --db-password=db-password
+      [mysql, postgresql] database password
+
+  --db-schema=db-schema
+      [postgresql] database schema
+
+  --db-user=db-user
+      [mysql, postgresql] database user name
+
+  --dir=dir
+      working directory
+
+  --header-param=header-param
+      [curl, graphql] specifies a parameter in a header value. Can be formed by taking a -H, --header flag and replacing
+      the variable part of the header value with a $paramName placeholder. Repeat this flag once for each header with a
+      parameter.
+
+      Example:
+      stepzen import curl https://example.com/api/customers \
+      -H "Authorization: apikey SecretAPIKeyValue" \
+      --header-param 'Authorization: apikey $apikey'
+
+  --name=name
+      Subfolder inside the workspace folder to save the imported schema files to. Defaults to the name of the imported
+      schema.
+
+  --path-params=path-params
+      [curl] specifies path parameters in the URL path. Can be formed by taking the original path and replacing the
+      variable segments with $paramName placeholders.
+
+      Example:
+      stepzen import curl https://example.com/users/jane/posts/12 --path-params '/users/$userId/posts/$postId'
+
+  --prefix=prefix
+      [curl, graphql] prefix to add every type in the generated schema.
+
+  --query-name=query-name
+      [curl] property name to add to the Query type as a way to access the imported cURL endpoint.
+
+  --query-type=query-type
+      [curl] name for the type returned by the cURL endpoint in the generated schema. The name specified by --query-type
+      is not prefixed by --prefix if both flags are present.
+```
+
+## `stepzen list TYPE`
+
+list your items
+
+```
+USAGE
+  $ stepzen list TYPE
+
+ARGUMENTS
+  TYPE  (configurationsets|schemas) type
+
+OPTIONS
+  -h, --help  show CLI help
+```
+
+## `stepzen login`
+
+log in to StepZen
+
+```
+USAGE
+  $ stepzen login
+
+OPTIONS
+  -h, --help  show CLI help
+
+  --public    Create a public anonymous StepZen account and use it. This is handy for trying StepZen out, but it not
+              suitable for handling private data as all endpoints created with a public account will be public.
+```
+
+## `stepzen logout`
+
+log out of StepZen
+
+```
+USAGE
+  $ stepzen logout
+
+OPTIONS
+  -h, --help  show CLI help
+```
+
+## `stepzen start`
+
+upload and deploy your schema
+
+```
+USAGE
+  $ stepzen start
+
+OPTIONS
+  -h, --help           show CLI help
+  --dir=dir            working directory
+  --endpoint=endpoint  Override workspace endpoint
+  --port=port          [default: 5001]
+```
+
+## `stepzen upload TYPE DESTINATION`
+
+upload to StepZen
+
+```
+USAGE
+  $ stepzen upload TYPE DESTINATION
+
+ARGUMENTS
+  TYPE         (configurationset|schema) type
+  DESTINATION  destination
+
+OPTIONS
+  -h, --help   show CLI help
+  --dir=dir    A directory to upload
+  --file=file  A file to upload
+  --silent
+```
+<!-- commandsstop -->

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+require('@oclif/command').run()
+.then(require('@oclif/command/flush'))
+.catch(require('@oclif/errors/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/lib/commands/deploy.d.ts

@@ -0,0 +1,18 @@
+import { flags } from '@oclif/command';
+import ZenCommand from '../shared/zen-command';
+export default class Deploy extends ZenCommand {
+    static description: string;
+    static flags: {
+        configurationsets: flags.IOptionFlag<string>;
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        schema: flags.IOptionFlag<string>;
+        silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<void>;
+}

package/lib/commands/deploy.js

@@ -0,0 +1,57 @@
+"use strict";
+// Copyright (c) 2020,2021,2022, StepZen, Inc.
+Object.defineProperty(exports, "__esModule", { value: true });
+// This file contains the code for the `stepzen deploy` command.
+// Deployment in stepzen is an operation that takes three classes of uploaded
+// objects, a single schema, and a collection of configurationsets
+// and uses them to produce an endpoint which serves a GraphQL API.
+const command_1 = require("@oclif/command");
+const errors_1 = require("@oclif/errors");
+const actions_1 = require("../shared/actions");
+const zen_command_1 = require("../shared/zen-command");
+class Deploy extends zen_command_1.default {
+    async run() {
+        const { args, flags } = this.parse(Deploy);
+        // Make sure that you definitely specify folder/name
+        if (args.destination.includes('/') === false) {
+            throw new errors_1.CLIError('You must specify the folder/name you want to use');
+        }
+        const { configuration } = await this.ensureStepZenAccount();
+        if (!flags.silent) {
+            this.log('Deploying...');
+        }
+        // If this is a public account, add a special configuration set to make the
+        // endpoint public (https://github.com/steprz/zen/pull/5701)
+        if (configuration.account.startsWith('public')) {
+            flags.configurationsets = flags.configurationsets
+                ? `${flags.configurationsets},stepzen/public`
+                : 'stepzen/public';
+        }
+        const response = await (0, actions_1.deploy)(args.destination, flags.configurationsets, flags.schema);
+        if (response.success) {
+            if (!flags.silent) {
+                this.log(response.message || 'Success');
+            }
+        }
+        else {
+            // Errors. Exit, and output the server's error response
+            throw new errors_1.CLIError(JSON.stringify(response.errors) || 'An error occurred.');
+        }
+    }
+}
+exports.default = Deploy;
+Deploy.description = 'deploy to stepzen';
+Deploy.flags = Object.assign(Object.assign({}, zen_command_1.default.flags), { 
+    // configurationsets is assumed to be a comma separated string naming uploaded configurationsets
+    // a special configuration 'stepzen/defaults' is recognized.
+    configurationsets: command_1.flags.string({
+        description: 'Configurationsets to use',
+        default: '',
+    }), help: command_1.flags.help({ char: 'h' }), schema: command_1.flags.string({ description: 'Schema to use', required: true }), silent: command_1.flags.boolean() });
+Deploy.args = [
+    {
+        name: 'destination',
+        description: 'destination',
+        required: true,
+    },
+];

package/lib/commands/import.d.ts

@@ -0,0 +1,105 @@
+import { flags } from '@oclif/command';
+import ZenCommand from '../shared/zen-command';
+import { HeaderInput } from '../shared/header';
+import { Workspace } from '../shared/types';
+export default class Import extends ZenCommand {
+    static description: string;
+    static commonIntrospectionFlags: {
+        prefix: flags.IOptionFlag<string | undefined>;
+        header: flags.IOptionFlag<string[]>;
+        'header-param': flags.IOptionFlag<string[]>;
+    };
+    static curlFlags: {
+        'query-name': flags.IOptionFlag<string | undefined>;
+        'query-type': flags.IOptionFlag<string | undefined>;
+        'path-params': flags.IOptionFlag<string | undefined>;
+    };
+    static sqlFlags: {
+        'db-host': flags.IOptionFlag<string | undefined>;
+        'db-user': flags.IOptionFlag<string | undefined>;
+        'db-password': flags.IOptionFlag<string | undefined>;
+        'db-database': flags.IOptionFlag<string | undefined>;
+    };
+    static postgresqlFlags: {
+        'db-schema': flags.IOptionFlag<string | undefined>;
+    };
+    static flagsForSchemas: ({
+        flags: {
+            prefix: flags.IOptionFlag<string | undefined>;
+            header: flags.IOptionFlag<string[]>;
+            'header-param': flags.IOptionFlag<string[]>;
+        };
+        schemas: string[];
+    } | {
+        flags: {
+            'query-name': flags.IOptionFlag<string | undefined>;
+            'query-type': flags.IOptionFlag<string | undefined>;
+            'path-params': flags.IOptionFlag<string | undefined>;
+        };
+        schemas: string[];
+    } | {
+        flags: {
+            'db-host': flags.IOptionFlag<string | undefined>;
+            'db-user': flags.IOptionFlag<string | undefined>;
+            'db-password': flags.IOptionFlag<string | undefined>;
+            'db-database': flags.IOptionFlag<string | undefined>;
+        };
+        schemas: string[];
+    } | {
+        flags: {
+            'db-schema': flags.IOptionFlag<string | undefined>;
+        };
+        schemas: string[];
+    })[];
+    static flags: {
+        'db-schema': flags.IOptionFlag<string | undefined>;
+        'db-host': flags.IOptionFlag<string | undefined>;
+        'db-user': flags.IOptionFlag<string | undefined>;
+        'db-password': flags.IOptionFlag<string | undefined>;
+        'db-database': flags.IOptionFlag<string | undefined>;
+        'query-name': flags.IOptionFlag<string | undefined>;
+        'query-type': flags.IOptionFlag<string | undefined>;
+        'path-params': flags.IOptionFlag<string | undefined>;
+        prefix: flags.IOptionFlag<string | undefined>;
+        header: flags.IOptionFlag<string[]>;
+        'header-param': flags.IOptionFlag<string[]>;
+        dir: flags.IOptionFlag<string | undefined>;
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        silent: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        name: flags.IOptionFlag<string | undefined>;
+        overwrite: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+        'non-interactive': import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        required: boolean;
+    }[];
+    static strict: boolean;
+    run(): Promise<void>;
+    ensureOnConflictBehavior(workspace: Workspace, schema: string, flags: ReturnType<Import['parseWorkaround']>['flags']): Promise<"overwrite" | "append">;
+    warnAboutIgnoredFlags(schema: string, usedFlags: {
+        [key: string]: any;
+    }): void;
+    parseWorkaround(): import("@oclif/parser").Output<{
+        'db-schema': string | undefined;
+        'db-host': string | undefined;
+        'db-user': string | undefined;
+        'db-password': string | undefined;
+        'db-database': string | undefined;
+        'query-name': string | undefined;
+        'query-type': string | undefined;
+        'path-params': string | undefined;
+        prefix: string | undefined;
+        header: string[];
+        'header-param': string[];
+        dir: string | undefined;
+        help: void;
+        silent: boolean;
+        name: string | undefined;
+        overwrite: boolean;
+        'non-interactive': boolean;
+    }, {
+        [name: string]: any;
+    }>;
+    parseHeaderFlags(headerFlagValues?: string[], headerParamFlagValues?: string[]): HeaderInput[];
+}