@supernovaio/cli 0.9.0 → 0.9.2

package/README.md

@@ -1,4 +1,4 @@
-<img src="https://github.com/Supernova-Studio/sdk-typescript/blob/main/readme-icon.png?raw=true" alt="Supernova SDK" style="max-width:100%; margin-bottom: 20px;" />
+<img src="https://github.com/Supernova-Studio/cli/blob/main/docs/images/cli.png?raw=true" alt="Supernova CLI" style="max-width:100%; margin-bottom: 20px;" />
 
 # Supernova CLI [![All passing](https://img.shields.io/badge/Test-passing-success)]() [![Version 1.0.0](https://img.shields.io/badge/Version-1.0.0-success)]()
 
@@ -11,7 +11,7 @@ CLI is separated into different commands that you can use to automate certain as
 To install, simply run:
 
 ```bash
-npm install @supernovaio/supernova-sdk
+npm install --save-dev @supernovaio/supernova-sdk
 yarn add --dev @supernovaio/cli
 ```
 
@@ -43,11 +43,23 @@ You can now test that everything was properly set up by running the `supernova`
 
 `Node 12.21.0` or newer environment is required to run the Supernova CLI.
 
+### Updating CLI globally
+
+You can update globally installed CLI by running npm update command on the package:
+
+```
+npm update -g @supernovaio/cli
+yarn global upgrade @supernovaio/cli
+```
+
+This will upgrade the CLI to the latest version and make it immediately last default used version.
+
 ## Use cases
 
 Following is the list of use cases for Supernova CLI. We will be adding more over time, stay tuned!
 
 - [Synchronize Figma Token Plugin data](./docs/figma-tokens-sync.md)
+- [List workspaces, design systems, brands and themes](./docs/list-workspaces.md)
 
 ## Contributions
 

package/dist/commands/describe-design-system.d.ts

