djkato/saleor-apps-redis_apl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
saleor-apps-redis_apl/apps/emails-and-messages
History
Adrian Pilarczyk 453baf78a1
feat: finalize order process (#355) 
* feat: ✨ add dummy order-created

* refactor: 🔥 unused private-providers-configuration-service

* feat: ✨ add dummy order-fulfilled

* refactor: 🚚 move provider-config

* refactor: 🚚 crudSettingsConfigurator -> crudSettingsManager

* refactor: ♻️ [tax-provider].ts -> [tax-provider]-webhook.service.ts

* feat: ✨ add dummy createOrder

* refactor: ♻️ distinguish between salesOrder and salesInvoice in avatax

* refactor: 🚚 [provider]-calculate.ts to [provider]-transform.ts

* refactor: 🚚 ResponseTaxPayload to tax-provider-webhook.ts

* refactor: 🚚 ResponseTaxPayload -> CalculateTaxesResponse

* refactor: ♻️ webhooks with active-tax-provider.service.ts

* feat: ✨ add skeleton orderCreate functionality

* refactor: ♻️ [provider]-transform.ts -> [provider]-[webhook]-transform.ts

* feat: ✨ add order-fulfilled with avatax call

* refactor: ♻️ move getActiveTaxProvider to active-tax-provider

* refactor: 🏷️ export types for [provider]-client function args

* refactor: 🚚 UpdateAppMetadata -> UpdateMetadata

* feat: ✨ fulfill order with id from metadata

* build: ⬆️ upgrade avatax

* feat: ✨ commit transaction on fulfill in avatax

* fix: 🐛 return of webhooks to ensure valid retry behavior

* refactor: 🚚 [provider]-[webhook]-transform -> [provider]-[webhook]-map

* refactor: 🏷️ export types of avatax-calculate-taxes mapPayload

* refactor: ♻️ extract address-map to separate function

* refactor: ♻️ remove schema.ts

* refactor: ♻️ move addressSchema to channels-config.ts

* feat: ✨ add tests & placeholder tests for avatax & taxjar maps

* refactor: ♻️ throw error if no metadata

* refactor: ♻️ change EXTERNAL_ID_KEY to PROVIDER_ORDER_ID_KEY

add comments

* refactor: ♻️ comments -> it.todo in tests

* refactor: 💡 add comment about shipping_item_code

* refactor: ✅ add todo items for tests

* refactor: ♻️ remove export and add sumLines to taxJarOrderCreated

* refactor: ♻️ address-map with avatarAddressFactory

* docs: 💡 add comment about MOCKED_SALEOR_PAYLOAD

* refactor: ♻️ remove export of mapLines and add to avataxCalculateTaxes

* style: 🎨 add newline-after-var warn to eslint-config-saleor

* style: 🎨 autofix newline-after-var in taxes

* test: ✅ restructure tests according to new naming in address-map

* refactor: ♻️ add shippingItemCode to avataxCalculateTaxes wrapper object

* refactor: 🚚 payloadProps -> payloadArgs

* refactor: ♻️ add Maps suffix to map wrapper objects

* refactor: ♻️ remove data: null from ActiveTaxProviderResult

* refactor: ♻️ maintain the object hierarchy in tests

* refactor: ♻️ refactor webhook responses with WebhookResponseFactory

* build: ⬆️ vitest

* test: ✅ add tests for get-app-config-test

* test: ✅ add tests for getActiveTaxProvider

* refactor: ♻️ use address fragment for taxBase and order

* refactor: ♻️ rename WebhookResponseFactory -> WebhookResponse

* style: 👷 add multiline-comment-style

* fix: 🐛 dummy test in get-app-config.test.ts

* refactor: ♻️ rename AddressFragment -> Address

* refactor: ♻️ use debug instead of error in webhook-response noRetry

* refactor: ♻️ refactor as variables in mutation

* build: 👷 add changeset

* refactor: ♻️ split changesets in two

* build: ⬆️ vite

* build: ⬆️ vite && vitest in all apps
2023-04-17 13:58:21 +02:00
..
graphql Replace export default with named exports (#352) 2023-04-05 20:27:23 +02:00
src Extract useDashboardNotification (#362) 2023-04-14 17:40:49 +02:00
.env.example Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
.eslintrc Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
.graphqlrc.yml Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
.npmrc Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
CHANGELOG.md Release apps (#357) - 2023-04-13 2023-04-13 16:24:38 +02:00
docker-compose.yml Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
next-env.d.ts Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
next.config.js Extract useDashboardNotification (#362) 2023-04-14 17:40:49 +02:00
package.json feat: finalize order process (#355) 2023-04-17 13:58:21 +02:00
README.md Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
tsconfig.json Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00
turbo.json Change turborepo config to use local turbo.json (#353) 2023-04-13 12:44:27 +02:00
vitest.config.ts Add emails and messages app (#236) 2023-03-09 09:14:29 +01:00

README.md

Hero image

Emails and messages

What's included?

  • sending emails via SMTP
  • MJML template support
  • supported messages:
    • order
      • created
      • confirmed
      • cancelled
      • fully fulfilled
      • fully paid
    • invoice
      • sent

How to install

  • start local dev server or deploy the application
  • install the application in your Saleor Instance using manifest URL
  • configure the application in the dashboard

Learn more about Apps

Apps guide

Configuring apps in dashboard

Development

Requirements

Before you start, make sure you have installed:

  1. Install the dependencies by running:
pnpm install
  1. Start the local server with:
pnpm dev
  1. Expose local environment using tunnel:
  • Use Saleor CLI saleor app tunnel
  • Use tunneling tools like localtunnel or ngrok.
  1. Install application at your dashboard:

If you use Saleor Cloud or your local server is exposed, you can install your app by following this link:

[YOUR_SALEOR_DASHBOARD_URL]/apps/install?manifestUrl=[YOUR_APP_TUNNEL_MANIFEST_URL]

This template host manifest at /api/manifest

You can also install application using GQL or command line. Follow the guide how to install your app to learn more.

  1. Start the dev SMTP server
docker compose up

All emails will be captured by the MailHog service. To inspect emails, open http://localhost:8025/ in your browser.

Generated schema and typings

Commands build and dev would generate schema and typed functions using Saleor's GraphQL endpoint. Commit the generated folder to your repo as they are necessary for queries and keeping track of the schema changes.

Learn more about GraphQL code generation.

Storing registration data - APL

During registration process Saleor API pass the auth token to the app. With this token App can query Saleor API with privileged access (depending on requested permissions during the installation). To store this data, app-template use a different APL interfaces.

The choice of the APL is done using APL environment variable. If value is not set, FileAPL is used. Available choices:

  • file: no additional setup is required. Good choice for local development. Can't be used for multi tenant-apps or be deployed (not intended for production)
  • upstash: use Upstash Redis as storage method. Free account required. Can be used for development and production and supports multi-tenancy. Requires UPSTASH_URL and UPSTASH_TOKEN environment variables to be set

If you want to use your own database, you can implement your own APL. Check the documentation to read more.