@plasmicapp/cli 0.1.169 → 0.1.173

package/dist/__mocks__/api.js

@@ -249,6 +249,7 @@ class PlasmicApi {
                     iconChecksums: [],
                     globalVariantChecksums: [],
                     projectCssChecksum: "",
+                    globalContextsChecksum: "",
                 },
                 usedNpmPackages: [],
                 externalCssImports: [],
@@ -281,7 +282,6 @@ class PlasmicApi {
             return "0.0.1";
         });
     }
-    ;
     requiredPackages() {
         return __awaiter(this, void 0, void 0, function* () {
             return {

package/dist/actions/fix-imports.js

@@ -11,14 +11,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fixImports = void 0;
 const code_utils_1 = require("../utils/code-utils");
-const file_utils_1 = require("../utils/file-utils");
+const config_utils_1 = require("../utils/config-utils");
 const get_context_1 = require("../utils/get-context");
 function fixImports(opts) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!opts.baseDir)
             opts.baseDir = process.cwd();
         const context = yield get_context_1.getContext(opts, { enableSkipAuth: true });
-        yield file_utils_1.fixAllFilePaths(context, opts.baseDir);
+        yield config_utils_1.updateConfig(context, context.config, opts.baseDir);
         yield code_utils_1.fixAllImportStatements(context, opts.baseDir);
     });
 }

package/dist/actions/info.d.ts

@@ -0,0 +1,5 @@
+import { CommonArgs } from "..";
+export interface InfoArgs extends CommonArgs {
+    projects: readonly string[];
+}
+export declare function printProjectInfo(opts: InfoArgs): Promise<void>;

package/dist/actions/info.js

@@ -0,0 +1,28 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printProjectInfo = void 0;
+const deps_1 = require("../deps");
+const get_context_1 = require("../utils/get-context");
+function printProjectInfo(opts) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        let context = yield get_context_1.getContext(opts);
+        const results = yield Promise.all(opts.projects.map((p) => __awaiter(this, void 0, void 0, function* () { return yield context.api.projectMeta(p); })));
+        for (const meta of results) {
+            deps_1.logger.info(`Id: ${meta.id}`);
+            deps_1.logger.info(`Name: ${meta.name}`);
+            deps_1.logger.info(`Host URL: ${(_a = meta.hostUrl) !== null && _a !== void 0 ? _a : null}`);
+            deps_1.logger.info(`Last published version: ${(_b = meta.lastPublishedVersion) !== null && _b !== void 0 ? _b : null}`);
+        }
+    });
+}
+exports.printProjectInfo = printProjectInfo;

package/dist/actions/sync-global-contexts.d.ts

@@ -0,0 +1,4 @@
+import { ChecksumBundle, ProjectMetaBundle } from "../api";
+import { PlasmicContext, ProjectConfig, ProjectLock } from "../utils/config-utils";
+export declare function syncGlobalContexts(context: PlasmicContext, projectMeta: ProjectMetaBundle, projectConfig: ProjectConfig, projectLock: ProjectLock, checksums: ChecksumBundle, baseDir: string): Promise<void>;
+export declare function getGlobalContextsResourcePath(context: PlasmicContext, projectConfig: ProjectConfig): string;

package/dist/actions/sync-global-contexts.js

@@ -0,0 +1,61 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGlobalContextsResourcePath = exports.syncGlobalContexts = void 0;
+const deps_1 = require("../deps");
+const code_utils_1 = require("../utils/code-utils");
+const lodash_1 = __importDefault(require("lodash"));
+const file_utils_1 = require("../utils/file-utils");
+const COMPONENT_NAME = "PlasmicGlobalContextsProvider";
+function syncGlobalContexts(context, projectMeta, projectConfig, projectLock, checksums, baseDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const resourcePath = getGlobalContextsResourcePath(context, projectConfig);
+        if (checksums.globalContextsChecksum && projectMeta.globalContextBundle) {
+            if (context.cliArgs.quiet !== true) {
+                deps_1.logger.info(`Syncing component: ${COMPONENT_NAME}@${projectLock.version}\t['${projectConfig.projectName}' ${projectConfig.projectId} ${projectConfig.version}]`);
+            }
+            if (context.config.code.lang === "js") {
+                projectMeta.globalContextBundle.contextModule = code_utils_1.formatScript(code_utils_1.tsxToJsx(projectMeta.globalContextBundle.contextModule), baseDir);
+            }
+            file_utils_1.writeFileContent(context, resourcePath, projectMeta.globalContextBundle.contextModule, { force: false });
+            projectConfig.globalContextsFilePath = resourcePath;
+            const fl = projectLock.fileLocks.find((fl) => fl.assetId === projectConfig.projectId && fl.type === "globalContexts");
+            if (fl) {
+                fl.checksum = checksums.globalContextsChecksum;
+            }
+            else {
+                projectLock.fileLocks.push({
+                    assetId: projectConfig.projectId,
+                    checksum: checksums.globalContextsChecksum,
+                    type: "globalContexts",
+                });
+            }
+        }
+        else if (!checksums.globalContextsChecksum &&
+            !projectMeta.globalContextBundle) {
+            if (file_utils_1.fileExists(context, resourcePath)) {
+                file_utils_1.deleteFile(context, resourcePath);
+            }
+            projectConfig.globalContextsFilePath = "";
+            lodash_1.default.remove(projectLock.fileLocks, (fl) => fl.assetId === projectConfig.projectId && fl.type === "globalContexts");
+        }
+    });
+}
+exports.syncGlobalContexts = syncGlobalContexts;
+function getGlobalContextsResourcePath(context, projectConfig) {
+    return projectConfig.globalContextsFilePath !== ""
+        ? projectConfig.globalContextsFilePath
+        : file_utils_1.defaultResourcePath(context, projectConfig, `${COMPONENT_NAME}.${context.config.code.lang === "ts" ? "tsx" : "jsx"}`);
+}
+exports.getGlobalContextsResourcePath = getGlobalContextsResourcePath;

