@coveo/push-api-client 1.5.7 → 1.6.2
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.
- package/dist/definitions/errors/baseError.d.ts +4 -0
- package/dist/definitions/errors/fieldErrors.d.ts +11 -0
- package/dist/definitions/{validation → errors}/validatorErrors.d.ts +1 -4
- package/dist/definitions/fieldAnalyser/fieldAnalyser.d.ts +44 -0
- package/dist/definitions/fieldAnalyser/fieldAnalyser.spec.d.ts +1 -0
- package/dist/definitions/fieldAnalyser/fieldStore.d.ts +5 -0
- package/dist/definitions/fieldAnalyser/inconsistencies.d.ts +5 -0
- package/dist/definitions/fieldAnalyser/inconsistencies.spec.d.ts +1 -0
- package/dist/definitions/fieldAnalyser/utils.d.ts +3 -0
- package/dist/definitions/fieldAnalyser/utils.spec.d.ts +1 -0
- package/dist/definitions/index.d.ts +1 -0
- package/dist/definitions/source.d.ts +13 -5
- package/dist/docs/assets/main.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +2 -2
- package/dist/docs/classes/DocumentBuilder.html +16 -16
- package/dist/docs/classes/FieldAnalyser.html +9 -0
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +2 -2
- package/dist/docs/classes/Source.html +17 -16
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +2 -2
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +2 -2
- package/dist/docs/enums/PlatformEnvironment.html +1 -1
- package/dist/docs/index.html +1 -1
- package/dist/docs/interfaces/BatchUpdateDocuments.html +1 -1
- package/dist/docs/interfaces/BatchUpdateDocumentsFromFiles.html +4 -2
- package/dist/docs/interfaces/Document.html +13 -13
- package/dist/docs/interfaces/SecurityIdentity.html +3 -3
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +1 -1
- package/dist/docs/interfaces/UploadBatchCallbackData.html +1 -1
- package/dist/docs/modules.html +2 -2
- package/dist/documentBuilder.js +1 -1
- package/dist/documentBuilder.js.map +1 -1
- package/dist/errors/baseError.js +11 -0
- package/dist/errors/baseError.js.map +1 -0
- package/dist/errors/fieldErrors.js +38 -0
- package/dist/errors/fieldErrors.js.map +1 -0
- package/dist/{validation → errors}/validatorErrors.js +6 -12
- package/dist/errors/validatorErrors.js.map +1 -0
- package/dist/fieldAnalyser/fieldAnalyser.js +133 -0
- package/dist/fieldAnalyser/fieldAnalyser.js.map +1 -0
- package/dist/fieldAnalyser/fieldAnalyser.spec.js +203 -0
- package/dist/fieldAnalyser/fieldAnalyser.spec.js.map +1 -0
- package/dist/fieldAnalyser/fieldStore.js +22 -0
- package/dist/fieldAnalyser/fieldStore.js.map +1 -0
- package/dist/fieldAnalyser/inconsistencies.js +15 -0
- package/dist/fieldAnalyser/inconsistencies.js.map +1 -0
- package/dist/fieldAnalyser/inconsistencies.spec.js +41 -0
- package/dist/fieldAnalyser/inconsistencies.spec.js.map +1 -0
- package/dist/fieldAnalyser/utils.js +23 -0
- package/dist/fieldAnalyser/utils.js.map +1 -0
- package/dist/fieldAnalyser/utils.spec.js +82 -0
- package/dist/fieldAnalyser/utils.spec.js.map +1 -0
- package/dist/index.js +5 -3
- package/dist/index.js.map +1 -1
- package/dist/source.js +47 -5
- package/dist/source.js.map +1 -1
- package/dist/source.spec.js +145 -49
- package/dist/source.spec.js.map +1 -1
- package/dist/validation/parseFile.js +1 -1
- package/dist/validation/parseFile.js.map +1 -1
- package/dist/validation/parseFile.spec.js +1 -1
- package/dist/validation/parseFile.spec.js.map +1 -1
- package/package.json +8 -8
- package/dist/validation/validatorErrors.js.map +0 -1
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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
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 id="identity" class="tsd-anchor"></a><h3 class="tsd-anchor-link">identity<a href="#identity" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/
|
|
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 id="identity" class="tsd-anchor"></a><h3 class="tsd-anchor-link">identity<a href="#identity" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/cb7294c/src/document.ts#L18">src/document.ts:18</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p>The name of the security identity.</p>
|
|
5
5
|
</div><div><p>Examples:</p>
|
|
6
6
|
<ul>
|
|
7
7
|
<li><code>asmith@example.com</code></li>
|
|
8
8
|
<li><code>SampleTeam2</code></li>
|
|
9
9
|
</ul>
|
|
10
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">identity<wbr/>Type<a href="#identityType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/
|
|
10
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="identityType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">identity<wbr/>Type<a href="#identityType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/cb7294c/src/document.ts#L27">src/document.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
11
|
<p>The type of the identity.
|
|
12
12
|
Valid values:</p>
|
|
13
13
|
<ul>
|
|
@@ -16,7 +16,7 @@ Valid values:</p>
|
|
|
16
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
17
|
<li><code>VIRTUAL_GROUP</code> : Defines a group that doesn't exist within the indexed system. Mechanically, a <code>VIRTUAL_GROUP</code> is identical to a <code>GROUP</code>.</li>
|
|
18
18
|
</ul>
|
|
19
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> security<wbr/>Provider<a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/
|
|
19
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="securityProvider" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> security<wbr/>Provider<a href="#securityProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/cb7294c/src/document.ts#L33">src/document.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
20
|
<p>The security identity provider through which the security identity is updated.</p>
|
|
21
21
|
</div><div><p>Defaults to the first security identity provider associated with the target Push source.</p>
|
|
22
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>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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
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 id="build" class="tsd-anchor"></a><h3 class="tsd-anchor-link">build<a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/
|
|
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 id="build" class="tsd-anchor"></a><h3 class="tsd-anchor-link">build<a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/cb7294c/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>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UploadBatchCallbackData | @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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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="UploadBatchCallbackData.html">UploadBatchCallbackData</a></li></ul><h1>Interface UploadBatchCallbackData</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"><dl class="tsd-comment-tags"><dt>param files</dt><dd><p>Files from which the documentBuilders were generated</p>
|
|
2
2
|
</dd><dt>param batch</dt><dd><p>List of the uploaded DocumentBuilders</p>
|
|
3
3
|
</dd><dt>param res</dt><dd><p>Axios response</p>
|
|
4
|
-
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">UploadBatchCallbackData</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="UploadBatchCallbackData.html#batch" class="tsd-kind-icon">batch</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#files" class="tsd-kind-icon">files</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#res" class="tsd-kind-icon">res</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 id="batch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">batch<a href="#batch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">batch<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/
|
|
4
|
+
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">UploadBatchCallbackData</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="UploadBatchCallbackData.html#batch" class="tsd-kind-icon">batch</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#files" class="tsd-kind-icon">files</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#res" class="tsd-kind-icon">res</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 id="batch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">batch<a href="#batch" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">batch<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/cb7294c/src/source.ts#L49">src/source.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="files" class="tsd-anchor"></a><h3 class="tsd-anchor-link">files<a href="#files" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">files<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/cb7294c/src/source.ts#L48">src/source.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="res" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> res<a href="#res" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">res<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</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/cb7294c/src/source.ts#L50">src/source.ts:50</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="UploadBatchCallbackData.html" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback<wbr/>Data</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#batch" class="tsd-kind-icon">batch</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#files" class="tsd-kind-icon">files</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="UploadBatchCallbackData.html#res" class="tsd-kind-icon">res</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,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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 "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/PlatformEnvironment.html" class="tsd-kind-icon">Platform<wbr/>Environment</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/Region.html" class="tsd-kind-icon">Region</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/BatchUpdateDocumentsFromFiles.html" class="tsd-kind-icon">Batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</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-interface"><a href="interfaces/UploadBatchCallbackData.html" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback<wbr/>Data</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><li class="tsd-kind-type-alias"><a href="modules.html#UploadBatchCallback" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback</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 id="CompressionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Compression<wbr/>Type<a href="#CompressionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Compression<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"UNCOMPRESSED"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"DEFLATE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GZIP"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LZMA"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ZLIB"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default"><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><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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 "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum"><a href="enums/PlatformEnvironment.html" class="tsd-kind-icon">Platform<wbr/>Environment</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/Region.html" class="tsd-kind-icon">Region</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/FieldAnalyser.html" class="tsd-kind-icon">Field<wbr/>Analyser</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/BatchUpdateDocumentsFromFiles.html" class="tsd-kind-icon">Batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</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-interface"><a href="interfaces/UploadBatchCallbackData.html" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback<wbr/>Data</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><li class="tsd-kind-type-alias"><a href="modules.html#UploadBatchCallback" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback</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 id="CompressionType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Compression<wbr/>Type<a href="#CompressionType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Compression<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"UNCOMPRESSED"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"DEFLATE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GZIP"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LZMA"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ZLIB"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cb7294c/src/document.ts#L42">src/document.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
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 id="Metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Metadata<a href="#Metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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"><</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">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0ffeb73/src/document.ts#L37">src/document.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MetadataValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Metadata<wbr/>Value<a href="#MetadataValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/0ffeb73/src/document.ts#L36">src/document.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SecurityIdentityType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Security<wbr/>Identity<wbr/>Type<a href="#SecurityIdentityType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Security<wbr/>Identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"UNKNOWN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GROUP"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"VIRTUAL_GROUP"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0ffeb73/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="UploadBatchCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Upload<wbr/>Batch<wbr/>Callback<a href="#UploadBatchCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, data<span class="tsd-signature-symbol">: </span><a href="interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/0ffeb73/src/source.ts#L50">src/source.ts:50</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, data<span class="tsd-signature-symbol">: </span><a href="interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li><li><h5>data: <a href="interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></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"><a href="enums/PlatformEnvironment.html" class="tsd-kind-icon">Platform<wbr/>Environment</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/Region.html" class="tsd-kind-icon">Region</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/BatchUpdateDocumentsFromFiles.html" class="tsd-kind-icon">Batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</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-interface"><a href="interfaces/UploadBatchCallbackData.html" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback<wbr/>Data</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><li class="tsd-kind-type-alias"><a href="modules.html#UploadBatchCallback" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback</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>
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="Metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Metadata<a href="#Metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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"><</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">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cb7294c/src/document.ts#L37">src/document.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="MetadataValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Metadata<wbr/>Value<a href="#MetadataValue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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/cb7294c/src/document.ts#L36">src/document.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="SecurityIdentityType" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Security<wbr/>Identity<wbr/>Type<a href="#SecurityIdentityType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Security<wbr/>Identity<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"UNKNOWN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"USER"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"GROUP"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"VIRTUAL_GROUP"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cb7294c/src/document.ts#L1">src/document.ts:1</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias"><a id="UploadBatchCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Upload<wbr/>Batch<wbr/>Callback<a href="#UploadBatchCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, data<span class="tsd-signature-symbol">: </span><a href="interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/cb7294c/src/source.ts#L53">src/source.ts:53</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, data<span class="tsd-signature-symbol">: </span><a href="interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5></li><li><h5>data: <a href="interfaces/UploadBatchCallbackData.html" class="tsd-signature-type" data-tsd-kind="Interface">UploadBatchCallbackData</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></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"><a href="enums/PlatformEnvironment.html" class="tsd-kind-icon">Platform<wbr/>Environment</a></li><li class="tsd-kind-enum tsd-is-external"><a href="enums/Region.html" class="tsd-kind-icon">Region</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/FieldAnalyser.html" class="tsd-kind-icon">Field<wbr/>Analyser</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/BatchUpdateDocumentsFromFiles.html" class="tsd-kind-icon">Batch<wbr/>Update<wbr/>Documents<wbr/>From<wbr/>Files</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-interface"><a href="interfaces/UploadBatchCallbackData.html" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback<wbr/>Data</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><li class="tsd-kind-type-alias"><a href="modules.html#UploadBatchCallback" class="tsd-kind-icon">Upload<wbr/>Batch<wbr/>Callback</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
|
@@ -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 =
|
|
186
|
+
const _a = this.doc, { uri, metadata, permissions } = _a, omitSomeProperties = 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
|
}
|
|
@@ -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,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,
|
|
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,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,MAAM,GAAG,GAAW,IAAA,mBAAU,EAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACzE,MAAM,IAAI,GAAW,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3E,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IACtD,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;AAtSD,0CAsSC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PushApiClientBaseError = void 0;
|
|
4
|
+
class PushApiClientBaseError extends Error {
|
|
5
|
+
constructor(message) {
|
|
6
|
+
super(message);
|
|
7
|
+
this.name = 'Push API Client Error';
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
exports.PushApiClientBaseError = PushApiClientBaseError;
|
|
11
|
+
//# sourceMappingURL=baseError.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"baseError.js","sourceRoot":"","sources":["../../src/errors/baseError.ts"],"names":[],"mappings":";;;AAAA,MAAsB,sBAAuB,SAAQ,KAAK;IAExD,YAAmB,OAAgB;QACjC,KAAK,CAAC,OAAO,CAAC,CAAC;QAFV,SAAI,GAAG,uBAAuB,CAAC;IAGtC,CAAC;CACF;AALD,wDAKC"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InvalidPermanentId = exports.FieldTypeInconsistencyError = void 0;
|
|
4
|
+
const baseError_1 = require("./baseError");
|
|
5
|
+
class FieldTypeInconsistencyError extends baseError_1.PushApiClientBaseError {
|
|
6
|
+
constructor(inconsitencies) {
|
|
7
|
+
super();
|
|
8
|
+
this.name = 'Field Type Inconsistency Error';
|
|
9
|
+
this.message = `Inconsistent types detected in the following field${inconsitencies.size > 1 ? 's' : ''}:`;
|
|
10
|
+
inconsitencies.forEach((typeSet, field) => {
|
|
11
|
+
const inconsistentTypes = [];
|
|
12
|
+
for (const type of typeSet) {
|
|
13
|
+
inconsistentTypes.push(type);
|
|
14
|
+
}
|
|
15
|
+
this.message += `
|
|
16
|
+
${field}: ${inconsistentTypes.sort().join(', ')}`;
|
|
17
|
+
});
|
|
18
|
+
// TODO: CDX-844: display document with type inconsistencies
|
|
19
|
+
this.message += `
|
|
20
|
+
Make sure to review and fix your document metadata before pushing`;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
exports.FieldTypeInconsistencyError = FieldTypeInconsistencyError;
|
|
24
|
+
class InvalidPermanentId extends baseError_1.PushApiClientBaseError {
|
|
25
|
+
constructor(field) {
|
|
26
|
+
super(`
|
|
27
|
+
The permanentid field detected in the index is not correctly configured.
|
|
28
|
+
Expected field type: STRING
|
|
29
|
+
Current field type: ${field.type}
|
|
30
|
+
|
|
31
|
+
You can delete and recreate the permanentid field as a STRING field.
|
|
32
|
+
See docs.coveo.com/en/1913 fore more info.
|
|
33
|
+
`);
|
|
34
|
+
this.name = 'Invalid permanentId field Error';
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
exports.InvalidPermanentId = InvalidPermanentId;
|
|
38
|
+
//# sourceMappingURL=fieldErrors.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fieldErrors.js","sourceRoot":"","sources":["../../src/errors/fieldErrors.ts"],"names":[],"mappings":";;;AAEA,2CAAmD;AAEnD,MAAa,2BAA4B,SAAQ,kCAAsB;IAErE,YAAmB,cAA+B;QAChD,KAAK,EAAE,CAAC;QAFH,SAAI,GAAG,gCAAgC,CAAC;QAG7C,IAAI,CAAC,OAAO,GAAG,qDACb,cAAc,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAClC,GAAG,CAAC;QACJ,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YACxC,MAAM,iBAAiB,GAAG,EAAE,CAAC;YAC7B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;gBAC1B,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC9B;YACD,IAAI,CAAC,OAAO,IAAI;QACd,KAAK,KAAK,iBAAiB,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,4DAA4D;QAC5D,IAAI,CAAC,OAAO,IAAI;wEACoD,CAAC;IACvE,CAAC;CACF;AApBD,kEAoBC;AAED,MAAa,kBAAmB,SAAQ,kCAAsB;IAE5D,YAAmB,KAAiB;QAClC,KAAK,CAAC;;;0BAGgB,KAAK,CAAC,IAAI;;;;KAI/B,CAAC,CAAC;QATE,SAAI,GAAG,iCAAiC,CAAC;IAUhD,CAAC;CACF;AAZD,gDAYC"}
|
|
@@ -1,35 +1,29 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.UnsupportedAttribute = exports.InvalidDocument = exports.NotAJsonFileError = exports.NotAFileError =
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
super(message);
|
|
7
|
-
this.name = 'Push API Client Error';
|
|
8
|
-
}
|
|
9
|
-
}
|
|
10
|
-
exports.PushApiClientBaseError = PushApiClientBaseError;
|
|
11
|
-
class NotAFileError extends PushApiClientBaseError {
|
|
3
|
+
exports.UnsupportedAttribute = exports.InvalidDocument = exports.NotAJsonFileError = exports.NotAFileError = void 0;
|
|
4
|
+
const baseError_1 = require("./baseError");
|
|
5
|
+
class NotAFileError extends baseError_1.PushApiClientBaseError {
|
|
12
6
|
constructor(p) {
|
|
13
7
|
super(`${p} is not a valid file, or does not exists.`);
|
|
14
8
|
this.name = 'Not A File Error';
|
|
15
9
|
}
|
|
16
10
|
}
|
|
17
11
|
exports.NotAFileError = NotAFileError;
|
|
18
|
-
class NotAJsonFileError extends PushApiClientBaseError {
|
|
12
|
+
class NotAJsonFileError extends baseError_1.PushApiClientBaseError {
|
|
19
13
|
constructor(p) {
|
|
20
14
|
super(`${p} is not a valid JSON file.`);
|
|
21
15
|
this.name = 'Not A JSON File Error';
|
|
22
16
|
}
|
|
23
17
|
}
|
|
24
18
|
exports.NotAJsonFileError = NotAJsonFileError;
|
|
25
|
-
class InvalidDocument extends PushApiClientBaseError {
|
|
19
|
+
class InvalidDocument extends baseError_1.PushApiClientBaseError {
|
|
26
20
|
constructor(p, explanation) {
|
|
27
21
|
super(`${p} is not a valid JSON document: ${explanation}`);
|
|
28
22
|
this.name = 'Invalid JSON Document Error';
|
|
29
23
|
}
|
|
30
24
|
}
|
|
31
25
|
exports.InvalidDocument = InvalidDocument;
|
|
32
|
-
class UnsupportedAttribute extends PushApiClientBaseError {
|
|
26
|
+
class UnsupportedAttribute extends baseError_1.PushApiClientBaseError {
|
|
33
27
|
constructor(p, unsupported) {
|
|
34
28
|
super(`${p} contains a currently unsupported document attribute: ${unsupported}`);
|
|
35
29
|
this.name = 'Unsupported Attribute Error';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validatorErrors.js","sourceRoot":"","sources":["../../src/errors/validatorErrors.ts"],"names":[],"mappings":";;;AACA,2CAAmD;AAEnD,MAAa,aAAc,SAAQ,kCAAsB;IAEvD,YAAmB,CAAW;QAC5B,KAAK,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;QAFlD,SAAI,GAAG,kBAAkB,CAAC;IAGjC,CAAC;CACF;AALD,sCAKC;AACD,MAAa,iBAAkB,SAAQ,kCAAsB;IAE3D,YAAmB,CAAW;QAC5B,KAAK,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAFnC,SAAI,GAAG,uBAAuB,CAAC;IAGtC,CAAC;CACF;AALD,8CAKC;AAED,MAAa,eAAgB,SAAQ,kCAAsB;IAEzD,YAAmB,CAAW,EAAE,WAAmB;QACjD,KAAK,CAAC,GAAG,CAAC,kCAAkC,WAAW,EAAE,CAAC,CAAC;QAFtD,SAAI,GAAG,6BAA6B,CAAC;IAG5C,CAAC;CACF;AALD,0CAKC;AAED,MAAa,oBAAqB,SAAQ,kCAAsB;IAE9D,YAAmB,CAAW,EAAE,WAAmB;QACjD,KAAK,CACH,GAAG,CAAC,yDAAyD,WAAW,EAAE,CAC3E,CAAC;QAJG,SAAI,GAAG,6BAA6B,CAAC;IAK5C,CAAC;CACF;AAPD,oDAOC"}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.FieldAnalyser = void 0;
|
|
4
|
+
const platform_client_1 = require("@coveord/platform-client");
|
|
5
|
+
const utils_1 = require("./utils");
|
|
6
|
+
const fieldStore_1 = require("./fieldStore");
|
|
7
|
+
const inconsistencies_1 = require("./inconsistencies");
|
|
8
|
+
const fieldErrors_1 = require("../errors/fieldErrors");
|
|
9
|
+
/**
|
|
10
|
+
* Analyse documents to detect type inconsistencies and missing fields in your index.
|
|
11
|
+
*
|
|
12
|
+
*/
|
|
13
|
+
class FieldAnalyser {
|
|
14
|
+
constructor(platformClient) {
|
|
15
|
+
this.platformClient = platformClient;
|
|
16
|
+
this.inconsistencies = new inconsistencies_1.Inconsistencies();
|
|
17
|
+
this.missingFields = new Map();
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Adds a batch of document builders to the analyser
|
|
21
|
+
* This method can be called as many time as needed as it will take into consideration document builders previously added.
|
|
22
|
+
*
|
|
23
|
+
* @param {DocumentBuilder[]} batch
|
|
24
|
+
* @return {*}
|
|
25
|
+
*/
|
|
26
|
+
async add(batch) {
|
|
27
|
+
const existingFields = await this.ensureExistingFields();
|
|
28
|
+
batch.flatMap((doc) => {
|
|
29
|
+
const documentMetadata = Object.entries(Object.assign({}, doc.build().metadata));
|
|
30
|
+
for (const [metadataKey, metadataValue] of documentMetadata) {
|
|
31
|
+
if (existingFields.some((field) => field.name === metadataKey)) {
|
|
32
|
+
continue;
|
|
33
|
+
}
|
|
34
|
+
this.storeMetadata(metadataKey, metadataValue);
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
return this;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Returns the analyser report containing the fields to create as well as the type inconsistencies in the documents
|
|
41
|
+
*
|
|
42
|
+
* @return {*} {FieldAnalyserReport}
|
|
43
|
+
*/
|
|
44
|
+
report() {
|
|
45
|
+
const fieldStore = this.getFieldTypes();
|
|
46
|
+
this.ensurePermanentId(fieldStore);
|
|
47
|
+
return {
|
|
48
|
+
fields: fieldStore.marshal(),
|
|
49
|
+
inconsistencies: this.inconsistencies,
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
storeMetadata(metadataKey, metadataValue) {
|
|
53
|
+
const initialTypeCount = 1;
|
|
54
|
+
const metadataType = this.getGuessedTypeFromValue(metadataValue);
|
|
55
|
+
const fieldTypeMap = this.missingFields.get(metadataKey);
|
|
56
|
+
if (fieldTypeMap) {
|
|
57
|
+
// Possible metadata inconsitency
|
|
58
|
+
const fieldTypeCount = fieldTypeMap.get(metadataType);
|
|
59
|
+
fieldTypeMap.set(metadataType, fieldTypeCount ? fieldTypeCount + 1 : initialTypeCount);
|
|
60
|
+
}
|
|
61
|
+
else {
|
|
62
|
+
const newFieldTypeMap = new Map().set(metadataType, initialTypeCount);
|
|
63
|
+
this.missingFields.set(metadataKey, newFieldTypeMap);
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
async ensureExistingFields() {
|
|
67
|
+
if (this.existingFields === undefined) {
|
|
68
|
+
this.existingFields = await (0, utils_1.listAllFieldsFromOrg)(this.platformClient);
|
|
69
|
+
}
|
|
70
|
+
return this.existingFields;
|
|
71
|
+
}
|
|
72
|
+
ensurePermanentId(fieldStore) {
|
|
73
|
+
var _a;
|
|
74
|
+
const permanentid = (_a = this.existingFields) === null || _a === void 0 ? void 0 : _a.find((field) => field.name === 'permanentid');
|
|
75
|
+
if (permanentid) {
|
|
76
|
+
if (permanentid.type !== platform_client_1.FieldTypes.STRING) {
|
|
77
|
+
throw new fieldErrors_1.InvalidPermanentId(permanentid);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
fieldStore.set('permanentid', platform_client_1.FieldTypes.STRING);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
getFieldTypes() {
|
|
85
|
+
const fieldStore = new fieldStore_1.FieldStore();
|
|
86
|
+
this.missingFields.forEach((fieldTypeMap, fieldName) => {
|
|
87
|
+
this.storePossibleTypeInconsistencies(fieldName, fieldTypeMap);
|
|
88
|
+
const fieldType = this.getMostProbableType(fieldTypeMap);
|
|
89
|
+
fieldStore.set(fieldName, fieldType);
|
|
90
|
+
});
|
|
91
|
+
return fieldStore;
|
|
92
|
+
}
|
|
93
|
+
storePossibleTypeInconsistencies(fieldName, fieldTypeMap) {
|
|
94
|
+
if (fieldTypeMap.size > 1) {
|
|
95
|
+
const fieldTypes = Array.from(fieldTypeMap.keys());
|
|
96
|
+
this.inconsistencies.add(fieldName, fieldTypes);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
getMostProbableType(field) {
|
|
100
|
+
const sortedType = Array.from(field.entries()).sort((a, b) => {
|
|
101
|
+
const countDiff = b[1] - a[1];
|
|
102
|
+
return countDiff ? countDiff : this.typeCompare(a[0], b[0]);
|
|
103
|
+
});
|
|
104
|
+
return sortedType[0][0];
|
|
105
|
+
}
|
|
106
|
+
typeCompare(field1, field2) {
|
|
107
|
+
const precedence = (field) => FieldAnalyser.fieldTypePrecedence.indexOf(field);
|
|
108
|
+
if (precedence(field1) < precedence(field2)) {
|
|
109
|
+
return 1;
|
|
110
|
+
}
|
|
111
|
+
if (precedence(field1) > precedence(field2)) {
|
|
112
|
+
return -1;
|
|
113
|
+
}
|
|
114
|
+
return 0;
|
|
115
|
+
}
|
|
116
|
+
getGuessedTypeFromValue(obj) {
|
|
117
|
+
switch (typeof obj) {
|
|
118
|
+
case 'number':
|
|
119
|
+
return this.getSpecificNumericType(obj);
|
|
120
|
+
case 'string':
|
|
121
|
+
return platform_client_1.FieldTypes.STRING;
|
|
122
|
+
default:
|
|
123
|
+
return platform_client_1.FieldTypes.STRING;
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
getSpecificNumericType(_number) {
|
|
127
|
+
// TODO: CDX-838 Support LONG, LONG32 and DATE types
|
|
128
|
+
return platform_client_1.FieldTypes.DOUBLE;
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
exports.FieldAnalyser = FieldAnalyser;
|
|
132
|
+
FieldAnalyser.fieldTypePrecedence = ['DOUBLE', 'STRING'];
|
|
133
|
+
//# sourceMappingURL=fieldAnalyser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fieldAnalyser.js","sourceRoot":"","sources":["../../src/fieldAnalyser/fieldAnalyser.ts"],"names":[],"mappings":";;;AAAA,8DAAgF;AAEhF,mCAA6C;AAC7C,6CAAwC;AACxC,uDAAkD;AAClD,uDAAyD;AASzD;;;GAGG;AACH,MAAa,aAAa;IAMxB,YAA2B,cAA8B;QAA9B,mBAAc,GAAd,cAAc,CAAgB;QACvD,IAAI,CAAC,eAAe,GAAG,IAAI,iCAAe,EAAE,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CAAC,KAAwB;QACvC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAEzD,KAAK,CAAC,OAAO,CAAC,CAAC,GAAoB,EAAE,EAAE;YACrC,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,mBAAK,GAAG,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC;YAEnE,KAAK,MAAM,CAAC,WAAW,EAAE,aAAa,CAAC,IAAI,gBAAgB,EAAE;gBAC3D,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,EAAE;oBAC9D,SAAS;iBACV;gBACD,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;aAChD;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QAEnC,OAAO;YACL,MAAM,EAAE,UAAU,CAAC,OAAO,EAAE;YAC5B,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC,CAAC;IACJ,CAAC;IAEO,aAAa,CAAC,WAAmB,EAAE,aAA4B;QACrE,MAAM,gBAAgB,GAAG,CAAC,CAAC;QAC3B,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAEzD,IAAI,YAAY,EAAE;YAChB,iCAAiC;YACjC,MAAM,cAAc,GAAG,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YACtD,YAAY,CAAC,GAAG,CACd,YAAY,EACZ,cAAc,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,CACvD,CAAC;SACH;aAAM;YACL,MAAM,eAAe,GAAG,IAAI,GAAG,EAAE,CAAC,GAAG,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;YACtE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;SACtD;IACH,CAAC;IAEO,KAAK,CAAC,oBAAoB;QAChC,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE;YACrC,IAAI,CAAC,cAAc,GAAG,MAAM,IAAA,4BAAoB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;SACvE;QACD,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAEO,iBAAiB,CAAC,UAAsB;;QAC9C,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,cAAc,0CAAE,IAAI,CAC3C,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,aAAa,CACxC,CAAC;QAEF,IAAI,WAAW,EAAE;YACf,IAAI,WAAW,CAAC,IAAI,KAAK,4BAAU,CAAC,MAAM,EAAE;gBAC1C,MAAM,IAAI,gCAAkB,CAAC,WAAW,CAAC,CAAC;aAC3C;SACF;aAAM;YACL,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,4BAAU,CAAC,MAAM,CAAC,CAAC;SAClD;IACH,CAAC;IAEO,aAAa;QACnB,MAAM,UAAU,GAAG,IAAI,uBAAU,EAAE,CAAC;QAEpC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,SAAS,EAAE,EAAE;YACrD,IAAI,CAAC,gCAAgC,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;YACzD,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,gCAAgC,CACtC,SAAiB,EACjB,YAA0B;QAE1B,IAAI,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE;YACzB,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;YACnD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SACjD;IACH,CAAC;IAEM,mBAAmB,CAAC,KAAmB;QAC5C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CACjD,CAAC,CAAuB,EAAE,CAAuB,EAAE,EAAE;YACnD,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,OAAO,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,CAAC,CACF,CAAC;QACF,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAEO,WAAW,CAAC,MAAkB,EAAE,MAAkB;QACxD,MAAM,UAAU,GAAG,CAAC,KAAiB,EAAE,EAAE,CACvC,aAAa,CAAC,mBAAmB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE;YAC3C,OAAO,CAAC,CAAC;SACV;QACD,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,EAAE;YAC3C,OAAO,CAAC,CAAC,CAAC;SACX;QACD,OAAO,CAAC,CAAC;IACX,CAAC;IAEO,uBAAuB,CAAC,GAAY;QAC1C,QAAQ,OAAO,GAAG,EAAE;YAClB,KAAK,QAAQ;gBACX,OAAO,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;YAC1C,KAAK,QAAQ;gBACX,OAAO,4BAAU,CAAC,MAAM,CAAC;YAC3B;gBACE,OAAO,4BAAU,CAAC,MAAM,CAAC;SAC5B;IACH,CAAC;IAEO,sBAAsB,CAAC,OAAe;QAC5C,oDAAoD;QACpD,OAAO,4BAAU,CAAC,MAAM,CAAC;IAC3B,CAAC;;AAlJH,sCAmJC;AAlJgB,iCAAmB,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC"}
|