Default import from one package

[fryorcraken]

This is a feature request

Problem

Basic usage of js-waku involved importing for a couple of packages:

• @waku/core
• @waku/create
• @waku/utils

See https://dev.waku.guide/browser/quick-start/

This kind be confusing for a developer.

More Context

The js-waku mono repo aims to be modular and to enable developer to limit their dependencies.
For more context, see #1159 for more context.

However, such characteristics are not desirable for a new comer, a developer trying out Waku or attempting to use it in a hackathon.

Hence, the @waku/create package was created to expose some API easy to use with good defaults.

Proposed Solutions

The proposal is for one js-waku package to be a proxy package for other packages that are expected to be used in most basic example.

@waku/create aimed to be said proxy package but fails at it as @waku/core and @waku/utils still need to be used.

Proposal:

1. Rename/replace @waku/create by a more attractive/general name. e.g. @waku/sdk
2. Proxy more function in new package from @waku/core so that all js-waku examples can be purely done by installing and importing from @waku/sdk (or whatever name we settle on).

• @waku/sdk package created
• Release @waku/sdk
• Use @waku/sdk in examples
• Removed forced version from release-please config Default import from one package #1353 (comment)

Notes

Cc @hackyguru @LordGhostX

[LordGhostX]

I agree with the proposal and would like to provide some additional considerations to support the transition:

1. Naming: Renaming @waku/create to @waku/sdk is brilliant. It's intuitive, beginner-friendly, and establishes it as the go-to toolkit. I was confused by the multiple imports in code examples when I first used Waku.

2. Proxying: To establish @waku/sdk as the primary package for basic examples, it should proxy important functions from @waku/core and @waku/utils. This simplifies the learning process and promotes its usage.

3. Documentation: Clear and comprehensive documentation for @waku/sdk is essential. It needs a beginner's guide, step-by-step instructions, and a clear distinction between basic usage (through @waku/sdk) and advanced usage (using direct imports from @waku/core and @waku/utils).

4. Examples: Practical examples using the @waku/sdk package will illustrate its use and capabilities, further encouraging adoption.

[weboko]

Keeping issue open to remove forced version after next release.

[fryorcraken]

FYI I defined next steps for this issue in the description. Moving back to "priority" column as no pending PR.

[fryorcraken]

Let's try to have remaining items done next week.

[weboko]

@waku/sdk is released and I will complete the transition of a basic example to it early next week

[weboko]

Basic examples are using @waku/sdk now. So we can start pointing it out in our docs. Meanwhile I started transitioning eth-pm and other React based examples.

cc: @LordGhostX

TODO of examples for me:

• eth-pm;
• light-chat;
• relay-angular-chat;
• relay-react-chat;
• store-reactjs-chat;
• web-chat;

[weboko]

The last example to update is relay-angular-chat and it is not that straightforward because of the inconsistency of internal types.
Will be addressed here a bit later - waku-org/examples.waku.org#246

Proposing to resolve this issue and track upgrade to the last example in this issue waku-org/examples.waku.org#247

[danisharora099]

Proposing to resolve this issue and track upgrade to the last example in this issue waku-org/js-waku-examples#247

I agree with this proposal as it resolves and upgrades all examples, but one which is being tracked in a separate issue 👍

[weboko]

Closing in favor of waku-org/examples.waku.org#247