@plasmicapp/cli 0.1.316 → 0.1.318

package/dist/plasmic.schema.json

@@ -404,6 +404,10 @@
                     "description": "Project name synced down from Studio",
                     "type": "string"
                 },
+                "splitsProviderFilePath": {
+                    "description": "File location for the project-wide splits provider. Relative to srcDir",
+                    "type": "string"
+                },
                 "version": {
                     "description": "A version range for syncing this project. Can be:\n* \"latest\" - always syncs down whatever has been saved in the project.\n* \">0\" - always syncs down the latest published version of the project.\n* any other semver string you'd like",
                     "type": "string"
@@ -418,6 +422,7 @@
                 "indirect",
                 "projectId",
                 "projectName",
+                "splitsProviderFilePath",
                 "version"
             ],
             "type": "object"

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

@@ -135,6 +135,8 @@ export interface ProjectConfig {
     cssFilePath: string;
     /** File location for the project-wide global contexts. Relative to srcDir */
     globalContextsFilePath: string;
+    /** File location for the project-wide splits provider. Relative to srcDir */
+    splitsProviderFilePath: string;
     jsBundleThemes?: JsBundleThemeConfig[];
     codeComponents?: CodeComponentConfig[];
     customFunctions?: CustomFunctionConfig[];
@@ -233,7 +235,7 @@ export interface GlobalVariantGroupConfig {
     contextFilePath: string;
 }
 export interface FileLock {
-    type: "renderModule" | "cssRules" | "icon" | "image" | "projectCss" | "globalVariant" | "globalContexts";
+    type: "renderModule" | "cssRules" | "icon" | "image" | "projectCss" | "globalVariant" | "globalContexts" | "splitsProvider";
     checksum: string;
     assetId: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.316",
+  "version": "0.1.318",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"
@@ -78,5 +78,5 @@
     "wrap-ansi": "^7.0.0",
     "yargs": "^15.4.1"
   },
-  "gitHead": "3b71c9fba9c00aea3d7197feefc45da8813b7e7a"
+  "gitHead": "f9ffe94b022627f4677d77f8d953e27a4076dc39"
 }

package/src/__mocks__/api.ts

@@ -355,6 +355,7 @@ class PlasmicApi {
         globalVariantChecksums: [],
         projectCssChecksum: "",
         globalContextsChecksum: "",
+        splitsProviderChecksum: "",
       } as ChecksumBundle,
       usedNpmPackages: [],
       externalCssImports: [],

package/src/actions/export.ts

@@ -20,6 +20,7 @@ import { getContext, getCurrentOrDefaultAuth } from "../utils/get-context";
 import { tuple } from "../utils/lang-utils";
 import { DEFAULT_GLOBAL_CONTEXTS_NAME } from "./sync-global-contexts";
 import { ensureImageAssetContents } from "./sync-images";
+import { DEFAULT_SPLITS_PROVIDER_NAME } from "./sync-splits-provider";
 
 export interface ExportArgs extends CommonArgs {
   projects: readonly string[];
@@ -130,6 +131,13 @@ export async function exportProjectsCli(opts: ExportArgs): Promise<void> {
       );
     }
 
+    if (bundle.projectConfig.splitsProviderBundle) {
+      writeFile(
+        `${DEFAULT_SPLITS_PROVIDER_NAME}.${extx}`,
+        bundle.projectConfig.splitsProviderBundle.module
+      );
+    }
+
     await Promise.all(promises);
   };
 
