Skip to content

Commit

Permalink
fix: missing configureParams from rule metadata spec
Browse files Browse the repository at this point in the history
  • Loading branch information
cesarenaldi committed Jan 27, 2025
1 parent 1c8f5a2 commit a44a424
Show file tree
Hide file tree
Showing 49 changed files with 839 additions and 35 deletions.
5 changes: 5 additions & 0 deletions .changeset/great-coins-march.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@lens-protocol/metadata': patch
---

**fix:** missing `configureParams` from rule metadata spec"
2 changes: 1 addition & 1 deletion docs/assets/navigation.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/functions/feedRule.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ <h5><span class="tsd-kind-parameter">input</span>: <a href="../types/FeedRuleOpt
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../types/FeedRuleMetadata.html" class="tsd-signature-type tsd-kind-type-alias">FeedRuleMetadata</a></h4>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-2">metadata</span><span class="hl-1"> = </span><span class="hl-9">feedRule</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;MyFeedRule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-3">&#39;This is my Feed Rule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">description:</span><span class="hl-1"> </span><span class="hl-3">&#39;Get ready for the future of social interaction!&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">authors:</span><span class="hl-1"> [</span><span class="hl-3">&#39;[email protected]&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-0">source:</span><span class="hl-1"> </span><span class="hl-3">&#39;https://github.com/foobarbaz/my-open-action&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">processCreatePostParams:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;83b03721c31435de384ca9cc3799cdfa10e19123e6a48dbf11589e36a0ef0b95&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;recipient&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;e4ddce99520beb836fc879fc2a7d0743f784ffb925f96544bb5ff27c441c8c99&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;fee&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address token, uint256 value&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-0">processEditPostParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1"> </span><span class="hl-0">processRemovePostParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1"> </span><span class="hl-0">processPostRuleChangesParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1">});</span>
<h4>Example</h4><pre><code class="language-ts"><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-2">metadata</span><span class="hl-1"> = </span><span class="hl-9">feedRule</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;MyFeedRule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-3">&#39;This is my Feed Rule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">description:</span><span class="hl-1"> </span><span class="hl-3">&#39;Get ready for the future of social interaction!&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">authors:</span><span class="hl-1"> [</span><span class="hl-3">&#39;[email protected]&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-0">source:</span><span class="hl-1"> </span><span class="hl-3">&#39;https://github.com/foobarbaz/my-open-action&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">configureParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1"> </span><span class="hl-0">processCreatePostParams:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;83b03721c31435de384ca9cc3799cdfa10e19123e6a48dbf11589e36a0ef0b95&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;recipient&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;e4ddce99520beb836fc879fc2a7d0743f784ffb925f96544bb5ff27c441c8c99&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;fee&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address token, uint256 value&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-0">processEditPostParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1"> </span><span class="hl-0">processRemovePostParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1"> </span><span class="hl-0">processPostRuleChangesParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/builders/rules.ts#L85">src/builders/rules.ts:85</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/builders/rules.ts#L86">src/builders/rules.ts:86</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
8 changes: 4 additions & 4 deletions docs/functions/followRule.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<h1>Function followRule</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="followRule"><span class="tsd-kind-call-signature">follow<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">FollowRuleMetadata</span><a href="#followRule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="followRule"><span class="tsd-kind-call-signature">follow<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/FollowRuleMetadata.html" class="tsd-signature-type tsd-kind-type-alias">FollowRuleMetadata</a><a href="#followRule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Creates a valid FollowRuleMetadata.</p>
</div>
Expand All @@ -29,13 +29,13 @@ <h5><span class="tsd-kind-parameter">input</span>: <a href="../types/FollowRuleO
<div class="tsd-comment tsd-typography"><p>Use your IDE suggestions for an enhanced development experience</p>
</div>
<div class="tsd-comment tsd-typography"></div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">FollowRuleMetadata</span></h4>
<h4 class="tsd-returns-title">Returns <a href="../types/FollowRuleMetadata.html" class="tsd-signature-type tsd-kind-type-alias">FollowRuleMetadata</a></h4>
<div class="tsd-comment tsd-typography">
<h4>Example</h4><pre><code class="language-ts"><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-2">metadata</span><span class="hl-1"> = </span><span class="hl-9">followRule</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;MyFollowRule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-3">&#39;This is my Follow Rule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">description:</span><span class="hl-1"> </span><span class="hl-3">&#39;Get ready for the future of social interaction!&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">authors:</span><span class="hl-1"> [</span><span class="hl-3">&#39;[email protected]&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-0">source:</span><span class="hl-1"> </span><span class="hl-3">&#39;https://github.com/foobarbaz/my-open-action&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">processFollowParams:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;83b03721c31435de384ca9cc3799cdfa10e19123e6a48dbf11589e36a0ef0b95&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;recipient&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;e4ddce99520beb836fc879fc2a7d0743f784ffb925f96544bb5ff27c441c8c99&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;fee&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address token, uint256 value&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1">});</span>
<h4>Example</h4><pre><code class="language-ts"><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-2">metadata</span><span class="hl-1"> = </span><span class="hl-9">followRule</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;MyFollowRule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-3">&#39;This is my Follow Rule&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">description:</span><span class="hl-1"> </span><span class="hl-3">&#39;Get ready for the future of social interaction!&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">authors:</span><span class="hl-1"> [</span><span class="hl-3">&#39;[email protected]&#39;</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-0">source:</span><span class="hl-1"> </span><span class="hl-3">&#39;https://github.com/foobarbaz/my-open-action&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">configureParams:</span><span class="hl-1"> [],</span><br/><span class="hl-1"> </span><span class="hl-0">processFollowParams:</span><span class="hl-1"> [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;83b03721c31435de384ca9cc3799cdfa10e19123e6a48dbf11589e36a0ef0b95&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;recipient&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">key:</span><span class="hl-1"> </span><span class="hl-3">&#39;e4ddce99520beb836fc879fc2a7d0743f784ffb925f96544bb5ff27c441c8c99&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">&#39;fee&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">type:</span><span class="hl-1"> </span><span class="hl-3">&#39;address token, uint256 value&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/builders/rules.ts#L376">src/builders/rules.ts:376</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/builders/rules.ts#L382">src/builders/rules.ts:382</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit a44a424

Please sign in to comment.