Feature Request: Todos tutorial step - sort Todos by createdAt date

[JoshuaTyler-GitHub]

Is this related to a new or existing framework?

React, Next.js

Is this related to a new or existing API?

GraphQL API, New API

Is this related to another service?

No response

Describe the feature you'd like to request

I would like the tutorial starter project to be expanded on a bit to cover how Todos are sorted by the createdAt timestamp.

https://docs.amplify.aws/nextjs/start/quickstart/nextjs-app-router-client-components/

Describe the solution you'd like

I would like code examples of how to sort Todos by the time at which they were created.

Describe alternatives you've considered

You can sort them on the frontend but that does not do you any good if the newest Todos are not delivered to you from the backend.

Additional context

No response

Is this something that you'd be interested in working on?

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

[cwomack]

Hello, @JoshuaTyler-GitHub and thanks for opening this issue. I've created a docs issue on the amplify-docs repo to have this considered and will review this request with our team internally. If there's any further context we need or questions we have, we'll follow up. Thanks!

[tomphan]

Hi. I would not need a feature request, but please could the team suggest how to list the Todo and sort by createdAt.
I tried & searched any available similar issue on the Internet but no luck.

As I see in other issue thread, we could create a secondaryIndexes with sortKeys(['createdAt']), however I cannot call the generated client query because this case we need to specify the exact field content value.

    Todo: a.model({
      content: a.string(),
      isDone: a.boolean(),
      createdAt: a.datetime(),
    }).secondaryIndexes((index) => [
      index('content').sortKeys(['createdAt']),      
    ]), 

          const { data: items, errors } = await client_schema.models.Todo.listTodoByContentAndCreatedAt(  
            {   
                content: "...", // ? <---- we need to specify
            },
            {
                sortDirection: 'DESC',
            }
        );

So, please could the anyone suggest how to sort a list with Gen 2? Thanks.

[tomphan]

Solved: After looking at the Gen 1 doc, for reference, I'm able to do that for Gen 2.
https://docs.amplify.aws/gen1/react/build-a-backend/graphqlapi/best-practice/query-with-sorting/

The trick is creating a new dummy field type with a fixed value Todo so all query with type: 'Todo' can return all records.

    Todo: a.model({
      content: a.string(),
      isDone: a.boolean(),
      createdAt: a.datetime(),
      type: a.string(),            // <------------ new field
    }).secondaryIndexes((index) => [
      index('type').sortKeys(['createdAt']),      // <-------- sort key
    ]),  

Then, populate / update all todos with new type field valued Todo, for querying.

          const { data: items, errors } = await client_schema.models.Todo.listTodoByTypeAndCreatedAt(  
            {   
                type: "Todo", //  <---------- populate all records contains value "Todo"
            },
            {
                sortDirection: 'DESC',
            }
        );

Anyway, please update the doc for Gen 2 so people like me will not need to adapt this trick from Gen 1. Thx.