@plasmicapp/cli 0.1.174 → 0.1.177

package/dist/actions/localization-strings.d.ts

@@ -0,0 +1,8 @@
+export interface LocalizationStringsArgs {
+    host: string;
+    projects: readonly string[];
+    format: "po" | "json" | "lingui";
+    output: string;
+    forceOverwrite: boolean;
+}
+export declare function localizationStrings(opts: LocalizationStringsArgs): Promise<void>;

package/dist/actions/localization-strings.js

@@ -0,0 +1,56 @@
+"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.localizationStrings = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const api_1 = require("../api");
+const deps_1 = require("../deps");
+const lib_1 = require("../lib");
+const auth_utils_1 = require("../utils/auth-utils");
+const config_utils_1 = require("../utils/config-utils");
+const file_utils_1 = require("../utils/file-utils");
+const user_utils_1 = require("../utils/user-utils");
+function localizationStrings(opts) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!opts.projects || opts.projects.length === 0) {
+            throw new lib_1.HandledError(`Missing projects.`);
+        }
+        const output = !opts.output
+            ? opts.format === "po"
+                ? "data.po"
+                : "data.json"
+            : opts.output;
+        const auth = yield auth_utils_1.getOrStartAuth({
+            baseDir: "",
+            host: opts.host || config_utils_1.DEFAULT_HOST,
+        });
+        if (auth) {
+            const api = new api_1.PlasmicApi(auth);
+            deps_1.logger.info(`Generating localization strings for ${chalk_1.default.bold(opts.projects.join(", "))}...`);
+            const data = yield api.genLocalizationStrings(opts.projects, opts.format);
+            if (file_utils_1.existsBuffered(output)) {
+                const overwrite = yield user_utils_1.confirmWithUser(`File ${output} already exists. Do you want to overwrite?`, opts.forceOverwrite);
+                if (!overwrite) {
+                    throw new lib_1.HandledError(`Cannot write to ${output}; file already exists.`);
+                }
+            }
+            file_utils_1.writeFileText(output, data);
+            deps_1.logger.info(`Localization strings have been written to ${output}`);
+        }
+        else {
+            deps_1.logger.error("Missing auth information");
+        }
+    });
+}
+exports.localizationStrings = localizationStrings;

package/dist/actions/sync.js

@@ -353,6 +353,7 @@ function syncProject(context, opts, projectIdsAndTokens, projectId, componentIds
             codeOpts: context.config.code,
             metadata: get_context_1.generateMetadata(Object.assign(Object.assign({}, metadataDefaults), { platform: context.config.platform }), opts.metadata),
             indirect,
+            wrapPagesWithGlobalContexts: context.config.wrapPagesWithGlobalContexts,
         });
         // Convert from TSX => JSX
         if (context.config.code.lang === "js") {

package/dist/api.d.ts

@@ -184,15 +184,18 @@ export declare class PlasmicApi {
         codeOpts: CodeConfig;
         checksums: ChecksumBundle;
         indirect: boolean;
+        wrapPagesWithGlobalContexts: boolean;
         metadata?: Metadata;
     }): Promise<ProjectBundle>;
     projectMeta(projectId: string): Promise<ProjectMetaInfo>;
+    genLocalizationStrings(projects: readonly string[], format: "po" | "json" | "lingui"): Promise<string>;
     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>;
     projectSyncMetadata(projectId: string, revision: number, rethrowAppError: boolean): Promise<ProjectSyncMetadataModel>;
     connectSocket(): SocketIOClient.Socket;
     private post;
+    private get;
     private makeErrorMessage;
     private makeHeaders;
     private projectIdsAndTokens?;

package/dist/api.js

@@ -99,6 +99,14 @@ class PlasmicApi {
             return result.data;
         });
     }
