@solana-mobile/dapp-store-cli 0.2.0 → 0.4.0

package/src/utils.ts

@@ -1,5 +1,5 @@
 import fs from "fs";
-import type { AndroidDetails, App, Publisher, Release } from "@solana-mobile/dapp-store-publishing-tools";
+import type { AndroidDetails, App, Publisher, Release, ReleaseJsonMetadata } from "@solana-mobile/dapp-store-publishing-tools";
 import type { Connection } from "@solana/web3.js";
 import { Keypair, PublicKey } from "@solana/web3.js";
 import type { CLIConfig } from "./config/index.js";
@@ -22,7 +22,7 @@ const runImgSize = util.promisify(imageSize);
 const runExec = util.promisify(exec);
 
 export class Constants {
-  static CLI_VERSION = "0.2.0";
+  static CLI_VERSION = "0.4.0";
   static CONFIG_FILE_NAME = "config.yaml";
 }
 
@@ -58,9 +58,12 @@ export const parseKeypair = (pathToKeypairFile: string) => {
     const keypairFile = fs.readFileSync(pathToKeypairFile, "utf-8");
     return Keypair.fromSecretKey(Buffer.from(JSON.parse(keypairFile)));
   } catch (e) {
-    console.error(
-      `Something went wrong when attempting to retrieve the keypair at ${pathToKeypairFile}`
-    );
+    showMessage
+    (
+      "KeyPair Error",
+      "Something went wrong when attempting to retrieve the keypair at " + pathToKeypairFile,
+      "error"
+    )
   }
 };
 
@@ -71,11 +74,10 @@ const AaptPrefixes = {
   verCodePrefix: "versionCode=",
   verNamePrefix: "versionName=",
   sdkPrefix: "sdkVersion:",
-  permissionPrefix: "uses-permission: name=",
   localePrefix: "locales: ",
 };
 
-export const getConfigFile = async (
+export const  getConfigWithChecks = async (
   buildToolsDir: string | null = null
 ): Promise<CLIConfig> => {
   const configFilePath = `${process.cwd()}/${Constants.CONFIG_FILE_NAME}`;
@@ -142,6 +144,17 @@ export const getConfigFile = async (
     }
   });
 
+  validateLocalizableResources(config);
+
+  const googlePkg = config.solana_mobile_dapp_publisher_portal.google_store_package;
+  if (googlePkg?.length) {
+    const pkgCompare = new RegExp("[a-zA-Z0-9_]+(\\.[a-zA-Z0-9_]+)+").exec(googlePkg);
+
+    if (!pkgCompare?.length) {
+      throw new Error("Please provide a valid Google store package name in the Publisher Portal section of your configuration file.");
+    }
+  }
+
   return config;
 };
 
@@ -165,6 +178,33 @@ const checkImageExtension = (uri: string): boolean => {
   );
 };
 
+/**
+ * We need to pre-check some things in the localized resources before we move forward
+ */
+const validateLocalizableResources = (config: CLIConfig) => {
+  if (!config.release.catalog["en-US"]) {
+    throw new Error("Please ensure you have the en-US locale strings in your configuration file.");
+  }
+
+  const baselineSize = Object.keys(config.release.catalog["en-US"]).length;
+  Object.keys(config.release.catalog).forEach((locale) => {
+    const size = Object.keys(config.release.catalog[locale]).length;
+
+    if (size != baselineSize) {
+      throw new Error("Please ensure you have included all localized strings for all locales in your configuration file.");
+    }
+  });
+
+  const descsWrongLength = Object.values(config.release.catalog)
+    .map((x) => x.short_description)
+    .filter((desc) => !desc?.length || desc.length > 50);
+
+  if (descsWrongLength.length > 0) {
+    throw new Error("Please ensure all translations of short_description are between 0 and 50 characters");
+  }
+};
+
+
 export const isDevnet = (rpcUrl: string): boolean => {
   return rpcUrl.indexOf("devnet") != -1;
 };
