@coveo/push-api-client 1.0.0 → 1.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +41 -2
  2. package/dist/definitions/document.d.ts +1 -1
  3. package/dist/docs/.nojekyll +1 -0
  4. package/dist/docs/assets/highlight.css +71 -0
  5. package/dist/docs/assets/icons.css +1043 -0
  6. package/dist/docs/assets/{images/icons.png → icons.png} +0 -0
  7. package/dist/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  8. package/dist/docs/assets/main.js +52 -0
  9. package/dist/docs/assets/{js/search.js → search.js} +1 -1
  10. package/dist/docs/assets/style.css +1384 -0
  11. package/dist/docs/assets/{images/widgets.png → widgets.png} +0 -0
  12. package/dist/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  13. package/dist/docs/classes/AnySecurityIdentityBuilder.html +12 -0
  14. package/dist/docs/classes/DocumentBuilder.html +37 -0
  15. package/dist/docs/classes/GroupSecurityIdentityBuilder.html +10 -0
  16. package/dist/docs/classes/Source.html +34 -0
  17. package/dist/docs/classes/UserSecurityIdentityBuilder.html +10 -0
  18. package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +10 -0
  19. package/dist/docs/enums/Environment.html +1 -0
  20. package/dist/docs/enums/SourceVisibility.html +1 -0
  21. package/dist/docs/index.html +38 -156
  22. package/dist/docs/interfaces/BatchUpdateDocuments.html +1 -0
  23. package/dist/docs/interfaces/Document.html +67 -0
  24. package/dist/docs/interfaces/SecurityIdentity.html +22 -0
  25. package/dist/docs/interfaces/SecurityIdentityBuilder.html +3 -0
  26. package/dist/docs/modules.html +3 -240
  27. package/dist/documentBuilder.js +10 -5
  28. package/dist/documentBuilder.js.map +1 -1
  29. package/dist/documentBuilder.spec.js +34 -0
  30. package/dist/documentBuilder.spec.js.map +1 -1
  31. package/dist/index.js +2 -2
  32. package/dist/index.js.map +1 -1
  33. package/dist/securityIdentityBuilder.js.map +1 -1
  34. package/dist/source.spec.js +1 -1
  35. package/dist/source.spec.js.map +1 -1
  36. package/package.json +20 -19
  37. package/CHANGELOG.md +0 -52
  38. package/dist/docs/assets/css/main.css +0 -2660
  39. package/dist/docs/assets/js/main.js +0 -248
  40. package/dist/docs/classes/anysecurityidentitybuilder.html +0 -297
  41. package/dist/docs/classes/documentbuilder.html +0 -949
  42. package/dist/docs/classes/groupsecurityidentitybuilder.html +0 -273
  43. package/dist/docs/classes/source.html +0 -897
  44. package/dist/docs/classes/usersecurityidentitybuilder.html +0 -273
  45. package/dist/docs/classes/virtualgroupsecurityidentitybuilder.html +0 -273
  46. package/dist/docs/enums/environment.html +0 -234
  47. package/dist/docs/enums/sourcevisibility.html +0 -220
  48. package/dist/docs/interfaces/batchupdatedocuments.html +0 -214
  49. package/dist/docs/interfaces/document.html +0 -518
  50. package/dist/docs/interfaces/securityidentity.html +0 -263
  51. package/dist/docs/interfaces/securityidentitybuilder.html +0 -223
