tilework / opus Goto Github PK

Overview

Currently, when an array-like field is getting created, it is necessary to pass an additional argument to the creation process:

const people = new Query('people', true)
    .addField('friends', true)
    .addField(new Field('parents', true)
        .addField('gender')
        .addField('age')
    );

const result = await client.post(people);

result[0].friends[0];
result[0].parents[0].gender;
result[0].parents[0].age;

Expected behavior

In the ideal world, this is handled completely automatically.

Brief mockup:

1. Use GraphQL type introspection functionality to generate the schema of TS types locally.
2. When building the type - either during the field generation process or query fetching, use the generated schema to determine whether the field is an array or not.

Native fetch accepts much more options than just an URL and headers.
If we add full options, we'll be able to use AbortController for example which is the right way of cancelling requests on the web.

Overview

Opus has started as a lightweight GraphQL client for the plugin system. It has proven itself very useful before, when being a part of the ScandiPWA technology.

The main feature that separates this package from the ScandiPWA implementation are typings.
Though, it is not yet clear how to extend the types of these queries. Opus has no idea about the plugin system, and if some query has additional fields coming from the plugins - they will not be respected by Opus typings.

Overview

In Opus, queries are built as objects and then serialized into a graphql document.

The serialization process, although is pretty fast already, can be improved with memoization, at least partly.

Requirements

When having a query for e.g. product, one will fetch it several times for different products with different arguments, but the query itself will remain the same. Hence, when re-fetching a query, it will be necessary to:

1. process the arguments all over again
2. use the result of previous query serialization for the body itself

Such a change will bring some additional bundle size. It is required to take a weighted decision on whether such an improvement in performance is worth it. The bundle size growth must be minimal.