@@ -196,17 +236,27 @@ export const generateNetworkSuffix = (rpcUrl: string): string => {
 export const showMessage = (
   titleMessage = "",
   contentMessage = "",
-  isError = false
-) => {
-  console.log(boxen(contentMessage, {
+  type: "standard" | "error" | "warning" = "standard",
+): string => {
+  let color = "cyan";
+  if (type == "error") {
+    color = "redBright";
+  } else if (type == "warning") {
+    color = "yellow";
+  }
+
+  const msg = boxen(contentMessage, {
     title: titleMessage,
     padding: 1,
     margin: 1,
     borderStyle: 'single',
-    borderColor: isError ? "redBright" : "cyan",
+    borderColor: color,
     textAlignment: "left",
-    titleAlignment: "center"
-  }));
+    titleAlignment: "center",
+  });
+
+  console.log(msg);
+  return msg;
 };
 
 const checkIconDimensions = async (iconPath: string): Promise<boolean> => {
@@ -233,30 +283,34 @@ const getAndroidDetails = async (
   const minSdk = new RegExp(
     AaptPrefixes.sdkPrefix + AaptPrefixes.quoteRegex
   ).exec(stdout);
-  const permissions = new RegExp(
-    AaptPrefixes.permissionPrefix + AaptPrefixes.quoteNonLazyRegex
-  ).exec(stdout);
+  const permissions = [...stdout.matchAll(/uses-permission: name='(.*)'/g)];
   const locales = new RegExp(
     AaptPrefixes.localePrefix + AaptPrefixes.quoteNonLazyRegex
   ).exec(stdout);
 
-  let permissionArray = Array.from(permissions?.values() ?? []);
-  if (permissionArray.length >= 2) {
-    permissionArray = permissionArray.slice(1);
-  }
-
   let localeArray = Array.from(locales?.values() ?? []);
   if (localeArray.length == 2) {
     const localesSrc = localeArray[1];
     localeArray = ["en-US"].concat(localesSrc.split("' '").slice(1));
   }
 
+  if (localeArray.length >= 60) {
+    showMessage(
+      "The bundle apk claims supports for following locales",
+      "Claim for supported locales::\n" + 
+      localeArray + 
+      "\nIf this release does not support all these locales the release may be rejected" +
+      "\nSee details at https://developer.android.com/guide/topics/resources/multilingual-support#design for configuring the supported locales",
+      "warning"
+    )
+  }
+
   return {
     android_package: appPackage?.[1] ?? "",
     min_sdk: parseInt(minSdk?.[1] ?? "0", 10),
     version_code: parseInt(versionCode?.[1] ?? "0", 10),
     version: versionName?.[1] ?? "0",
-    permissions: permissionArray,
+    permissions: permissions.flatMap(permission => permission[1]),
     locales: localeArray,
   };
 };
@@ -272,7 +326,7 @@ export const saveToConfig = async ({
   app,
   release,
 }: SaveToConfigArgs) => {
-  const currentConfig = await getConfigFile();
+  const currentConfig = await getConfigWithChecks();
 
   delete currentConfig.publisher.icon;
   delete currentConfig.app.icon;

package/src/config/schema.json

@@ -1,195 +0,0 @@
-{
-  "type": "object",
-  "properties": {
-    "publisher": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string"
-        },
-        "address": {
-          "type": "string"
-        },
-        "website": {
-          "type": "string"
-        },
-        "email": {
-          "type": "string"
-        },
-        "media": {
-          "type": "array",
-          "items": [
-            {
-              "type": "object",
-              "properties": {
-                "purpose": {
-                  "type": "string"
-                },
-                "uri": {
-                  "type": "string"
-                }
-              },
-              "required": ["purpose", "uri"]
-            }
-          ]
-        }
-      },
-      "required": ["name", "website", "email", "media"]
-    },
-    "app": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string"
-        },
-        "address": {
-          "type": "string"
-        },
-        "android_package": {
-          "type": "string"
-        },
-        "urls": {
-          "type": "object",
-          "properties": {
-            "license_url": {
-              "type": "string"
-            },
-            "copyright_url": {
-              "type": "string"
-            },
-            "privacy_policy_url": {
-              "type": "string"
-            },
-            "website": {
-              "type": "string"
-            }
-          },
-          "required": [
-            "license_url",
-            "copyright_url",
-            "privacy_policy_url",
-            "website"
-          ]
-        },
-        "media": {
-          "type": "array",
-          "items": [
-            {
-              "type": "object",
-              "properties": {
-                "purpose": {
-                  "type": "string"
-                },
-                "uri": {
-                  "type": "string"
-                }
-              },
-              "required": ["purpose", "uri"]
-            }
-          ]
-        }
-      },
-      "required": ["name", "android_package", "urls", "media"]
-    },
-    "release": {
-      "type": "object",
-      "properties": {
-        "address": {
-          "type": "string"
-        },
-        "media": {
-          "type": "array",
-          "items": [
-            {
-              "type": "object",
-              "properties": {
-                "purpose": {
-                  "type": "string"
-                },
-                "uri": {
-                  "type": "string"
-                }
-              },
-              "required": ["purpose", "uri"]
-            }
-          ]
-        },
-        "files": {
-          "type": "array",
-          "minItems": 1,
-          "contains": {
-            "type": "object",
-            "properties": {
-              "purpose": {
-                "type": "string",
-                "const": "install"
-              }
-            }
-          },
-          "items": [
-            {
-              "type": "object",
-              "properties": {
-                "purpose": {
-                  "type": "string"
-                },
-                "uri": {
-                  "type": "string"
-                }
-              },
-              "required": ["purpose", "uri"]
-            }
-          ]
-        },
-        "catalog": {
-          "type": "object",
-          "patternProperties": {
-            "^[a-zA-Z]{2,8}(-[a-zA-Z0-9]{2,8})*$": {
-              "type": "object",
-              "properties": {
-                "name": {
-                  "type": "string"
-                },
-                "long_description": {
-                  "type": "string"
-                },
-                "new_in_version": {
-                  "type": "string"
-                },
-                "saga_features": {
-                  "type": "string"
-                }
-              },
-              "required": [
-                "name",
-                "long_description",
-                "new_in_version",
-                "saga_features"
-              ]
-            }
-          },
-          "additionalProperties": false
-        }
-      },
-      "required": ["media", "files", "catalog"]
-    },
-    "solana_mobile_dapp_publisher_portal": {
-      "type": "object",
-      "properties": {
-        "google_store_package": {
-          "type": "string"
-        },
-        "testing_instructions": {
-          "type": "string"
-        }
-      },
-      "required": ["testing_instructions"]
-    }
-  },
-  "required": [
-    "publisher",
-    "app",
-    "release",
-    "solana_mobile_dapp_publisher_portal"
-  ]
-}

