@solana-mobile/dapp-store-cli 0.16.0 → 1.0.0

package/src/config/PublishDetails.ts

@@ -1,456 +0,0 @@
-import {
-  AndroidDetails,
-  App,
-  LastSubmittedVersionOnChain,
-  LastUpdatedVersionOnStore,
-  Publisher,
-  Release,
-  SolanaMobileDappPublisherPortal
-} from "@solana-mobile/dapp-store-publishing-tools";
-import { dump, load } from "js-yaml";
-import Ajv from "ajv";
-// eslint-disable-next-line require-extensions/require-extensions
-import { readFile } from 'fs/promises';
-const schemaJson = JSON.parse((await readFile(new URL("../generated/config_schema.json", import.meta.url))).toString());
-import fs from "fs";
-import path from "path";
-import { toMetaplexFile } from "@metaplex-foundation/js";
-import { Constants, showMessage } from "../CliUtils.js";
-import util from "util";
-import { imageSize } from "image-size";
-import { exec } from "child_process";
-import getVideoDimensions from "get-video-dimensions";
-import { PublicKey } from "@solana/web3.js";
-
-const runImgSize = util.promisify(imageSize);
-const runExec = util.promisify(exec);
-
-export interface PublishDetails {
-  publisher: Publisher;
-  app: App;
-  release: Release;
-  solana_mobile_dapp_publisher_portal: SolanaMobileDappPublisherPortal;
-  lastSubmittedVersionOnChain: LastSubmittedVersionOnChain
-  lastUpdatedVersionOnStore: LastUpdatedVersionOnStore,
-}
-
-const AaptPrefixes = {
-  quoteRegex: "'(.*?)'",
-  quoteNonLazyRegex: "'(.*)'",
-  packagePrefix: "package: name=",
-  verCodePrefix: "versionCode=",
-  verNamePrefix: "versionName=",
-  sdkPrefix: "(?:minSdk|sdk)Version:",
-  debuggableApkPrefix: "application-debuggable",
-  localePrefix: "locales: ",
-};
-
-type SaveToConfigArgs = {
-  publisher?: Pick<Publisher, "address">;
-  app?: Pick<App, "address">;
-  release?: Release;
-  lastSubmittedVersionOnChain?: LastSubmittedVersionOnChain;
-  lastUpdatedVersionOnStore?: LastUpdatedVersionOnStore;
-};
-
-const ajv = new Ajv({ strictTuples: false });
-const validate = ajv.compile(schemaJson);
-
-export const loadPublishDetails = async (configPath: string) => {
-  const configFile = await fs.promises.readFile(configPath, "utf-8");
-
-  const valid = validate(load(configFile) as object);
-
-  if (!valid) {
-    console.error(validate.errors);
-    process.exit(1);
-  }
-
-  return load(configFile) as PublishDetails;
-};
-
-export const loadPublishDetailsWithChecks = async (
-  buildToolsDir: string | null = null
-): Promise<PublishDetails> => {
-  const config = await loadPublishDetails(Constants.getConfigFilePath());
-
-  // We validate that the config is going to have at least one installable asset
-  const apkEntry = config.release.files.find(
-    (asset: PublishDetails["release"]["files"][0]) => asset.purpose === "install"
-  )!;
-  const apkPath = path.join(process.cwd(), apkEntry?.uri);
-  if (!fs.existsSync(apkPath)) {
-    throw new Error("Invalid path to APK file.");
-  }
-
-  const developerOverridenLocales = config.release?.android_details?.locales
-
-  if (buildToolsDir) {
-    config.release.android_details = await getAndroidDetails(
-      buildToolsDir,
-      apkPath,
-      developerOverridenLocales
-    );
-  }
-
-  const appIcon = config.app.media?.find(
-    (asset: any) => asset.purpose === "icon"
-  )?.uri;
-
-  if (appIcon) {
-    const iconPath = path.join(process.cwd(), appIcon);
-    await checkIconCompatibility(iconPath, "App");
-
-    const iconBuffer = await fs.promises.readFile(iconPath);
-    config.app.icon = toMetaplexFile(iconBuffer, appIcon);
-  }
-
-  const releaseIcon = config.release.media?.find(
-    (asset: any) => asset.purpose === "icon"
-  )?.uri;
-
-  if (releaseIcon) {
-    const iconPath = path.join(process.cwd(), releaseIcon);
-    await checkIconCompatibility(iconPath, "Release");
-  }
-
-  if (!appIcon && !releaseIcon) {
-    throw new Error("Please specify at least one media entry of type icon in your configuration file");
-  }
-
-  const banner = config.release.media?.find(
-      (asset: any) => asset.purpose === "banner"
-    )?.uri;
-
-    if (banner) {
-      const bannerPath = path.join(process.cwd(), banner);
-      await checkBannerCompatibility(bannerPath);
-    } else {
-      throw new Error("Please specify banner image of size 1200x600 in your configuration file");
-    }
-
-  const featureGraphic = config.release.media?.find(
-    (asset: any) => asset.purpose === "featureGraphic"
-  )?.uri;
-
-  if (featureGraphic) {
-    const featureGraphicPath = path.join(process.cwd(), featureGraphic);
-    await checkFeatureGraphicCompatibility(featureGraphicPath);
-  }
-
-  config.release.media.forEach((item: PublishDetails["release"]["media"][0]) => {
-    const mediaPath = path.join(process.cwd(), item.uri);
-    if (!fs.existsSync(mediaPath)) {
-      throw new Error(`File doesnt exist: ${item.uri}.`)
-    }
-
-    if (item.purpose == "screenshot" && !checkImageExtension(mediaPath)) {
-      throw new Error(`Please ensure the file ${item.uri} is a jpeg, png, or webp file.`)
-    }
-
-    if (item.purpose == "video" && !checkVideoExtension(mediaPath)) {
-      throw new Error(`Please ensure the file ${item.uri} is a mp4.`)
-    }
-  }
-  );
-
-  const screenshots = config.release.media?.filter(
-    (asset: any) => asset.purpose === "screenshot"
-  )
-
-  for (const item of screenshots) {
-    const mediaPath = path.join(process.cwd(), item.uri);
-    if (await checkScreenshotDimensions(mediaPath)) {
-      throw new Error(`Screenshot ${mediaPath} must be at least 1080px in width and height.`);
-    }
-  }
-
-  const videos = config.release.media?.filter(
-    (asset: any) => asset.purpose === "video"
-  )
-
-  for (const video of videos) {
-    const mediaPath = path.join(process.cwd(), video.uri);
-    if (await checkVideoDimensions(mediaPath)) {
-      throw new Error(`Video ${mediaPath} must be at least 720px in width and height.`);
-    }
-  }
-
-  if (screenshots.length + videos.length < 4) {
-    throw new Error(`At least 4 screenshots or videos are required for publishing a new release. Found only ${screenshots.length + videos.length}`)
-  }
-
-  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.");
-    }
-  }
-
-  const alpha_testers = config.solana_mobile_dapp_publisher_portal.alpha_testers;
-  if (alpha_testers !== undefined) {
-    for (const wallet of alpha_testers) {
-      try {
-        void new PublicKey(wallet.address);
-      } catch (e: unknown) {
-        throw new Error(`invalid alpha tester wallet address <${wallet}>`);
-      }
-    }
-
-    if (alpha_testers.size > 10) {
-      throw new Error(`Alpha testers are limited to 10 per app submission`);
-    }
-  }
-
-  return config;
-};
-
-const checkIconCompatibility = async (path: string, typeString: string) => {
-  if (!fs.existsSync(path) || !checkImageExtension(path)) {
-    throw new Error(`Please check the path to your ${typeString} icon and ensure the file is a jpeg, png, or webp file.`);
-  }
-
-  if (await checkIconDimensions(path)) {
-    throw new Error("Icons must be 512px by 512px.");
-  }
-};
-
-const checkBannerCompatibility = async (path: string) => {
-  if (!fs.existsSync(path) || !checkImageExtension(path)) {
-    throw new Error(`Please check the path to your banner image and ensure the file is a jpeg, png, or webp file.`);
-  }
-
-  if (await checkBannerDimensions(path)) {
-    throw new Error("Banner must be 1200px by 600px.");
-  }
-};
-
-const checkFeatureGraphicCompatibility = async (path: string) => {
-  if (!fs.existsSync(path) || !checkImageExtension(path)) {
-    throw new Error(`Please check the path to your featureGraphic image and ensure the file is a jpeg, png, or webp file.`);
-  }
-
-  if (await checkFeatureGraphicDimensions(path)) {
-    throw new Error("Feature Graphic must be 1200px by 1200px.");
-  }
-};
-
-const checkImageExtension = (uri: string): boolean => {
-  const fileExt = path.extname(uri).toLowerCase();
-  return (
-    fileExt == ".png" ||
-    fileExt == ".jpg" ||
-    fileExt == ".jpeg" ||
-    fileExt == ".webp"
-  );
-};
-
-const checkVideoExtension = (uri: string): boolean => {
-  const fileExt = path.extname(uri).toLowerCase();
-  return (
-    fileExt == ".mp4"
-  );
-};
-
-/**
- * We need to pre-check some things in the localized resources before we move forward
- */
-const validateLocalizableResources = (config: PublishDetails) => {
-  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 > 30);
-
-  if (descsWrongLength.length > 0) {
-    throw new Error("Please ensure all translations of short_description are between 0 and 30 characters");
-  }
-};
-
-const checkIconDimensions = async (iconPath: string): Promise<boolean> => {
-  const size = await runImgSize(iconPath);
-
-  return size?.width != size?.height || (size?.width ?? 0) != 512;
-};
-
-const checkScreenshotDimensions = async (imagePath: string): Promise<boolean> => {
-  const size = await runImgSize(imagePath);
-
-  return (size?.width ?? 0) < 1080 || (size?.height ?? 0) < 1080;
-}
-
-const checkBannerDimensions = async (imagePath: string): Promise<boolean> => {
-  const size = await runImgSize(imagePath);
-
-  return (size?.width ?? 0) != 1200 || (size?.height ?? 0) != 600;
-}
-
-const checkFeatureGraphicDimensions = async (imagePath: string): Promise<boolean> => {
-  const size = await runImgSize(imagePath);
-
-  return (size?.width ?? 0) != 1200 || (size?.height ?? 0) != 1200;
-}
-
-const checkVideoDimensions = async (imagePath: string): Promise<boolean> => {
-  const size = await getVideoDimensions(imagePath);
-
-  return (size?.width ?? 0) < 720 || (size?.height ?? 0) < 720;
-}
-
-
-const getAndroidDetails = async (
-  aaptDir: string,
-  apkPath: string,
-  developerOverridenLocales: [string]
-): Promise<AndroidDetails> => {
-  try {
-    const { stdout } = await runExec(`${aaptDir}/aapt2 dump badging "${apkPath}"`);
-
-    const appPackage = new RegExp(
-      AaptPrefixes.packagePrefix + AaptPrefixes.quoteRegex
-    ).exec(stdout);
-    const versionCode = new RegExp(
-      AaptPrefixes.verCodePrefix + AaptPrefixes.quoteRegex
-    ).exec(stdout);
-    const versionName = new RegExp(
-      AaptPrefixes.verNamePrefix + AaptPrefixes.quoteRegex
-    ).exec(stdout);
-    const minSdk = new RegExp(
-      AaptPrefixes.sdkPrefix + AaptPrefixes.quoteRegex
-    ).exec(stdout);
-    const permissions = [...stdout.matchAll(/(?:uses-permission|uses-permission-sdk-23): name='([^']*)'/g)].flatMap(permission => permission[1]);
-    const locales = new RegExp(
-      AaptPrefixes.localePrefix + AaptPrefixes.quoteNonLazyRegex
-    ).exec(stdout);
-    const isDebuggable = new RegExp(
-      AaptPrefixes.debuggableApkPrefix
-    ).exec(stdout);
-
-    if (isDebuggable != null) {
-      throw new TypeError("Debug apks are not supported on Solana dApp store.\nSubmit a signed release apk")
-    }
-
-    let localeArray = Array.from(locales?.values() ?? []);
-    if (localeArray.length == 2) {
-      const localesSrc = localeArray[1];
-      localeArray = ["en-US"].concat(localesSrc.split("' '").slice(1));
-    }
-
-    if (permissions.includes("android.permission.INSTALL_PACKAGES") || permissions.includes("android.permission.DELETE_PACKAGES")) {
-      showMessage(
-        "App requests system app install/delete permission",
-        "Your app requests system install/delete permission which is managed by Solana dApp Store.\nThis app will be not approved for listing on Solana dApp Store.",
-        "error"
-      );
-    }
-
-    if (permissions.includes("android.permission.REQUEST_INSTALL_PACKAGES") || permissions.includes("android.permission.REQUEST_DELETE_PACKAGES")) {
-      showMessage(
-        "App requests install or delete permission",
-        "App will be subject to additional security reviews for listing on Solana dApp Store and processing time may be beyond regular review time",
-        "warning"
-      );
-    }
-
-    if (permissions.includes("com.solanamobile.seedvault.ACCESS_SEED_VAULT") || permissions.includes("com.solanamobile.seedvault.ACCESS_SEED_VAULT_PRIVILEGED")) {
-      showMessage(
-        "App requests Seed Vault permission",
-        "If this is not a wallet application, your app maybe rejected from listing on Solana dApp Store.",
-        "warning"
-      );
-    }
-
-    if (developerOverridenLocales == null && localeArray.length >= 60 || developerOverridenLocales?.length >= 60) {
-      showMessage(
-        "Excessive language support detected",
-        "The bundle apk claims supports for following locales \n" +
-        localeArray +
-        "\nYou config.yaml claims support for following locales\n" + 
-        developerOverridenLocales +
-        "\nIf this release does not support all these locales the release may be rejected\n." +
-        "You can override this list of supported locales in config.yaml" +
-        "\nSee details at https://developer.android.com/guide/topics/resources/multilingual-support#design for configuring the supported locales in your apk file",
-        "warning"
-      );
-    }
-    
-    return {
-      android_package: appPackage?.[1] ?? "",
-      min_sdk: parseInt(minSdk?.[1] ?? "0", 10),
-      version_code: parseInt(versionCode?.[1] ?? "0", 10),
-      version: versionName?.[1] ?? "0",
-      cert_fingerprint: await extractCertFingerprint(aaptDir, apkPath),
-      permissions: permissions,
-      locales: developerOverridenLocales ?? localeArray
-    };
-  } catch (e) {
-    if (e instanceof TypeError) {
-      throw e
-    } else {
-      throw new Error(`There was an error parsing your APK. Please ensure you have installed Java and provided a valid Android tools directory containing AAPT2.\n` + e);
-    }
-  }
-};
-
-export const extractCertFingerprint = async (aaptDir: string, apkPath: string): Promise<string> => {
-  const { stdout } = await runExec(`${aaptDir}/apksigner verify --print-certs -v "${apkPath}"`);
-
-  const regex = /Signer #1 certificate SHA-256 digest:\s*([a-fA-F0-9]+)/;
-  const match = stdout.match(regex);
-
-  if (match && match[1]) {
-    return match[1];
-  } else {
-    throw new Error("Could not obtain cert fingerprint")
-  }
-}
-
-export const writeToPublishDetails = async ({ app, release, lastSubmittedVersionOnChain, lastUpdatedVersionOnStore }: SaveToConfigArgs) => {
-  const currentConfig = await loadPublishDetailsWithChecks();
-
-  delete currentConfig.publisher.icon;
-  delete currentConfig.app.icon;
-
-  const newConfig: PublishDetails = {
-    publisher: {
-      ...currentConfig.publisher,
-    },
-    app: {
-      ...currentConfig.app,
-      address: app?.address ?? currentConfig.app.address
-    },
-    release: {
-      ...currentConfig.release,
-      address: release?.address ?? currentConfig.release.address,
-      android_details: {
-        cert_fingerprint: release?.android_details?.cert_fingerprint ?? currentConfig.release.android_details?.cert_fingerprint,
-        min_sdk: release?.android_details?.min_sdk ?? currentConfig.release.android_details?.min_sdk,
-        version: release?.android_details?.version ?? currentConfig.release.android_details?.version,
-        version_code: release?.android_details?.version_code ?? currentConfig.release.android_details?.version_code,
-        locales: release?.android_details?.locales ?? currentConfig.release.android_details?.locales
-      }
-    },
-    solana_mobile_dapp_publisher_portal: currentConfig.solana_mobile_dapp_publisher_portal,
-    lastSubmittedVersionOnChain: lastSubmittedVersionOnChain ?? currentConfig.lastSubmittedVersionOnChain,
-    lastUpdatedVersionOnStore: lastUpdatedVersionOnStore ?? currentConfig.lastUpdatedVersionOnStore
-  };
-
-  fs.writeFileSync(Constants.getConfigFilePath(), dump(newConfig, {
-    lineWidth: -1
-  }));
-};

