@supernovaio/cli 1.1.1 → 1.1.3

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

@@ -35,7 +35,7 @@ class DescribeDesignSystem extends core_1.Command {
             this.log(`\n↳ Design system "${designSystem.name}", id: ${designSystem.id}`.cyan);
             for (let brand of brands) {
                 this.log(`  ↳ Brand: "${brand.name}", id: ${brand.id}`);
-                let brandThemes = themes.filter((t) => t.brandId === brand.id);
+                let brandThemes = themes.filter(t => t.brandId === brand.id);
                 if (brandThemes.length > 0) {
                     for (let theme of brandThemes) {
                         this.log(`    ↳ Theme: "${theme.name}", id: ${theme.id}`);

package/dist/commands/describe-workspaces.js

@@ -45,7 +45,7 @@ class DescribeWorkspaces extends core_1.Command {
                     let themes = await instance.tokens.getTokenThemes(id);
                     for (let brand of brands) {
                         this.log(`    ↳ Brand: "${brand.name}", id: ${brand.id}`);
-                        let brandThemes = themes.filter((t) => t.brandId === brand.id);
+                        let brandThemes = themes.filter(t => t.brandId === brand.id);
                         if (brandThemes.length > 0) {
                             for (let theme of brandThemes) {
                                 this.log(`      ↳ Theme: "${theme.name}", id: ${theme.id}`.gray);

package/dist/commands/publish-documentation.d.ts

@@ -12,6 +12,7 @@ export declare class PublishDocumentation extends Command {
         target: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         environment: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         proxyUrl: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        awaitPublishJob: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
 }

package/dist/commands/publish-documentation.js

@@ -15,6 +15,7 @@ const types_1 = require("../types/types");
 const sdk_1 = require("../utils/sdk");
 require("colors");
 const sdk_2 = require("@supernovaio/sdk");
+const common_1 = require("../utils/common");
 // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
 // MARK: - Definition
 // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
@@ -26,6 +27,7 @@ class PublishDocumentation extends core_1.Command {
     // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
     // MARK: - Command runtime
     async run() {
+        var _a;
         try {
             const { flags } = await this.parse(PublishDocumentation);
             const environment = tryParseDocsEnvironment(flags.target);
@@ -34,19 +36,35 @@ class PublishDocumentation extends core_1.Command {
                 this.error(`Unknown target ${flags.target}, must be one of [${supportedEnvs.join(", ")}]`);
             }
             // Get workspace -> design system –> version
-            let { instance, id } = await (0, sdk_1.getWritableVersion)(flags);
-            let result = await instance.documentation.publishDrafts(id, environment, {
+            const { instance, id, designSystem } = await (0, sdk_1.getWritableVersion)(flags);
+            let publishJob = await instance.documentation.publishDrafts(id, environment, {
                 pagePersistentIds: [],
                 groupPersistentIds: [],
             });
-            if (result.status === "Success") {
+            if (!((_a = flags.awaitPublishJob) !== null && _a !== void 0 ? _a : true)) {
+                this.log(`Publishing documentation in ${designSystem.name} has started, job await is disabled, exiting...`);
+            }
+            else {
+                this.log(`Publishing documentation in ${designSystem.name}...`);
+            }
+            // Timeout is roughly 30 minutes
+            for (let i = 0; i < 30 * 60; i++) {
+                await (0, common_1.sleep)(1000);
+                publishJob = await instance.documentation.getDocumentationBuild(designSystem.workspaceId, publishJob.id);
+                if (isJobStatusDone(publishJob.status))
+                    break;
+            }
+            if (publishJob.status === "Success") {
                 this.log("\nDone: Documentation queued for publishing".green);
             }
-            else if (result.status === "InProgress") {
-                this.log("\n Done: Skipped documentation publish as another build is already in progress".green);
+            else if (publishJob.status === "Failed") {
+                throw new Error(`Documentation publish failed`);
             }
-            else if (result.status === "Failed") {
-                throw new Error(`Documentation publish failed with unknown failure`);
+            else if (publishJob.status === "Timeout") {
+                throw new Error(`Documentation publish timed out`);
+            }
+            else {
+                throw new Error(`Error awaiting publish job`);
             }
         }
         catch (error) {
@@ -86,6 +104,13 @@ PublishDocumentation.flags = {
         hidden: true,
         required: false,
     }),
+    awaitPublishJob: core_1.Flags.boolean({
+        description: "Whether to block the process until the publishing is done. " +
+            "Setting the flag to false will exit with success as long as documentation publish was successfully triggered, " +
+            "but before the publish is completed. Setting the flag to true will exit once the publish is complete and will " +
+            "throw if documentation publish is not successful.",
+        default: true,
+    }),
 };
 function tryParseDocsEnvironment(targetArg) {
     switch (targetArg.toLowerCase()) {
@@ -97,3 +122,6 @@ function tryParseDocsEnvironment(targetArg) {
             return null;
     }
 }
+function isJobStatusDone(status) {
+    return (status === sdk_2.ExportBuildStatus.Failed || status === sdk_2.ExportBuildStatus.Success || status === sdk_2.ExportBuildStatus.Timeout);
+}

package/dist/commands/run-local-exporter.js

@@ -134,7 +134,7 @@ class RunLocalExporter extends core_1.Command {
         const chunkSize = 4;
         for (let i = 0; i < result.emittedFiles.length; i += chunkSize) {
             const chunk = result.emittedFiles.slice(i, i + chunkSize);
-            await Promise.all(chunk.map((file) => processFile(file)));
+            await Promise.all(chunk.map(file => processFile(file)));
         }
         // Write all files from the temporary structure to the filesystem as a final step - this is to avoid partial writes
         filesToWrite.forEach(({ filePath, content }) => {
@@ -200,7 +200,10 @@ RunLocalExporter.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 export from", required: true }),
     exporterDir: core_1.Flags.string({ description: "Path to exporter package", required: true }),
-    outputDir: core_1.Flags.string({ description: "Path to output folder. Must be empty, unless `forceClearOutputDir` is set", required: true }),
+    outputDir: core_1.Flags.string({
+        description: "Path to output folder. Must be empty, unless `forceClearOutputDir` is set",
+        required: true,
+    }),
     themeId: core_1.Flags.string({
         description: "Theme to export. Will only be used when exporter has usesThemes: true, and is optional",
         required: false,

package/dist/commands/sync-tokens.js

@@ -46,7 +46,7 @@ class SyncDesignTokens extends core_1.Command {
             let tokenDefinition = flags.tokenDirPath
                 ? await dataLoader.loadTokensFromDirectory(flags.tokenDirPath, flags.configFilePath)
                 : await dataLoader.loadTokensFromPath(flags.tokenFilePath);
-            const response = await instance.versions.writeTokenStudioData(id, buildData(tokenDefinition));
+            const response = (await instance.versions.writeTokenStudioData(id, buildData(tokenDefinition)));
             if (((_a = response === null || response === void 0 ? void 0 : response.result) === null || _a === void 0 ? void 0 : _a.logs) && response.result.logs.length > 0) {
                 for (const log of response.result.logs) {
                     this.log(log);
@@ -94,7 +94,10 @@ SyncDesignTokens.flags = {
         exactlyOne: ["tokenDirPath", "tokenFilePath"],
     }),
     configFilePath: core_1.Flags.string({ description: "Path to configuration JSON file", required: true, exclusive: [] }),
-    apiUrl: core_1.Flags.string({ description: "API url to use for accessing Supernova instance, would ignore defaults", hidden: true }),
+    apiUrl: core_1.Flags.string({
+        description: "API url to use for accessing Supernova instance, would ignore defaults",
+        hidden: true,
+    }),
     environment: core_1.Flags.string({
         description: "When set, CLI will target a specific environment",
         hidden: true,

package/dist/index.d.ts

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

package/dist/utils/common.d.ts

@@ -0,0 +1 @@
+export declare function sleep(ms: number): Promise<void>;

package/dist/utils/common.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = void 0;
+async function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+exports.sleep = sleep;

package/dist/utils/sdk.js

@@ -13,7 +13,9 @@ async function getWritableVersion(flags, apiVersion = "v2") {
         throw new Error(`Design System ID must not be empty`);
     }
     // Create instance for prod / dev
-    let apiUrl = flags.apiUrl && flags.apiUrl.length > 0 ? flags.apiUrl : (0, network_1.environmentAPI)(flags.environment, apiVersion);
+    let apiUrl = flags.apiUrl && flags.apiUrl.length > 0
+        ? flags.apiUrl
+        : (0, network_1.environmentAPI)(flags.environment, apiVersion);
     let instance = new sdk_1.Supernova(flags.apiKey, { apiUrl, bypassEnvFetch: true, proxyUrl: flags.proxyUrl });
     let designSystem = await instance.designSystems.designSystem(flags.designSystemId);
     if (!designSystem) {
@@ -26,12 +28,12 @@ async function getWritableVersion(flags, apiVersion = "v2") {
     let id = {
         designSystemId: flags.designSystemId,
         versionId: version.id,
-        workspaceId: designSystem.workspaceId
+        workspaceId: designSystem.workspaceId,
     };
     let brand = null;
     if (flags.brandId) {
         const brands = await instance.brands.getBrands(id);
-        brand = (_a = brands.find((brand) => brand.id === flags.brandId || brand.idInVersion === flags.brandId)) !== null && _a !== void 0 ? _a : null;
+        brand = (_a = brands.find(brand => brand.id === flags.brandId || brand.idInVersion === flags.brandId)) !== null && _a !== void 0 ? _a : null;
         if (!brand) {
             throw new Error(`Brand ${flags.brandId} not found in specified design system`);
         }
@@ -39,7 +41,7 @@ async function getWritableVersion(flags, apiVersion = "v2") {
     let theme = null;
     if (flags.themeId) {
         const themes = await instance.tokens.getTokenThemes(id);
-        theme = (_b = themes.find((theme) => theme.id === flags.themeId || theme.idInVersion === flags.themeId)) !== null && _b !== void 0 ? _b : null;
+        theme = (_b = themes.find(theme => theme.id === flags.themeId || theme.idInVersion === flags.themeId)) !== null && _b !== void 0 ? _b : null;
         if (!theme) {
             throw new Error(`Theme ${flags.themeId} not found in specified brand`);
         }

package/oclif.manifest.json

@@ -186,6 +186,12 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "awaitPublishJob": {
+          "description": "Whether to block the process until the publishing is done. Setting the flag to false will exit with success as long as documentation publish was successfully triggered, but before the publish is completed. Setting the flag to true will exit once the publish is complete and will throw if documentation publish is not successful.",
+          "name": "awaitPublishJob",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -405,5 +411,5 @@
       ]
     }
   },
-  "version": "1.1.1"
+  "version": "1.1.3"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@supernovaio/cli",
   "description": "Supernova.io Command Line Interface",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "author": "Supernova.io",
   "homepage": "https://supernova.io/",
   "keywords": [
@@ -56,6 +56,7 @@
     "globby": "^11",
     "mocha": "^9",
     "oclif": "4.14.15",
+    "prettier": "^3.3.3",
     "shx": "^0.3.3",
     "ts-node": "10.9.1",
     "tslib": "^2.3.1",