package/dist/docs/interfaces/BatchUpdateDocuments.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>BatchUpdateDocuments | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@coveo/push-api-client</a></li><li><a href="BatchUpdateDocuments.html">BatchUpdateDocuments</a></li></ul><h1>Interface BatchUpdateDocuments</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BatchUpdateDocuments</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchUpdateDocuments.html#addOrUpdate" class="tsd-kind-icon">add<wbr/>Or<wbr/>Update</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchUpdateDocuments.html#delete" class="tsd-kind-icon">delete</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="addOrUpdate" class="tsd-anchor"></a><h3>add<wbr/>Or<wbr/>Update</h3><div class="tsd-signature tsd-kind-icon">add<wbr/>Or<wbr/>Update<span class="tsd-signature-symbol">:</span> <a href="../classes/DocumentBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">DocumentBuilder</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/source.ts#L24">src/source.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="delete" class="tsd-anchor"></a><h3>delete</h3><div class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>deleteChildren<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>documentId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/source.ts#L25">src/source.ts:25</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="BatchUpdateDocuments.html" class="tsd-kind-icon">Batch<wbr/>Update<wbr/>Documents</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchUpdateDocuments.html#addOrUpdate" class="tsd-kind-icon">add<wbr/>Or<wbr/>Update</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="BatchUpdateDocuments.html#delete" class="tsd-kind-icon">delete</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/interfaces/Document.html ADDED
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Document | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@coveo/push-api-client</a></li><li><a href="Document.html">Document</a></li></ul><h1>Interface Document</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>A Coveo document.</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Document</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#author" class="tsd-kind-icon">author</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#clickableUri" class="tsd-kind-icon">clickable<wbr/>Uri</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#compressedBinaryData" class="tsd-kind-icon">compressed<wbr/>Binary<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#data-1" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#date" class="tsd-kind-icon">date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#fileExtension" class="tsd-kind-icon">file<wbr/>Extension</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#metadata" class="tsd-kind-icon">metadata</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#modifiedDate" class="tsd-kind-icon">modified<wbr/>Date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#parentId" class="tsd-kind-icon">parent<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permanentId" class="tsd-kind-icon">permanent<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#uri" class="tsd-kind-icon">uri</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="author" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> author</h3><div class="tsd-signature tsd-kind-icon">author<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L72">src/document.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>The author of the document.</p>
5
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="clickableUri" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> clickable<wbr/>Uri</h3><div class="tsd-signature tsd-kind-icon">clickable<wbr/>Uri<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L68">src/document.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>The clickable URI associated with the document.</p>
7
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="compressedBinaryData" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> compressed<wbr/>Binary<wbr/>Data</h3><div class="tsd-signature tsd-kind-icon">compressed<wbr/>Binary<wbr/>Data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>compressionType<span class="tsd-signature-symbol">: </span><a href="../modules.html#CompressionType" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a><span class="tsd-signature-symbol">; </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L122">src/document.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
+ <p>The original binary item content, compressed using one of the supported compression types (Deflate, GZip, LZMA, Uncompressed, or ZLib), and then Base64 encoded.</p>
9
+ </div><div><p>You can use this parameter when you&#39;re pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary) whose size is less than 5 MB.</p>
10
+ <p>Whenever you&#39;re pushing an item whose size is 5 MB or more, use the CompressedBinaryDataFileIdproperty instead.</p>
11
+ <p>If you&#39;re pushing less than 5 MB of textual (non-binary) content, you can use the data property instead.</p>
12
+ <p>See <a href="https://docs.coveo.com/en/73">https://docs.coveo.com/en/73</a> for more information.</p>
13
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>compression<wbr/>Type<span class="tsd-signature-symbol">: </span><a href="../modules.html#CompressionType" class="tsd-signature-type" data-tsd-kind="Type alias">CompressionType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>The compression type that was applied to your document.</p>
15
+ </div></div></li><li class="tsd-parameter"><h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
16
+ <p>The base64 encoded binary data.</p>
17
+ </div><div><p>Example: <code>eJxzrUjMLchJBQAK4ALN</code></p>
18
+ </div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="data-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> data</h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L110">src/document.ts:110</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
19
+ <p>The textual (non-binary) content of the item.</p>
20
+ </div><div><p>Whenever you&#39;re pushing a compressed binary item (such as XML/HTML, PDF, Word, or binary), you should use the CompressedBinaryData or CompressedBinaryDataFileId attribute instead, depending on the content size.</p>
21
+ <p>Accepts 5 MB or less of uncompressed textual data.</p>
22
+ <p>See <a href="https://docs.coveo.com/en/73">https://docs.coveo.com/en/73</a> for more information.</p>
23
+ <p>Example: <code>This is a simple string that will be used for searchability as well as to generate excerpt and summaries for the document.</code></p>
24
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="date" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> date</h3><div class="tsd-signature tsd-kind-icon">date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L78">src/document.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
25
+ <p>The date of the document, represented as an ISO string.</p>
26
+ </div><div><p>Optional, will default to indexation date.</p>
27
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="fileExtension" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> file<wbr/>Extension</h3><div class="tsd-signature tsd-kind-icon">file<wbr/>Extension<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L176">src/document.ts:176</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
28
+ <p>The file extension of the data you&#39;re pushing.</p>
29
+ </div><div><p>This is useful when pushing a compressed item. The converter uses this information to identify how to correctly process the item.</p>
30
+ <p>Values must include the preceding . character.</p>
31
+ <p>Example: <code>.html</code></p>
32
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="metadata" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3><div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#Metadata" class="tsd-signature-type" data-tsd-kind="Type alias">Metadata</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L143">src/document.ts:143</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
33
+ <p>The metadata key-value pairs for a given document.</p>
34
+ </div><div><p>Each metadata in the document must be unique.</p>
35
+ <p>Metadata are case-insensitive (e.g., the Push API considers mykey, MyKey, myKey, MYKEY, etc. as identical).</p>
36
+ <p>See <a href="https://docs.coveo.com/en/115">https://docs.coveo.com/en/115</a> for more information.</p>
37
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="modifiedDate" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> modified<wbr/>Date</h3><div class="tsd-signature tsd-kind-icon">modified<wbr/>Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L84">src/document.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
38
+ <p>The modified date of the document, represented as an ISO string.</p>
39
+ </div><div><p>Optional, will default to indexation date.</p>
40
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="parentId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> parent<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">parent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L98">src/document.ts:98</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
41
+ <p>The unique identifier (URI) of the parent item.</p>
42
+ </div><div><p>Specifying a value for this key creates a relationship between the attachment item (child) and its parent item.</p>
43
+ <p>This value also ensures that a parent and all of its attachments will be routed in the same index slice.</p>
44
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="permanentId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permanent<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">permanent<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L90">src/document.ts:90</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
45
+ <p>The permanent identifier of a document that does not change over time.</p>
46
+ </div><div><p>Optional, will be derived from the document URI.</p>
47
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="permissions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> permissions</h3><div class="tsd-signature tsd-kind-icon">permissions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>allowAnonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>allowedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>deniedPermissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L151">src/document.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
48
+ <p>The list of permission sets for this item.</p>
49
+ </div><div><p>This is useful when item based security is required (i.e., when security isn&#39;t configured at the source level).</p>
50
+ <p>See <a href="https://docs.coveo.com/en/107">https://docs.coveo.com/en/107</a> for more information.</p>
51
+ </div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>allow<wbr/>Anonymous<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
52
+ <p>Whether to allow anonymous users in this permission set.</p>
53
+ </div><div><p>Default value is false.</p>
54
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> allowed<wbr/>Permissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
55
+ <p>The list of allowed permissions for this permission set.</p>
56
+ </div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> denied<wbr/>Permissions<span class="tsd-signature-symbol">?: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
57
+ <p>The list of denied permissions for this permission set.</p>
58
+ </div></div></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="title" class="tsd-anchor"></a><h3>title</h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L64">src/document.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
59
+ <p>The title of the document.</p>
60
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="uri" class="tsd-anchor"></a><h3>uri</h3><div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L60">src/document.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
61
+ <p>The Uniform Resource Identifier (URI) that uniquely identifies the document in a Coveo index.</p>
62
+ </div><div><p>Examples:</p>
63
+ <ul>
64
+ <li><code>http://www.example.com/</code></li>
65
+ <li><code>file://folder/text.txt</code></li>
66
+ </ul>
67
+ </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="Document.html" class="tsd-kind-icon">Document</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#author" class="tsd-kind-icon">author</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#clickableUri" class="tsd-kind-icon">clickable<wbr/>Uri</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#compressedBinaryData" class="tsd-kind-icon">compressed<wbr/>Binary<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#data-1" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#date" class="tsd-kind-icon">date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#fileExtension" class="tsd-kind-icon">file<wbr/>Extension</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#metadata" class="tsd-kind-icon">metadata</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#modifiedDate" class="tsd-kind-icon">modified<wbr/>Date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#parentId" class="tsd-kind-icon">parent<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permanentId" class="tsd-kind-icon">permanent<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#permissions" class="tsd-kind-icon">permissions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Document.html#uri" class="tsd-kind-icon">uri</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/interfaces/SecurityIdentity.html ADDED
@@ -0,0 +1,22 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SecurityIdentity | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@coveo/push-api-client</a></li><li><a href="SecurityIdentity.html">SecurityIdentity</a></li></ul><h1>Interface SecurityIdentity</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>A security identity. See <a href="https://docs.coveo.com/en/1719">https://docs.coveo.com/en/1719</a> for more information.</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SecurityIdentity</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#identity" class="tsd-kind-icon">identity</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#identityType" class="tsd-kind-icon">identity<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#securityProvider" class="tsd-kind-icon">security<wbr/>Provider</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="identity" class="tsd-anchor"></a><h3>identity</h3><div class="tsd-signature tsd-kind-icon">identity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L18">src/document.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
+ <p>The name of the security identity.</p>
5
+ </div><div><p>Examples:</p>
6
+ <ul>
7
+ <li><code>asmith@example.com</code></li>
8
+ <li><code>SampleTeam2</code></li>
9
+ </ul>
10
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="identityType" class="tsd-anchor"></a><h3>identity<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../modules.html#SecurityIdentityType" class="tsd-signature-type" data-tsd-kind="Type alias">SecurityIdentityType</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L27">src/document.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>The type of the identity.
12
+ Valid values:</p>
13
+ <ul>
14
+ <li><code>UNKNOWN</code></li>
15
+ <li><code>USER</code> : Defines a single user.</li>
16
+ <li><code>GROUP</code> : Defines an existing group of identities within the indexed system. Individual members of this group can be of any valid identity Type (USER, GROUP, or VIRTUAL_GROUP).</li>
17
+ <li><code>VIRTUAL_GROUP</code> : Defines a group that doesn&#39;t exist within the indexed system. Mechanically, a <code>VIRTUAL_GROUP</code> is identical to a <code>GROUP</code>.</li>
18
+ </ul>
19
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="securityProvider" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> security<wbr/>Provider</h3><div class="tsd-signature tsd-kind-icon">security<wbr/>Provider<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L33">src/document.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
20
+ <p>The security identity provider through which the security identity is updated.</p>
21
+ </div><div><p>Defaults to the first security identity provider associated with the target Push source.</p>
22
+ </div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SecurityIdentity.html" class="tsd-kind-icon">Security<wbr/>Identity</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#identity" class="tsd-kind-icon">identity</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#identityType" class="tsd-kind-icon">identity<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SecurityIdentity.html#securityProvider" class="tsd-kind-icon">security<wbr/>Provider</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/interfaces/SecurityIdentityBuilder.html ADDED
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SecurityIdentityBuilder | @coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@coveo/push-api-client</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@coveo/push-api-client</a></li><li><a href="SecurityIdentityBuilder.html">SecurityIdentityBuilder</a></li></ul><h1>Interface SecurityIdentityBuilder</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Build a security identity. See <a href="SecurityIdentity.html">SecurityIdentity</a>.</p>
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SecurityIdentityBuilder</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/AnySecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">AnySecurityIdentityBuilder</a></li><li><a href="../classes/GroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">GroupSecurityIdentityBuilder</a></li><li><a href="../classes/UserSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">UserSecurityIdentityBuilder</a></li><li><a href="../classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">VirtualGroupSecurityIdentityBuilder</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SecurityIdentityBuilder.html#build" class="tsd-kind-icon">build</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="build" class="tsd-anchor"></a><h3>build</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">build<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/securityIdentityBuilder.ts#L7">src/securityIdentityBuilder.ts:7</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol"> | </span><a href="SecurityIdentity.html" class="tsd-signature-type" data-tsd-kind="Interface">SecurityIdentity</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SecurityIdentityBuilder.html" class="tsd-kind-icon">Security<wbr/>Identity<wbr/>Builder</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SecurityIdentityBuilder.html#build" class="tsd-kind-icon">build</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/dist/docs/modules.html CHANGED
@@ -1,240 +1,3 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>@coveo/push-api-client</title>
7
- <meta name="description" content="Documentation for @coveo/push-api-client">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="assets/css/main.css">
10
- <script async src="assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="index.html" class="title">@coveo/push-api-client</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <h1>@coveo/push-api-client</h1>
54
- </div>
55
- </div>
56
- </header>
57
- <div class="container container-main">
58
- <div class="row">
59
- <div class="col-8 col-content">
60
- <section class="tsd-panel-group tsd-index-group">
61
- <h2>Index</h2>
62
- <section class="tsd-panel tsd-index-panel">
63
- <div class="tsd-index-content">
64
- <section class="tsd-index-section tsd-is-external">
65
- <h3>Enumerations</h3>
66
- <ul class="tsd-index-list">
67
- <li class="tsd-kind-enum tsd-is-external"><a href="enums/environment.html" class="tsd-kind-icon">Environment</a></li>
68
- <li class="tsd-kind-enum tsd-is-external"><a href="enums/sourcevisibility.html" class="tsd-kind-icon">Source<wbr>Visibility</a></li>
69
- </ul>
70
- </section>
71
- <section class="tsd-index-section ">
72
- <h3>Classes</h3>
73
- <ul class="tsd-index-list">
74
- <li class="tsd-kind-class"><a href="classes/anysecurityidentitybuilder.html" class="tsd-kind-icon">Any<wbr>Security<wbr>Identity<wbr>Builder</a></li>
75
- <li class="tsd-kind-class"><a href="classes/documentbuilder.html" class="tsd-kind-icon">Document<wbr>Builder</a></li>
76
- <li class="tsd-kind-class"><a href="classes/groupsecurityidentitybuilder.html" class="tsd-kind-icon">Group<wbr>Security<wbr>Identity<wbr>Builder</a></li>
77
- <li class="tsd-kind-class"><a href="classes/source.html" class="tsd-kind-icon">Source</a></li>
78
- <li class="tsd-kind-class"><a href="classes/usersecurityidentitybuilder.html" class="tsd-kind-icon">User<wbr>Security<wbr>Identity<wbr>Builder</a></li>
79
- <li class="tsd-kind-class"><a href="classes/virtualgroupsecurityidentitybuilder.html" class="tsd-kind-icon">Virtual<wbr>Group<wbr>Security<wbr>Identity<wbr>Builder</a></li>
80
- </ul>
81
- </section>
82
- <section class="tsd-index-section ">
83
- <h3>Interfaces</h3>
84
- <ul class="tsd-index-list">
85
- <li class="tsd-kind-interface"><a href="interfaces/batchupdatedocuments.html" class="tsd-kind-icon">Batch<wbr>Update<wbr>Documents</a></li>
86
- <li class="tsd-kind-interface"><a href="interfaces/document.html" class="tsd-kind-icon">Document</a></li>
87
- <li class="tsd-kind-interface"><a href="interfaces/securityidentity.html" class="tsd-kind-icon">Security<wbr>Identity</a></li>
88
- <li class="tsd-kind-interface"><a href="interfaces/securityidentitybuilder.html" class="tsd-kind-icon">Security<wbr>Identity<wbr>Builder</a></li>
89
- </ul>
90
- </section>
91
- <section class="tsd-index-section ">
92
- <h3>Type aliases</h3>
93
- <ul class="tsd-index-list">
94
- <li class="tsd-kind-type-alias"><a href="modules.html#compressiontype" class="tsd-kind-icon">Compression<wbr>Type</a></li>
95
- <li class="tsd-kind-type-alias"><a href="modules.html#metadata" class="tsd-kind-icon">Metadata</a></li>
96
- <li class="tsd-kind-type-alias"><a href="modules.html#metadatavalue" class="tsd-kind-icon">Metadata<wbr>Value</a></li>
97
- <li class="tsd-kind-type-alias"><a href="modules.html#securityidentitytype" class="tsd-kind-icon">Security<wbr>Identity<wbr>Type</a></li>
98
- </ul>
99
- </section>
100
- </div>
101
- </section>
102
- </section>
103
- <section class="tsd-panel-group tsd-member-group ">
104
- <h2>Type aliases</h2>
105
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
106
- <a name="compressiontype" class="tsd-anchor"></a>
107
- <h3>Compression<wbr>Type</h3>
108
- <div class="tsd-signature tsd-kind-icon">Compression<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNCOMPRESSED&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;DEFLATE&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GZIP&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LZMA&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ZLIB&quot;</span></div>
109
- <aside class="tsd-sources">
110
- <ul>
111
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/document.ts#L42">src/document.ts:42</a></li>
112
- </ul>
113
- </aside>
114
- <div class="tsd-comment tsd-typography">
115
- <div class="lead">
116
- <p>The compression type that was applied to your compressed document.</p>
117
- </div>
118
- </div>
119
- </section>
120
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
121
- <a name="metadata" class="tsd-anchor"></a>
122
- <h3>Metadata</h3>
123
- <div class="tsd-signature tsd-kind-icon">Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="modules.html#metadatavalue" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a><span class="tsd-signature-symbol">&gt;</span></div>
124
- <aside class="tsd-sources">
125
- <ul>
126
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/document.ts#L37">src/document.ts:37</a></li>
127
- </ul>
128
- </aside>
129
- </section>
130
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
131
- <a name="metadatavalue" class="tsd-anchor"></a>
132
- <h3>Metadata<wbr>Value</h3>
133
- <div class="tsd-signature tsd-kind-icon">Metadata<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
134
- <aside class="tsd-sources">
135
- <ul>
136
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/document.ts#L36">src/document.ts:36</a></li>
137
- </ul>
138
- </aside>
139
- </section>
140
- <section class="tsd-panel tsd-member tsd-kind-type-alias">
141
- <a name="securityidentitytype" class="tsd-anchor"></a>
142
- <h3>Security<wbr>Identity<wbr>Type</h3>
143
- <div class="tsd-signature tsd-kind-icon">Security<wbr>Identity<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNKNOWN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GROUP&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;VIRTUAL_GROUP&quot;</span></div>
144
- <aside class="tsd-sources">
145
- <ul>
146
- <li>Defined in <a href="https://github.com/coveo/shovel.js/blob/2cec4e2/src/document.ts#L1">src/document.ts:1</a></li>
147
- </ul>
148
- </aside>
149
- </section>
150
- </section>
151
- </div>
152
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
153
- <nav class="tsd-navigation primary">
154
- <ul>
155
- <li class="current ">
156
- <a href="modules.html">Exports</a>
157
- </li>
158
- </ul>
159
- </nav>
160
- <nav class="tsd-navigation secondary menu-sticky">
161
- <ul class="before-current">
162
- <li class=" tsd-kind-enum tsd-is-external">
163
- <a href="enums/environment.html" class="tsd-kind-icon">Environment</a>
164
- </li>
165
- <li class=" tsd-kind-enum tsd-is-external">
166
- <a href="enums/sourcevisibility.html" class="tsd-kind-icon">Source<wbr>Visibility</a>
167
- </li>
168
- <li class=" tsd-kind-class">
169
- <a href="classes/anysecurityidentitybuilder.html" class="tsd-kind-icon">Any<wbr>Security<wbr>Identity<wbr>Builder</a>
170
- </li>
171
- <li class=" tsd-kind-class">
172
- <a href="classes/documentbuilder.html" class="tsd-kind-icon">Document<wbr>Builder</a>
173
- </li>
174
- <li class=" tsd-kind-class">
175
- <a href="classes/groupsecurityidentitybuilder.html" class="tsd-kind-icon">Group<wbr>Security<wbr>Identity<wbr>Builder</a>
176
- </li>
177
- <li class=" tsd-kind-class">
178
- <a href="classes/source.html" class="tsd-kind-icon">Source</a>
179
- </li>
180
- <li class=" tsd-kind-class">
181
- <a href="classes/usersecurityidentitybuilder.html" class="tsd-kind-icon">User<wbr>Security<wbr>Identity<wbr>Builder</a>
182
- </li>
183
- <li class=" tsd-kind-class">
184
- <a href="classes/virtualgroupsecurityidentitybuilder.html" class="tsd-kind-icon">Virtual<wbr>Group<wbr>Security<wbr>Identity<wbr>Builder</a>
185
- </li>
186
- <li class=" tsd-kind-interface">
187
- <a href="interfaces/batchupdatedocuments.html" class="tsd-kind-icon">Batch<wbr>Update<wbr>Documents</a>
188
- </li>
189
- <li class=" tsd-kind-interface">
190
- <a href="interfaces/document.html" class="tsd-kind-icon">Document</a>
191
- </li>
192
- <li class=" tsd-kind-interface">
193
- <a href="interfaces/securityidentity.html" class="tsd-kind-icon">Security<wbr>Identity</a>
194
- </li>
195
- <li class=" tsd-kind-interface">
196
- <a href="interfaces/securityidentitybuilder.html" class="tsd-kind-icon">Security<wbr>Identity<wbr>Builder</a>
197
- </li>
198
- <li class=" tsd-kind-type-alias">
199
- <a href="modules.html#compressiontype" class="tsd-kind-icon">Compression<wbr>Type</a>
200
- </li>
201
- <li class=" tsd-kind-type-alias">
202
- <a href="modules.html#metadata" class="tsd-kind-icon">Metadata</a>
203
- </li>
204
- <li class=" tsd-kind-type-alias">
205
- <a href="modules.html#metadatavalue" class="tsd-kind-icon">Metadata<wbr>Value</a>
206
- </li>
207
- <li class=" tsd-kind-type-alias">
208
- <a href="modules.html#securityidentitytype" class="tsd-kind-icon">Security<wbr>Identity<wbr>Type</a>
209
- </li>
210
- </ul>
211
- </nav>
212
- </div>
213
- </div>
214
- </div>
215
- <footer class="with-border-bottom">
216
- <div class="container">
217
- <h2>Legend</h2>
218
- <div class="tsd-legend-group">
219
- <ul class="tsd-legend">
220
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
221
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
222
- </ul>
223
- <ul class="tsd-legend">
224
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
225
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
226
- </ul>
227
- <ul class="tsd-legend">
228
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
229
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
230
- </ul>
231
- </div>
232
- </div>
233
- </footer>
234
- <div class="container tsd-generator">
235
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
236
- </div>
237
- <div class="overlay"></div>
238
- <script src="assets/js/main.js"></script>
239
- </body>
240
- </html>
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>@coveo/push-api-client</title><meta name="description" content="Documentation for @coveo/push-api-client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@coveo/push-api-client</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@coveo/push-api-client</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section tsd-is-external"><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-is-external"><a href="enums/Environment.html" class="tsd-kind-icon">Environment</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/SourceVisibility.html" class="tsd-kind-icon">Source<wbr/>Visibility</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class"><a href="classes/AnySecurityIdentityBuilder.html" class="tsd-kind-icon">Any<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/DocumentBuilder.html" class="tsd-kind-icon">Document<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/GroupSecurityIdentityBuilder.html" class="tsd-kind-icon">Group<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/Source.html" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-class"><a href="classes/UserSecurityIdentityBuilder.html" class="tsd-kind-icon">User<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-kind-icon">Virtual<wbr/>Group<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface"><a href="interfaces/BatchUpdateDocuments.html" class="tsd-kind-icon">Batch<wbr/>Update<wbr/>Documents</a></li><li class="tsd-kind-interface"><a href="interfaces/Document.html" class="tsd-kind-icon">Document</a></li><li class="tsd-kind-interface"><a href="interfaces/SecurityIdentity.html" class="tsd-kind-icon">Security<wbr/>Identity</a></li><li class="tsd-kind-interface"><a href="interfaces/SecurityIdentityBuilder.html" class="tsd-kind-icon">Security<wbr/>Identity<wbr/>Builder</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias"><a href="modules.html#CompressionType" class="tsd-kind-icon">Compression<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Metadata" class="tsd-kind-icon">Metadata</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MetadataValue" class="tsd-kind-icon">Metadata<wbr/>Value</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SecurityIdentityType" class="tsd-kind-icon">Security<wbr/>Identity<wbr/>Type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="CompressionType" class="tsd-anchor"></a><h3>Compression<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Compression<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNCOMPRESSED&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;DEFLATE&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GZIP&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LZMA&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ZLIB&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L42">src/document.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>The compression type that was applied to your compressed document.</p>
3
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="Metadata" class="tsd-anchor"></a><h3>Metadata</h3><div class="tsd-signature tsd-kind-icon">Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="modules.html#MetadataValue" class="tsd-signature-type" data-tsd-kind="Type alias">MetadataValue</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L37">src/document.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="MetadataValue" class="tsd-anchor"></a><h3>Metadata<wbr/>Value</h3><div class="tsd-signature tsd-kind-icon">Metadata<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L36">src/document.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a name="SecurityIdentityType" class="tsd-anchor"></a><h3>Security<wbr/>Identity<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Security<wbr/>Identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNKNOWN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;USER&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;GROUP&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;VIRTUAL_GROUP&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/1e22a0a/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-is-external"><a href="enums/Environment.html" class="tsd-kind-icon">Environment</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/SourceVisibility.html" class="tsd-kind-icon">Source<wbr/>Visibility</a></li><li class="tsd-kind-class"><a href="classes/AnySecurityIdentityBuilder.html" class="tsd-kind-icon">Any<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/DocumentBuilder.html" class="tsd-kind-icon">Document<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/GroupSecurityIdentityBuilder.html" class="tsd-kind-icon">Group<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/Source.html" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-class"><a href="classes/UserSecurityIdentityBuilder.html" class="tsd-kind-icon">User<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-class"><a href="classes/VirtualGroupSecurityIdentityBuilder.html" class="tsd-kind-icon">Virtual<wbr/>Group<wbr/>Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-interface"><a href="interfaces/BatchUpdateDocuments.html" class="tsd-kind-icon">Batch<wbr/>Update<wbr/>Documents</a></li><li class="tsd-kind-interface"><a href="interfaces/Document.html" class="tsd-kind-icon">Document</a></li><li class="tsd-kind-interface"><a href="interfaces/SecurityIdentity.html" class="tsd-kind-icon">Security<wbr/>Identity</a></li><li class="tsd-kind-interface"><a href="interfaces/SecurityIdentityBuilder.html" class="tsd-kind-icon">Security<wbr/>Identity<wbr/>Builder</a></li><li class="tsd-kind-type-alias"><a href="modules.html#CompressionType" class="tsd-kind-icon">Compression<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#Metadata" class="tsd-kind-icon">Metadata</a></li><li class="tsd-kind-type-alias"><a href="modules.html#MetadataValue" class="tsd-kind-icon">Metadata<wbr/>Value</a></li><li class="tsd-kind-type-alias"><a href="modules.html#SecurityIdentityType" class="tsd-kind-icon">Security<wbr/>Identity<wbr/>Type</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
package/dist/documentBuilder.js CHANGED
@@ -19,7 +19,7 @@ class DocumentBuilder {
19
19
  uri,
20
20
  title,
21
21
  metadata: {},
22
- permissions: { allowAnonymous: true },
22
+ permissions: { allowAnonymous: true }, // TODO: Revisit with CDX-307 on validation
23
23
  };
24
24
  }