package/dist/actions/sync.js

@@ -54,6 +54,7 @@ const sync_global_variants_1 = require("./sync-global-variants");
 const sync_icons_1 = require("./sync-icons");
 const sync_images_1 = require("./sync-images");
 const sync_styles_1 = require("./sync-styles");
+const sync_global_contexts_1 = require("./sync-global-contexts");
 function ensureRequiredPackages(context, baseDir, yes) {
     return __awaiter(this, void 0, void 0, function* () {
         const requireds = yield context.api.requiredPackages();
@@ -258,8 +259,8 @@ function sync(opts, metadataDefaults) {
                 writeLoaderConfig(opts, config);
             }
             const codegenVersion = yield context.api.latestCodegenVersion();
-            context.lock.projects.forEach(p => {
-                if (projectsToSync.some(syncedProject => syncedProject.projectId === p.projectId)) {
+            context.lock.projects.forEach((p) => {
+                if (projectsToSync.some((syncedProject) => syncedProject.projectId === p.projectId)) {
                     p.codegenVersion = codegenVersion;
                 }
             });
@@ -444,6 +445,7 @@ function syncProjectConfig(context, projectBundle, projectApiToken, version, dep
             projectConfig.jsBundleThemes.length === 0) {
             delete projectConfig.jsBundleThemes;
         }
+        yield sync_global_contexts_1.syncGlobalContexts(context, projectBundle, projectConfig, projectLock, checksums, baseDir);
         // Write out components
         yield sync_components_1.syncProjectComponents(context, projectConfig, version, componentBundles, forceOverwrite, appendJsxOnMissingBase, summary, pendingMerge, projectLock, checksums, baseDir);
     });

package/dist/api.d.ts

@@ -25,6 +25,10 @@ export interface GlobalVariantBundle {
     contextModule: string;
     contextFileName: string;
 }
+export interface GlobalContextBundle {
+    id: string;
+    contextModule: string;
+}
 export interface JsBundleTheme {
     themeFileName: string;
     themeModule: string;
@@ -36,6 +40,7 @@ export interface ProjectMetaBundle {
     cssFileName: string;
     cssRules: string;
     jsBundleThemes?: JsBundleTheme[];
+    globalContextBundle?: GlobalContextBundle;
 }
 export interface IconBundle {
     id: string;
@@ -71,6 +76,13 @@ export interface RequiredPackages {
     "@plasmicapp/react-web": string;
     "@plasmicapp/react-web-runtime": string;
 }
+export interface ProjectMetaInfo {
+    id: string;
+    name: string;
+    workspaceId?: string;
+    hostUrl?: string;
+    lastPublishedVersion?: string;
+}
 export interface ProjectBundle {
     components: ComponentBundle[];
     codeComponentMetas: CodeComponentMeta[];
@@ -111,6 +123,7 @@ export interface ChecksumBundle {
     iconChecksums: Array<[string, string]>;
     globalVariantChecksums: Array<[string, string]>;
     projectCssChecksum: string;
+    globalContextsChecksum: string;
 }
 export interface CodeComponentMeta {
     id: string;
@@ -173,6 +186,7 @@ export declare class PlasmicApi {
         indirect: boolean;
         metadata?: Metadata;
     }): Promise<ProjectBundle>;
+    projectMeta(projectId: string): Promise<ProjectMetaInfo>;
     uploadBundle(projectId: string, bundleName: string, bundleJs: string, css: string[], metaJson: string, genModulePath: string | undefined, genCssPaths: string[], pkgVersion: string | undefined, extraPropMetaJson: string | undefined, themeProviderWrapper: string | undefined, themeModule: string | undefined): Promise<StyleTokensMap>;
     projectStyleTokens(projectId: string, versionRange?: string): Promise<StyleTokensMap>;
     projectIcons(projectId: string, versionRange?: string, iconIds?: string[]): Promise<ProjectIconsResponse>;

package/dist/api.js

@@ -93,6 +93,12 @@ class PlasmicApi {
             return result.data;
         });
     }
+    projectMeta(projectId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.post(`${this.codegenHost}/api/v1/projects/${projectId}/code/meta`);
+            return result.data;
+        });
+    }
     uploadBundle(projectId, bundleName, bundleJs, css, metaJson, genModulePath, genCssPaths, pkgVersion, extraPropMetaJson, themeProviderWrapper, themeModule) {
         return __awaiter(this, void 0, void 0, function* () {
             const result = yield this.post(`${this.codegenHost}/api/v1/projects/${projectId}/jsbundle/upload`, {

package/dist/index.js

@@ -28,6 +28,7 @@ const update_notifier_1 = __importDefault(require("update-notifier"));
 const yargs_1 = __importDefault(require("yargs"));
 const auth = __importStar(require("./actions/auth"));
 const fix_imports_1 = require("./actions/fix-imports");
+const info_1 = require("./actions/info");
 const init_1 = require("./actions/init");
 const projectToken = __importStar(require("./actions/project-token"));
 const sync_1 = require("./actions/sync");
@@ -118,6 +119,14 @@ yargs_1.default
     }));
 })
     .command("fix-imports", "Fixes import paths after you've moved around Plasmic blackbox files", (yags) => 0, (argv) => error_1.handleError(fix_imports_1.fixImports(argv)))
+    .command("info", "Fetches metadata for projects", (yags) => yags.option("projects", {
+    alias: "p",
+    describe: "ID of plasmic project to check",
+    type: "array",
+    default: [],
+}), (argv) => {
+    error_1.handleError(info_1.printProjectInfo(argv));
+})
     .command("upload-bundle", false, (yargs) => yargs
     .option("project", {
     alias: "p",

package/dist/migrations/0.1.143-ensureImportModuleType.d.ts

@@ -0,0 +1,2 @@
+import { PlasmicConfig } from "../utils/config-utils";
+export declare function ensureImportModuleType(config: PlasmicConfig): PlasmicConfig;

package/dist/migrations/0.1.143-ensureImportModuleType.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureImportModuleType = void 0;
+function ensureImportModuleType(config) {
+    for (const project of config.projects) {
+        for (const component of project.components) {
+            component.importSpec.moduleType = "local";
+        }
+    }
+    return config;
+}
+exports.ensureImportModuleType = ensureImportModuleType;

package/dist/plasmic.schema.json

@@ -282,6 +282,10 @@
                     "description": "File location for the project-wide css styles. Relative to srcDir",
                     "type": "string"
                 },
+                "globalContextsFilePath": {
+                    "description": "File location for the project-wide global contexts. Relative to srcDir",
+                    "type": "string"
+                },
                 "icons": {
                     "description": "Metadata for each synced icon in this project",
                     "items": {
@@ -326,6 +330,7 @@
             "required": [
                 "components",
                 "cssFilePath",
+                "globalContextsFilePath",
                 "icons",
                 "images",
                 "indirect",
@@ -348,6 +353,9 @@
                         "css-modules"
                     ],
                     "type": "string"
+                },
+                "skipGlobalCssImport": {
+                    "type": "boolean"
                 }
             },
             "required": [

package/dist/test-common/fixtures.js

@@ -139,6 +139,7 @@ exports.project1Config = {
     images: [],
     jsBundleThemes: [],
     indirect: false,
+    globalContextsFilePath: "",
 };
 function expectProject1PlasmicJson(optional) {
     const plasmicJson = exports.tmpRepo.readPlasmicJson();

package/dist/utils/checksum.js

@@ -13,6 +13,7 @@ function getChecksums(context, opts, projectId, componentIds) {
             cssRulesChecksums: [],
             globalVariantChecksums: [],
             projectCssChecksum: "",
+            globalContextsChecksum: "",
         };
     }
     const fileLocks = projectLock.fileLocks;
@@ -51,6 +52,11 @@ function getChecksums(context, opts, projectId, componentIds) {
     const projectCssChecksums = fileLocks.filter((fileLock) => fileLock.type === "projectCss");
     lang_utils_1.assert(projectCssChecksums.length < 2);
     const projectCssChecksum = projectCssChecksums.length > 0 ? projectCssChecksums[0].checksum : "";
+    const globalContextsChecksums = fileLocks.filter((fileLock) => fileLock.type === "globalContexts" && fileLock.assetId === projectId);
+    lang_utils_1.assert(globalContextsChecksums.length < 2);
+    const globalContextsChecksum = globalContextsChecksums.length > 0
+        ? globalContextsChecksums[0].checksum
+        : "";
     return {
         imageChecksums,
         iconChecksums,
@@ -58,6 +64,7 @@ function getChecksums(context, opts, projectId, componentIds) {
         cssRulesChecksums,
         globalVariantChecksums,
         projectCssChecksum,
+        globalContextsChecksum,
     };
 }
 exports.getChecksums = getChecksums;

package/dist/utils/code-utils.js

@@ -41,9 +41,11 @@ const Prettier = __importStar(require("prettier"));
 const prettier_1 = require("prettier");
 const ts = __importStar(require("typescript"));
 const upath_1 = __importDefault(require("upath"));
+const sync_global_contexts_1 = require("../actions/sync-global-contexts");
 const sync_images_1 = require("../actions/sync-images");
 const deps_1 = require("../deps");
 const error_1 = require("../utils/error");
+const config_utils_1 = require("./config-utils");
 const file_utils_1 = require("./file-utils");
 const lang_utils_1 = require("./lang-utils");
 exports.formatAsLocal = (content, filePath, baseDir, defaultOpts = {}) => {
@@ -341,13 +343,15 @@ function fixAllImportStatements(context, baseDir, summary) {
                 }
             }
         }
+        fixGlobalContextImportStatements(context, fixImportContext, baseDir);
     });
 }
 exports.fixAllImportStatements = fixAllImportStatements;
 function fixComponentImportStatements(context, compConfig, fixImportContext, fixSkeletonModule, baseDir) {
     return __awaiter(this, void 0, void 0, function* () {
         // If ComponentConfig.importPath is still a local file, we best-effort also fix up the import statements there.
-        if (isLocalModulePath(compConfig.importSpec.modulePath) &&
+        if (compConfig.type !== "mapped" &&
+            isLocalModulePath(compConfig.importSpec.modulePath) &&
             fixSkeletonModule) {
             yield fixFileImportStatements(context, compConfig.importSpec.modulePath, fixImportContext, true, baseDir);
         }
@@ -455,3 +459,26 @@ exports.formatScript = (code, baseDir) => {
         useTabs: false,
     });
 };
+function fixGlobalContextImportStatements(context, fixImportContext, baseDir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        for (const project of context.config.projects) {
+            if (!project.globalContextsFilePath)
+                continue;
+            const resourcePath = sync_global_contexts_1.getGlobalContextsResourcePath(context, project);
+            let prevContent;
+            try {
+                prevContent = file_utils_1.readFileText(file_utils_1.makeFilePath(context, resourcePath)).toString();
+            }
+            catch (e) {
+                deps_1.logger.warn(`${resourcePath} is missing. If you deleted this component, remember to remove the component from ${config_utils_1.CONFIG_FILE_NAME}`);
+                throw e;
+            }
+            const newContent = replaceImports(context, prevContent, resourcePath, fixImportContext, false, baseDir, true);
+            if (prevContent !== newContent) {
+                yield file_utils_1.writeFileContent(context, resourcePath, newContent, {
+                    force: true,
+                });
+            }
+        }
+    });
+}

package/dist/utils/config-utils.d.ts

@@ -73,6 +73,7 @@ export interface StyleConfig {
     scheme: "css" | "css-modules";
     /** File location for global css styles shared by all components. Relative to srcDir */
     defaultStyleCssFilePath: string;
+    skipGlobalCssImport?: boolean;
 }
 export interface ImagesConfig {
     /**
@@ -118,6 +119,8 @@ export interface ProjectConfig {
     version: string;
     /** File location for the project-wide css styles. Relative to srcDir */
     cssFilePath: string;
+    /** File location for the project-wide global contexts. Relative to srcDir */
+    globalContextsFilePath: string;
     jsBundleThemes?: JsBundleThemeConfig[];
     codeComponents?: CodeComponentConfig[];
     /** Metadata for each synced component in this project. */
@@ -213,7 +216,7 @@ export interface GlobalVariantGroupConfig {
     contextFilePath: string;
 }
 export interface FileLock {
-    type: "renderModule" | "cssRules" | "icon" | "image" | "projectCss" | "globalVariant";
+    type: "renderModule" | "cssRules" | "icon" | "image" | "projectCss" | "globalVariant" | "globalContexts";
     checksum: string;
     assetId: string;
 }

package/dist/utils/config-utils.js

@@ -40,6 +40,7 @@ function createProjectConfig(base) {
         icons: [],
         images: [],
         indirect: base.indirect,
+        globalContextsFilePath: "",
     };
 }
 exports.createProjectConfig = createProjectConfig;
@@ -150,6 +151,7 @@ function getOrAddProjectConfig(context, projectId, base // if one doesn't exist,
                 images: [],
                 jsBundleThemes: [],
                 indirect: false,
+                globalContextsFilePath: "",
             };
         context.config.projects.push(project);
     }

package/dist/utils/file-utils.d.ts

@@ -45,11 +45,6 @@ export declare function findSrcDirPath(absoluteSrcDir: string, expectedPath: str
 export declare function findFile(dir: string, pred: (name: string) => boolean, opts: {
     traverseParents?: boolean;
 }): string | undefined;
-/**
- * Fixes all src-relative file paths in PlasmicConfig by detecting file
- * movement on disk.
- */
-export declare function fixAllFilePaths(context: PlasmicContext, baseDir: string): Promise<void>;
 /**
  * Throws an error if some file in PlasmicConfig is not inside the root
  * directory (i.e., the directory containing plasmic.json).

package/dist/utils/file-utils.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.existsBuffered = exports.deleteFileBuffered = exports.renameFileBuffered = exports.readFileText = exports.writeFileText = exports.withBufferedFs = exports.assertAllPathsInRootDir = exports.fixAllFilePaths = exports.findFile = exports.findSrcDirPath = exports.buildBaseNameToFiles = exports.renameFile = exports.makeFilePath = exports.fileExists = exports.deleteFile = exports.readFileContent = exports.writeFileContent = exports.defaultPagePath = exports.defaultPublicResourcePath = exports.defaultResourcePath = exports.writeFileContentRaw = exports.stripExtension = void 0;
+exports.existsBuffered = exports.deleteFileBuffered = exports.renameFileBuffered = exports.readFileText = exports.writeFileText = exports.withBufferedFs = exports.assertAllPathsInRootDir = exports.findFile = exports.findSrcDirPath = exports.buildBaseNameToFiles = exports.renameFile = exports.makeFilePath = exports.fileExists = exports.deleteFile = exports.readFileContent = exports.writeFileContent = exports.defaultPagePath = exports.defaultPublicResourcePath = exports.defaultResourcePath = exports.writeFileContentRaw = exports.stripExtension = void 0;
 const fs_1 = __importDefault(require("fs"));
 const glob_1 = __importDefault(require("glob"));
 const lodash_1 = __importDefault(require("lodash"));
@@ -188,6 +188,7 @@ function getAllPaths(context) {
     };
     const pushProject = (proj) => {
         pushPath(proj, "cssFilePath");
+        pushPath(proj, "globalContextsFilePath");
         for (const component of proj.components) {
             pushComponent(component);
         }
@@ -218,37 +219,6 @@ function getAllPaths(context) {
     }
     return pairs;
 }
-/**
- * Fixes all src-relative file paths in PlasmicConfig by detecting file
- * movement on disk.
- */
-function fixAllFilePaths(context, baseDir) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const baseNameToFiles = buildBaseNameToFiles(context);
-        let changed = false;
-        const paths = getAllPaths(context);
-        for (const { bundle, key } of paths) {
-            const known = bundle[key];
-            // Check null and undefined
-            if (known == null) {
-                throw new error_1.HandledError(`"${key} is required, but missing in ${config_utils_1.CONFIG_FILE_NAME}. Please restore the file or delete from ${config_utils_1.CONFIG_FILE_NAME} and run plasmic sync: ${bundle}"`);
-            }
-            // Check falsey values (e.g. "")
-            if (!known) {
-                continue;
-            }
-            const found = findSrcDirPath(context.absoluteSrcDir, known, baseNameToFiles);
-            if (known !== found) {
-                bundle[key] = found;
-                changed = true;
-            }
-        }
-        if (changed) {
-            yield config_utils_1.updateConfig(context, context.config, baseDir);
-        }
-    });
-}
-exports.fixAllFilePaths = fixAllFilePaths;
 /**
  * Throws an error if some file in PlasmicConfig is not inside the root
  * directory (i.e., the directory containing plasmic.json).

package/dist/utils/get-context.js

@@ -81,10 +81,7 @@ function removeMissingFilesFromLock(context, config, lock) {
             image.id,
             image,
         ]));
-        const knownIcons = Object.fromEntries(knownProjects[project.projectId].icons.map((icons) => [
-            icons.id,
-            icons,
-        ]));
+        const knownIcons = Object.fromEntries(knownProjects[project.projectId].icons.map((icons) => [icons.id, icons]));
         project.fileLocks = project.fileLocks.filter((lock) => {
             switch (lock.type) {
                 default:
@@ -100,6 +97,8 @@ function removeMissingFilesFromLock(context, config, lock) {
                     return knownImages[lock.assetId];
                 case "icon":
                     return knownIcons[lock.assetId];
+                case "globalContexts":
+                    return knownProjects[project.projectId].globalContextsFilePath;
             }
         });
         return project;
@@ -169,6 +168,11 @@ function resolveMissingFilesInConfig(context, config) {
         for (const project of config.projects) {
             project.cssFilePath =
                 (yield attemptToRestoreFilePath(context, project.cssFilePath, baseNameToFiles)) || "";
+            if (!project.globalContextsFilePath) {
+                project.globalContextsFilePath = "";
+            }
+            project.globalContextsFilePath =
+                (yield attemptToRestoreFilePath(context, project.globalContextsFilePath, baseNameToFiles)) || "";
             project.images = yield filterFiles(project.images, "filePath");
             project.icons = yield filterFiles(project.icons, "moduleFilePath");
             project.jsBundleThemes = yield filterFiles(project.jsBundleThemes || [], "themeFilePath");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.169",
+  "version": "0.1.173",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"
@@ -20,7 +20,7 @@
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.12.1",
-    "@plasmicapp/react-web": "^0.2.18",
+    "@plasmicapp/react-web": "^0.2.91",
     "@types/findup-sync": "^2.0.2",
     "@types/glob": "^7.1.3",
     "@types/inquirer": "^6.5.0",

package/src/__mocks__/api.ts

@@ -339,6 +339,7 @@ class PlasmicApi {
         iconChecksums: [],
         globalVariantChecksums: [],
         projectCssChecksum: "",
+        globalContextsChecksum: "",
       } as ChecksumBundle,
       usedNpmPackages: [],
       externalCssImports: [],
@@ -374,7 +375,7 @@ class PlasmicApi {
 
   async latestCodegenVersion(): Promise<string> {
     return "0.0.1";
-  };
+  }
 
   async requiredPackages(): Promise<RequiredPackages> {
     return {

package/src/actions/fix-imports.ts

@@ -1,13 +1,12 @@
 import { CommonArgs } from "..";
 import { fixAllImportStatements } from "../utils/code-utils";
-import { fixAllFilePaths } from "../utils/file-utils";
+import { updateConfig } from "../utils/config-utils";
 import { getContext } from "../utils/get-context";
 
 export interface FixImportsArgs extends CommonArgs {}
 export async function fixImports(opts: FixImportsArgs) {
   if (!opts.baseDir) opts.baseDir = process.cwd();
   const context = await getContext(opts, { enableSkipAuth: true });
-
-  await fixAllFilePaths(context, opts.baseDir);
+  await updateConfig(context, context.config, opts.baseDir);
   await fixAllImportStatements(context, opts.baseDir);
 }

package/src/actions/info.ts

@@ -0,0 +1,20 @@
+import { CommonArgs } from "..";
+import { logger } from "../deps";
+import { getContext } from "../utils/get-context";
+
+export interface InfoArgs extends CommonArgs {
+  projects: readonly string[];
+}
+
+export async function printProjectInfo(opts: InfoArgs): Promise<void> {
+  let context = await getContext(opts);
+  const results = await Promise.all(
+    opts.projects.map(async (p) => await context.api.projectMeta(p))
+  );
+  for (const meta of results) {
+    logger.info(`Id: ${meta.id}`);
+    logger.info(`Name: ${meta.name}`);
+    logger.info(`Host URL: ${meta.hostUrl ?? null}`);
+    logger.info(`Last published version: ${meta.lastPublishedVersion ?? null}`);
+  }
+}

package/src/actions/sync-global-contexts.ts

@@ -0,0 +1,87 @@
+import { ChecksumBundle, ProjectMetaBundle } from "../api";
+import { logger } from "../deps";
+import { formatScript, tsxToJsx } from "../utils/code-utils";
+import L from "lodash";
+import {
+  PlasmicContext,
+  ProjectConfig,
+  ProjectLock,
+} from "../utils/config-utils";
+import {
+  defaultResourcePath,
+  deleteFile,
+  fileExists,
+  writeFileContent,
+} from "../utils/file-utils";
+
+const COMPONENT_NAME = "PlasmicGlobalContextsProvider";
+
+export async function syncGlobalContexts(
+  context: PlasmicContext,
+  projectMeta: ProjectMetaBundle,
+  projectConfig: ProjectConfig,
+  projectLock: ProjectLock,
+  checksums: ChecksumBundle,
+  baseDir: string
+) {
+  const resourcePath = getGlobalContextsResourcePath(context, projectConfig);
+  if (checksums.globalContextsChecksum && projectMeta.globalContextBundle) {
+    if (context.cliArgs.quiet !== true) {
+      logger.info(
+        `Syncing component: ${COMPONENT_NAME}@${projectLock.version}\t['${projectConfig.projectName}' ${projectConfig.projectId} ${projectConfig.version}]`
+      );
+    }
+    if (context.config.code.lang === "js") {
+      projectMeta.globalContextBundle.contextModule = formatScript(
+        tsxToJsx(projectMeta.globalContextBundle.contextModule),
+        baseDir
+      );
+    }
+    writeFileContent(
+      context,
+      resourcePath,
+      projectMeta.globalContextBundle.contextModule,
+      { force: false }
+    );
+    projectConfig.globalContextsFilePath = resourcePath;
+    const fl = projectLock.fileLocks.find(
+      (fl) =>
+        fl.assetId === projectConfig.projectId && fl.type === "globalContexts"
+    );
+    if (fl) {
+      fl.checksum = checksums.globalContextsChecksum;
+    } else {
+      projectLock.fileLocks.push({
+        assetId: projectConfig.projectId,
+        checksum: checksums.globalContextsChecksum,
+        type: "globalContexts",
+      });
+    }
+  } else if (
+    !checksums.globalContextsChecksum &&
+    !projectMeta.globalContextBundle
+  ) {
+    if (fileExists(context, resourcePath)) {
+      deleteFile(context, resourcePath);
+    }
+    projectConfig.globalContextsFilePath = "";
+    L.remove(
+      projectLock.fileLocks,
+      (fl) =>
+        fl.assetId === projectConfig.projectId && fl.type === "globalContexts"
+    );
+  }
+}
+
+export function getGlobalContextsResourcePath(
+  context: PlasmicContext,
+  projectConfig: ProjectConfig
+) {
+  return projectConfig.globalContextsFilePath !== ""
+    ? projectConfig.globalContextsFilePath
+    : defaultResourcePath(
+        context,
+        projectConfig,
+        `${COMPONENT_NAME}.${context.config.code.lang === "ts" ? "tsx" : "jsx"}`
+      );
+}

package/src/actions/sync.ts

@@ -64,6 +64,7 @@ import { syncGlobalVariants } from "./sync-global-variants";
 import { syncProjectIconAssets } from "./sync-icons";
 import { syncProjectImageAssets } from "./sync-images";
 import { upsertStyleTokens } from "./sync-styles";
+import { syncGlobalContexts } from "./sync-global-contexts";
 
 export interface SyncArgs extends CommonArgs {
   projects: readonly string[];
@@ -417,11 +418,15 @@ export async function sync(
     }
 
     const codegenVersion = await context.api.latestCodegenVersion();
-    context.lock.projects.forEach(p => {
-      if (projectsToSync.some(syncedProject => syncedProject.projectId === p.projectId)) {
+    context.lock.projects.forEach((p) => {
+      if (
+        projectsToSync.some(
+          (syncedProject) => syncedProject.projectId === p.projectId
+        )
+      ) {
         p.codegenVersion = codegenVersion;
       }
-    })
+    });
     // Write the new ComponentConfigs to disk
     await updateConfig(context, context.config, baseDir);
   });
@@ -787,6 +792,15 @@ async function syncProjectConfig(
     delete projectConfig.jsBundleThemes;
   }
 
+  await syncGlobalContexts(
+    context,
+    projectBundle,
+    projectConfig,
+    projectLock,
+    checksums,
+    baseDir
+  );
+
   // Write out components
   await syncProjectComponents(
     context,

package/src/api.ts

@@ -39,6 +39,11 @@ export interface GlobalVariantBundle {
   contextFileName: string;
 }
 
+export interface GlobalContextBundle {
+  id: string;
+  contextModule: string;
+}
+
 export interface JsBundleTheme {
   themeFileName: string;
   themeModule: string;
@@ -51,6 +56,7 @@ export interface ProjectMetaBundle {
   cssFileName: string;
   cssRules: string;
   jsBundleThemes?: JsBundleTheme[];
+  globalContextBundle?: GlobalContextBundle;
 }
 
 export interface IconBundle {
@@ -92,6 +98,14 @@ export interface RequiredPackages {
   "@plasmicapp/react-web-runtime": string;
 }
 
+export interface ProjectMetaInfo {
+  id: string;
+  name: string;
+  workspaceId?: string;
+  hostUrl?: string;
+  lastPublishedVersion?: string;
+}
+
 export interface ProjectBundle {
   components: ComponentBundle[];
   codeComponentMetas: CodeComponentMeta[];
@@ -142,6 +156,8 @@ export interface ChecksumBundle {
   globalVariantChecksums: Array<[string, string]>;
   // Checksum of projectCss file
   projectCssChecksum: string;
+  // Checksum of project global contexts
+  globalContextsChecksum: string;
 }
 
 export interface CodeComponentMeta {
@@ -262,6 +278,13 @@ export class PlasmicApi {
     return result.data as ProjectBundle;
   }
 
+  async projectMeta(projectId: string) {
+    const result = await this.post(
+      `${this.codegenHost}/api/v1/projects/${projectId}/code/meta`
+    );
+    return result.data as ProjectMetaInfo;
+  }
+
   async uploadBundle(
     projectId: string,
     bundleName: string,

package/src/index.ts

@@ -4,6 +4,7 @@ import updateNotifier from "update-notifier";
 import yargs from "yargs";
 import * as auth from "./actions/auth";
 import { fixImports, FixImportsArgs } from "./actions/fix-imports";
+import { InfoArgs, printProjectInfo } from "./actions/info";
 import { getYargsOption, InitArgs, initPlasmic } from "./actions/init";
 import * as projectToken from "./actions/project-token";
 import { sync, SyncArgs } from "./actions/sync";
@@ -134,6 +135,20 @@ yargs
     (yags) => 0,
     (argv) => handleError(fixImports(argv))
   )
+  .command<InfoArgs>(
+    "info",
+    "Fetches metadata for projects",
+    (yags) =>
+      yags.option("projects", {
+        alias: "p",
+        describe: "ID of plasmic project to check",
+        type: "array",
+        default: [],
+      }),
+    (argv) => {
+      handleError(printProjectInfo(argv));
+    }
+  )
   .command<UploadBundleArgs>(
     "upload-bundle",
     false,

package/src/test-common/fixtures.ts

@@ -148,6 +148,7 @@ export const project1Config: ProjectConfig = {
   images: [],
   jsBundleThemes: [],
   indirect: false,
+  globalContextsFilePath: "",
 };
 
 export function expectProject1PlasmicJson(

package/src/utils/checksum.ts

@@ -25,6 +25,7 @@ export function getChecksums(
       cssRulesChecksums: [],
       globalVariantChecksums: [],
       projectCssChecksum: "",
+      globalContextsChecksum: "",
     };
   }
 
@@ -95,6 +96,16 @@ export function getChecksums(
   const projectCssChecksum =
     projectCssChecksums.length > 0 ? projectCssChecksums[0].checksum : "";
 
+  const globalContextsChecksums = fileLocks.filter(
+    (fileLock) =>
+      fileLock.type === "globalContexts" && fileLock.assetId === projectId
+  );
+  assert(globalContextsChecksums.length < 2);
+  const globalContextsChecksum =
+    globalContextsChecksums.length > 0
+      ? globalContextsChecksums[0].checksum
+      : "";
+
   return {
     imageChecksums,
     iconChecksums,
@@ -102,5 +113,6 @@ export function getChecksums(
     cssRulesChecksums,
     globalVariantChecksums,
     projectCssChecksum,
+    globalContextsChecksum,
   };
 }

package/src/utils/code-utils.ts

@@ -8,6 +8,7 @@ import * as Prettier from "prettier";
 import { Options, resolveConfig } from "prettier";
 import * as ts from "typescript";
 import path from "upath";
+import { getGlobalContextsResourcePath } from "../actions/sync-global-contexts";
 import {
   fixComponentCssReferences,
   fixComponentImagesReferences,
@@ -17,6 +18,7 @@ import { HandledError } from "../utils/error";
 import {
   CodeComponentConfig,
   ComponentConfig,
+  CONFIG_FILE_NAME,
   GlobalVariantGroupConfig,
   IconConfig,
   ImageConfig,
@@ -473,6 +475,7 @@ export async function fixAllImportStatements(
       }
     }
   }
+  fixGlobalContextImportStatements(context, fixImportContext, baseDir);
 }
 
 async function fixComponentImportStatements(
@@ -484,6 +487,7 @@ async function fixComponentImportStatements(
 ) {
   // If ComponentConfig.importPath is still a local file, we best-effort also fix up the import statements there.
   if (
+    compConfig.type !== "mapped" &&
     isLocalModulePath(compConfig.importSpec.modulePath) &&
     fixSkeletonModule
   ) {
@@ -654,3 +658,42 @@ export const formatScript = (code: string, baseDir: string) => {
     useTabs: false,
   });
 };
+
+async function fixGlobalContextImportStatements(
+  context: PlasmicContext,
+  fixImportContext: FixImportContext,
+  baseDir: string
+) {
+  for (const project of context.config.projects) {
+    if (!project.globalContextsFilePath) continue;
+    const resourcePath = getGlobalContextsResourcePath(context, project);
+
+    let prevContent: string;
+    try {
+      prevContent = readFileText(
+        makeFilePath(context, resourcePath)
+      ).toString();
+    } catch (e) {
+      logger.warn(
+        `${resourcePath} is missing. If you deleted this component, remember to remove the component from ${CONFIG_FILE_NAME}`
+      );
+      throw e;
+    }
+
+    const newContent = replaceImports(
+      context,
+      prevContent,
+      resourcePath,
+      fixImportContext,
+      false,
+      baseDir,
+      true
+    );
+
+    if (prevContent !== newContent) {
+      await writeFileContent(context, resourcePath, newContent, {
+        force: true,
+      });
+    }
+  }
+}

package/src/utils/config-utils.ts

@@ -108,6 +108,8 @@ export interface StyleConfig {
 
   /** File location for global css styles shared by all components. Relative to srcDir */
   defaultStyleCssFilePath: string;
