ref: add home, order, orders, and account profile urls to shop object

[kieckhafer]

Resolves #5144 (non-UI parts)
Impact: minor
Type: refactor

Issue

The API does not know what the storefront URLs are, so it can't use proper URLs when generating emails or redirecting after password resets, etc.

Solution

• Add the following fields to Shop schema. They have been grouped in a storefrontUrls object on shop. They are all String type and optional with no default value:

• • storefrontHomeUrl
• • storefrontOrderUrl (can have :orderReferenceId and :orderToken in the string)
• • storefrontOrdersUrl (can have :accountId in the string)
• • storefrontAccountProfileUrl (can have :accountId in the string)

• Add a new GraphQL mutation, updateShopUrls that allows admins to update these new fields.

Breaking changes

None

Testing

1. Go to the admin panel's shop settings.
2. Add urls for the various fields
3. See the URL's have been added to the Shop object in the DB
4. Change the values
5. See the values have been changed
6. Only pass 1 or 2 of the Urls, and see only those update

query {
  primaryShop {
    _id
    storefrontUrls {
      storefrontHomeUrl
      storefrontOrderUrl
      storefrontOrdersUrl
      storefrontAccountProfileUrl
    }
  }
}

mutation {
  updateShopUrls(
    input: {
    	shopId: "SHOP-ID-GOES-HERE",
        storefrontUrls: {
          storefrontHomeUrl: "storefrontHomeUrl updateTest",
          storefrontOrderUrl: " storefrontOrderUrl updateTest",
          storefrontOrdersUrl: "storefrontOrdersUrl updateTest",
          storefrontAccountProfileUrl: null
       }
     }
  ) {
    clientMutationId
    shop {
      _id
      storefrontUrls {
        storefrontHomeUrl
        storefrontOrderUrl
        storefrontOrdersUrl
        storefrontAccountProfileUrl
      }
    }
  }
}

[kieckhafer]

@aldeed @mikemurray this is the non-UI work for #5144. Will do UI next, but separately, so that all the blocked tickets mentioned in #5144 can be moved on.

@aldeed also working on separating the four URL's so that they can be independently updated in a GQL query, we can squeeze that in here, or add that in the UI PR.

[aldeed]

A few minor things

[kieckhafer]

@aldeed Ready for another look.

Made fixes based on your comments. also added code so now you can update each URL independently: 7b880ae

fixed issues, ready for another look

[machikoyasuda]

1 small JSDoc change and otherwise good!!!

Updated with jsdoc changes

[kieckhafer]

@machikoyasuda updated with changes, ready for another look