25
25
  /**
@@ -183,7 +183,7 @@ class DocumentBuilder {
183
183
  */
184
184
  marshal() {
185
185
  this.validateAndFillMissing();
186
- const _a = this.doc, { uri, metadata, permissions } = _a, omitSomeProperties = tslib_1.__rest(_a, ["uri", "metadata", "permissions"]);
186
+ const _a = this.doc, { uri, metadata, permissions } = _a, omitSomeProperties = (0, tslib_1.__rest)(_a, ["uri", "metadata", "permissions"]);
187
187
  const out = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, omitSomeProperties), this.marshalMetadata()), this.marshalCompressedBinaryData()), this.marshalPermissions()), { documentId: uri });
188
188
  return out;
189
189
  }
@@ -230,7 +230,7 @@ class DocumentBuilder {
230
230
  return;
231
231
  }
232
232
  generatePermanentId() {
233
- return crypto_1.createHash('sha256').update(this.doc.uri).digest('hex');
233
+ return (0, crypto_1.createHash)('sha256').update(this.doc.uri).digest('hex');
234
234
  }
235
235
  validateDateAndReturnValidDate(d) {
236
236
  const validatedDate = dayjs(d);
@@ -243,12 +243,17 @@ class DocumentBuilder {
243
243
  }
244
244
  }
