-
Notifications
You must be signed in to change notification settings - Fork 16
feat(examples): link Domains by DomainId to preserve ENSv1/ENSv2 variant #2180
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
951fa4b
feat(examples): link Domains by DomainId to preserve ENSv1/ENSv2 variant
shrugs 8c672d4
chore: drop changeset for example app
shrugs 758ed77
chore(examples): unpin to workspace:* and migrate to 1.14.x Omnigraph…
shrugs ddf3bd5
docs: version-lock Omnigraph walkthroughs and schema reference to act…
shrugs 145c974
docs: version-lock the ENSv2 Quickstart to the active Omnigraph version
shrugs a60e8f5
docs/examples: address review findings
shrugs 8256629
docs: simplify HostedInstanceSdkVersionWarning to always show both SDKs
shrugs 7672715
docs: drop dead `for` plumbing now that the SDK warning always shows …
shrugs e22335a
checkpoint
shrugs 118cad3
fix: clean up examples
shrugs c55eb9b
Merge main into worktree-issue-2141-domain-by-id
shrugs 08ef463
fix: address PR review feedback (loop 1)
shrugs c2a3da8
fix: address PR review feedback (loop 2)
shrugs 66895e9
fix: clean up stackblitz env handling
shrugs File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
38 changes: 8 additions & 30 deletions
38
docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,18 @@ | ||
| --- | ||
| import { Aside } from "@astrojs/starlight/components"; | ||
|
|
||
| interface Props { | ||
| /** | ||
| * Which SDK(s) the warning is for. | ||
| * - "enssdk": only enssdk | ||
| * - "enskit": both enskit and enssdk (enskit depends on enssdk) | ||
| * - "both": mention both enssdk and enskit, show both install commands | ||
| */ | ||
| for?: "enssdk" | "enskit" | "both"; | ||
| } | ||
| import { ACTIVE_OMNIGRAPH_VERSION } from "@data/omnigraph-examples/active"; | ||
|
|
||
| const { for: target = "enssdk" } = Astro.props; | ||
|
|
||
| const isEnskit = target === "enskit"; | ||
| const isBoth = target === "both"; | ||
|
|
||
| const sdkList = isEnskit | ||
| ? "<code>enskit@1.13.1</code> and <code>enssdk@1.13.1</code>" | ||
| : isBoth | ||
| ? "<code>enssdk@1.13.1</code> (and <code>enskit@1.13.1</code> when using React)" | ||
| : "<code>enssdk@1.13.1</code>"; | ||
| // The SDK version is locked to the production-deployed Omnigraph version (see | ||
| // `@data/omnigraph-examples/active`). The SDK bundles the Omnigraph schema, so pinning the matching | ||
| // version keeps gql.tada's generated types aligned with the deployed API. Updates on promotion. | ||
| const VERSION = ACTIVE_OMNIGRAPH_VERSION.replace(/^v/, ""); | ||
| --- | ||
|
|
||
| <Aside type="caution" title="Version compatibility with hosted instances"> | ||
| Our hosted ENSNode instances currently run ENSNode v1.13. If you are querying them from your own app, you <strong>must</strong> use <span set:html={sdkList} />. The latest published versions (<code>1.14.0+</code>) contain breaking changes in the Omnigraph API data model not yet deployed to our hosted infrastructure. Use these exact install commands: | ||
| Our hosted ENSNode instances currently run ENSNode <code>{VERSION}</code>. The Omnigraph GraphQL schema is bundled inside the SDK and consumed by the <code>gql.tada</code> TypeScript plugin to type your queries, so pin an <strong>exact</strong> version (no <code>^</code> or <code>~</code>) of <code>enssdk@{VERSION}</code> (and <code>enskit@{VERSION}</code> when using React) to keep your generated types matched to the deployed schema. Use these exact install commands: | ||
|
|
||
| {isBoth ? ( | ||
| <pre>npm install enssdk@1.13.1 | ||
| <pre>{`npm install enssdk@${VERSION} | ||
| # or, for React apps: | ||
| npm install enskit@1.13.1 enssdk@1.13.1</pre> | ||
| ) : isEnskit ? ( | ||
| <pre>npm install enskit@1.13.1 enssdk@1.13.1</pre> | ||
| ) : ( | ||
| <pre>npm install enssdk@1.13.1</pre> | ||
| )} | ||
|
|
||
| This notice will be removed once the hosted instances are upgraded. | ||
| npm install enskit@${VERSION} enssdk@${VERSION}`}</pre> | ||
|
shrugs marked this conversation as resolved.
|
||
| </Aside> | ||
14 changes: 1 addition & 13 deletions
14
docs/ensnode.io/src/components/molecules/IntegrateHostedEnsNodeTip.astro
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 16 additions & 1 deletion
17
docs/ensnode.io/src/components/organisms/OmnigraphSchemaDocExplorer.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.