feat: Implement Next.js server (#2)

[aahna-ashina]

https://app.dework.xyz/nation3/app-2?taskId=2a5ceb0e-ed0f-43ef-a211-16830aaba13f

---

Implement Next.js server

• 6835dbe refactor: change extensions from .js to .ts
• ee5a62a Add ESLint config ("Strict")
• 4ea62d5 Set strict TypeScript mode
• 97eca07 Add TypeScript interfaces
  • ApplePass
  • GooglePass

Server Build and Deployment

• Configure server deployment in Vercel
  • Create new project in Vercel
  • Add environment variables in Vercel

Download Pass - /api/downloadPass

• 222b87b Add API endpoint: /api/downloadPass
• Implement logic in the Passes class - downloadPass(passportID, platform)
  • Check if the address has a passport NFT
  • Check if the signature is valid
  • Populate the pass template
    • Generate passes compatible with Google Pay #5
    • Send template updates to Apple Wallet passes #6
• Serve the pass download to the user

Connect Wallet and Initiate Pass Download

• Extend UI at app.nation.org to include download of the mobile passport (ref feat: Implement Next.js server (#2) #1 (comment))

Push Notification - /api/pushNotification

• 0580a98 Add API endpoint
• 0a5ec99 Add authentication (Basic Auth)
• Implement logic in the Passes class - pushNotification({title, content})
  • Google Pay: Send updates and push notifications to Google Pay passes #7
  • Apple Wallet: Send template updates to Apple Wallet passes #6

Push Template Update - /api/pushUpdate

• 3923533 Add API endpoint
• 0a5ec99 Add authentication (Basic Auth)
• Implement logic in the Passes class - pushUpdate(newPassTemplate)
  • Google Pay: Send updates and push notifications to Google Pay passes #7
  • Apple Wallet: Send template updates to Apple Wallet passes #6

Documentation

• Document the functionality of each REST API endpoint
  • /api/downloadPass
  • /api/pushUpdate: Document the steps for updating the pass template
  • /api/pushNotification: Document the commands for pushing a notification

[luisivan]

Thanks a lot! This is a great starting point. A few comments:

• We indeed use wagmi so far, so we should keep using it
• I'm thinking that it would make sense to implement the API here, and then implement the frontend part directly in nation3/app. That way, we can reuse all the existing styling/utilities (like connecting the user's wallet). Any thoughts?

[aahna-ashina]

• I'm thinking that it would make sense to implement the API here, and then implement the frontend part directly in nation3/app. That way, we can reuse all the existing styling/utilities (like connecting the user's wallet). Any thoughts?

@luisivan All right, that makes sense. So this Next.js server will purely be a REST API, with no visible UI 👍

A few follow-up questions about this:

1. Will the /api/downloadPass requests coming from the nation3/app be HTTP GET or HTTP POST requests?
2. When the /api/downloadPass request is successful, should the pass file be returned directly in the response body?
3. When the /api/downloadPass request is unsuccessful (e.g. invalid address or signature), what type of response should be returned? I'm assuming an HTTP error status code with a JSON response body explaining the error?

[luisivan]

1. Will the /api/downloadPass requests coming from the nation3/app be HTTP GET or HTTP POST requests?

I'd say GET makes more semantic sense.

2. When the /api/downloadPass request is successful, should the pass file be returned directly in the response body?

I think so, with the correct MIME type defined so it triggers a download.

3. When the /api/downloadPass request is unsuccessful (e.g. invalid address or signature), what type of response should be returned? I'm assuming an HTTP error status code with a JSON response body explaining the error?

Exactly.