+
+  skipGlobalCssImport?: boolean;
 }
 
 export interface ImagesConfig {
@@ -159,6 +161,8 @@ export interface ProjectConfig {
   version: string;
   /** File location for the project-wide css styles. Relative to srcDir */
   cssFilePath: string;
+  /** File location for the project-wide global contexts. Relative to srcDir */
+  globalContextsFilePath: string;
 
   // Code-component-related fields can be treated as optional not to be shown
   // to the users nor appear to be missing in the documentation.
@@ -197,6 +201,7 @@ export function createProjectConfig(base: {
     icons: [],
     images: [],
     indirect: base.indirect,
+    globalContextsFilePath: "",
   };
 }
 
@@ -299,7 +304,8 @@ export interface FileLock {
     | "icon"
     | "image"
     | "projectCss"
-    | "globalVariant";
+    | "globalVariant"
+    | "globalContexts";
   // The checksum value for the file
   checksum: string;
   // The component id, or the image asset id
@@ -530,6 +536,7 @@ export function getOrAddProjectConfig(
           images: [],
           jsBundleThemes: [],
           indirect: false,
+          globalContextsFilePath: "",
         };
     context.config.projects.push(project);
   }

package/src/utils/file-utils.ts

@@ -11,7 +11,6 @@ import {
   CONFIG_FILE_NAME,
   PlasmicContext,
   ProjectConfig,
-  updateConfig,
 } from "./config-utils";
 import { ensureString } from "./lang-utils";
 import { confirmWithUser } from "./user-utils";
@@ -242,6 +241,7 @@ function getAllPaths(context: PlasmicContext): BundleKeyPair[] {
 
   const pushProject = (proj: ProjectConfig) => {
     pushPath(proj, "cssFilePath");
+    pushPath(proj, "globalContextsFilePath");
     for (const component of proj.components) {
       pushComponent(component);
     }
@@ -278,43 +278,6 @@ function getAllPaths(context: PlasmicContext): BundleKeyPair[] {
   return pairs;
 }
 
-/**
- * Fixes all src-relative file paths in PlasmicConfig by detecting file
- * movement on disk.
- */
-export async function fixAllFilePaths(context: PlasmicContext, baseDir: string) {
-  const baseNameToFiles = buildBaseNameToFiles(context);
-  let changed = false;
-
-  const paths = getAllPaths(context);
-  for (const { bundle, key } of paths) {
-    const known = bundle[key];
-    // Check null and undefined
-    if (known == null) {
-      throw new HandledError(
-        `"${key} is required, but missing in ${CONFIG_FILE_NAME}. Please restore the file or delete from ${CONFIG_FILE_NAME} and run plasmic sync: ${bundle}"`
-      );
-    }
-    // Check falsey values (e.g. "")
-    if (!known) {
-      continue;
-    }
-    const found = findSrcDirPath(
-      context.absoluteSrcDir,
-      known,
-      baseNameToFiles
-    );
-    if (known !== found) {
-      bundle[key] = found;
-      changed = true;
-    }
-  }
-
-  if (changed) {
-    await updateConfig(context, context.config, baseDir);
-  }
-}
-
 /**
  * Throws an error if some file in PlasmicConfig is not inside the root
  * directory (i.e., the directory containing plasmic.json).

package/src/utils/get-context.ts

@@ -79,10 +79,7 @@ function removeMissingFilesFromLock(
         ])
       );
       const knownIcons = Object.fromEntries(
-        knownProjects[project.projectId].icons.map((icons) => [
-          icons.id,
-          icons,
-        ])
+        knownProjects[project.projectId].icons.map((icons) => [icons.id, icons])
       );
 
       project.fileLocks = project.fileLocks.filter((lock) => {
@@ -100,6 +97,8 @@ function removeMissingFilesFromLock(
             return knownImages[lock.assetId];
           case "icon":
             return knownIcons[lock.assetId];
+          case "globalContexts":
+            return knownProjects[project.projectId].globalContextsFilePath;
         }
       });
 
@@ -209,6 +208,16 @@ async function resolveMissingFilesInConfig(
         baseNameToFiles
       )) || "";
 
+    if (!project.globalContextsFilePath) {
+      project.globalContextsFilePath = "";
+    }
+    project.globalContextsFilePath =
+      (await attemptToRestoreFilePath(
+        context,
+        project.globalContextsFilePath,
+        baseNameToFiles
+      )) || "";
+
     project.images = await filterFiles(project.images, "filePath");
     project.icons = await filterFiles(project.icons, "moduleFilePath");
     project.jsBundleThemes = await filterFiles(