@@ -179,6 +187,9 @@ export async function exportProjectsCli(opts: ExportArgs): Promise<void> {
             globalContextsFilePath: bundle.projectConfig.globalContextBundle
               ? `${projectName}/${DEFAULT_GLOBAL_CONTEXTS_NAME}.${extx}`
               : "",
+            splitsProviderFilePath: bundle.projectConfig.splitsProviderBundle
+              ? `${projectName}/${DEFAULT_SPLITS_PROVIDER_NAME}.${extx}`
+              : "",
             components: bundle.components.map((comp) => ({
               id: comp.id,
               name: comp.componentName,
@@ -326,6 +337,14 @@ async function exportProjects(api: PlasmicApi, opts: ExportOpts) {
         );
         proj.projectConfig.globalContextBundle.contextModule = res[1];
       }
+      if (proj.projectConfig.splitsProviderBundle) {
+        const res = maybeConvertTsxToJsx(
+          `${DEFAULT_SPLITS_PROVIDER_NAME}.tsx`,
+          proj.projectConfig.splitsProviderBundle.module,
+          "."
+        );
+        proj.projectConfig.splitsProviderBundle.module = res[1];
+      }
     }
   }
 

package/src/actions/sync-splits-provider.ts

@@ -0,0 +1,88 @@
+import L from "lodash";
+import { ChecksumBundle, ProjectMetaBundle } from "../api";
+import { logger } from "../deps";
+import { formatScript, tsxToJsx } from "../utils/code-utils";
+import {
+  PlasmicContext,
+  ProjectConfig,
+  ProjectLock,
+} from "../utils/config-utils";
+import {
+  defaultResourcePath,
+  deleteFile,
+  fileExists,
+  writeFileContent,
+} from "../utils/file-utils";
+
+const COMPONENT_NAME = "PlasmicSplitsProvider";
+export const DEFAULT_SPLITS_PROVIDER_NAME = COMPONENT_NAME;
+
+export async function syncSplitsProvider(
+  context: PlasmicContext,
+  projectMeta: ProjectMetaBundle,
+  projectConfig: ProjectConfig,
+  projectLock: ProjectLock,
+  checksums: ChecksumBundle,
+  baseDir: string
+) {
+  const resourcePath = getSplitsProviderResourcePath(context, projectConfig);
+  if (checksums.splitsProviderChecksum && projectMeta.splitsProviderBundle) {
+    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.splitsProviderBundle.module = formatScript(
+        tsxToJsx(projectMeta.splitsProviderBundle.module),
+        baseDir
+      );
+    }
+    writeFileContent(
+      context,
+      resourcePath,
+      projectMeta.splitsProviderBundle.module,
+      { force: true }
+    );
+    projectConfig.splitsProviderFilePath = resourcePath;
+    const fl = projectLock.fileLocks.find(
+      (fl) =>
+        fl.assetId === projectConfig.projectId && fl.type === "splitsProvider"
+    );
+    if (fl) {
+      fl.checksum = checksums.splitsProviderChecksum;
+    } else {
+      projectLock.fileLocks.push({
+        assetId: projectConfig.projectId,
+        checksum: checksums.splitsProviderChecksum,
+        type: "splitsProvider",
+      });
+    }
+  } else if (
+    !checksums.splitsProviderChecksum &&
+    !projectMeta.splitsProviderBundle
+  ) {
+    if (fileExists(context, resourcePath)) {
+      deleteFile(context, resourcePath);
+    }
+    projectConfig.splitsProviderFilePath = "";
+    L.remove(
+      projectLock.fileLocks,
+      (fl) =>
+        fl.assetId === projectConfig.projectId && fl.type === "splitsProvider"
+    );
+  }
+}
+
+export function getSplitsProviderResourcePath(
+  context: PlasmicContext,
+  projectConfig: ProjectConfig
+) {
+  return projectConfig.splitsProviderFilePath !== ""
+    ? projectConfig.splitsProviderFilePath
+    : defaultResourcePath(
+        context,
+        projectConfig,
+        `${COMPONENT_NAME}.${context.config.code.lang === "ts" ? "tsx" : "jsx"}`
+      );
+}

package/src/actions/sync.ts

@@ -56,6 +56,7 @@ import { syncGlobalContexts } from "./sync-global-contexts";
 import { syncGlobalVariants } from "./sync-global-variants";
 import { syncProjectIconAssets } from "./sync-icons";
 import { syncProjectImageAssets } from "./sync-images";
+import { syncSplitsProvider } from "./sync-splits-provider";
 import { upsertStyleTokens } from "./sync-styles";
 
 export interface SyncArgs extends CommonArgs {
@@ -774,6 +775,15 @@ async function syncProjectConfig(
     baseDir
   );
 
+  await syncSplitsProvider(
+    context,
+    projectBundle,
+    projectConfig,
+    projectLock,
+    checksums,
+    baseDir
+  );
+
   // Write out components
   await syncProjectComponents(
     context,

package/src/api.ts

@@ -46,6 +46,11 @@ export interface GlobalContextBundle {
   contextModule: string;
 }
 
+export interface SplitsProviderBundle {
+  id: string;
+  module: string;
+}
+
 export interface JsBundleTheme {
   themeFileName: string;
   themeModule: string;
@@ -59,6 +64,7 @@ export interface ProjectMetaBundle {
   cssRules: string;
   jsBundleThemes?: JsBundleTheme[];
   globalContextBundle?: GlobalContextBundle;
+  splitsProviderBundle?: SplitsProviderBundle;
 }
 
 export interface IconBundle {
@@ -163,6 +169,8 @@ export interface ChecksumBundle {
   projectCssChecksum: string;
   // Checksum of project global contexts
   globalContextsChecksum: string;
+  // Checksum of project splits provider
+  splitsProviderChecksum: string;
 }
 
 export interface CodeComponentMeta {

package/src/test-common/fixtures.ts

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

package/src/utils/checksum.ts

@@ -30,6 +30,9 @@ function getFilesByFileLockAssetId(
     globalContext: {
       [projectConfig.projectId]: projectConfig.globalContextsFilePath,
     },
+    splitsProvider: {
+      [projectConfig.projectId]: projectConfig.splitsProviderFilePath,
+    },
   } as const;
 }
 
@@ -56,6 +59,7 @@ export function getChecksums(
       globalVariantChecksums: [],
       projectCssChecksum: "",
       globalContextsChecksum: "",
+      splitsProviderChecksum: "",
     };
   }
 
@@ -157,6 +161,20 @@ export function getChecksums(
       ? globalContextsChecksums[0].checksum
       : "";
 
+  const splitsProviderChecksums = fileLocks
+    .filter(
+      (fileLock) =>
+        fileLock.type === "splitsProvider" && fileLock.assetId === projectId
+    )
+    .filter((fileLock) =>
+      checkFile(fileLocations.splitsProvider[fileLock.assetId])
+    );
+  assert(splitsProviderChecksums.length < 2);
+  const splitsProviderChecksum =
+    splitsProviderChecksums.length > 0
+      ? splitsProviderChecksums[0].checksum
+      : "";
+
   return {
     imageChecksums,
     iconChecksums,
@@ -165,5 +183,6 @@ export function getChecksums(
     globalVariantChecksums,
     projectCssChecksum,
     globalContextsChecksum,
+    splitsProviderChecksum,
   };
 }

package/src/utils/code-utils.ts

@@ -13,6 +13,7 @@ import {
   fixComponentCssReferences,
   fixComponentImagesReferences,
 } from "../actions/sync-images";
+import { getSplitsProviderResourcePath } from "../actions/sync-splits-provider";
 import { logger } from "../deps";
 import { GLOBAL_SETTINGS } from "../globals";
 import { HandledError } from "../utils/error";
@@ -171,6 +172,7 @@ type PlasmicImportType =
   | "codeComponentHelper"
   | "globalContext"
   | "customFunction"
+  | "splitsProvider"
   | undefined;
 
 const validJsIdentifierChars = [
@@ -199,7 +201,7 @@ function tryParsePlasmicImportSpec(node: ImportDeclaration) {
         "plasmic-import:\\s+([",
         ...validJsIdentifierChars,
         "\\.",
-        "]+)(?:\\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent|globalContext|customFunction))?",
+        "]+)(?:\\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent|globalContext|customFunction|splitsProvider))?",
       ].join("")
     )
   );
@@ -425,6 +427,18 @@ export function replaceImports(
         // npm package
         stmt.source.value = meta.importPath;
       }
+    } else if (type === "splitsProvider") {
+      const projectConfig = fixImportContext.projects[uuid];
+      if (!projectConfig) {
+        throwMissingReference(context, "project", uuid, fromPath);
+      }
+      const realPath = makeImportPath(
+        context,
+        fromPath,
+        projectConfig.splitsProviderFilePath,
+        true
+      );
+      stmt.source.value = realPath;
     }
   });
 