package/src/config/S3StorageManager.ts

@@ -1,47 +0,0 @@
-import { EnvVariables, S3Config } from "./EnvVariables.js";
-
-export class S3StorageManager {
-  private _config: S3Config | undefined = undefined
-
-  public get hasS3Config(): boolean {
-    return this._config != undefined;
-  }
-
-  public get s3Config(): S3Config {
-    return this._config as S3Config;
-  }
-
-  constructor(private envVars: EnvVariables) {
-    if (envVars.hasS3EnvArgs) {
-      this._config = {
-        accessKey: this.envVars.s3Config.accessKey,
-        secretKey: this.envVars.s3Config.secretKey,
-        bucketName: this.envVars.s3Config.bucketName,
-        regionName: this.envVars.s3Config.regionName
-      };
-    }
-  }
-
-  parseCmdArg(cmdArg: string) {
-    if (!cmdArg || cmdArg == "") return;
-
-    try {
-      //This will overwrite any existing parameters already obtained from the .env file
-      const parsedArray = JSON.parse(`${cmdArg}`);
-
-      if (parsedArray instanceof Array && parsedArray[0] == "s3") {
-        if (parsedArray.length != 5) throw new Error("Invalid parameters")
-
-        this._config = {
-          accessKey: parsedArray[1],
-          secretKey: parsedArray[2],
-          bucketName: parsedArray[3],
-          regionName: parsedArray[4]
-        };
-      }
-    } catch (e) {
-      throw new Error("There was an error parsing your s3 parameters from the CLI. Please ensure they are formatted correctly.");
-    }
-  }
-
-}

