@supernovaio/cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Salesforce
+
+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,319 @@
+oclif-hello-world
+=================
+
+oclif example Hello World CLI
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
+[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
+[![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
+[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @supernovaio/cli
+$ supernova COMMAND
+running command...
+$ supernova (--version)
+@supernovaio/cli/0.1.0 darwin-x64 node-v12.21.0
+$ supernova --help [COMMAND]
+USAGE
+  $ supernova COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`supernova help [COMMAND]`](#supernova-help-command)
+* [`supernova plugins`](#supernova-plugins)
+* [`supernova plugins:install PLUGIN...`](#supernova-pluginsinstall-plugin)
+* [`supernova plugins:inspect PLUGIN...`](#supernova-pluginsinspect-plugin)
+* [`supernova plugins:install PLUGIN...`](#supernova-pluginsinstall-plugin-1)
+* [`supernova plugins:link PLUGIN`](#supernova-pluginslink-plugin)
+* [`supernova plugins:uninstall PLUGIN...`](#supernova-pluginsuninstall-plugin)
+* [`supernova plugins:uninstall PLUGIN...`](#supernova-pluginsuninstall-plugin-1)
+* [`supernova plugins:uninstall PLUGIN...`](#supernova-pluginsuninstall-plugin-2)
+* [`supernova plugins update`](#supernova-plugins-update)
+* [`supernova sync-design-tokens`](#supernova-sync-design-tokens)
+
+## `supernova help [COMMAND]`
+
+Display help for supernova.
+
+```
+USAGE
+  $ supernova 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 supernova.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
+
+## `supernova plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ supernova plugins [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ supernova plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
+
+## `supernova plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ supernova plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+ALIASES
+  $ supernova plugins add
+
+EXAMPLES
+  $ supernova plugins:install myplugin 
+
+  $ supernova plugins:install https://github.com/someuser/someplugin
+
+  $ supernova plugins:install someuser/someplugin
+```
+
+## `supernova plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ supernova plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ supernova plugins:inspect myplugin
+```
+
+## `supernova plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ supernova plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+ALIASES
+  $ supernova plugins add
+
+EXAMPLES
+  $ supernova plugins:install myplugin 
+
+  $ supernova plugins:install https://github.com/someuser/someplugin
+
+  $ supernova plugins:install someuser/someplugin
+```
+
+## `supernova plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ supernova plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+EXAMPLES
+  $ supernova plugins:link myplugin
+```
+
+## `supernova plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ supernova plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ supernova plugins unlink
+  $ supernova plugins remove
+```
+
+## `supernova plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ supernova plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ supernova plugins unlink
+  $ supernova plugins remove
+```
+
+## `supernova plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ supernova plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ supernova plugins unlink
+  $ supernova plugins remove
+```
+
+## `supernova plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ supernova plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+## `supernova sync-design-tokens`
+
+Supernova CLI description TODO
+
+```
+USAGE
+  $ supernova sync-design-tokens -k <value> -d <value> [-b <value>] [-i <value> | -p <value>] [-r]
+
+FLAGS
+  -b, --brandName=<value>       Brand to synchronize contents with
+  -d, --designSystemId=<value>  (required) Design System to synchronize contents with
+  -i, --input=<value>           Contents of design tokens plugin definition JSON file
+  -k, --apiKey=<value>          (required) API key to use for accessing Supernova instance
+  -p, --inputPath=<value>       Contents of design tokens plugin definition JSON file
+  -r, --dryRun                  When enabled, CLI will validate entire setup including loading/parsing/merging of tokens
+                                but will stop before writing them to remote source
+
+DESCRIPTION
+  Supernova CLI description TODO
+
+EXAMPLES
+  $ @supernovaio/cli sync-design-tokens --apiKey="{key}" --workspaceId=123 --designSystemId=456 --brandName="Test" --input "{}"
+```
+
+_See code: [dist/commands/sync-design-tokens.ts](https://github.com/Supernova-Studio/cli/blob/v0.1.0/dist/commands/sync-design-tokens.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

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

package/bin/run

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

package/bin/run.cmd

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

package/dist/commands/sync-design-tokens.d.ts

@@ -0,0 +1,27 @@
+import { Command } from "@oclif/core";
+import { Brand, DesignSystem, DesignSystemVersion, Supernova } from "@supernovaio/supernova-sdk";
+/** Command that handles synchronization with design tokens plugin */
+export declare class SyncDesignTokens extends Command {
+    static description: string;
+    static examples: string[];
+    static aliases: [
+        "sync-design-tokens"
+    ];
+    static flags: {
+        apiKey: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        designSystemId: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        brandName: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        input: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        inputPath: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        dryRun: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        dev: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: never[];
+    run(): Promise<void>;
+    getWritableBrand(flags: any): Promise<{
+        instance: Supernova;
+        designSystem: DesignSystem;
+        version: DesignSystemVersion;
+        brand: Brand;
+    }>;
+}

package/dist/commands/sync-design-tokens.js

@@ -0,0 +1,103 @@
+"use strict";
+//
+//  CommandSyncDesignTokens.ts
+//  Supernova SDK
+//
+//  Created by Jiri Trecak.
+//  Copyright © 2021 Supernova. All rights reserved.
+//
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SyncDesignTokens = void 0;
+// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+// MARK: - Imports
+const core_1 = require("@oclif/core");
+const supernova_sdk_1 = require("@supernovaio/supernova-sdk");
+// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+// MARK: - Configuration
+// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+// MARK: - Tool implementation
+/** Command that handles synchronization with design tokens plugin */
+class SyncDesignTokens extends core_1.Command {
+    // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+    // MARK: - Command runtime
+    async run() {
+        const { args, flags } = await this.parse(SyncDesignTokens);
+        // Get workspace -> design system –> version -> brand
+        let connected = await this.getWritableBrand(flags);
+        let dsTool = new supernova_sdk_1.SupernovaToolsDesignTokensPlugin(connected.instance, connected.version, connected.brand);
+        // Load from either flag or raw input, depending on what was set
+        if (flags.input && flags.inputPath) {
+            throw new Error("Unable to use both input and inputPath arguments at the same time. Choose one of them first and then run command again");
+        }
+        if (!flags.input && !flags.inputPath) {
+            throw new Error("Either input or inputPath arguments must be provided and non-empty. Choose one of them first and then run command again");
+        }
+        let nodes;
+        this.log(JSON.stringify(flags, null, 2));
+        if (flags.input) {
+            nodes = await dsTool.loadTokensFromDefinition(flags.input);
+        }
+        else if (flags.inputPath) {
+            nodes = await dsTool.loadTokensFromPath(flags.inputPath);
+        }
+        else {
+            throw new Error("Internal input error");
+        }
+        // Write tokens
+        let merged = await dsTool.mergeWithRemoteSource(nodes.processedNodes, !flags.dryRun);
+        this.log(`Synchronization done | Written or updated ${merged.tokens.length} tokens, ${merged.groups.length} groups`);
+    }
+    async getWritableBrand(flags) {
+        // Create instance for prod / dev
+        let supernova = new supernova_sdk_1.Supernova(flags.apiKey, flags.dev ? "https://dev.api2.supernova.io/api" : null, null);
+        let designSystem = await supernova.designSystem(flags.designSystemId);
+        if (!designSystem) {
+            throw new Error(`Design system ${flags.designSystemId} not found or not available under provided API key`);
+        }
+        let version = await designSystem.activeVersion();
+        if (!version) {
+            throw new Error(`Design system  ${flags.designSystemId} writable version not found or not available under provided API key`);
+        }
+        let brands = await version.brands();
+        let brand = undefined;
+        if (!brands) {
+            throw new Error(`Unable to retrieve brands for design system ${flags.designSystemId} or not available under provided API key`);
+        }
+        if (flags.brandName) {
+            brand = brands.filter(f => f.name.trim() === flags.brandName.trim())[0];
+        }
+        else {
+            brand = brands[0];
+        }
+        if (!brand) {
+            throw new Error(`No usable brand found in design system ${flags.designSystemId}`);
+        }
+        return {
+            instance: supernova,
+            designSystem: designSystem,
+            version: version,
+            brand: brand
+        };
+    }
+}
+exports.SyncDesignTokens = SyncDesignTokens;
+// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+// MARK: - Command configuration
+// Command help description
+SyncDesignTokens.description = "Supernova CLI description TODO";
+// Examples how to use the command
+SyncDesignTokens.examples = [
+    `$ @supernovaio/cli sync-design-tokens --apiKey="{key}" --workspaceId=123 --designSystemId=456 --brandName="Test" --input "{}"`,
+];
+// Static flags to enable / disable features
+SyncDesignTokens.flags = {
+    apiKey: core_1.Flags.string({ char: 'k', description: 'API key to use for accessing Supernova instance', required: true }),
+    designSystemId: core_1.Flags.string({ char: 'd', description: 'Design System to synchronize contents with', required: true }),
+    brandName: core_1.Flags.string({ char: 'b', description: 'Brand to synchronize contents with', required: false }),
+    input: core_1.Flags.string({ char: 'i', description: 'Contents of design tokens plugin definition JSON file', required: false, exclusive: ['inputPath'] }),
+    inputPath: core_1.Flags.string({ char: 'p', description: 'Contents of design tokens plugin definition JSON file', required: false, exclusive: ['input'] }),
+    dryRun: core_1.Flags.boolean({ char: 'r', description: 'When enabled, CLI will validate entire setup including loading/parsing/merging of tokens but will stop before writing them to remote source', required: false }),
+    dev: core_1.Flags.boolean({ description: 'When enabled, CLI will target dev server', hidden: true })
+};
+// Required and optional attributes
+SyncDesignTokens.args = [];

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"0.1.0","commands":{"sync-design-tokens":{"id":"sync-design-tokens","description":"Supernova CLI description TODO","strict":true,"pluginName":"@supernovaio/cli","pluginAlias":"@supernovaio/cli","pluginType":"core","aliases":[],"examples":["$ @supernovaio/cli sync-design-tokens --apiKey=\"{key}\" --workspaceId=123 --designSystemId=456 --brandName=\"Test\" --input \"{}\""],"flags":{"apiKey":{"name":"apiKey","type":"option","char":"k","description":"API key to use for accessing Supernova instance","required":true,"multiple":false},"designSystemId":{"name":"designSystemId","type":"option","char":"d","description":"Design System to synchronize contents with","required":true,"multiple":false},"brandName":{"name":"brandName","type":"option","char":"b","description":"Brand to synchronize contents with","required":false,"multiple":false},"input":{"name":"input","type":"option","char":"i","description":"Contents of design tokens plugin definition JSON file","required":false,"multiple":false,"exclusive":["inputPath"]},"inputPath":{"name":"inputPath","type":"option","char":"p","description":"Contents of design tokens plugin definition JSON file","required":false,"multiple":false,"exclusive":["input"]},"dryRun":{"name":"dryRun","type":"boolean","char":"r","description":"When enabled, CLI will validate entire setup including loading/parsing/merging of tokens but will stop before writing them to remote source","required":false,"allowNo":false},"dev":{"name":"dev","type":"boolean","description":"When enabled, CLI will target dev server","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}}}}

package/package.json

@@ -0,0 +1,86 @@
+{
+    "name": "@supernovaio/cli",
+    "description": "Supernova.io Command Line Interface",
+    "version": "0.1.0",
+    "author": "Supernova.io",
+    "homepage": "https://supernova.io/",
+    "keywords": [
+        "Supernova",
+        "Design Systems",
+        "Supernovaio",
+        "SDK",
+        "Design Tokens",
+        "Tokens",
+        "Assets",
+        "Components",
+        "Documentation",
+        "CMS"
+    ],
+    "license": "MIT",
+    "bin": {
+        "supernova": "./bin/run"
+    },
+    "bugs": "https://github.com/Supernova-Studio/cli/issues",
+    "dependencies": {
+        "@oclif/core": "^1",
+        "@oclif/plugin-help": "^5",
+        "@oclif/plugin-plugins": "^2.0.1",
+        "@supernovaio/supernova-sdk": "^1.7.6",
+        "chalk": "^5.0.1",
+        "node-fetch": "^3.2.4"
+    },
+    "devDependencies": {
+        "@oclif/test": "^2",
+        "@types/chai": "^4",
+        "@types/mocha": "^9.0.0",
+        "@types/node": "^16.11.36",
+        "chai": "^4",
+        "eslint": "^7.32.0",
+        "eslint-config-oclif": "^4",
+        "eslint-config-oclif-typescript": "^1.0.2",
+        "globby": "^11",
+        "mocha": "^9",
+        "oclif": "^3",
+        "shx": "^0.3.3",
+        "ts-node": "^10.2.1",
+        "tslib": "^2.3.1",
+        "typescript": "^4.4.3"
+    },
+    "engines": {
+        "node": ">=12.0.0"
+    },
+    "files": [
+        "/bin",
+        "/dist",
+        "/npm-shrinkwrap.json",
+        "/oclif.manifest.json"
+    ],
+    "main": "dist/index.js",
+    "oclif": {
+        "bin": "supernova",
+        "dirname": "supernova",
+        "commands": "./dist/commands",
+        "plugins": [
+            "@oclif/plugin-help",
+            "@oclif/plugin-plugins"
+        ],
+        "topicSeparator": " ",
+        "topics": {
+            "sync-design-tokens": {
+                "description": "Synchronize tokens between design tokens plugin and Supernova design system"
+            }
+        }
+    },
+    "repository": "https://github.com/Supernova-Studio/cli",
+    "scripts": {
+        "build": "shx rm -rf dist && tsc -b",
+        "lint": "eslint . --ext .ts --config .eslintrc",
+        "postpack": "shx rm -f oclif.manifest.json",
+        "posttest": "yarn lint",
+        "prepack": "yarn build && oclif manifest && oclif readme",
+        "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+        "version": "oclif readme && git add README.md",
+        "publish-package": "npm run build && npm run prepack && npm publish --access public && npm run postpack"
+    },
+    "types": "dist/index.d.ts"
+}