245
245
  setPermission(securityIdentityBuilder, permissionSection) {
246
+ var _a, _b;
246
247
  const identities = securityIdentityBuilder.build();
248
+ if (!this.doc.permissions[permissionSection]) {
249
+ this.doc.permissions[permissionSection] = [];
250
+ }
247
251
  if (Array.isArray(identities)) {
248
- this.doc.permissions[permissionSection] = identities;
252
+ this.doc.permissions[permissionSection] =
253
+ (_a = this.doc.permissions[permissionSection]) === null || _a === void 0 ? void 0 : _a.concat(identities);
249
254
  }
250
255
  else {
251
- this.doc.permissions[permissionSection] = [identities];
256
+ (_b = this.doc.permissions[permissionSection]) === null || _b === void 0 ? void 0 : _b.push(identities);
252
257
  }
253
258
  }
254
259
  }
package/dist/documentBuilder.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"documentBuilder.js","sourceRoot":"","sources":["../src/documentBuilder.ts"],"names":[],"mappings":";;;;AAAA,+BAAgC;AAChC,mCAAkC;AAIlC;;GAEG;AACH,MAAa,eAAe;IAE1B;;;;OAIG;IACH,YAAoB,GAAW,EAAE,KAAa;QAA1B,QAAG,GAAH,GAAG,CAAQ;QAC7B,IAAI,CAAC,GAAG,GAAG;YACT,GAAG;YACH,KAAK;YACL,QAAQ,EAAE,EAAE;YACZ,WAAW,EAAE,EAAC,cAAc,EAAE,IAAI,EAAC;SACpC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,IAAY;QAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,IAA4B;QAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAA4B;QAClD,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,WAAmB;QACxC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,wBAAwB,CAC7B,IAAY,EACZ,eAAgC;QAEhC,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,oBAAoB,GAAG;YAC9B,IAAI;YACJ,eAAe;SAChB,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,SAAiB;QACxC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;YACxB,MAAM,aAAa,SAAS,gCAAgC,CAAC;SAC9D;QACD,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,SAAS,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,EAAU;QAC5B,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,QAAgB;QACtC,2DAA2D;QAC3D,SAAS;QACT,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,QAAQ,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAc;QAC9B,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,GAAW,EAAE,KAAoB;QACxD,MAAM,gBAAgB,GAAG;YACvB,sBAAsB;YACtB,4BAA4B;YAC5B,UAAU;YACV,eAAe;YACf,MAAM;YACN,aAAa;YACb,YAAY;YACZ,YAAY;SACb,CAAC;QACF,IACE,gBAAgB,CAAC,IAAI,CACnB,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,CACjE,EACD;YACA,MAAM,cAAc,GAAG,mJAAmJ,CAAC;SAC5K;QAED,IAAI,CAAC,GAAG,CAAC,QAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,QAAkB;QACpC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC7C,IAAI,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAC3B,uBAAgD;QAEhD,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAC1B,uBAAgD;QAEhD,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,cAAuB;QACpD,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,cAAc,GAAG,cAAc,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,MAAM,KAAsD,IAAI,CAAC,GAAG,EAA9D,EAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,OAAmC,EAA9B,kBAAkB,sBAAlD,kCAAmD,CAAW,CAAC;QACrE,MAAM,GAAG,6EACJ,kBAAkB,GAClB,IAAI,CAAC,eAAe,EAAE,GACtB,IAAI,CAAC,2BAA2B,EAAE,GAClC,IAAI,CAAC,kBAAkB,EAAE,KAC5B,UAAU,EAAE,GAAG,GAChB,CAAC;QACF,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;YACtB,OAAO,EAAE,CAAC;SACX;QACD,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACtD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACZ;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,2BAA2B;QACjC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE;YAClC,OAAO,EAAE,CAAC;SACX;QACD,OAAO;YACL,oBAAoB,EAAE,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI;YACxD,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,eAAe;SAC/D,CAAC;IACJ,CAAC;IAEO,kBAAkB;QACxB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE;YACzB,OAAO,EAAE,CAAC;SACX;QACD,OAAO;YACL,WAAW,EAAE;gBACX;oBACE,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,cAAc;oBACnD,kBAAkB,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,kBAAkB,IAAI,EAAE;oBACjE,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,iBAAiB,IAAI,EAAE;iBAChE;aACF;SACF,CAAC;IACJ,CAAC;IAEO,sBAAsB;QAC5B,8HAA8H;QAC9H,yEAAyE;QACzE,2GAA2G;QAC3G,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE;YACzB,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;SACnD;QACD,OAAO;IACT,CAAC;IAEO,mBAAmB;QACzB,OAAO,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAEO,8BAA8B,CAAC,CAAyB;QAC9D,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,aAAa,CAAC,WAAW,EAAE,CAAC;IACrC,CAAC;IAEO,4BAA4B,CAAC,IAAY;QAC/C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;QACzE,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,iGAAiG,CAAC;SACzG;IACH,CAAC;IAEO,aAAa,CACnB,uBAAgD,EAChD,iBAA6D;QAE7D,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,EAAE,CAAC;QACnD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,iBAAiB,CAAC,GAAG,UAAU,CAAC;SACvD;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;SACzD;IACH,CAAC;CACF;AAhSD,0CAgSC"}
1
+ {"version":3,"file":"documentBuilder.js","sourceRoot":"","sources":["../src/documentBuilder.ts"],"names":[],"mappings":";;;;AAAA,+BAAgC;AAChC,mCAAkC;AAIlC;;GAEG;AACH,MAAa,eAAe;IAE1B;;;;OAIG;IACH,YAAoB,GAAW,EAAE,KAAa;QAA1B,QAAG,GAAH,GAAG,CAAQ;QAC7B,IAAI,CAAC,GAAG,GAAG;YACT,GAAG;YACH,KAAK;YACL,QAAQ,EAAE,EAAE;YACZ,WAAW,EAAE,EAAC,cAAc,EAAE,IAAI,EAAC,EAAE,2CAA2C;SACjF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,IAAY;QAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,IAA4B;QAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,IAA4B;QAClD,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,WAAmB;QACxC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,wBAAwB,CAC7B,IAAY,EACZ,eAAgC;QAEhC,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,oBAAoB,GAAG;YAC9B,IAAI;YACJ,eAAe;SAChB,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,SAAiB;QACxC,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;YACxB,MAAM,aAAa,SAAS,gCAAgC,CAAC;SAC9D;QACD,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,SAAS,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,EAAU;QAC5B,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,QAAgB;QACtC,2DAA2D;QAC3D,SAAS;QACT,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,QAAQ,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAc;QAC9B,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,GAAW,EAAE,KAAoB;QACxD,MAAM,gBAAgB,GAAG;YACvB,sBAAsB;YACtB,4BAA4B;YAC5B,UAAU;YACV,eAAe;YACf,MAAM;YACN,aAAa;YACb,YAAY;YACZ,YAAY;SACb,CAAC;QACF,IACE,gBAAgB,CAAC,IAAI,CACnB,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,WAAW,EAAE,CACjE,EACD;YACA,MAAM,cAAc,GAAG,mJAAmJ,CAAC;SAC5K;QAED,IAAI,CAAC,GAAG,CAAC,QAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,QAAkB;QACpC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC7C,IAAI,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAC3B,uBAAgD;QAEhD,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAC1B,uBAAgD;QAEhD,IAAI,CAAC,aAAa,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,cAAuB;QACpD,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,cAAc,GAAG,cAAc,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC9B,MAAM,KAAsD,IAAI,CAAC,GAAG,EAA9D,EAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,OAAmC,EAA9B,kBAAkB,2BAAlD,kCAAmD,CAAW,CAAC;QACrE,MAAM,GAAG,6EACJ,kBAAkB,GAClB,IAAI,CAAC,eAAe,EAAE,GACtB,IAAI,CAAC,2BAA2B,EAAE,GAClC,IAAI,CAAC,kBAAkB,EAAE,KAC5B,UAAU,EAAE,GAAG,GAChB,CAAC;QACF,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,eAAe;QACrB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE;YACtB,OAAO,EAAE,CAAC;SACX;QACD,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACtD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACZ;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,2BAA2B;QACjC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE;YAClC,OAAO,EAAE,CAAC;SACX;QACD,OAAO;YACL,oBAAoB,EAAE,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI;YACxD,eAAe,EAAE,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,eAAe;SAC/D,CAAC;IACJ,CAAC;IAEO,kBAAkB;QACxB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE;YACzB,OAAO,EAAE,CAAC;SACX;QACD,OAAO;YACL,WAAW,EAAE;gBACX;oBACE,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,cAAc;oBACnD,kBAAkB,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,kBAAkB,IAAI,EAAE;oBACjE,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,iBAAiB,IAAI,EAAE;iBAChE;aACF;SACF,CAAC;IACJ,CAAC;IAEO,sBAAsB;QAC5B,8HAA8H;QAC9H,yEAAyE;QACzE,2GAA2G;QAC3G,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE;YACzB,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;SACnD;QACD,OAAO;IACT,CAAC;IAEO,mBAAmB;QACzB,OAAO,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAEO,8BAA8B,CAAC,CAAyB;QAC9D,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,aAAa,CAAC,WAAW,EAAE,CAAC;IACrC,CAAC;IAEO,4BAA4B,CAAC,IAAY;QAC/C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC;QACzE,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,iGAAiG,CAAC;SACzG;IACH,CAAC;IAEO,aAAa,CACnB,uBAAgD,EAChD,iBAA6D;;QAE7D,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,EAAE,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,iBAAiB,CAAC,EAAE;YAC7C,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC;SAC/C;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,iBAAiB,CAAC;gBACtC,MAAA,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,iBAAiB,CAAC,0CAAE,MAAM,CAAC,UAAU,CAAC,CAAC;SAChE;aAAM;YACL,MAAA,IAAI,CAAC,GAAG,CAAC,WAAY,CAAC,iBAAiB,CAAC,0CAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SAC5D;IACH,CAAC;CACF;AApSD,0CAoSC"}