package/src/generated/config_obj.json

@@ -1 +0,0 @@
-{"publisher":{"name":"<<YOUR_PUBLISHER_NAME>>","address":"","website":"<<URL_OF_PUBLISHER_WEBSITE>>","email":"<<EMAIL_ADDRESS_TO_CONTACT_PUBLISHER>>","media":[{"purpose":"icon","uri":"<<RELATIVE_PATH_TO_PUBLISHER_ICON>>"}]},"app":{"name":"<<APP_NAME>>","address":"","android_package":"<<ANDROID_PACKAGE_NAME>>","urls":{"license_url":"<<URL_OF_APP_LICENSE_OR_TERMS_OF_SERVICE>>","copyright_url":"<<URL_OF_COPYRIGHT_DETAILS_FOR_APP>>","privacy_policy_url":"<<URL_OF_APP_PRIVACY_POLICY>>","website":"<<URL_OF_APP_WEBSITE>>"},"media":[{"purpose":"icon","uri":"<<RELATIVE_PATH_TO_APP_ICON>>"}]},"release":{"address":"","media":[{"purpose":"icon","uri":"<<RELATIVE_PATH_TO_RELEASE_ICON>>"},{"purpose":"screenshot","uri":"<<RELATIVE_PATH_TO_SCREENSHOT>>"}],"files":[{"purpose":"install","uri":"<<RELATIVE_PATH_TO_APK>>"}],"catalog":{"en-US":{"name":"<<APP_NAME>>\n","long_description":"<<LONG_APP_DESCRIPTION>>\n","new_in_version":"<<WHATS_NEW_IN_THIS_VERSION>>\n","saga_features":"<<ANY_FEATURES_ONLY_AVAILBLE_WHEN_RUNNING_ON_SAGA>>\n"}}},"solana_mobile_dapp_publisher_portal":{"google_store_package":"<<ANDROID_PACKAGE_NAME_OF_GOOGLE_PLAY_STORE_VERSION_IF_DIFFERENT>>","testing_instructions":"<<TESTING_INSTRUCTIONS>>\n"}}

package/src/generated/config_schema.json

@@ -1 +0,0 @@
-{"type":"object","properties":{"publisher":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"media":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"string"},"uri":{"type":"string"}}}}}},"app":{"type":"object","properties":{"name":{"type":"string"},"address":{"type":"string"},"android_package":{"type":"string"},"urls":{"type":"object","properties":{"license_url":{"type":"string"},"copyright_url":{"type":"string"},"privacy_policy_url":{"type":"string"},"website":{"type":"string"}}},"media":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"string"},"uri":{"type":"string"}}}}}},"release":{"type":"object","properties":{"address":{"type":"string"},"media":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"string"},"uri":{"type":"string"}},"required":["purpose","uri"]}},"files":{"type":"array","items":{"type":"object","properties":{"purpose":{"type":"string"},"uri":{"type":"string"}}}},"catalog":{"type":"object","properties":{"en-US":{"type":"object","properties":{"name":{"type":"string"},"long_description":{"type":"string"},"new_in_version":{"type":"string"},"saga_features":{"type":"string"}}}}}}},"solana_mobile_dapp_publisher_portal":{"type":"object","properties":{"google_store_package":{"type":"string"},"testing_instructions":{"type":"string"}}}}}