@plasmicapp/cli 0.1.186 → 0.1.188

package/dist/index.js

@@ -213,6 +213,11 @@ yargs_1.default
     type: "boolean",
     describe: "Overwrite the output file.",
     default: false,
+})
+    .option("project-tokens", {
+    type: "array",
+    default: [],
+    describe: "(Optional) List of project API tokens to be used for auth, in the format PROJECT_ID:PROJECT_API_TOKEN (the pairs should be separated by comma)",
 }), (argv) => error_1.handleError(localization_strings_1.localizationStrings(argv)))
     .demandCommand()
     .strict()

package/dist/plasmic.schema.json

@@ -314,6 +314,10 @@
                     "description": "Project API token. Grants read-only sync access to just this specific project and its dependencies.",
                     "type": "string"
                 },
+                "projectBranchName": {
+                    "description": "Project branch to be synced",
+                    "type": "string"
+                },
                 "projectId": {
                     "description": "Project ID",
                     "type": "string"

package/dist/test-common/fixtures.js

@@ -40,6 +40,7 @@ function standardTestSetup(includeDep = true) {
     // Setup server-side mock data
     const project1 = {
         projectId: "projectId1",
+        branchName: "main",
         projectApiToken: "abc",
         version: "1.2.3",
         projectName: "project1",
@@ -61,6 +62,7 @@ function standardTestSetup(includeDep = true) {
     };
     const dependency = {
         projectId: "dependencyId1",
+        branchName: "main",
         projectApiToken: "def",
         version: "2.3.4",
         projectName: "dependency1",
@@ -119,6 +121,7 @@ exports.expectProject1Components = expectProject1Components;
 exports.project1Config = {
     projectId: "projectId1",
     projectName: "Project 1",
+    projectBranchName: "main",
     version: "latest",
     cssFilePath: "plasmic/PP__demo.css",
     components: [

package/dist/utils/auth-utils.js

@@ -26,7 +26,7 @@ const error_1 = require("../utils/error");
 const config_utils_1 = require("./config-utils");
 const file_utils_1 = require("./file-utils");
 function authByPolling(host, initToken) {
-    const socket = socket_io_client_1.default.connect(host, {
+    const socket = socket_io_client_1.default(host, {
         path: `/api/v1/init-token`,
         transportOptions: {
             polling: {
@@ -37,7 +37,7 @@ function authByPolling(host, initToken) {
         },
     });
     const promise = new Promise((resolve, reject) => {
-        socket.on("connect", (reason) => {
+        socket.on("connect", () => {
             deps_1.logger.info("Waiting for token...");
         });
         socket.on("token", (data) => {

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

@@ -112,6 +112,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.
@@ -224,6 +226,7 @@ export interface FileLock {
 }
 export interface ProjectLock {
     projectId: string;
+    branchName: string;
     version: string;
     dependencies: {
         [projectId: string]: string;
@@ -279,5 +282,5 @@ export declare function writeConfig(configFile: string, config: PlasmicConfig, b
 export declare function writeLock(lockFile: string, lock: PlasmicLock, baseDir: string): Promise<void>;
 export declare function updateConfig(context: PlasmicContext, newConfig: PlasmicConfig, baseDir: string): Promise<void>;
 export declare function getOrAddProjectConfig(context: PlasmicContext, projectId: string, base?: ProjectConfig): ProjectConfig;
-export declare function getOrAddProjectLock(context: PlasmicContext, projectId: string, base?: ProjectLock): ProjectLock;
+export declare function getOrAddProjectLock(context: PlasmicContext, projectId: string, branchName: string, base?: ProjectLock): ProjectLock;
 export declare function isPageAwarePlatform(platform: string): boolean;

package/dist/utils/config-utils.js

@@ -159,7 +159,7 @@ function getOrAddProjectConfig(context, projectId, base // if one doesn't exist,
     return project;
 }
 exports.getOrAddProjectConfig = getOrAddProjectConfig;
-function getOrAddProjectLock(context, projectId, base // if one doesn't exist, start with this
+function getOrAddProjectLock(context, projectId, branchName, base // if one doesn't exist, start with this
 ) {
     let project = context.lock.projects.find((p) => p.projectId === projectId);
     if (!project) {
@@ -167,6 +167,7 @@ function getOrAddProjectLock(context, projectId, base // if one doesn't exist, s
             ? lodash_1.default.cloneDeep(base)
             : {
                 projectId,
+                branchName,
                 version: "",
                 dependencies: {},
                 lang: context.config.code.lang,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.186",
+  "version": "0.1.188",
   "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/localization-strings.ts

@@ -1,15 +1,23 @@
 import chalk from "chalk";
-import { PlasmicApi } from "../api";
+import { pick } from "lodash";
+import { CommonArgs } from "..";
+import { PlasmicApi, ProjectIdAndToken } from "../api";
 import { logger } from "../deps";
 import { HandledError } from "../lib";
-import { getOrStartAuth } from "../utils/auth-utils";
-import { DEFAULT_HOST } from "../utils/config-utils";
+import { getCurrentAuth, getOrStartAuth } from "../utils/auth-utils";
+import {
+  DEFAULT_HOST,
+  findConfigFile,
+  PlasmicContext,
+} from "../utils/config-utils";
 import { existsBuffered, writeFileText } from "../utils/file-utils";
+import { getContext } from "../utils/get-context";
 import { confirmWithUser } from "../utils/user-utils";
 
-export interface LocalizationStringsArgs {
+export interface LocalizationStringsArgs extends CommonArgs {
   host: string;
   projects: readonly string[];
+  projectTokens?: readonly string[];
   format: "po" | "json" | "lingui";
   output: string;
   forceOverwrite: boolean;
@@ -21,23 +29,60 @@ export async function localizationStrings(
   if (!opts.projects || opts.projects.length === 0) {
     throw new HandledError(`Missing projects.`);
   }
+  if (!opts.baseDir) opts.baseDir = process.cwd();
+  const parsedProjectTokens: ProjectIdAndToken[] = (
+    opts.projectTokens ?? []
+  ).map((val) => {
+    const [projectId, projectApiToken] = val.split(":");
+    if (!projectId || !projectApiToken) {
+      throw new Error(
+        `Invalid value passed to '--project-tokens': ${val}\nPlease provide the API tokens with the format PROJECT_ID:PROJECT_API_TOKEN`
+      );
+    }
+    return {
+      projectId: projectId.trim(),
+      projectApiToken: projectApiToken.trim(),
+    };
+  });
   const output = !opts.output
     ? opts.format === "po"
       ? "data.po"
       : "data.json"
     : opts.output;
-  const auth = await getOrStartAuth({
-    baseDir: "",
-    host: opts.host || DEFAULT_HOST,
-  });
-  if (auth) {
-    const api = new PlasmicApi(auth);
+  const projectTokensFromConfig: ProjectIdAndToken[] = [];
+  const auth = await getCurrentAuth(opts.auth);
+  const maybeConfigFile =
+    opts.config || findConfigFile(opts.baseDir, { traverseParents: true });
+  if (maybeConfigFile) {
+    const context = await getContext(opts, { enableSkipAuth: true });
+    context.config.projects.forEach((p) => {
+      projectTokensFromConfig.push(pick(p, "projectId", "projectApiToken"));
+    });
+  }
+
+  const projectIdsAndTokens = [
+    ...parsedProjectTokens,
+    ...projectTokensFromConfig,
+  ].filter((v) => !!v && !!v.projectId && !!v.projectApiToken);
+
+  if (auth || projectIdsAndTokens.length > 0) {
+    const api = new PlasmicApi(
+      auth ?? {
+        host: DEFAULT_HOST,
+        user: "",
+        token: "",
+      }
+    );
     logger.info(
       `Generating localization strings for ${chalk.bold(
         opts.projects.join(", ")
       )}...`
     );
-    const data = await api.genLocalizationStrings(opts.projects, opts.format);
+    const data = await api.genLocalizationStrings(
+      opts.projects,
+      opts.format,
+      projectIdsAndTokens
+    );
     if (existsBuffered(output)) {
       const overwrite = await confirmWithUser(
         `File ${output} already exists. Do you want to overwrite?`,
@@ -52,6 +97,9 @@ export async function localizationStrings(
     writeFileText(output, data);
     logger.info(`Localization strings have been written to ${output}`);
   } else {
-    logger.error("Missing auth information");
+    logger.error(`Missing auth information. You can follow any of the steps below to fix it:
+- Run 'plasmic auth'
+- Provide the project API token to 'plasmic.json'
+- Or provide the project API token through '--project-tokens' flag`);
   }
 }

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-styles.ts

@@ -9,7 +9,8 @@ import {
 
 export async function upsertStyleTokens(
   context: PlasmicContext,
-  newStyleMap: StyleTokensMap
+  newStyleMap: StyleTokensMap,
+  projectId: string
 ) {
   const curStyleMap = await readCurStyleMap(context);
   for (const prop of newStyleMap.props) {
@@ -22,6 +23,19 @@ export async function upsertStyleTokens(
       curStyleMap.props.push(prop);
     }
   }
+  const allNewPropIds = new Set(newStyleMap.props.map((prop) => prop.meta.id));
+  curStyleMap.props = curStyleMap.props.filter((prop) => {
+    if (prop.meta.projectId !== projectId) {
+      // Keep all tokens from other projects
+      return true;
+    }
+    if (allNewPropIds.has(prop.meta.id)) {
+      // Keep the current tokens in this project
+      return true;
+    }
+    // Delete the tokens that have been removed from the project
+    return false;
+  });
   curStyleMap.props.sort((prop1, prop2) =>
     prop1.name === prop2.name ? 0 : prop1.name < prop2.name ? -1 : 1
   );