@constructor-io/constructorio-connect-cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Constructor.io
+
+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,184 @@
+# Constructor.io Connect CLI
+
+[![npm](https://img.shields.io/npm/v/@constructor-io/constructorio-connect-cli)](https://www.npmjs.com/package/@constructor-io/constructorio-connect-cli)
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Constructor-io/constructorio-connect-cli/blob/master/LICENSE)
+
+Constructor.io is an e-commerce first product discovery service that optimizes results using artificial intelligence (including natural language processing, re-ranking to optimize for business metrics, and end user personalization).
+
+This package is a CLI tool that helps you **build, test and deploy your connector templates**. By using templates, you can customize your catalog integration to shape your data the way you want it.
+
+> If you're looking for a package to consume our API, please use [@constructor-io/constructorio-node](https://github.com/Constructor-io/constructorio-node) instead. Alternatively, if you want a JavaScript client for client side (i.e. front end) integrations please use [@constructor-io/constructorio-client-javascript](https://github.com/Constructor-io/constructorio-client-javascript).
+
+## 1. Review the Requirements
+
+Before you begin, note that this package is intended for use with partner connections. If you don't have a connector
+running yet, please take a look at [our documentation](https://docs-beta.constructor.io/docs/integrating-with-constructor-platform-connectors) to see how you can get started.
+
+## 2. Install
+
+This package can be installed via npm: `npm i @constructor-io/constructorio-connect-cli`. Once installed, simply import or require the package into your repository.
+
+## 3.  Commands
+
+<!-- Generated code below. Do not update! -->
+
+<!-- commands -->
+* [`constructorio-connect-cli deploy ENV`](#constructorio-connect-cli-deploy-env)
+* [`constructorio-connect-cli execute`](#constructorio-connect-cli-execute)
+* [`constructorio-connect-cli help [COMMAND]`](#constructorio-connect-cli-help-command)
+* [`constructorio-connect-cli init NAME`](#constructorio-connect-cli-init-name)
+
+## `constructorio-connect-cli deploy ENV`
+
+Deploys all templates defined on the `connectrc.js` file to the specified environment.
+
+```
+USAGE
+  $ constructorio-connect-cli deploy ENV
+
+ARGUMENTS
+  ENV  (development|qa|production|demo) The target Constructor environment to deploy to.
+
+DESCRIPTION
+
+  Deploys all templates defined on the `connectrc.js` file to the specified environment.
+
+  The script will use the `CONNECT_AUTH_TOKEN` environment variable to authenticate with Constructor.
+
+EXAMPLES
+  $ constructorio-connect-cli deploy development
+
+  $ constructorio-connect-cli deploy qa
+
+  $ constructorio-connect-cli deploy production
+```
+
+_See code: [src/commands/deploy.ts](https://github.com/Constructor-io/constructorio-connect-cli/blob/v1.0.0/src/commands/deploy.ts)_
+
+## `constructorio-connect-cli execute`
+
+Execute a template against a connection and fixture to see the resulting transformed data. Each value not provided as a flag will be prompted for when the command is executed.
+
+```
+USAGE
+  $ constructorio-connect-cli execute [--template-path <value>] [--fixture-path <value>]
+    [--external-data-path <value>] [--connection-id <value>]
+
+FLAGS
+  --connection-id=<value>       The ID of the connection to execute the template against.
+  --external-data-path=<value>  The path to the external data to execute the template against. Must be in the
+                                'src/fixtures/external_data' directory.
+  --fixture-path=<value>        The path to the fixture to execute the template against. Must be in the 'src/fixtures'
+                                directory.
+  --template-path=<value>       The path to the template to execute. Must be in the 'src/templates' directory.
+
+DESCRIPTION
+  Execute a template against a connection and fixture to see the resulting transformed data. Each value not provided as
+  a flag will be prompted for when the command is executed.
+
+EXAMPLES
+  $ constructorio-connect-cli execute
+
+  $ constructorio-connect-cli execute --template-path=item/item.jsonata
+
+  $ constructorio-connect-cli execute --template-path=variation/variation.jsonata
+
+  $ constructorio-connect-cli execute --template-path=item_group/item_group.jsonata --fixture-path=item_group.json
+
+  $ constructorio-connect-cli execute --template-path=grouping/grouping.jsonata --connection-id=example-connection-id
+
+  $ constructorio-connect-cli execute --template-path=mapping/mapping.jsonata
+```
+
+_See code: [src/commands/execute.ts](https://github.com/Constructor-io/constructorio-connect-cli/blob/v1.0.0/src/commands/execute.ts)_
+
+## `constructorio-connect-cli help [COMMAND]`
+
+Display help for constructorio-connect-cli.
+
+```
+USAGE
+  $ constructorio-connect-cli help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for constructorio-connect-cli.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
+
+## `constructorio-connect-cli init NAME`
+
+Bootstrap a new Constructor.io Connect CLI repository.
+
+```
+USAGE
+  $ constructorio-connect-cli init NAME
+
+ARGUMENTS
+  NAME  name of the new folder
+
+DESCRIPTION
+  Bootstrap a new Constructor.io Connect CLI repository.
+
+EXAMPLES
+  $ constructorio-connect-cli init
+
+  $ constructorio-connect-cli init new-repo-name
+```
+
+_See code: [src/commands/init.ts](https://github.com/Constructor-io/constructorio-connect-cli/blob/v1.0.0/src/commands/init.ts)_
+<!-- commandsstop -->
+
+## Development
+
+Here's some useful npm scripts:
+
+```bash
+npm run lint            # run lint on source code and tests
+npm run test            # run tests
+npm run test:cov        # run tests with coverage report
+```
+
+### Running locally
+
+First, install dependencies:
+
+```bash
+npm ci
+```
+
+Then, set up your local environment and fill `.env` with your credentials:
+
+```bash
+cp .env.example .env
+```
+
+All done! You can now run the package locally:
+
+```bash
+npm run dev [command] -- [arguments and flags]
+# or, you can just directly access the built CLI:
+bin/dev.js [command] [arguments and flags]
+```
+
+You can also test inside other projects with:
+
+```bash
+npm i full/path/to/this/repo
+# or even install it globally
+
+npm i -g full/path/to/this/repo
+constructorio-connect-cli --help
+```
+
+Finally, you can switch the host you're sending requests to if you need. For example, you can point to a local host if you have a local instance running.
+
+```
+HOST=http://localhost:3000 constructorio-connect-cli deploy development
+```

package/bin/dev.cmd

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

package/bin/dev.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env -S npx ts-node
+
+void (async () => {
+  const { config } = await import("dotenv");
+  config();
+
+  const oclif = await import("@oclif/core");
+
+  /**
+   * ! Disclaimer
+   *
+   * With the development flag set to true, the CLI will print/output some UX elements differently from the run.js command.
+   * Please use the run.js command for any layout or UX testing.
+   */
+  await oclif.execute({ dir: __dirname, development: true });
+})();

package/bin/run.cmd

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

package/bin/run.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+void (async () => {
+  const oclif = await import("@oclif/core");
+  const { config } = await import("dotenv");
+  const path = await import("path");
+
+  config({ path: path.join(process.cwd(), ".env") });
+  await oclif.execute({ dir: __dirname });
+})();

package/boilerplate-repo/.env.example

@@ -0,0 +1 @@
+CONNECT_AUTH_TOKEN=

package/boilerplate-repo/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+    "root": true,
+    "env": {
+        "es2021": true,
+        "node": true
+      },
+    "extends": [
+      "plugin:prettier/recommended"
+    ],
+    "ignorePatterns": [".eslintrc.js"]
+}

package/boilerplate-repo/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+	"recommendations": [
+		"bigbug.vscode-language-jsonata"
+	]
+}

package/boilerplate-repo/.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "program": "${file}",
+      "name": "Execute template",
+      "preLaunchTask": "Execute template",
+      "skipFiles": ["<node_internals>/**"]
+    }
+  ]
+}

package/boilerplate-repo/.vscode/tasks.json

@@ -0,0 +1,20 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Execute template",
+      "type": "shell",
+      "command": "npm",
+      "args": ["run", "execute", "--", "--template-path=${file}"],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "presentation": {
+        "reveal": "always",
+        "focus": true,
+        "showReuseMessage": true
+      }
+    }
+  ]
+}

package/boilerplate-repo/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Constructor.io
+
+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.