add support_email to release

Author: kumailn

example/config.yaml

@@ -2,6 +2,7 @@ publisher:
   name: Solana Mobile
   website: https://solanamobile.com
   email: [email protected]
+  support_email: [email protected]
 app:
   name: Cute Kittens
   address: ''

packages/cli/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 must now include publisher.support_email (shown to end users) alongside publisher.email for Solana Mobile outreach.`,
   ].join('\n\n')
   showMessage(
     `Publishing Tools Version ${ Constants.CLI_VERSION }`,
@@ -87,10 +88,20 @@ export const initCliCmd = mainCli
     })
   });
 
+
 export const createCliCmd = mainCli
   .command("create")
   .description("Create a `app`, or `release`")
 
+createCliCmd.addHelpText(
+  "after",
+  [
+    "",
+    "Release metadata requirements:",
+    "  Ensure publisher.support_email is set in your config. Releases expose this to end users, while publisher.email remains for Solana Mobile outreach.",
+  ].join("\n")
+);
+
 export const createAppCliCmd = createCliCmd
   .command("app")
   .description("Create a app")

packages/cli/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, contact email, and support_email
 // Optional fields are: description, image_url (need dimensions!)
 
 // App

packages/cli/src/config/PublishDetails.ts

@@ -74,6 +74,10 @@ export const loadPublishDetailsWithChecks = async (
 ): Promise<PublishDetails> => {
   const config = await loadPublishDetails(Constants.getConfigFilePath());
 
+  if (!config.publisher?.support_email?.length) {
+    throw new Error("Please specify `publisher.support_email` in your configuration file. This email is displayed to dApp Store users for end-user support.");
+  }
+
   // 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"

packages/cli/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: <<[REQUIRED] SUPPORT_EMAIL_ADDRESS_FOR_END_USERS>>
 app:
   name: <<[REQUIRED] APP_NAME>>
   address: ""

packages/cli/src/prebuild_schema/schemagen.js

@@ -16,6 +16,10 @@ try {
     ["properties"]
     ["en-US"].required = ["short_description"];
 
+  schema["properties"]
+    ["publisher"]
+    .required = ["name", "website", "email", "support_email"];
+
   // Generator adds some keys/values we don't need & mess up validation
   delete schema.$schema;
   delete schema.title;

packages/core/src/create/ReleaseCore.ts

@@ -130,6 +130,7 @@ export const createReleaseJson = async (
           name: publisherDetails.name,
           website: publisherDetails.website,
           contact: publisherDetails.email,
+          support_email: publisherDetails.support_email,
         },
         release_details: {
           updated_on: new Date().toISOString(),

packages/core/src/schemas/releaseJsonMetadata.json

@@ -53,9 +53,13 @@
                 "contact": {
                   "type": "string",
                   "pattern": "^[a-zA-Z0-9_!#$%&'*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
+                },
+                "support_email": {
+                  "type": "string",
+                  "pattern": "^[a-zA-Z0-9_!#$%&'*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
                 }
               },
-              "required": ["name", "website", "contact"]
+              "required": ["name", "website", "contact", "support_email"]
             },
             "release_details": {
               "type": "object",

packages/core/src/types.ts

@@ -43,6 +43,7 @@ export type Publisher = {
   name: string;
   website: string;
   email: string;
+  support_email: string;
 };
 
 export type App = {

publishing-spec/SPEC.md

@@ -161,6 +161,8 @@ The following is a readable example instance with sample data filled in:
 }
 ```
 
+The `publisher_details` block includes both a `contact` address used by Solana Mobile to reach the publisher team directly and a `support_email` that is surfaced to end users in the dApp Store.
+
 ## App NFT JSON
 
 All releases for a dApp store entry will be grouped under an "App" collection, which itself will be an NFT that contains JSON metadata representing “global” immutable data for a dApp’s catalog entry. This actually ends up being just _one_ extension property, the app package name.