@@ -0,0 +1,26 @@
+import { Command } from "@oclif/core";
+import { DesignSystem, DesignSystemVersion, Supernova } from "@supernovaio/supernova-sdk";
+interface SyncDesignTokensFlags {
+    apiKey: string;
+    designSystemId: string;
+    dev: boolean;
+}
+/** Command that describes the structure of provided design system */
+export declare class SyncDesignTokens extends Command {
+    static description: string;
+    static examples: string[];
+    static aliases: ["describe-design-system"];
+    static flags: {
+        apiKey: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        designSystemId: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        dev: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: never[];
+    run(): Promise<void>;
+    getWritableVersion(flags: SyncDesignTokensFlags): Promise<{
+        instance: Supernova;
+        designSystem: DesignSystem;
+        version: DesignSystemVersion;
+    }>;
+}
+export {};

package/dist/commands/describe-design-system.js

@@ -0,0 +1,86 @@
+"use strict";
+//
+//  describe-design-system.ts
+//  Supernova CLI
+//
+//  Created by Jiri Trecak.
+//  Copyright © 2022 Supernova.io. 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 describes the structure of provided design system */
+class SyncDesignTokens extends core_1.Command {
+    // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+    // MARK: - Command runtime
+    async run() {
+        const { args, flags } = await this.parse(SyncDesignTokens);
+        // Get workspace -> design system –> version
+        let connected = await this.getWritableVersion(flags);
+        // Get brands and themes
+        let version = connected.version;
+        let brands = await version.brands();
+        let themes = await version.themes();
+        console.log(`---  Design system "${connected.designSystem.name}", id: ${connected.designSystem.id}:`);
+        console.log(`\n`);
+        for (let brand of brands) {
+            console.log(`  ↳  Brand: "${brand.name}", id: ${brand.persistentId}`);
+            let brandThemes = themes.filter(t => t.brandId === brand.persistentId);
+            if (brandThemes.length > 0) {
+                for (let theme of brandThemes) {
+                    console.log(`    ↳  Theme: "${theme.name}", id: ${theme.id}`);
+                }
+            }
+            else {
+                console.log(`    ↳  No themes defined in this brand`);
+            }
+            console.log("\n");
+        }
+    }
+    async getWritableVersion(flags) {
+        if (!flags.apiKey || flags.apiKey.length === 0) {
+            throw new Error(`API key must not be empty`);
+        }
+        if (!flags.designSystemId || flags.designSystemId.length === 0) {
+            throw new Error(`Design System ID must not be empty`);
+        }
+        // Create instance for prod / dev
+        const devAPIhost = "https://dev.api2.supernova.io/api";
+        let sdkInstance = new supernova_sdk_1.Supernova(flags.apiKey, flags.dev ? devAPIhost : null, null);
+        let designSystem = await sdkInstance.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`);
+        }
+        return {
+            instance: sdkInstance,
+            designSystem: designSystem,
+            version: version,
+        };
+    }
+}
+exports.SyncDesignTokens = SyncDesignTokens;
+// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+// MARK: - Command configuration
+// Command help description
+SyncDesignTokens.description = "Describe structure of single design system by provided ID";
+// Examples how to use the command
+SyncDesignTokens.examples = [`$ @supernovaio/cli describe-design-system --apiKey="{xxx-xxx-xxx}" --designSystemId="{1234}"`];
+// Static flags to enable / disable features
+SyncDesignTokens.flags = {
+    apiKey: core_1.Flags.string({ description: "API key to use for accessing Supernova instance", required: true }),
+    designSystemId: core_1.Flags.string({ description: "Design System to describe structure of", required: true }),
+    dev: core_1.Flags.boolean({ description: "When enabled, CLI will target dev server", hidden: true, default: false }),
+};
+// Required and optional attributes
+SyncDesignTokens.args = [];

package/dist/commands/describe-workspaces.d.ts

@@ -0,0 +1,23 @@
+import { Command } from "@oclif/core";
+import { Supernova, Workspace } from "@supernovaio/supernova-sdk";
+interface SyncDesignTokensFlags {
+    apiKey: string;
+    dev: boolean;
+}
+/** Command that describes the structure of provided design system */
+export declare class SyncDesignTokens extends Command {
+    static description: string;
+    static examples: string[];
+    static aliases: ["describe-workspaces"];
+    static flags: {
+        apiKey: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        dev: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: never[];
+    run(): Promise<void>;
+    getWorkspaces(flags: SyncDesignTokensFlags): Promise<{
+        instance: Supernova;
+        workspaces: Array<Workspace>;
+    }>;
+}
+export {};

package/dist/commands/describe-workspaces.js

@@ -0,0 +1,80 @@
+"use strict";
+//
+//  describe-workspaces.ts
+//  Supernova CLI
+//
+//  Created by Jiri Trecak.
+//  Copyright © 2022 Supernova.io. 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 describes the structure of provided design system */
+class SyncDesignTokens extends core_1.Command {
+    // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+    // MARK: - Command runtime
+    async run() {
+        const { args, flags } = await this.parse(SyncDesignTokens);
+        // Get workspaces
+        let connected = await this.getWorkspaces(flags);
+        for (let workspace of connected.workspaces) {
+            // Get design systems and log
+            let designSystems = await workspace.designSystems();
+            console.log(`\n`);
+            console.log(`---  Workspace "${workspace.name}", handle: "${workspace.handle}":`);
+            for (let designSystem of designSystems) {
+                console.log(`\n`);
+                console.log(`  ↳  DS "${designSystem.name}", id: ${designSystem.id}:`);
+                let version = await designSystem.activeVersion();
+                let brands = await version.brands();
+                let themes = await version.themes();
+                for (let brand of brands) {
+                    console.log(`    ↳  Brand: "${brand.name}", id: ${brand.persistentId}`);
+                    let brandThemes = themes.filter((t) => t.brandId === brand.persistentId);
+                    if (brandThemes.length > 0) {
+                        for (let theme of brandThemes) {
+                            console.log(`      ↳ Theme: "${theme.name}", id: ${theme.id}`);
+                        }
+                    }
+                    else {
+                        console.log(`      ↳ No themes defined in this brand`);
+                    }
+                }
+            }
+        }
+    }
+    async getWorkspaces(flags) {
+        if (!flags.apiKey || flags.apiKey.length === 0) {
+            throw new Error(`API key must not be empty`);
+        }
+        // Create instance for prod / dev
+        const devAPIhost = "https://dev.api2.supernova.io/api";
+        let sdkInstance = new supernova_sdk_1.Supernova(flags.apiKey, flags.dev ? devAPIhost : null, null);
+        let workspaces = await sdkInstance.workspaces();
+        return {
+            instance: sdkInstance,
+            workspaces: workspaces,
+        };
+    }
+}
+exports.SyncDesignTokens = SyncDesignTokens;
+// --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
+// MARK: - Command configuration
+// Command help description
+SyncDesignTokens.description = "Describe structure of all workspaces and design systems available under those workspaces available for specified API key";
+// Examples how to use the command
+SyncDesignTokens.examples = [`$ @supernovaio/cli describe-workspaces --apiKey="{xxx-xxx-xxx}"`];
+// Static flags to enable / disable features
+SyncDesignTokens.flags = {
+    apiKey: core_1.Flags.string({ description: "API key to use for accessing Supernova instance", required: true }),
+    dev: core_1.Flags.boolean({ description: "When enabled, CLI will target dev server", hidden: true, default: false }),
+};
+// Required and optional attributes
+SyncDesignTokens.args = [];

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

@@ -12,9 +12,7 @@ interface SyncDesignTokensFlags {
 export declare class SyncDesignTokens extends Command {
     static description: string;
     static examples: string[];
-    static aliases: [
-        "sync-tokens"
-    ];
+    static aliases: ["sync-tokens"];
     static flags: {
         apiKey: import("@oclif/core/lib/interfaces").OptionFlag<string>;
         designSystemId: import("@oclif/core/lib/interfaces").OptionFlag<string>;

package/dist/commands/sync-tokens.js

@@ -54,7 +54,7 @@ class SyncDesignTokens extends core_1.Command {
         return {
             instance: sdkInstance,
             designSystem: designSystem,
-            version: version
+            version: version,
         };
     }
 }
@@ -70,12 +70,18 @@ SyncDesignTokens.examples = [
 ];
 // Static flags to enable / disable features
 SyncDesignTokens.flags = {
-    apiKey: core_1.Flags.string({ description: 'API key to use for accessing Supernova instance', required: true }),
-    designSystemId: core_1.Flags.string({ description: 'Design System to synchronize contents with', required: true }),
-    tokenFilePath: core_1.Flags.string({ description: 'Path to JSON file containing token definitions', exactlyOne: ["tokenDirPath", "tokenFilePath"] }),
-    tokenDirPath: core_1.Flags.string({ description: 'Path to directory of JSON files containing token definitions', exactlyOne: ["tokenDirPath", "tokenFilePath"] }),
-    configFilePath: core_1.Flags.string({ description: 'Path to configuration JSON file', required: true, exclusive: [] }),
-    dev: core_1.Flags.boolean({ description: 'When enabled, CLI will target dev server', hidden: true, default: false })
+    apiKey: core_1.Flags.string({ description: "API key to use for accessing Supernova instance", required: true }),
+    designSystemId: core_1.Flags.string({ description: "Design System to synchronize contents with", required: true }),
+    tokenFilePath: core_1.Flags.string({
+        description: "Path to JSON file containing token definitions",
+        exactlyOne: ["tokenDirPath", "tokenFilePath"],
+    }),
+    tokenDirPath: core_1.Flags.string({
+        description: "Path to directory of JSON files containing token definitions",
+        exactlyOne: ["tokenDirPath", "tokenFilePath"],
+    }),
+    configFilePath: core_1.Flags.string({ description: "Path to configuration JSON file", required: true, exclusive: [] }),
+    dev: core_1.Flags.boolean({ description: "When enabled, CLI will target dev server", hidden: true, default: false }),
 };
 // Required and optional attributes
 SyncDesignTokens.args = [];

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.9.0","commands":{"sync-tokens":{"id":"sync-tokens","description":"Synchronize tokens from Figma Tokens plugin to Supernova workspaces","strict":true,"pluginName":"@supernovaio/cli","pluginAlias":"@supernovaio/cli","pluginType":"core","aliases":[],"examples":["$ @supernovaio/cli sync-tokens --apiKey=\"{xxx-xxx-xxx}\" --designSystemId={1234} --tokenFilePath \"/path/to/tokens.json\" --configFilePath \"/path/to/config.json\"","$ @supernovaio/cli sync-tokens --apiKey=\"{xxx-xxx-xxx}\" --designSystemId={1234} --tokenDirPath \"/path/to/tokens/\" --configFilePath \"/path/to/config.json\""],"flags":{"apiKey":{"name":"apiKey","type":"option","description":"API key to use for accessing Supernova instance","required":true,"multiple":false},"designSystemId":{"name":"designSystemId","type":"option","description":"Design System to synchronize contents with","required":true,"multiple":false},"tokenFilePath":{"name":"tokenFilePath","type":"option","description":"Path to JSON file containing token definitions","multiple":false},"tokenDirPath":{"name":"tokenDirPath","type":"option","description":"Path to directory of JSON files containing token definitions","multiple":false},"configFilePath":{"name":"configFilePath","type":"option","description":"Path to configuration JSON file","required":true,"multiple":false,"exclusive":[]},"dev":{"name":"dev","type":"boolean","description":"When enabled, CLI will target dev server","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}}}}
+{"version":"0.9.2","commands":{"describe-design-system":{"id":"describe-design-system","description":"Describe structure of single design system by provided ID","strict":true,"pluginName":"@supernovaio/cli","pluginAlias":"@supernovaio/cli","pluginType":"core","aliases":[],"examples":["$ @supernovaio/cli describe-design-system --apiKey=\"{xxx-xxx-xxx}\" --designSystemId=\"{1234}\""],"flags":{"apiKey":{"name":"apiKey","type":"option","description":"API key to use for accessing Supernova instance","required":true,"multiple":false},"designSystemId":{"name":"designSystemId","type":"option","description":"Design System to describe structure of","required":true,"multiple":false},"dev":{"name":"dev","type":"boolean","description":"When enabled, CLI will target dev server","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}},"describe-workspaces":{"id":"describe-workspaces","description":"Describe structure of all workspaces and design systems available under those workspaces available for specified API key","strict":true,"pluginName":"@supernovaio/cli","pluginAlias":"@supernovaio/cli","pluginType":"core","aliases":[],"examples":["$ @supernovaio/cli describe-workspaces --apiKey=\"{xxx-xxx-xxx}\""],"flags":{"apiKey":{"name":"apiKey","type":"option","description":"API key to use for accessing Supernova instance","required":true,"multiple":false},"dev":{"name":"dev","type":"boolean","description":"When enabled, CLI will target dev server","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}},"sync-tokens":{"id":"sync-tokens","description":"Synchronize tokens from Figma Tokens plugin to Supernova workspaces","strict":true,"pluginName":"@supernovaio/cli","pluginAlias":"@supernovaio/cli","pluginType":"core","aliases":[],"examples":["$ @supernovaio/cli sync-tokens --apiKey=\"{xxx-xxx-xxx}\" --designSystemId={1234} --tokenFilePath \"/path/to/tokens.json\" --configFilePath \"/path/to/config.json\"","$ @supernovaio/cli sync-tokens --apiKey=\"{xxx-xxx-xxx}\" --designSystemId={1234} --tokenDirPath \"/path/to/tokens/\" --configFilePath \"/path/to/config.json\""],"flags":{"apiKey":{"name":"apiKey","type":"option","description":"API key to use for accessing Supernova instance","required":true,"multiple":false},"designSystemId":{"name":"designSystemId","type":"option","description":"Design System to synchronize contents with","required":true,"multiple":false},"tokenFilePath":{"name":"tokenFilePath","type":"option","description":"Path to JSON file containing token definitions","multiple":false},"tokenDirPath":{"name":"tokenDirPath","type":"option","description":"Path to directory of JSON files containing token definitions","multiple":false},"configFilePath":{"name":"configFilePath","type":"option","description":"Path to configuration JSON file","required":true,"multiple":false,"exclusive":[]},"dev":{"name":"dev","type":"boolean","description":"When enabled, CLI will target dev server","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}}}}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@supernovaio/cli",
     "description": "Supernova.io Command Line Interface",
-    "version": "0.9.0",
+    "version": "0.9.2",
     "author": "Supernova.io",
     "homepage": "https://supernova.io/",
     "keywords": [
@@ -25,7 +25,7 @@
         "@oclif/core": "^1",
         "@oclif/plugin-help": "^5",
         "@oclif/plugin-plugins": "^2.0.1",
-        "@supernovaio/supernova-sdk": "^1.8.10",
+        "@supernovaio/supernova-sdk": "^1.8.13",
         "chalk": "^5.0.1",
         "node-fetch": "^3.2.4",
         "dotenv": "^16.0.0"
@@ -73,6 +73,12 @@
         "topics": {
             "sync-tokens": {
                 "description": "Synchronize tokens from Figma Tokens plugin to Supernova workspaces"
+            },
+            "describe-design-system": {
+                "description": "Describe structure (brands and themes) of selected design system"
+            },
+            "describe-workspaces": {
+                "description": "Describe structure of all workspaces provided API key has access to"
             }
         }
     },