+    genLocalizationStrings(projects, format) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.get(`${this.codegenHost}/api/v1/localization/gen-texts?format=${format}&preview=true&${projects
+                .map((p) => `projectId=${p}`)
+                .join("&")}`);
+            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`, {
@@ -168,6 +176,26 @@ class PlasmicApi {
             }
         });
     }
+    get(url, rethrowAppError) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield axios_1.default.get(url, {
+                    headers: this.makeHeaders(),
+                });
+            }
+            catch (e) {
+                const error = e;
+                const errorMsg = this.makeErrorMessage(error);
+                if (rethrowAppError) {
+                    throw new AppServerError(errorMsg);
+                }
+                if (!errorMsg) {
+                    throw e;
+                }
+                throw new error_1.HandledError(errorMsg);
+            }
+        });
+    }
     makeErrorMessage(error) {
         var _a, _b;
         const response = error.response;

package/dist/index.js

@@ -30,6 +30,7 @@ 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 localization_strings_1 = require("./actions/localization-strings");
 const projectToken = __importStar(require("./actions/project-token"));
 const sync_1 = require("./actions/sync");
 const upload_bundle_1 = require("./actions/upload-bundle");
@@ -186,6 +187,33 @@ yargs_1.default
     type: "string",
     default: "https://studio.plasmic.app",
 }), (argv) => error_1.handleError(projectToken.projectToken(argv)))
+    .command("localization-strings", false, (yargs) => yargs
+    .option("projects", {
+    alias: "p",
+    describe: "One or more projects to generate localization strings, separated by comma. Version constraints can be specified using @. Example: projectid, projectid@>=version",
+    type: "array",
+})
+    .option("host", {
+    describe: "Plasmic host to use",
+    type: "string",
+    default: "https://studio.plasmic.app",
+})
+    .option("format", {
+    describe: 'Output format. Either "json", "po" or "lingui"',
+    type: "string",
+    choices: ["json", "po", "lingui"],
+    default: "json",
+})
+    .option("output", {
+    alias: "o",
+    describe: "Output file",
+    type: "string",
+})
+    .option("force-overwrite", {
+    type: "boolean",
+    describe: "Overwrite the output file.",
+    default: false,
+}), (argv) => error_1.handleError(localization_strings_1.localizationStrings(argv)))
     .demandCommand()
     .strict()
     .help("h")

package/dist/plasmic.schema.json

@@ -458,6 +458,10 @@
         "tokens": {
             "$ref": "#/definitions/TokensConfig",
             "description": "Config for style tokens"
+        },
+        "wrapPagesWithGlobalContexts": {
+            "description": "Wether we should wrap the pages with the project global contexts or not",
+            "type": "boolean"
         }
     },
     "required": [
@@ -469,7 +473,8 @@
         "projects",
         "srcDir",
         "style",
-        "tokens"
+        "tokens",
+        "wrapPagesWithGlobalContexts"
     ],
     "type": "object"
 }

package/dist/test-common/fixtures.js

@@ -32,6 +32,7 @@ exports.defaultPlasmicJson = {
     globalVariants: {
         variantGroups: [],
     },
+    wrapPagesWithGlobalContexts: true,
     cliVersion: "0.1.44",
 };
 function standardTestSetup(includeDep = true) {

package/dist/utils/code-utils.js

@@ -125,7 +125,7 @@ function tryParsePlasmicImportSpec(node) {
     if (!c) {
         return undefined;
     }
-    const m = c.value.match(/plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent))?/);
+    const m = c.value.match(/plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent|globalContext))?/);
     if (m) {
         return { id: m[1], type: m[2] };
     }
@@ -262,6 +262,14 @@ function replaceImports(context, code, fromPath, fixImportContext, removeImportD
                 stmt.source.value = meta.componentImportPath;
             }
         }
+        else if (type === "globalContext") {
+            const projectConfig = fixImportContext.projects[uuid];
+            if (!projectConfig) {
+                throwMissingReference(context, "project", uuid, fromPath);
+            }
+            const realPath = makeImportPath(context, fromPath, projectConfig.globalContextsFilePath, true);
+            stmt.source.value = realPath;
+        }
     });
     if (!changed) {
         return code;
@@ -297,8 +305,10 @@ function makeImportPath(context, fromPath, toPath, stripExt, forceRelative = fal
  * a local file
  */
 function isLocalModulePath(modulePath) {
-    // It is a local file reference if the importPath includes the file extension
-    return !!upath_1.default.extname(modulePath);
+    // It is a local file reference if the importPath includes the file extension, and
+    // modulePath doesn't start with "@" (like an alias by convention, or scoped npm
+    // package). This is not a reliable way to detect scoped npm package, but :shrug:
+    return !!upath_1.default.extname(modulePath) && !modulePath.startsWith("@");
 }
 exports.isLocalModulePath = isLocalModulePath;
 exports.mkFixImportContext = (config) => {

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

@@ -56,6 +56,8 @@ export interface PlasmicConfig {
     globalVariants: GlobalVariantsConfig;
     /** Metadata for each project that has been synced */
     projects: ProjectConfig[];
+    /** Wether we should wrap the pages with the project global contexts or not */
+    wrapPagesWithGlobalContexts: boolean;
     /** The version of cli when this file was written */
     cliVersion?: string;
     /** Arbitrary command to run after `plasmic sync` has run; useful for linting and code formatting synced files */

package/dist/utils/config-utils.js

@@ -70,6 +70,7 @@ exports.DEFAULT_CONFIG = {
     globalVariants: {
         variantGroups: [],
     },
+    wrapPagesWithGlobalContexts: true,
 };
 exports.DEFAULT_PUBLIC_FILES_CONFIG = {
     scheme: "public-files",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plasmicapp/cli",
-  "version": "0.1.174",
+  "version": "0.1.177",
   "description": "plasmic cli for syncing local code with Plasmic designs",
   "engines": {
     "node": ">=12"

package/src/actions/localization-strings.ts

@@ -0,0 +1,57 @@
+import chalk from "chalk";
+import { PlasmicApi } from "../api";
+import { logger } from "../deps";
+import { HandledError } from "../lib";
+import { getOrStartAuth } from "../utils/auth-utils";
+import { DEFAULT_HOST } from "../utils/config-utils";
+import { existsBuffered, writeFileText } from "../utils/file-utils";
+import { confirmWithUser } from "../utils/user-utils";
+
+export interface LocalizationStringsArgs {
+  host: string;
+  projects: readonly string[];
+  format: "po" | "json" | "lingui";
+  output: string;
+  forceOverwrite: boolean;
+}
+
+export async function localizationStrings(
+  opts: LocalizationStringsArgs
+): Promise<void> {
+  if (!opts.projects || opts.projects.length === 0) {
+    throw new HandledError(`Missing projects.`);
+  }
+  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);
+    logger.info(
+      `Generating localization strings for ${chalk.bold(
+        opts.projects.join(", ")
+      )}...`
+    );
+    const data = await api.genLocalizationStrings(opts.projects, opts.format);
+    if (existsBuffered(output)) {
+      const overwrite = await confirmWithUser(
+        `File ${output} already exists. Do you want to overwrite?`,
+        opts.forceOverwrite
+      );
+      if (!overwrite) {
+        throw new HandledError(
+          `Cannot write to ${output}; file already exists.`
+        );
+      }
+    }
+    writeFileText(output, data);
+    logger.info(`Localization strings have been written to ${output}`);
+  } else {
+    logger.error("Missing auth information");
+  }
+}

package/src/actions/sync.ts

@@ -595,6 +595,7 @@ async function syncProject(
       opts.metadata
     ),
     indirect,
+    wrapPagesWithGlobalContexts: context.config.wrapPagesWithGlobalContexts,
   });
 
   // Convert from TSX => JSX

package/src/api.ts

@@ -266,6 +266,7 @@ export class PlasmicApi {
       codeOpts: CodeConfig;
       checksums: ChecksumBundle;
       indirect: boolean;
+      wrapPagesWithGlobalContexts: boolean;
       metadata?: Metadata;
     }
   ): Promise<ProjectBundle> {
@@ -285,6 +286,20 @@ export class PlasmicApi {
     return result.data as ProjectMetaInfo;
   }
 
+  async genLocalizationStrings(
+    projects: readonly string[],
+    format: "po" | "json" | "lingui"
+  ) {
+    const result = await this.get(
+      `${
+        this.codegenHost
+      }/api/v1/localization/gen-texts?format=${format}&preview=true&${projects
+        .map((p) => `projectId=${p}`)
+        .join("&")}`
+    );
+    return result.data as string;
+  }
+
   async uploadBundle(
     projectId: string,
     bundleName: string,
@@ -392,6 +407,27 @@ export class PlasmicApi {
     }
   }
 
+  private async get(url: string, rethrowAppError?: boolean) {
+    try {
+      return await axios.get(url, {
+        headers: this.makeHeaders(),
+      });
+    } catch (e) {
+      const error = e as AxiosError;
+      const errorMsg = this.makeErrorMessage(error);
+
+      if (rethrowAppError) {
+        throw new AppServerError(errorMsg);
+      }
+
+      if (!errorMsg) {
+        throw e;
+      }
+
+      throw new HandledError(errorMsg);
+    }
+  }
+
   private makeErrorMessage(error: AxiosError) {
     const response = error.response;
     if (!response) {

package/src/index.ts

@@ -6,6 +6,10 @@ 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 {
+  localizationStrings,
+  LocalizationStringsArgs,
+} from "./actions/localization-strings";
 import * as projectToken from "./actions/project-token";
 import { sync, SyncArgs } from "./actions/sync";
 import { UploadBundleArgs, uploadJsBundle } from "./actions/upload-bundle";
@@ -226,6 +230,40 @@ yargs
         }),
     (argv) => handleError(projectToken.projectToken(argv))
   )
+  .command<LocalizationStringsArgs>(
+    "localization-strings",
+    false,
+    (yargs) =>
+      yargs
+        .option("projects", {
+          alias: "p",
+          describe:
+            "One or more projects to generate localization strings, separated by comma. Version constraints can be specified using @. Example: projectid, projectid@>=version",
+          type: "array",
+        })
+        .option("host", {
+          describe: "Plasmic host to use",
+          type: "string",
+          default: "https://studio.plasmic.app",
+        })
+        .option("format", {
+          describe: 'Output format. Either "json", "po" or "lingui"',
+          type: "string",
+          choices: ["json", "po", "lingui"],
+          default: "json",
+        })
+        .option("output", {
+          alias: "o",
+          describe: "Output file",
+          type: "string",
+        })
+        .option("force-overwrite", {
+          type: "boolean",
+          describe: "Overwrite the output file.",
+          default: false,
+        }),
+    (argv) => handleError(localizationStrings(argv))
+  )
   .demandCommand()
   .strict()
   .help("h")

package/src/test-common/fixtures.ts

@@ -34,6 +34,7 @@ export const defaultPlasmicJson: PlasmicConfig = {
   globalVariants: {
     variantGroups: [],
   },
+  wrapPagesWithGlobalContexts: true,
   cliVersion: "0.1.44",
 };
 export function standardTestSetup(includeDep = true) {

package/src/utils/code-utils.ts

@@ -156,6 +156,7 @@ type PlasmicImportType =
   | "picture"
   | "jsBundle"
   | "codeComponent"
+  | "globalContext"
   | undefined;
 
 function tryParsePlasmicImportSpec(node: ImportDeclaration) {
@@ -164,7 +165,7 @@ function tryParsePlasmicImportSpec(node: ImportDeclaration) {
     return undefined;
   }
   const m = c.value.match(
-    /plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent))?/
+    /plasmic-import:\s+([\w-]+)(?:\/(component|css|render|globalVariant|projectcss|defaultcss|icon|picture|jsBundle|codeComponent|globalContext))?/
   );
   if (m) {
     return { id: m[1], type: m[2] as PlasmicImportType } as PlasmicImportSpec;
@@ -337,6 +338,18 @@ export function replaceImports(
         // npm package
         stmt.source.value = meta.componentImportPath;
       }
+    } else if (type === "globalContext") {
+      const projectConfig = fixImportContext.projects[uuid];
+      if (!projectConfig) {
+        throwMissingReference(context, "project", uuid, fromPath);
+      }
+      const realPath = makeImportPath(
+        context,
+        fromPath,
+        projectConfig.globalContextsFilePath,
+        true
+      );
+      stmt.source.value = realPath;
     }
   });
 
@@ -392,8 +405,10 @@ function makeImportPath(
  * a local file
  */
 export function isLocalModulePath(modulePath: string) {
-  // It is a local file reference if the importPath includes the file extension
-  return !!path.extname(modulePath);
+  // It is a local file reference if the importPath includes the file extension, and
+  // modulePath doesn't start with "@" (like an alias by convention, or scoped npm
+  // package). This is not a reliable way to detect scoped npm package, but :shrug:
+  return !!path.extname(modulePath) && !modulePath.startsWith("@");
 }
 
 export interface ComponentUpdateSummary {

package/src/utils/config-utils.ts

@@ -85,6 +85,9 @@ export interface PlasmicConfig {
   /** Metadata for each project that has been synced */
   projects: ProjectConfig[];
 
+  /** Wether we should wrap the pages with the project global contexts or not */
+  wrapPagesWithGlobalContexts: boolean;
+
   /** The version of cli when this file was written */
   cliVersion?: string;
 
@@ -411,6 +414,7 @@ export const DEFAULT_CONFIG: PlasmicConfig = {
   globalVariants: {
     variantGroups: [],
   },
+  wrapPagesWithGlobalContexts: true,
 };
 
 export const DEFAULT_PUBLIC_FILES_CONFIG: ImagesConfig = {