@solana-mobile/dapp-store-cli 0.13.1 → 0.14.0

package/lib/CliSetup.js

@@ -149,7 +149,8 @@ function resolveBuildToolsPath(buildToolsPath) {
  */ function latestReleaseMessage() {
     var messages = [
         "- Banner Graphic image of size 1200x600px is now manadatory for publishing updates.",
-        "- Feature Graphic image of size 1200x1200px is required to be featured in Editor's choice carousel. (optional)"
+        "- Feature Graphic image of size 1200x1200px is required to be featured in Editor's choice carousel. (optional)",
+        "- Release metadata now publishes publisher.support_email when provided; otherwise we reuse publisher.email for end-user support."
     ].join('\n\n');
     showMessage("Publishing Tools Version ".concat(Constants.CLI_VERSION), messages, "warning");
 }
@@ -223,6 +224,11 @@ export var initCliCmd = mainCli.command("init").description("First-time initiali
     })();
 });
 export var createCliCmd = mainCli.command("create").description("Create a `app`, or `release`");
+createCliCmd.addHelpText("after", [
+    "",
+    "Release metadata notes:",
+    "  We include publisher.support_email when provided; if omitted we fall back to publisher.email."
+].join("\n"));
 export var createAppCliCmd = createCliCmd.command("app").description("Create a app").requiredOption("-k, --keypair <path-to-keypair-file>", "Path to keypair file").option("-u, --url <url>", "RPC URL", Constants.DEFAULT_RPC_DEVNET).option("-d, --dry-run", "Flag for dry run. Doesn't mint an NFT").option("-s, --storage-config <storage-config>", "Provide alternative storage configuration details").option("-p, --priority-fee-lamports <priority-fee-lamports>", "Priority Fee lamports").action(function(param) {
     var keypair = param.keypair, url = param.url, dryRun = param.dryRun, storageConfig = param.storageConfig, priorityFeeLamports = param.priorityFeeLamports;
     return _async_to_generator(function() {

package/lib/CliUtils.js

@@ -156,7 +156,7 @@ export var Constants = function Constants() {
     "use strict";
     _class_call_check(this, Constants);
 };
-_define_property(Constants, "CLI_VERSION", "0.13.1");
+_define_property(Constants, "CLI_VERSION", "0.14.0");
 _define_property(Constants, "CONFIG_FILE_NAME", "config.yaml");
 _define_property(Constants, "DEFAULT_RPC_DEVNET", "https://api.devnet.solana.com");
 _define_property(Constants, "DEFAULT_PRIORITY_FEE", 500000);

package/lib/__tests__/CliSetupTest.js

@@ -17,10 +17,10 @@ describe("Cli Setup & Execution", function() {
                 return 250;
             },
             writeOut: function writeOut(str) {
-                otherOutput = str;
+                otherOutput += str;
             },
             writeErr: function writeErr(str) {
-                errorOutput = str;
+                errorOutput += str;
             }
         });
     });
@@ -111,7 +111,7 @@ describe("Cli Setup & Execution", function() {
     var generalHelp = "Usage: dapp-store [options] [command]\n\nCLI to assist with publishing to the Saga Dapp Store\n\nOptions:\n  -V, --version       output the version number\n  -h, --help          display help for command\n\nCommands:\n  init                First-time initialization of tooling configuration\n  create              Create a `app`, or `release`\n  validate [options]  Validates details prior to publishing\n  publish             Submit a publishing request (`submit`, `update`, `remove`, or `support`) to the Solana Mobile dApp publisher portal\n  help [command]      display help for command\n";
     var initHelp = "Usage: dapp-store init [options]\n\nFirst-time initialization of tooling configuration\n\nOptions:\n  -h, --help  display help for command\n";
     var keyPairArgHelp = "error: required option '-k, --keypair <path-to-keypair-file>' not specified";
-    var createHelp = "Usage: dapp-store create [options] [command]\n\nCreate a `app`, or `release`\n\nOptions:\n  -h, --help         display help for command\n\nCommands:\n  app [options]      Create a app\n  release [options]  Create a release\n  help [command]     display help for command\n";
+    var createHelp = "Usage: dapp-store create [options] [command]\n\nCreate a `app`, or `release`\n\nOptions:\n  -h, --help         display help for command\n\nCommands:\n  app [options]      Create a app\n  release [options]  Create a release\n  help [command]     display help for command\n\nRelease metadata notes:\n  We include publisher.support_email when provided; if omitted we fall back to publisher.email.\n";
     var createAppHelp = 'Usage: dapp-store create app [options]\n\nCreate a app\n\nOptions:\n  -k, --keypair <path-to-keypair-file>                 Path to keypair file\n  -u, --url <url>                                      RPC URL (default: "https://api.devnet.solana.com")\n  -d, --dry-run                                        Flag for dry run. Doesn\'t mint an NFT\n  -s, --storage-config <storage-config>                Provide alternative storage configuration details\n  -p, --priority-fee-lamports <priority-fee-lamports>  Priority Fee lamports\n  -h, --help                                           display help for command\n';
     var createReleaseHelp = 'Usage: dapp-store create release [options]\n\nCreate a release\n\nOptions:\n  -k, --keypair <path-to-keypair-file>                 Path to keypair file\n  -a, --app-mint-address <app-mint-address>            The mint address of the app NFT\n  -u, --url <url>                                      RPC URL (default: "https://api.devnet.solana.com")\n  -d, --dry-run                                        Flag for dry run. Doesn\'t mint an NFT\n  -b, --build-tools-path <build-tools-path>            Path to Android build tools which contains AAPT2\n  -s, --storage-config <storage-config>                Provide alternative storage configuration details\n  -p, --priority-fee-lamports <priority-fee-lamports>  Priority Fee lamports\n  -h, --help                                           display help for command\n';
 });

package/lib/commands/create/index.js

@@ -10,7 +10,7 @@ export * from "./CreateCliRelease.js"; /*
  // Publisher
  // Public key attached to a publisher must also verify applications and releases
  // Most information here can be be edited after the fact
- // Only required fields are name, address, publisher website, and contact
+ // Only required fields are name, address, publisher website, and contact email
  // Optional fields are: description, image_url (need dimensions!)
  // App
  // Publisher creator key required

package/lib/generated/config_obj.json

@@ -1 +1 @@
-{"publisher":{"name":"<<[REQUIRED] YOUR_PUBLISHER_NAME>>","website":"<<[REQUIRED] URL_OF_PUBLISHER_WEBSITE>>","email":"<<[REQUIRED] EMAIL_ADDRESS_TO_CONTACT_PUBLISHER>>"},"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>>"}]}}
+{"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/lib/generated/config_schema.json

@@ -1 +1 @@
-{"type":"object","properties":{"publisher":{"type":"object","properties":{"name":{"type":"string"},"website":{"type":"string"},"email":{"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"},"short_description":{"type":"string"},"long_description":{"type":"string"},"new_in_version":{"type":"string"},"saga_features":{"type":"string"}},"required":["short_description"]}}},"android_details":{"type":"object","properties":{"locales":{"type":"array","items":{"type":"string"}}}}}},"solana_mobile_dapp_publisher_portal":{"type":"object","properties":{"google_store_package":{"type":"string"},"testing_instructions":{"type":"string"},"alpha_testers":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"comment":{"type":"string"}},"required":["address","comment"]}}}}}}
+{"type":"object","properties":{"publisher":{"type":"object","properties":{"name":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"support_email":{"type":"string"}},"required":["name","website","email"]},"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"},"short_description":{"type":"string"},"long_description":{"type":"string"},"new_in_version":{"type":"string"},"saga_features":{"type":"string"}},"required":["short_description"]}}},"android_details":{"type":"object","properties":{"locales":{"type":"array","items":{"type":"string"}}}}}},"solana_mobile_dapp_publisher_portal":{"type":"object","properties":{"google_store_package":{"type":"string"},"testing_instructions":{"type":"string"},"alpha_testers":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string"},"comment":{"type":"string"}},"required":["address","comment"]}}}}}}

package/lib/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana-mobile/dapp-store-cli",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,
@@ -54,7 +54,7 @@
     "@ardrive/turbo-sdk": "^1.31.1",
     "@aws-sdk/client-s3": "^3.321.1",
     "@metaplex-foundation/js-plugin-aws": "^0.20.0",
-    "@solana-mobile/dapp-store-publishing-tools": "workspace:0.13.1",
+    "@solana-mobile/dapp-store-publishing-tools": "workspace:0.14.0",
     "@solana/web3.js": "1.92.1",
     "@types/semver": "^7.3.13",
     "ajv": "^8.11.0",

package/lib/prebuild_schema/publishing_source.yaml

@@ -2,6 +2,7 @@ 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: ""

package/lib/prebuild_schema/schemagen.js

@@ -10,6 +10,11 @@ try {
     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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana-mobile/dapp-store-cli",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,
@@ -47,7 +47,7 @@
     "@ardrive/turbo-sdk": "^1.31.1",
     "@aws-sdk/client-s3": "^3.321.1",
     "@metaplex-foundation/js-plugin-aws": "^0.20.0",
-    "@solana-mobile/dapp-store-publishing-tools": "0.13.1",
+    "@solana-mobile/dapp-store-publishing-tools": "0.14.0",
     "@solana/web3.js": "1.92.1",
     "@types/semver": "^7.3.13",
     "ajv": "^8.11.0",

package/src/CliSetup.ts

@@ -52,6 +52,7 @@ function latestReleaseMessage() {
   const messages = [
     `- Banner Graphic image of size 1200x600px is now manadatory for publishing updates.`,
     `- Feature Graphic image of size 1200x1200px is required to be featured in Editor's choice carousel. (optional)`,
+    `- Release metadata now publishes publisher.support_email when provided; otherwise we reuse publisher.email for end-user support.`,
   ].join('\n\n')
   showMessage(
     `Publishing Tools Version ${ Constants.CLI_VERSION }`,
@@ -91,6 +92,15 @@ export const createCliCmd = mainCli
   .command("create")
   .description("Create a `app`, or `release`")
 
+createCliCmd.addHelpText(
+  "after",
+  [
+    "",
+    "Release metadata notes:",
+    "  We include publisher.support_email when provided; if omitted we fall back to publisher.email.",
+  ].join("\n")
+);
+
 export const createAppCliCmd = createCliCmd
   .command("app")
   .description("Create a app")

package/src/CliUtils.ts

@@ -17,7 +17,7 @@ import { awsStorage } from "@metaplex-foundation/js-plugin-aws";
 import { S3StorageManager } from "./config/index.js";
 
 export class Constants {
-  static CLI_VERSION = "0.13.1";
+  static CLI_VERSION = "0.14.0";
   static CONFIG_FILE_NAME = "config.yaml";
   static DEFAULT_RPC_DEVNET = "https://api.devnet.solana.com";
   static DEFAULT_PRIORITY_FEE = 500000;

package/src/__tests__/CliSetupTest.ts

@@ -24,11 +24,11 @@ describe("Cli Setup & Execution", () => {
       getErrHelpWidth(): number { return 250;},
 
       writeOut(str: string) {
-        otherOutput = str;
+        otherOutput += str;
       },
 
       writeErr(str: string) {
-        errorOutput = str;
+        errorOutput += str;
       }
     });
   });
@@ -136,7 +136,7 @@ Options:
 
   const keyPairArgHelp = "error: required option '-k, --keypair <path-to-keypair-file>' not specified"
 
-  const createHelp = `Usage: dapp-store create [options] [command]
+const createHelp = `Usage: dapp-store create [options] [command]
 
 Create a \`app\`, or \`release\`
 
@@ -147,6 +147,9 @@ Commands:
   app [options]      Create a app
   release [options]  Create a release
   help [command]     display help for command
+
+Release metadata notes:
+  We include publisher.support_email when provided; if omitted we fall back to publisher.email.
 `;
 
   const createAppHelp = `Usage: dapp-store create app [options]
@@ -177,4 +180,4 @@ Options:
   -h, --help                                           display help for command
 `;
 
-});
+});

package/src/commands/create/index.ts

@@ -15,7 +15,7 @@ export * from "./CreateCliRelease.js";
 // Publisher
 // Public key attached to a publisher must also verify applications and releases
 // Most information here can be be edited after the fact
-// Only required fields are name, address, publisher website, and contact
+// Only required fields are name, address, publisher website, and contact email
 // Optional fields are: description, image_url (need dimensions!)
 
 // App

package/src/prebuild_schema/publishing_source.yaml

@@ -2,6 +2,7 @@ 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: ""

package/src/prebuild_schema/schemagen.js

@@ -16,6 +16,10 @@ try {
     ["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;