@supernovaio/cli 1.0.10 → 1.1.1

package/dist/commands/publish-documentation.js

@@ -14,6 +14,7 @@ const core_1 = require("@oclif/core");
 const types_1 = require("../types/types");
 const sdk_1 = require("../utils/sdk");
 require("colors");
+const sdk_2 = require("@supernovaio/sdk");
 // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
 // MARK: - Definition
 // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
@@ -27,10 +28,17 @@ class PublishDocumentation extends core_1.Command {
     async run() {
         try {
             const { flags } = await this.parse(PublishDocumentation);
+            const environment = tryParseDocsEnvironment(flags.target);
+            if (!environment) {
+                const supportedEnvs = [sdk_2.DocumentationEnvironment.live, sdk_2.DocumentationEnvironment.preview];
+                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 documentation = await instance.documentation.getDocumentation(id);
-            let result = await instance.documentation.publish(id, flags.target);
+            let result = await instance.documentation.publishDrafts(id, environment, {
+                pagePersistentIds: [],
+                groupPersistentIds: [],
+            });
             if (result.status === "Success") {
                 this.log("\nDone: Documentation queued for publishing".green);
             }
@@ -61,7 +69,11 @@ PublishDocumentation.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 publish the documentation", required: true }),
     dev: core_1.Flags.boolean({ description: "When enabled, CLI will target dev server", hidden: true, default: false }),
-    target: core_1.Flags.string({ description: "Environment to use for publishing: Live or Preview", required: false, default: "Live" }),
+    target: core_1.Flags.string({
+        description: "Environment to use for publishing: Live or Preview",
+        required: false,
+        default: "Live",
+    }),
     environment: core_1.Flags.string({
         description: "When set, CLI will target a specific environment",
         hidden: true,
@@ -75,3 +87,13 @@ PublishDocumentation.flags = {
         required: false,
     }),
 };
+function tryParseDocsEnvironment(targetArg) {
+    switch (targetArg.toLowerCase()) {
+        case "live":
+            return sdk_2.DocumentationEnvironment.live;
+        case "preview":
+            return sdk_2.DocumentationEnvironment.preview;
+        default:
+            return null;
+    }
+}

package/dist/utils/figma-tokens-data-loader.js

@@ -4,7 +4,7 @@ exports.FigmaTokensDataLoader = void 0;
 const tslib_1 = require("tslib");
 const sdk_1 = require("@supernovaio/sdk");
 const fs = tslib_1.__importStar(require("fs"));
-const path = require('path');
+const path = require("path");
 class FigmaTokensDataLoader {
     /** Load token definitions from path */
     async loadTokensFromPath(pathToFile) {
@@ -12,12 +12,12 @@ class FigmaTokensDataLoader {
             if (!(fs.existsSync(pathToFile) && fs.lstatSync(pathToFile).isFile())) {
                 throw Error(`Provided token file directory ${pathToFile} is not a file or doesn't exist`);
             }
-            let definition = fs.readFileSync(pathToFile, 'utf8');
+            let definition = fs.readFileSync(pathToFile, "utf8");
             let parsedDefinition = this.parseDefinition(definition);
             return parsedDefinition;
         }
         catch (error) {
-            throw new Error('Unable to load JSON definition file: ' + error);
+            throw new Error("Unable to load JSON definition file: " + error);
         }
     }
     async loadTokensFromDirectory(pathToDirectory, settingsPath) {
@@ -28,9 +28,9 @@ class FigmaTokensDataLoader {
             }
             let jsonPaths = this.getAllJSONFiles(pathToDirectory);
             for (let path of jsonPaths) {
-                if (path.endsWith('json') && path !== settingsPath && !path.includes('$')) {
+                if (path.endsWith("json") && path !== settingsPath && !path.includes("$")) {
                     let result = await this.loadObjectFile(path);
-                    if (typeof result === 'object') {
+                    if (typeof result === "object") {
                         // let name = this.getFileNameWithoutExtension(path)
                         let name = this.getSetKey(path, pathToDirectory);
                         fullStructuredObject[name] = result;
@@ -38,21 +38,21 @@ class FigmaTokensDataLoader {
                 }
             }
             // Try to load themes, if any
-            let themePath = pathToDirectory + '/' + '$themes.json';
+            let themePath = pathToDirectory + "/" + "$themes.json";
             if (fs.existsSync(themePath)) {
                 let themes = await this.loadObjectFile(themePath);
-                fullStructuredObject['$themes'] = themes;
+                fullStructuredObject["$themes"] = themes;
             }
             // Try to load metadata, if any
-            let metadataPath = pathToDirectory + '/' + '$metadata.json';
+            let metadataPath = pathToDirectory + "/" + "$metadata.json";
             if (fs.existsSync(metadataPath)) {
                 let metadata = await this.loadObjectFile(metadataPath);
-                fullStructuredObject['$metadata'] = metadata;
+                fullStructuredObject["$metadata"] = metadata;
             }
             return fullStructuredObject;
         }
         catch (error) {
-            throw new Error('Unable to load JSON definition file: ' + error);
+            throw new Error("Unable to load JSON definition file: " + error);
         }
     }
     getAllJSONFiles(dir) {
@@ -64,7 +64,7 @@ class FigmaTokensDataLoader {
             if (fileStat.isDirectory()) {
                 jsonFiles.push(...this.getAllJSONFiles(filePath));
             }
-            else if (fileStat.isFile() && filePath.endsWith('.json')) {
+            else if (fileStat.isFile() && filePath.endsWith(".json")) {
                 jsonFiles.push(filePath);
             }
         }
@@ -87,7 +87,7 @@ class FigmaTokensDataLoader {
             return this.processFileToMapping(parsedDefinition);
         }
         catch (error) {
-            throw new Error('Unable to load JSON definition file: ' + error);
+            throw new Error("Unable to load JSON definition file: " + error);
         }
     }
     loadConfigFromPathAsIs(pathToFile) {
@@ -95,66 +95,67 @@ class FigmaTokensDataLoader {
             if (!(fs.existsSync(pathToFile) && fs.lstatSync(pathToFile).isFile())) {
                 throw new Error(`Provided configuration file directory ${pathToFile} is not a file or doesn't exist`);
             }
-            let definition = fs.readFileSync(pathToFile, 'utf8');
+            let definition = fs.readFileSync(pathToFile, "utf8");
             let parsedDefinition = this.parseDefinition(definition);
             return parsedDefinition;
         }
         catch (error) {
-            throw new Error('Unable to load JSON definition file: ' + error);
+            throw new Error("Unable to load JSON definition file: " + error);
         }
     }
     weakValidateMapping(mapping) {
-        if (!mapping.hasOwnProperty('mode') ||
-            typeof mapping.mode !== 'string' ||
-            (mapping.mode !== 'multi-file' && mapping.mode !== 'single-file')) {
-            throw new Error('Unable to load mapping file: `mode` must be provided [single-file or multi-file]`');
+        if (!mapping.hasOwnProperty("mode") ||
+            typeof mapping.mode !== "string" ||
+            (mapping.mode !== "multi-file" && mapping.mode !== "single-file")) {
+            throw new Error("Unable to load mapping file: `mode` must be provided [single-file or multi-file]`");
         }
         if (!mapping.mapping || !(mapping.mapping instanceof Array)) {
-            throw new Error('Unable to load mapping file: `mapping` key must be present and array.');
+            throw new Error("Unable to load mapping file: `mapping` key must be present and array.");
         }
         let mapPack = mapping.mapping;
         for (let map of mapPack) {
-            if (typeof map !== 'object') {
-                throw new Error('Unable to load mapping file: `mapping` must contain objects only');
+            if (typeof map !== "object") {
+                throw new Error("Unable to load mapping file: `mapping` must contain objects only");
             }
             if (!map.tokenSets && !map.tokensTheme) {
-                throw new Error('Unable to load mapping file: `mapping` must contain either `tokensTheme` or `tokenSets`');
+                throw new Error("Unable to load mapping file: `mapping` must contain either `tokensTheme` or `tokenSets`");
             }
             if (map.tokenSets && map.tokensTheme) {
-                throw new Error('Unable to load mapping file: `mapping` must not contain both `tokensTheme` or `tokenSets`');
+                throw new Error("Unable to load mapping file: `mapping` must not contain both `tokensTheme` or `tokenSets`");
             }
             if (map.tokenSets && (!(map.tokenSets instanceof Array) || map.tokenSets.length === 0)) {
-                throw new Error('Unable to load mapping file: `mapping`.`tokenSets` must be an Array with at least one entry');
+                throw new Error("Unable to load mapping file: `mapping`.`tokenSets` must be an Array with at least one entry");
             }
-            if (map.tokensTheme && ((typeof map.tokensTheme !== 'string' && !Array.isArray(map.tokensTheme)) || map.tokensTheme.length === 0)) {
-                throw new Error('Unable to load mapping file: `mapping`.`tokensTheme` must be a non-empty string or non-empty array of strings');
+            if (map.tokensTheme &&
+                ((typeof map.tokensTheme !== "string" && !Array.isArray(map.tokensTheme)) || map.tokensTheme.length === 0)) {
+                throw new Error("Unable to load mapping file: `mapping`.`tokensTheme` must be a non-empty string or non-empty array of strings");
             }
-            if (!map.supernovaBrand || typeof map.supernovaBrand !== 'string' || map.supernovaBrand.length === 0) {
-                throw new Error('Unable to load mapping file: `supernovaBrand` must be a non-empty string');
+            if (!map.supernovaBrand || typeof map.supernovaBrand !== "string" || map.supernovaBrand.length === 0) {
+                throw new Error("Unable to load mapping file: `supernovaBrand` must be a non-empty string");
             }
-            if (map.supernovaTheme && (typeof map.supernovaTheme !== 'string' || map.supernovaTheme.length === 0)) {
-                throw new Error('Unable to load mapping file: `supernovaTheme` may be empty but must be non-empty string if not');
+            if (map.supernovaTheme && (typeof map.supernovaTheme !== "string" || map.supernovaTheme.length === 0)) {
+                throw new Error("Unable to load mapping file: `supernovaTheme` may be empty but must be non-empty string if not");
             }
         }
         if (mapping.settings) {
-            if (typeof mapping.settings !== 'object') {
-                throw new Error('Unable to load mapping file: `settings` must be an object');
+            if (typeof mapping.settings !== "object") {
+                throw new Error("Unable to load mapping file: `settings` must be an object");
             }
-            if (mapping.settings.hasOwnProperty('dryRun') && typeof mapping.settings.dryRun !== 'boolean') {
-                throw new Error('Unable to load mapping file: `dryRun` must be of boolean type');
+            if (mapping.settings.hasOwnProperty("dryRun") && typeof mapping.settings.dryRun !== "boolean") {
+                throw new Error("Unable to load mapping file: `dryRun` must be of boolean type");
             }
-            if (mapping.settings.hasOwnProperty('verbose') && typeof mapping.settings.verbose !== 'boolean') {
-                throw new Error('Unable to load mapping file: `verbose` must be of boolean type');
+            if (mapping.settings.hasOwnProperty("verbose") && typeof mapping.settings.verbose !== "boolean") {
+                throw new Error("Unable to load mapping file: `verbose` must be of boolean type");
             }
-            if (mapping.settings.hasOwnProperty('preciseCopy')
-                && typeof mapping.settings.preciseCopy !== 'boolean'
-                && typeof mapping.settings.preciseCopy !== "string") {
-                throw new Error('Unable to load mapping file: `preciseCopy` must be of boolean or string type');
+            if (mapping.settings.hasOwnProperty("preciseCopy") &&
+                typeof mapping.settings.preciseCopy !== "boolean" &&
+                typeof mapping.settings.preciseCopy !== "string") {
+                throw new Error("Unable to load mapping file: `preciseCopy` must be of boolean or string type");
             }
         }
     }
     processFileToMapping(mapping) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         let result = new Array();
         for (let map of mapping.mapping) {
             result.push({
@@ -165,18 +166,19 @@ class FigmaTokensDataLoader {
                 bindToTheme: (_c = map.supernovaTheme) !== null && _c !== void 0 ? _c : null,
                 nodes: null,
                 processedNodes: null,
-                processedGroups: null
+                processedGroups: null,
             });
         }
         let settings = {
             ...((_d = mapping.settings) !== null && _d !== void 0 ? _d : {}),
             dryRun: (_f = (_e = mapping.settings) === null || _e === void 0 ? void 0 : _e.dryRun) !== null && _f !== void 0 ? _f : false,
             verbose: (_h = (_g = mapping.settings) === null || _g === void 0 ? void 0 : _g.verbose) !== null && _h !== void 0 ? _h : false,
-            preciseCopy: (_k = (_j = mapping.settings) === null || _j === void 0 ? void 0 : _j.preciseCopy) !== null && _k !== void 0 ? _k : false
+            preciseCopy: (0, sdk_1.toPreciseCopyStrategy)((_j = mapping.settings) === null || _j === void 0 ? void 0 : _j.preciseCopy),
+            themeOverridesStrategy: (_l = (_k = mapping.settings) === null || _k === void 0 ? void 0 : _k.themeOverridesStrategy) !== null && _l !== void 0 ? _l : "default",
         };
         return {
             mapping: result,
-            settings: settings
+            settings: settings,
         };
     }
     // --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- --- ---
@@ -184,13 +186,13 @@ class FigmaTokensDataLoader {
     parseDefinition(definition) {
         try {
             let object = JSON.parse(definition);
-            if (typeof object !== 'object') {
-                throw new Error('Invalid Supernova mapping definition JSON file - root level entity must be object');
+            if (typeof object !== "object") {
+                throw new Error("Invalid Supernova mapping definition JSON file - root level entity must be object");
             }
             return object;
         }
         catch (error) {
-            throw new Error('Invalid Supernova mapping definition JSON file - file structure invalid');
+            throw new Error("Invalid Supernova mapping definition JSON file - file structure invalid");
         }
     }
     async loadObjectFile(pathToFile) {
@@ -198,12 +200,12 @@ class FigmaTokensDataLoader {
             if (!(fs.existsSync(pathToFile) && fs.lstatSync(pathToFile).isFile())) {
                 throw new Error(`Provided token file directory ${pathToFile} is not a file or doesn't exist`);
             }
-            let definition = fs.readFileSync(pathToFile, 'utf8');
+            let definition = fs.readFileSync(pathToFile, "utf8");
             let parsedDefinition = this.parseDefinition(definition);
             return parsedDefinition;
         }
         catch (error) {
-            throw new Error('Unable to load JSON definition file: ' + error);
+            throw new Error("Unable to load JSON definition file: " + error);
         }
     }
 }