@plasmicapp/cli 0.1.187 → 0.1.189

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.187",
+  "version": "0.1.189",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"
@@ -53,7 +53,6 @@
     "@babel/traverse": "^7.12.1",
     "@plasmicapp/code-merger": "^0.0.33",
     "@sentry/node": "^5.19.2",
-    "@types/socket.io-client": "^1.4.34",
     "axios": "^0.21.1",
     "chalk": "^4.1.0",
     "fast-glob": "^3.2.4",
@@ -69,7 +68,7 @@
     "path": "^0.12.7",
     "prettier": "^2.0.5",
     "semver": "^7.3.2",
-    "socket.io-client": "^3.0.3",
+    "socket.io-client": "^4.1.2",
     "typescript": "^3.9.6",
     "upath": "^1.2.0",
     "update-notifier": "^4.1.0",

package/src/__mocks__/api.ts

@@ -26,6 +26,7 @@ const api: any = jest.genMockFromModule("../api");
 const PROJECTS: MockProject[] = [];
 export interface MockProject {
   projectId: string;
+  branchName: string;
   projectApiToken: string;
   version: string;
   projectName: string;
@@ -38,6 +39,7 @@ export interface MockComponent {
   id: string;
   name: string;
   projectId?: string;
+  branchName?: string;
   version?: string;
 }
 
@@ -72,6 +74,7 @@ function mockProjectToProjectVersionMeta(
  */
 function addMockProject(proj: MockProject) {
   const projectId = proj.projectId;
+  const branchName = proj.branchName;
   const version = proj.version;
   // Populate projectId and version into each component
   // will be useful when reading / writing components to files
@@ -79,11 +82,12 @@ function addMockProject(proj: MockProject) {
     return {
       ...c,
       projectId,
+      branchName,
       version,
     };
   });
 
-  const existing = getMockProject(projectId, version);
+  const existing = getMockProject(projectId, branchName, version);
   if (!existing) {
     PROJECTS.push(proj);
   } else {
@@ -117,10 +121,14 @@ function mockComponentToString(component: MockComponent): string {
 
 function getMockProject(
   projectId: string,
+  branchName: string,
   version: string
 ): MockProject | undefined {
   return PROJECTS.find(
-    (m) => m.projectId === projectId && m.version === version
+    (m) =>
+      m.projectId === projectId &&
+      m.branchName === branchName &&
+      m.version === version
   );
 }
 
@@ -128,15 +136,17 @@ function getMockProject(
  * Only fetch top-level components that match the projectId (optionally also componentIdOrNames + version)
  * Does not crawl the dependency tree
  * @param projectId
+ * @param branchName
  * @param componentIdOrNames
  * @param versionRange
  */
 function getMockComponents(
   projectId: string,
+  branchName: string,
   version: string,
   componentIdOrNames: readonly string[] | undefined
 ): MockComponent[] {
-  const project = getMockProject(projectId, version);
+  const project = getMockProject(projectId, branchName, version);
   return !project
     ? []
     : project.components.filter(
@@ -193,7 +203,7 @@ function* getDeps(projects: ProjectVersionMeta[]) {
   while (queue.length > 0) {
     const curr = ensure(queue.shift());
     for (const [projectId, version] of L.toPairs(curr.dependencies)) {
-      const mockProject = ensure(getMockProject(projectId, version));
+      const mockProject = ensure(getMockProject(projectId, "main", version));
       const projectMeta = mockProjectToProjectVersionMeta(mockProject);
       yield projectMeta;
       queue.push(projectMeta);
@@ -215,6 +225,7 @@ class PlasmicApi {
   async resolveSync(
     projects: {
       projectId: string;
+      branchName: string;
       versionRange: string;
       componentIdOrNames: readonly string[] | undefined;
       projectApiToken?: string;
@@ -248,7 +259,9 @@ class PlasmicApi {
         proj.versionRange
       );
       if (version) {
-        const mockProject = ensure(getMockProject(proj.projectId, version));
+        const mockProject = ensure(
+          getMockProject(proj.projectId, proj.branchName, version)
+        );
         const projectMeta = mockProjectToProjectVersionMeta(
           mockProject,
           proj.componentIdOrNames
@@ -272,6 +285,7 @@ class PlasmicApi {
 
   async projectComponents(
     projectId: string,
+    branchName: string,
     opts: {
       platform: string;
       newCompScheme: "blackbox" | "direct";
@@ -310,6 +324,7 @@ class PlasmicApi {
     }
     const mockComponents = getMockComponents(
       projectId,
+      branchName,
       version,
       componentIdOrNames
     );
@@ -357,11 +372,17 @@ class PlasmicApi {
     throw new Error("Unimplemented");
   }
 
-  async projectStyleTokens(projectId: string): Promise<StyleTokensMap> {
+  async projectStyleTokens(
+    projectId: string,
+    branchName: string
+  ): Promise<StyleTokensMap> {
     throw new Error("Unimplemented");
   }
 
-  async projectIcons(projectId: string): Promise<ProjectIconsResponse> {
+  async projectIcons(
+    projectId: string,
+    branchName: string
+  ): Promise<ProjectIconsResponse> {
     throw new Error("Unimplemented");
   }
 

package/src/__tests__/project-api-token-spec.ts

@@ -145,7 +145,7 @@ describe("Project API tokens", () => {
     // We sync project1 which got updated, but the dependency is still same version.
     opts.force = false;
     removeAuth();
-    mockApi.getMockProject("projectId1", "1.2.3").version = "1.2.4";
+    mockApi.getMockProject("projectId1", "main", "1.2.3").version = "1.2.4";
     await expect(sync(opts)).resolves.toBeUndefined();
   });
 
@@ -196,7 +196,7 @@ describe("Project API tokens", () => {
     // We sync project1 which got updated, but the dependency is still same version.
     opts.force = false;
     removeAuth();
-    mockApi.getMockProject("projectId1", "1.2.3").version = "1.2.4";
+    mockApi.getMockProject("projectId1", "main", "1.2.3").version = "1.2.4";
     await expect(sync(opts)).resolves.toBeUndefined();
   });
 

package/src/__tests__/versioned-sync-spec.ts

@@ -54,7 +54,7 @@ describe("versioned-sync", () => {
     opts.projects = ["projectId1"];
     await expect(sync(opts)).resolves.toBeUndefined();
     // Change component name server-side
-    const mockProject = mockApi.getMockProject("projectId1", "1.2.3");
+    const mockProject = mockApi.getMockProject("projectId1", "main", "1.2.3");
     const buttonData = mockProject.components.find(
       (c: MockComponent) => c.id === "buttonId"
     );
@@ -79,7 +79,7 @@ describe("versioned-sync", () => {
     opts.projects = ["projectId1"];
     await expect(sync(opts)).resolves.toBeUndefined();
     // Change component version server-side
-    const mockProject = mockApi.getMockProject("projectId1", "1.2.3");
+    const mockProject = mockApi.getMockProject("projectId1", "main", "1.2.3");
     mockProject.version = "1.3.4";
     mockApi.addMockProject(mockProject);
     // Try syncing again and see if things show up
@@ -97,7 +97,7 @@ describe("versioned-sync", () => {
     opts.nonRecursive = true;
     await expect(sync(opts)).resolves.toBeUndefined();
     // Change component version server-side
-    const mockProject = mockApi.getMockProject("projectId1", "1.2.3");
+    const mockProject = mockApi.getMockProject("projectId1", "main", "1.2.3");
     mockProject.version = "2.0.0";
     mockApi.addMockProject(mockProject);
     // Read in updated plasmic.json post-sync
@@ -125,7 +125,7 @@ describe("versioned-sync", () => {
     opts.nonRecursive = true;
     await expect(sync(opts)).resolves.toBeUndefined();
     // Change component version server-side
-    const mockProject = mockApi.getMockProject("projectId1", "1.2.3");
+    const mockProject = mockApi.getMockProject("projectId1", "main", "1.2.3");
     mockProject.version = "1.10.1";
     mockApi.addMockProject(mockProject);
     // Update plasmic.json to use semver

package/src/actions/project-token.ts

@@ -18,7 +18,7 @@ export const getProjectApiToken = async (projectId: string, host?: string) => {
   if (auth) {
     const api = new PlasmicApi(auth);
     const versionResolution = await api.resolveSync([
-      { projectId, componentIdOrNames: undefined },
+      { projectId, branchName: "main", componentIdOrNames: undefined },
     ]);
     return versionResolution.projects[0]?.projectApiToken;
   }

package/src/actions/sync-components.ts

@@ -64,7 +64,12 @@ const updateDirectSkeleton = async (
     compConfig.projectId,
     makeCachedProjectSyncDataProvider(async (projectId, revision) => {
       try {
-        return await context.api.projectSyncMetadata(projectId, revision, true);
+        return await context.api.projectSyncMetadata(
+          projectId,
+          "main",
+          revision,
+          true
+        );
       } catch (e) {
         if (
           e instanceof AppServerError &&

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

@@ -18,10 +18,11 @@ export async function syncGlobalVariants(
   projectMeta: ProjectMetaBundle,
   bundles: GlobalVariantBundle[],
   checksums: ChecksumBundle,
-  baseDir: string,
+  branchName: string,
+  baseDir: string
 ) {
   const projectId = projectMeta.projectId;
-  const projectLock = getOrAddProjectLock(context, projectId);
+  const projectLock = getOrAddProjectLock(context, projectId, branchName);
   const existingVariantConfigs = L.keyBy(
     context.config.globalVariants.variantGroups.filter(
       (group) => group.projectId === projectId
@@ -100,7 +101,11 @@ export async function syncGlobalVariants(
     await writeFileContent(
       context,
       variantConfig.contextFilePath,
-      formatAsLocal(bundle.contextModule, variantConfig.contextFilePath, baseDir),
+      formatAsLocal(
+        bundle.contextModule,
+        variantConfig.contextFilePath,
+        baseDir
+      ),
       { force: !isNew }
     );
   }

package/src/actions/sync-icons.ts

@@ -25,17 +25,18 @@ export interface SyncIconsArgs extends CommonArgs {
 export async function syncProjectIconAssets(
   context: PlasmicContext,
   projectId: string,
+  branchName: string,
   version: string,
   iconBundles: IconBundle[],
   checksums: ChecksumBundle,
-  baseDir: string,
+  baseDir: string
 ) {
   const project = getOrAddProjectConfig(context, projectId);
   if (!project.icons) {
     project.icons = [];
   }
 
-  const projectLock = getOrAddProjectLock(context, projectId);
+  const projectLock = getOrAddProjectLock(context, projectId, branchName);
   const knownIconConfigs = L.keyBy(project.icons, (i) => i.id);
   const iconFileLocks = L.keyBy(
     projectLock.fileLocks.filter((fileLock) => fileLock.type === "icon"),

package/src/actions/sync-images.ts

@@ -22,12 +22,13 @@ import { ensure } from "../utils/lang-utils";
 export async function syncProjectImageAssets(
   context: PlasmicContext,
   projectId: string,
+  branchName: string,
   version: string,
   imageBundles: ImageBundle[],
   checksums: ChecksumBundle
 ) {
   const project = getOrAddProjectConfig(context, projectId);
-  const projectLock = getOrAddProjectLock(context, projectId);
+  const projectLock = getOrAddProjectLock(context, projectId, branchName);
   const knownImageConfigs = L.keyBy(project.images, (i) => i.id);
   const imageBundleIds = L.keyBy(imageBundles, (i) => i.id);
   const imageFileLocks = L.keyBy(

package/src/actions/sync.ts

@@ -243,6 +243,7 @@ export async function sync(
     const [projectId, projectApiToken] = projectIdToken.split(":");
     return {
       projectId,
+      branchName: projectConfigMap[projectId]?.projectBranchName ?? "main",
       versionRange:
         versionRange || projectConfigMap[projectId]?.version || "latest",
       componentIdOrNames: undefined, // Get all components!
@@ -255,6 +256,7 @@ export async function sync(
     ? projectWithVersion
     : context.config.projects.map((p) => ({
         projectId: p.projectId,
+        branchName: p.projectBranchName ?? "main",
         versionRange: p.version,
         componentIdOrNames: undefined, // Get all components!
         projectApiToken: p.projectApiToken,
@@ -341,6 +343,7 @@ export async function sync(
         opts,
         projectIdsAndTokens,
         projectMeta.projectId,
+        projectMeta.branchName,
         projectMeta.componentIds,
         projectMeta.version,
         projectMeta.dependencies,
@@ -557,6 +560,7 @@ async function syncProject(
   opts: SyncArgs,
   projectIdsAndTokens: ProjectIdAndToken[],
   projectId: string,
+  branchName: string,
   componentIds: string[],
   projectVersion: string,
   dependencies: { [projectId: string]: string },
@@ -591,26 +595,30 @@ async function syncProject(
   );
 
   // Server-side code-gen
-  const projectBundle = await context.api.projectComponents(projectId, {
-    platform: context.config.platform,
-    newCompScheme: newComponentScheme,
-    existingCompScheme,
-    componentIdOrNames: componentIds,
-    version: projectVersion,
-    imageOpts: context.config.images,
-    stylesOpts: context.config.style,
-    checksums: existingChecksums,
-    codeOpts: context.config.code,
-    metadata: generateMetadata(
-      {
-        ...metadataDefaults,
-        platform: context.config.platform,
-      },
-      opts.metadata
-    ),
-    indirect,
-    wrapPagesWithGlobalContexts: context.config.wrapPagesWithGlobalContexts,
-  });
+  const projectBundle = await context.api.projectComponents(
+    projectId,
+    branchName,
+    {
+      platform: context.config.platform,
+      newCompScheme: newComponentScheme,
+      existingCompScheme,
+      componentIdOrNames: componentIds,
+      version: projectVersion,
+      imageOpts: context.config.images,
+      stylesOpts: context.config.style,
+      checksums: existingChecksums,
+      codeOpts: context.config.code,
+      metadata: generateMetadata(
+        {
+          ...metadataDefaults,
+          platform: context.config.platform,
+        },
+        opts.metadata
+      ),
+      indirect,
+      wrapPagesWithGlobalContexts: context.config.wrapPagesWithGlobalContexts,
+    }
+  );
 
   // Convert from TSX => JSX
   if (context.config.code.lang === "js") {
@@ -653,6 +661,7 @@ async function syncProject(
     projectBundle.projectConfig,
     projectBundle.globalVariants,
     projectBundle.checksums,
+    branchName,
     opts.baseDir
   );
 
@@ -660,6 +669,7 @@ async function syncProject(
     context,
     projectBundle.projectConfig,
     projectApiToken,
+    branchName,
     projectVersion,
     dependencies,
     projectBundle.components,
@@ -680,6 +690,7 @@ async function syncProject(
   await syncProjectIconAssets(
     context,
     projectId,
+    branchName,
     projectVersion,
     projectBundle.iconAssets,
     projectBundle.checksums,
@@ -688,6 +699,7 @@ async function syncProject(
   await syncProjectImageAssets(
     context,
     projectId,
+    branchName,
     projectVersion,
     projectBundle.imageAssets,
     projectBundle.checksums
@@ -720,6 +732,7 @@ async function syncProjectConfig(
   context: PlasmicContext,
   projectBundle: ProjectMetaBundle,
   projectApiToken: string,
+  branchName: string,
   version: string,
   dependencies: { [projectId: string]: string },
   componentBundles: ComponentBundle[],
@@ -760,7 +773,11 @@ async function syncProjectConfig(
   }
 
   // plasmic.lock
-  const projectLock = getOrAddProjectLock(context, projectConfig.projectId);
+  const projectLock = getOrAddProjectLock(
+    context,
+    projectConfig.projectId,
+    branchName
+  );
   projectLock.version = version;
   projectLock.dependencies = dependencies;
   projectLock.lang = context.config.code.lang;

package/src/api.ts

@@ -1,6 +1,6 @@
 import { ProjectSyncMetadataModel } from "@plasmicapp/code-merger";
 import axios, { AxiosError } from "axios";
-import socketio from "socket.io-client";
+import socketio, { Socket } from "socket.io-client";
 import {
   AuthConfig,
   CodeConfig,
@@ -75,6 +75,7 @@ export interface ImageBundle {
 
 export interface ProjectVersionMeta {
   projectId: string;
+  branchName: string;
   projectApiToken: string;
   version: string;
   projectName: string;
@@ -201,6 +202,7 @@ export class PlasmicApi {
   async resolveSync(
     projects: {
       projectId: string;
+      branchName: string;
       versionRange?: string;
       componentIdOrNames: readonly string[] | undefined;
       projectApiToken?: string;
@@ -243,9 +245,10 @@ export class PlasmicApi {
 
   /**
    * Code-gen endpoint.
-   * This will fetch components at an exact specified version.
+   * This will fetch components from a given branch at an exact specified version.
    * If you don't know what version should be used, call `resolveSync` first.
    * @param projectId
+   * @param branchName
    * @param cliVersion
    * @param reactWebVersion
    * @param newCompScheme
@@ -255,6 +258,7 @@ export class PlasmicApi {
    */
   async projectComponents(
     projectId: string,
+    branchName: string,
     opts: {
       platform: string;
       newCompScheme: "blackbox" | "direct";
@@ -272,7 +276,7 @@ export class PlasmicApi {
     }
   ): Promise<ProjectBundle> {
     const result = await this.post(
-      `${this.codegenHost}/api/v1/projects/${projectId}/code/components`,
+      `${this.codegenHost}/api/v1/projects/${projectId}/code/components?branchName=${branchName}`,
       {
         ...opts,
       }
@@ -345,10 +349,11 @@ export class PlasmicApi {
 
   async projectStyleTokens(
     projectId: string,
+    branchName: string,
     versionRange?: string
   ): Promise<StyleTokensMap> {
     const result = await this.post(
-      `${this.codegenHost}/api/v1/projects/${projectId}/code/tokens`,
+      `${this.codegenHost}/api/v1/projects/${projectId}/code/tokens?branchName=${branchName}`,
       { versionRange }
     );
     return result.data as StyleTokensMap;
@@ -356,11 +361,12 @@ export class PlasmicApi {
 
   async projectIcons(
     projectId: string,
+    branchName: string,
     versionRange?: string,
     iconIds?: string[]
   ): Promise<ProjectIconsResponse> {
     const result = await this.post(
-      `${this.codegenHost}/api/v1/projects/${projectId}/code/icons`,
+      `${this.codegenHost}/api/v1/projects/${projectId}/code/icons?branchName=${branchName}`,
       { versionRange, iconIds }
     );
     return result.data as ProjectIconsResponse;
@@ -368,19 +374,20 @@ export class PlasmicApi {
 
   async projectSyncMetadata(
     projectId: string,
+    branchName: string,
     revision: number,
     rethrowAppError: boolean
   ): Promise<ProjectSyncMetadataModel> {
     const result = await this.post(
-      `${this.codegenHost}/api/v1/projects/${projectId}/code/project-sync-metadata`,
+      `${this.codegenHost}/api/v1/projects/${projectId}/code/project-sync-metadata?branchName=${branchName}`,
       { revision },
       rethrowAppError
     );
     return ProjectSyncMetadataModel.fromJson(result.data);
   }
 
-  connectSocket(): SocketIOClient.Socket {
-    const socket = socketio.connect(this.studioHost, {
+  connectSocket(): Socket {
+    const socket = socketio(this.studioHost, {
       path: `/api/v1/socket`,
       transportOptions: {
         polling: {

package/src/test-common/fixtures.ts

@@ -43,6 +43,7 @@ export function standardTestSetup(includeDep = true) {
   // Setup server-side mock data
   const project1: MockProject = {
     projectId: "projectId1",
+    branchName: "main",
     projectApiToken: "abc",
     version: "1.2.3",
     projectName: "project1",
@@ -64,6 +65,7 @@ export function standardTestSetup(includeDep = true) {
   };
   const dependency: MockProject = {
     projectId: "dependencyId1",
+    branchName: "main",
     projectApiToken: "def",
     version: "2.3.4",
     projectName: "dependency1",
@@ -128,6 +130,7 @@ export function expectProject1Components() {
 export const project1Config: ProjectConfig = {
   projectId: "projectId1",
   projectName: "Project 1",
+  projectBranchName: "main",
   version: "latest",
   cssFilePath: "plasmic/PP__demo.css",
   components: [

package/src/utils/auth-utils.ts

@@ -38,7 +38,7 @@ export function authByPolling(
   host: string,
   initToken: string
 ): CancellablePromise<AuthData> {
-  const socket = socketio.connect(host, {
+  const socket = socketio(host, {
     path: `/api/v1/init-token`,
     transportOptions: {
       polling: {
@@ -50,7 +50,7 @@ export function authByPolling(
   });
 
   const promise = new Promise<AuthData>((resolve, reject) => {
-    socket.on("connect", (reason: string) => {
+    socket.on("connect", () => {
       logger.info("Waiting for token...");
     });
 
@@ -219,7 +219,7 @@ export async function getCurrentAuth(authPath?: string) {
     await api.getCurrentUser();
     return auth;
   } catch (e) {
-    if (e.response?.status === 401) {
+    if ((e as any).response?.status === 401) {
       logger.error(`The current credentials expired or are not valid.`);
       return undefined;
     }

package/src/utils/config-utils.ts

@@ -155,6 +155,8 @@ export interface ProjectConfig {
   projectApiToken?: string;
   /** Project name synced down from Studio */
   projectName: string;
+  /** Project branch to be synced */
+  projectBranchName?: string;
   /**
    * A version range for syncing this project. Can be:
    * * "latest" - always syncs down whatever has been saved in the project.
@@ -317,6 +319,7 @@ export interface FileLock {
 
 export interface ProjectLock {
   projectId: string;
+  branchName: string;
   // The exact version that was last synced
   version: string;
   dependencies: {
@@ -550,6 +553,7 @@ export function getOrAddProjectConfig(
 export function getOrAddProjectLock(
   context: PlasmicContext,
   projectId: string,
+  branchName: string,
   base?: ProjectLock // if one doesn't exist, start with this
 ): ProjectLock {
   let project = context.lock.projects.find((p) => p.projectId === projectId);
@@ -558,6 +562,7 @@ export function getOrAddProjectLock(
       ? L.cloneDeep(base)
       : {
           projectId,
+          branchName,
           version: "",
           dependencies: {},
           lang: context.config.code.lang,