package/src/config/index.ts

@@ -1,2 +0,0 @@
-export * from "./EnvVariables.js";
-export * from "./S3StorageManager.js";

package/src/prebuild_schema/publishing_source.yaml

@@ -1,64 +0,0 @@
-publisher:
-  name: <<[REQUIRED] YOUR_PUBLISHER_NAME>>
-  website: <<[REQUIRED] URL_OF_PUBLISHER_WEBSITE>>
-  email: <<[REQUIRED] EMAIL_ADDRESS_TO_CONTACT_PUBLISHER>>
-  support_email: <<[Optional] SUPPORT_EMAIL_ADDRESS_FOR_END_USERS>>
-app:
-  name: <<[REQUIRED] APP_NAME>>
-  address: ""
-  android_package: <<[REQUIRED] ANDROID_PACKAGE_NAME>>
-  urls:
-    license_url: <<[REQUIRED] URL For App's T&C. Don't put placeholder urls.>>
-    copyright_url: <<[REQUIRED] URL For App's Copyright. Don't put placeholder urls.>>
-    privacy_policy_url: <<[REQUIRED] URL For App's Privacy Policy. Don't put placeholder urls.>>
-    website: <<[REQUIRED] URL_OF_APP_WEBSITE>>
-  media:
-    - purpose: icon
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_APP_ICON>>
-release:
-  address: ""
-  media:
-    - purpose: icon
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_RELEASE_ICON>>
-    - purpose: banner
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_BANNER>>
-    - purpose: featureGraphic
-      uri: <<[Optional] RELATIVE_PATH_TO_FEATURE_GRAPHIC>>
-    - purpose: screenshot
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_SCREENSHOT1>>
-    - purpose: screenshot
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_SCREENSHOT2>>
-    - purpose: screenshot
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_SCREENSHOT3>>
-    - purpose: screenshot
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_SCREENSHOT4>>
-    - purpose: video
-      uri: <<[Optional] RELATIVE_PATH_TO_VIDEO1>>
-  files:
-    - purpose: install
-      uri: <<[REQUIRED] RELATIVE_PATH_TO_APK>>
-  catalog:
-    en-US:
-      name: >-
-        <<[REQUIRED] APP_NAME>>
-      short_description: >-
-        <<[REQUIRED] SHORT_APP_DESCRIPTION>>
-      long_description: >-
-        <<[REQUIRED] LONG_APP_DESCRIPTION>>
-      new_in_version: >-
-        <<[REQUIRED] WHATS_NEW_IN_THIS_VERSION>>
-      saga_features: >-
-        <<[Optional.] ANY_FEATURES_ONLY_AVAILBLE_WHEN_RUNNING_ON_SAGA>>
-  android_details:
-    locales: 
-      - en-US
-      - <Add more supported locales>
-solana_mobile_dapp_publisher_portal:
-  google_store_package: <<[Optional] ANDROID_PACKAGE_NAME_OF_GOOGLE_PLAY_STORE_VERSION>>
-  testing_instructions: >-
-    <<[REQUIRED] TESTING_INSTRUCTIONS. Please provide any test account details if applicable>>
-  alpha_testers: 
-    - address: <<Optional. genesis token wallet address>>
-      comment: <<Optional. For internal use only>>
-    - address: <<Optional. genesis token wallet address>>
-      comment: <<Optional. For internal use only>>

