chore: updates metadata and fixes some types

lens-protocol · Dec 10, 2024 · f4dc8d0 · f4dc8d0
1 parent 73b107c
commit f4dc8d0
Show file tree

Hide file tree

Showing 35 changed files with 130 additions and 158 deletions.
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/enums/Platform.html b/docs/enums/Platform.html
@@ -16,7 +16,7 @@
 <li><a href="Platform.html">Platform</a></li></ul>
 <h1>Enumeration Platform</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L67">src/app/AppMetadataSchema.ts:67</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L71">src/app/AppMetadataSchema.ts:71</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,17 +34,17 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>ANDROID</span><a href="#ANDROID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">ANDROID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;android&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L70">src/app/AppMetadataSchema.ts:70</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L74">src/app/AppMetadataSchema.ts:74</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="IOS" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>IOS</span><a href="#IOS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">IOS</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ios&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L69">src/app/AppMetadataSchema.ts:69</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L73">src/app/AppMetadataSchema.ts:73</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="WEB" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>WEB</span><a href="#WEB" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">WEB</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;web&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L68">src/app/AppMetadataSchema.ts:68</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/app/AppMetadataSchema.ts#L72">src/app/AppMetadataSchema.ts:72</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/docs/functions/app.html b/docs/functions/app.html
@@ -34,7 +34,7 @@ <h5><span class="tsd-kind-parameter">input</span>: <a href="../types/AppOptions.
 <h4 class="tsd-returns-title">Returns <a href="../types/AppMetadata.html" class="tsd-signature-type tsd-kind-type-alias">AppMetadata</a></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/builders/app.ts#L65">src/builders/app.ts:65</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/lens-protocol/metadata/blob/main/src/builders/app.ts#L69">src/builders/app.ts:69</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

diff --git a/docs/functions/group.html b/docs/functions/group.html
@@ -20,7 +20,7 @@ <h1>Function group</h1></div>
 <li class="tsd-signature tsd-anchor-link" id="group"><span class="tsd-kind-call-signature">group</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/GroupMetadata.html" class="tsd-signature-type tsd-kind-type-alias">GroupMetadata</a><a href="#group" 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 GroupMetadata.</p>
-<pre><code class="language-ts"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-2">metadata</span><span class="hl-1"> = </span><span class="hl-10">group</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-4">&#39;XYZ&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">slug:</span><span class="hl-1"> </span><span class="hl-4">&#39;xyz&#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-4">&#39;Bringing you one step closer to achieving absolutely nothing, but in style!&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">icon:</span><span class="hl-1"> </span><span class="hl-4">&#39;lens://BsdfA...&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
+<pre><code class="language-ts"><span class="hl-8">const</span><span class="hl-1"> </span><span class="hl-2">metadata</span><span class="hl-1"> = </span><span class="hl-10">group</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-4">&#39;XYZ&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">slug:</span><span class="hl-1"> </span><span class="hl-4">&#39;xyz&#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-4">&#39;Bringing you one step closer to achieving absolutely nothing, but in style!&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">icon:</span><span class="hl-1"> </span><span class="hl-4">&#39;lens://BsdfA...&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-0">coverPicture:</span><span class="hl-1"> </span><span class="hl-4">&#39;lens://BsdfA...&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 </div>
 <div class="tsd-parameters">

diff --git a/docs/types/AppMetadataDetails.html b/docs/types/AppMetadataDetails.html
@@ -15,7 +15,7 @@
 <li><a href="../index.html">Lens Protocol Metadata Standards</a></li>
 <li><a href="AppMetadataDetails.html">AppMetadataDetails</a></li></ul>
 <h1>Type alias AppMetadataDetails</h1></div>
-<div class="tsd-signature"><span class="tsd-kind-type-alias">App<wbr/>Metadata<wbr/>Details</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?: </span><a href="Markdown.html" class="tsd-signature-type tsd-kind-type-alias">Markdown</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">developer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">logo</span><span class="tsd-signature-symbol">?: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">platforms</span><span class="tsd-signature-symbol">: </span><a href="../enums/Platform.html" class="tsd-signature-type tsd-kind-enum">Platform</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">privacyPolicy</span><span class="tsd-signature-symbol">?: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">termsOfService</span><span class="tsd-signature-symbol">?: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
+<div class="tsd-signature"><span class="tsd-kind-type-alias">App<wbr/>Metadata<wbr/>Details</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?: </span><a href="Markdown.html" class="tsd-signature-type tsd-kind-type-alias">Markdown</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">developer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">logo</span><span class="tsd-signature-symbol">?: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">platforms</span><span class="tsd-signature-symbol">: </span><a href="../enums/Platform.html" class="tsd-signature-type tsd-kind-enum">Platform</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">privacyPolicy</span><span class="tsd-signature-symbol">?: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">tagline</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">termsOfService</span><span class="tsd-signature-symbol">?: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div>
 <div class="tsd-type-declaration">
 <h4>Type declaration</h4>
 <ul class="tsd-parameters">
@@ -50,6 +50,11 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
 </div>
 <div class="tsd-comment tsd-typography"></div></li>
 <li class="tsd-parameter">
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">tagline</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>A memorable phrase to capture the essence of the app.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></li>
+<li class="tsd-parameter">
 <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">terms<wbr/>Of<wbr/>Service</span><span class="tsd-signature-symbol">?: </span><a href="URI.html" class="tsd-signature-type tsd-kind-type-alias">URI</a></h5>
 <div class="tsd-comment tsd-typography"><p>The terms of service for the app.</p>
 </div>