@superblocksteam/cli 1.6.0 → 1.7.0

package/README.md

@@ -12,7 +12,7 @@ $ npm install -g @superblocksteam/cli
 $ superblocks COMMAND
 running command...
 $ superblocks (--version)
-@superblocksteam/cli/1.6.0 linux-x64 node-v18.20.2
+@superblocksteam/cli/1.7.0 linux-x64 node-v18.20.2
 $ superblocks --help [COMMAND]
 USAGE
   $ superblocks COMMAND

package/assets/custom-components/setup/package.json

@@ -7,7 +7,7 @@
     "lint:fix": "npx eslint . --fix"
   },
   "dependencies": {
-    "@superblocksteam/custom-components": "1.6.0",
+    "@superblocksteam/custom-components": "1.7.0",
     "react": "^18",
     "react-dom": "^18"
   },

package/dist/commands/login.js

@@ -39,7 +39,7 @@ class Login extends core_1.Command {
             this.log((0, colorette_1.green)(`Welcome to the Superblocks 🐨 CLI ${user.user.name}!`));
         }
         catch (error) {
-            if (error.name === util_1.ERROR_FILE_ACCESS) {
+            if (error instanceof util_1.FileAccessError) {
                 this.log((0, colorette_1.red)("Could not save token, ensure the Superblocks CLI has access to create folders in your home directory."));
                 return;
             }

package/dist/commands/pull.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const core_1 = require("@oclif/core");
+const sdk_1 = require("@superblocksteam/sdk");
 const util_1 = require("@superblocksteam/util");
 const listr2_1 = require("listr2");
 const authenticated_command_1 = require("../common/authenticated-command");
@@ -128,14 +129,26 @@ Would you like to also delete these resources from your filesystem?`,
                     var _a, _b;
                     task.title = `Validating git configuration...`;
                     const subtasks = [];
+                    ctx.resourceIdsToSkip = new Set();
                     for (const resourceId of ctx.resourceIdsToPull) {
                         const resource = (_a = ctx.existingSuperblocksRootConfig) === null || _a === void 0 ? void 0 : _a.resources[resourceId];
                         const resourceTitle = `${((_b = resource.resourceType) !== null && _b !== void 0 ? _b : "").toLowerCase()} ${resourceId}`;
                         subtasks.push({
                             title: `Checking ${resourceTitle}...`,
                             task: async () => {
-                                const { branchName } = await this.validateGitSetup(resource === null || resource === void 0 ? void 0 : resource.resourceType, resourceId, util_1.ComponentEvent.PULL, ctx.localBranchName);
-                                ctx.branchToPullFrom.set(resourceId, branchName);
+                                try {
+                                    const { branchName } = await this.validateGitSetup(resource === null || resource === void 0 ? void 0 : resource.resourceType, resourceId, util_1.ComponentEvent.PULL, ctx.localBranchName);
+                                    ctx.branchToPullFrom.set(resourceId, branchName);
+                                }
+                                catch (error) {
+                                    if ((0, version_control_1.isCI)() && error instanceof sdk_1.ValidateGitSetupError) {
+                                        this.log(`WARN: Failed to validate git setup for ${resourceTitle}. Skipping pull.\n\n${error.message}.`);
+                                    }
+                                    else {
+                                        throw error;
+                                    }
+                                    ctx.resourceIdsToSkip.add(resourceId);
+                                }
                             },
                         });
                     }
@@ -149,6 +162,8 @@ Would you like to also delete these resources from your filesystem?`,
                     var _a, _b;
                     task.title = `Pulling resources from branch ${ctx.localBranchName}...`;
                     const viewMode = await (0, version_control_1.getMode)(task, mode);
+                    // Remove resources to skip from list of resources to push
+                    ctx.resourceIdsToPull = ctx.resourceIdsToPull.filter((id) => !ctx.resourceIdsToSkip.has(id));
                     const subtasks = [];
                     for (const resourceId of ctx.resourceIdsToPull) {
                         const resource = (_a = ctx.existingSuperblocksRootConfig) === null || _a === void 0 ? void 0 : _a.resources[resourceId];

package/dist/commands/push.js

@@ -135,6 +135,7 @@ Would you like to also delete these resources from your filesystem?`,
                     var _a, _b;
                     task.title = `Validating git configuration...`;
                     const subtasks = [];
+                    ctx.resourceIdsToSkip = new Set();
                     for (const resourceId of ctx.resourceIdsToPush) {
                         const resource = (_a = ctx.existingSuperblocksRootConfig) === null || _a === void 0 ? void 0 : _a.resources[resourceId];
                         // for user messages:
@@ -142,8 +143,43 @@ Would you like to also delete these resources from your filesystem?`,
                         subtasks.push({
                             title: `Checking ${resourceTitle}...`,
                             task: async () => {
-                                const { branchName } = await this.validateGitSetup(resource === null || resource === void 0 ? void 0 : resource.resourceType, resourceId, util_1.ComponentEvent.PUSH, ctx.localBranchName);
-                                ctx.branchToPushTo.set(resourceId, branchName);
+                                try {
+                                    const { branchName } = await this.validateGitSetup(resource === null || resource === void 0 ? void 0 : resource.resourceType, resourceId, util_1.ComponentEvent.PUSH, ctx.localBranchName);
+                                    ctx.branchToPushTo.set(resourceId, branchName);
+                                }
+                                catch (error) {
+                                    if ((0, version_control_1.isCI)() && error instanceof sdk_1.ValidateGitSetupError) {
+                                        this.log(`WARN: Failed to validate git setup for ${resourceTitle}. Skipping push.\n\n${error.message}.`);
+                                    }
+                                    else {
+                                        throw error;
+                                    }
+                                    ctx.resourceIdsToSkip.add(resourceId);
+                                }
+                            },
+                        });
+                    }
+                    return task.newListr(subtasks, {
+                        concurrent: true,
+                    });
+                },
+            },
+            {
+                task: async (ctx, task) => {
+                    var _a, _b;
+                    task.title = `Validating project structure...`;
+                    const subtasks = [];
+                    const superblocksRootPath = node_path_1.default.resolve(node_path_1.default.dirname(ctx.superblocksRootConfigPath), "..");
+                    for (const resourceId of ctx.resourceIdsToPush) {
+                        const resource = (_a = ctx.existingSuperblocksRootConfig) === null || _a === void 0 ? void 0 : _a.resources[resourceId];
+                        const resourceTitle = `${((_b = resource.resourceType) !== null && _b !== void 0 ? _b : "").toLowerCase()} at ${resource.location}`;
+                        subtasks.push({
+                            title: `Validating ${resourceTitle}...`,
+                            task: async () => {
+                                const validationError = await (0, version_control_1.validateLocalResource)(superblocksRootPath, resource);
+                                if (validationError) {
+                                    this.error(`Push failed for resource '${resource.location}' (id: ${resourceId}). ${validationError}`);
+                                }
                             },
                         });
                     }
@@ -156,6 +192,8 @@ Would you like to also delete these resources from your filesystem?`,
                 task: async (ctx, task) => {
                     var _a;
                     task.title = `Pushing resources to branch ${ctx.localBranchName}...`;
+                    // Remove resources to skip from list of resources to push
+                    ctx.resourceIdsToPush = ctx.resourceIdsToPush.filter((id) => !ctx.resourceIdsToSkip.has(id));
                     const subtasks = [];
                     const superblocksRootPath = node_path_1.default.resolve(node_path_1.default.dirname(ctx.superblocksRootConfigPath), "..");
                     for (const resourceId of ctx.resourceIdsToPush) {
@@ -231,7 +269,7 @@ Would you like to also delete these resources from your filesystem?`,
                                             });
                                         }
                                         catch (error) {
-                                            if ((error === null || error === void 0 ? void 0 : error.name) === "BranchNotCheckedOutError") {
+                                            if (error instanceof sdk_1.BranchNotCheckedOutError) {
                                                 this.log(`WARN: Workflow/Scheduled Job ${(0, version_control_1.extractApiName)(apiConfig)} failed to push, please check branch out in the Superblocks UI first in order to check this branch out for this resource.`);
                                             }
                                             else if (error instanceof sdk_1.CommitAlreadyExistsError) {

package/dist/common/version-control.d.ts

@@ -36,6 +36,8 @@ export declare function getCurrentGitBranchIfGit(): Promise<string | null>;
  */
 export declare function getCurrentGitBranch(): Promise<string>;
 export declare function getHeadCommit(branch: string): Promise<[string, string]>;
+export declare function isCI(): boolean;
 export declare function isGitRepoDirty(): Promise<boolean>;
 export declare function extractApiName(api: ApiWrapper): string;
+export declare function validateLocalResource(superblocksRootPath: string, resource: VersionedResourceConfig): Promise<string | undefined>;
 export declare function deleteResourcesAndUpdateRootConfig(removedResourceIds: string[], existingSuperblocksRootConfig: SuperblocksMonorepoConfig, superblocksRootPath: string, superblocksRootConfigPath: string): Promise<void>;

package/dist/common/version-control.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteResourcesAndUpdateRootConfig = exports.extractApiName = exports.isGitRepoDirty = exports.getHeadCommit = exports.getCurrentGitBranch = exports.getCurrentGitBranchIfGit = exports.getLocalGitRepoState = exports.sortByKey = exports.getMode = exports.removeResourceFromDisk = exports.writeMultiPageApplicationToDisk = exports.writeResourceToDisk = exports.readApiFromDisk = exports.readMultiPageApplicationFromDisk = exports.readApplicationFromDisk = exports.getFileStructureType = exports.atLeastOneSelection = exports.MULTI_SELECT_PROMPT_HELP = exports.SELECT_PROMPT_HELP = exports.modeFlagToViewMode = exports.FileStructureType = exports.modeFlagValuesMap = exports.DEFAULT_BRANCH = exports.DEPLOYED_MODE = exports.MOST_RECENT_COMMIT_MODE = exports.LATEST_EDITS_MODE = void 0;
+exports.deleteResourcesAndUpdateRootConfig = exports.validateLocalResource = exports.extractApiName = exports.isGitRepoDirty = exports.isCI = exports.getHeadCommit = exports.getCurrentGitBranch = exports.getCurrentGitBranchIfGit = exports.getLocalGitRepoState = exports.sortByKey = exports.getMode = exports.removeResourceFromDisk = exports.writeMultiPageApplicationToDisk = exports.writeResourceToDisk = exports.readApiFromDisk = exports.readMultiPageApplicationFromDisk = exports.readApplicationFromDisk = exports.getFileStructureType = exports.atLeastOneSelection = exports.MULTI_SELECT_PROMPT_HELP = exports.SELECT_PROMPT_HELP = exports.modeFlagToViewMode = exports.FileStructureType = exports.modeFlagValuesMap = exports.DEFAULT_BRANCH = exports.DEPLOYED_MODE = exports.MOST_RECENT_COMMIT_MODE = exports.LATEST_EDITS_MODE = void 0;
 const tslib_1 = require("tslib");
 const https = tslib_1.__importStar(require("https"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
@@ -574,8 +574,12 @@ async function getHeadCommit(branch) {
     return [headCommitId, headCommitMessage];
 }
 exports.getHeadCommit = getHeadCommit;
+function isCI() {
+    return process.env.CI === "true";
+}
+exports.isCI = isCI;
 async function isGitRepoDirty() {
-    if (process.env.CI === "true") {
+    if (isCI()) {
         // Skip dirtiness check in CI environments
         return false;
     }
@@ -600,6 +604,123 @@ function writeApi(api, originalApiName, appDirName) {
     };
     return handleApi();
 }
+function validateSinglePageApplication(applicationConfig, superblocksRootPath, location) {
+    // validate app level APIs
+    for (const apiName of Object.values(applicationConfig.apis)) {
+        const apiPath = node_path_1.default.resolve(superblocksRootPath, location, "apis", `${slugifyName(apiName)}.yaml`);
+        const validateApiError = validateYamlFile(apiPath);
+        if (validateApiError) {
+            return validateApiError;
+        }
+    }
+    // validate page
+    const pagePath = node_path_1.default.resolve(superblocksRootPath, location, "page.yaml");
+    const validatePageError = validateYamlFile(pagePath);
+    if (validatePageError) {
+        return validatePageError;
+    }
+}
+async function validateMultiPageApplication(applicationConfig, superblocksRootPath, location) {
+    var _a;
+    // validate app level APIs
+    for (const apiName of Object.values(applicationConfig.apis)) {
+        const apiPath = node_path_1.default.resolve(superblocksRootPath, location, "apis", `${slugifyName(apiName)}.yaml`);
+        const validateApiError = await validateYamlFile(apiPath);
+        if (validateApiError) {
+            return validateApiError;
+        }
+    }
+    // validate pages
+    for (const page of Object.values((_a = applicationConfig.pages) !== null && _a !== void 0 ? _a : {})) {
+        const pagePath = node_path_1.default.resolve(superblocksRootPath, location, "pages", slugifyName(page.name), "page.yaml");
+        const validatePageError = await validateYamlFile(pagePath);
+        if (validatePageError) {
+            return validatePageError;
+        }
+        // validate page level APIs
+        for (const apiName of Object.values(page.apis)) {
+            const apiPath = node_path_1.default.resolve(superblocksRootPath, location, "pages", slugifyName(page.name), "apis", `${slugifyName(apiName)}.yaml`);
+            const validateApiError = await validateYamlFile(apiPath);
+            if (validateApiError) {
+                return validateApiError;
+            }
+        }
+    }
+    return undefined;
+}
+async function validateLocalResource(superblocksRootPath, resource) {
+    switch (resource.resourceType) {
+        case "APPLICATION": {
+            // make sure application config exists
+            const applicationConfigPath = node_path_1.default.resolve(superblocksRootPath, resource.location, util_2.RESOURCE_CONFIG_PATH);
+            if (!(await fs.pathExists(applicationConfigPath))) {
+                return `File ${relativeToCurrentDir(applicationConfigPath)} not found. Superblocks CLI commands cannot function without it.`;
+            }
+            let fileStructureType = undefined;
+            let applicationConfig = undefined;
+            try {
+                // make sure it's a well-formed application config
+                applicationConfig = await fs.readJSON(applicationConfigPath);
+                if (!applicationConfig) {
+                    throw new Error();
+                }
+                fileStructureType =
+                    getFileStructureTypeFromResourceConfig(applicationConfig);
+            }
+            catch {
+                return `File ${relativeToCurrentDir(applicationConfigPath)} is not a valid JSON file. Please be sure it's valid JSON and rerun the command.`;
+            }
+            const applicationYamlPath = node_path_1.default.resolve(superblocksRootPath, resource.location, "application.yaml");
+            // make sure application.yaml is a well-formed yaml file
+            try {
+                await readYamlFile(applicationYamlPath);
+            }
+            catch {
+                return `File ${relativeToCurrentDir(applicationYamlPath)} is not a valid YAML file. Please be sure it's valid YAML and rerun the command.`;
+            }
+            switch (fileStructureType) {
+                case FileStructureType.SINGLE_PAGE: {
+                    validateSinglePageApplication(applicationConfig, superblocksRootPath, resource.location);
+                    break;
+                }
+                case FileStructureType.MULTI_PAGE: {
+                    const validationError = validateMultiPageApplication(applicationConfig, superblocksRootPath, resource.location);
+                    if (validationError) {
+                        return validationError;
+                    }
+                    break;
+                }
+                default: {
+                    return `Invalid file structure type ${fileStructureType}`;
+                }
+            }
+            break;
+        }
+        case "BACKEND": {
+            // make sure the backend config exists
+            const backendConfigPath = node_path_1.default.resolve(superblocksRootPath, resource.location, util_2.RESOURCE_CONFIG_PATH);
+            if (!(await fs.pathExists(backendConfigPath))) {
+                return `File ${relativeToCurrentDir(backendConfigPath)} not found. Superblocks CLI commands cannot function without it.`;
+            }
+            // make sure it's a well-formed backend config
+            try {
+                await fs.readJSON(backendConfigPath);
+            }
+            catch {
+                return `File ${relativeToCurrentDir(backendConfigPath)} is not a valid JSON file. Please be sure it's valid JSON and rerun the command.`;
+            }
+            // make sure that api.yaml exists
+            const apiYamlPath = node_path_1.default.resolve(superblocksRootPath, resource.location, "api.yaml");
+            const validateYamlFileError = await validateYamlFile(apiYamlPath);
+            if (validateYamlFileError) {
+                return validateYamlFileError;
+            }
+            break;
+        }
+    }
+    return undefined;
+}
+exports.validateLocalResource = validateLocalResource;
 async function deleteResourcesAndUpdateRootConfig(removedResourceIds, existingSuperblocksRootConfig, superblocksRootPath, superblocksRootConfigPath) {
     for (const resourceId of removedResourceIds) {
         const resource = existingSuperblocksRootConfig === null || existingSuperblocksRootConfig === void 0 ? void 0 : existingSuperblocksRootConfig.resources[resourceId];
@@ -612,3 +733,15 @@ async function deleteResourcesAndUpdateRootConfig(removedResourceIds, existingSu
     await fs.writeFile(superblocksRootConfigPath, JSON.stringify(sortByKey(existingSuperblocksRootConfig), null, 2));
 }
 exports.deleteResourcesAndUpdateRootConfig = deleteResourcesAndUpdateRootConfig;
+async function validateYamlFile(yamlPath) {
+    // make sure a yaml file is well-formed
+    try {
+        await readYamlFile(yamlPath);
+    }
+    catch {
+        return `File ${relativeToCurrentDir(yamlPath)} is not a valid YAML file. Please be sure it's valid YAML and rerun the command.`;
+    }
+}
+function relativeToCurrentDir(applicationConfigPath) {
+    return `./${node_path_1.default.relative(process.cwd(), applicationConfigPath)}`;
+}

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.0",
+  "version": "1.7.0",
   "commands": {
     "init": {
       "id": "init",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superblocksteam/cli",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Official Superblocks CLI",
   "bin": {
     "superblocks": "bin/run"
@@ -18,11 +18,11 @@
     "@oclif/core": "^2.11.7",
     "@oclif/plugin-help": "^5.2.16",
     "@oclif/plugin-plugins": "^3.1.10",
-    "@superblocksteam/css-plugin": "1.6.0",
-    "@superblocksteam/react-shim": "1.6.0",
-    "@superblocksteam/sdk": "1.6.0",
-    "@superblocksteam/util": "1.6.0",
-    "@superblocksteam/vite-custom-component-reload-plugin": "1.6.0",
+    "@superblocksteam/css-plugin": "1.7.0",
+    "@superblocksteam/react-shim": "1.7.0",
+    "@superblocksteam/sdk": "1.7.0",
+    "@superblocksteam/util": "1.7.0",
+    "@superblocksteam/vite-custom-component-reload-plugin": "1.7.0",
     "@vitejs/plugin-react": "^4.1.0",
     "colorette": "^2.0.19",
     "enquirer": "^2.3.6",