package/src/prebuild_schema/schemagen.js

@@ -1,31 +0,0 @@
-import fs, { read } from "fs";
-import yaml from "js-yaml";
-import generateSchema from "generate-schema";
-
-try {
-  const yamlSrc = fs.readFileSync('./src/prebuild_schema/publishing_source.yaml', 'utf8')
-  const convertedYaml = yaml.load(yamlSrc);
-  fs.writeFileSync('./src/generated/config_obj.json', Buffer.from(JSON.stringify(convertedYaml)), 'utf-8');
-
-  const schema = generateSchema.json('result', convertedYaml);
-  // CLI 0.3.0: Adding requirement for `short_description` so validation will catch
-  schema["properties"]
-    ["release"]
-    ["properties"]
-    ["catalog"]
-    ["properties"]
-    ["en-US"].required = ["short_description"];
-
-  schema["properties"]
-    ["publisher"]
-    .required = ["name", "website", "email"];
-
-  // Generator adds some keys/values we don't need & mess up validation
-  delete schema.$schema;
-  delete schema.title;
-
-  const toWrite = Buffer.from(JSON.stringify(schema));
-  fs.writeFileSync('./src/generated/config_schema.json', toWrite, 'utf-8');
-} catch (e) {
-  console.log(":: Schema generation step failed ::");
-}