@@ -590,6 +604,15 @@ export async function fixAllImportStatements(
     lastError = err;
   }
 
+  try {
+    fixSplitsProviderImportStatements(context, fixImportContext, baseDir);
+  } catch (err) {
+    logger.error(
+      `Error encountered while fixing imports for splits provider: ${err}`
+    );
+    lastError = err;
+  }
+
   if (lastError) {
     throw lastError;
   }
@@ -814,3 +837,42 @@ async function fixGlobalContextImportStatements(
     }
   }
 }
+
+async function fixSplitsProviderImportStatements(
+  context: PlasmicContext,
+  fixImportContext: FixImportContext,
+  baseDir: string
+) {
+  for (const project of context.config.projects) {
+    if (!project.splitsProviderFilePath) continue;
+    const resourcePath = getSplitsProviderResourcePath(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

@@ -180,6 +180,8 @@ export interface ProjectConfig {
   cssFilePath: string;
   /** File location for the project-wide global contexts. Relative to srcDir */
   globalContextsFilePath: string;
+  /** File location for the project-wide splits provider. Relative to srcDir */
+  splitsProviderFilePath: 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.
@@ -220,6 +222,7 @@ export function createProjectConfig(base: {
     images: [],
     indirect: base.indirect,
     globalContextsFilePath: "",
+    splitsProviderFilePath: "",
   };
 }
 
@@ -326,7 +329,8 @@ export interface FileLock {
     | "image"
     | "projectCss"
     | "globalVariant"
-    | "globalContexts";
+    | "globalContexts"
+    | "splitsProvider";
   // The checksum value for the file
   checksum: string;
   // The component id, or the image asset id
@@ -576,6 +580,7 @@ export function getOrAddProjectConfig(
           jsBundleThemes: [],
           indirect: false,
           globalContextsFilePath: "",
+          splitsProviderFilePath: "",
         };
     context.config.projects.push(project);
   }

package/src/utils/get-context.ts

@@ -99,6 +99,8 @@ function removeMissingFilesFromLock(
             return knownIcons[lock.assetId];
           case "globalContexts":
             return knownProjects[project.projectId].globalContextsFilePath;
+          case "splitsProvider":
+            return knownProjects[project.projectId].splitsProviderFilePath;
         }
       });
 
@@ -230,6 +232,17 @@ async function resolveMissingFilesInConfig(
         baseNameToFiles
       )) || project.globalContextsFilePath;
 
+    if (!project.splitsProviderFilePath) {
+      project.splitsProviderFilePath = "";
+    }
+    // Try to find the file, otherwise recreate at either the specified path or default path (if both are falsey)
+    project.splitsProviderFilePath =
+      (await attemptToRestoreFilePath(
+        context,
+        project.splitsProviderFilePath,
+        baseNameToFiles
+      )) || project.splitsProviderFilePath;
+
     project.images = await filterFiles(project.images, "filePath");
     project.icons = await filterFiles(project.icons, "moduleFilePath");
     project.jsBundleThemes = await filterFiles(