Skip to content

Commit 0cbf7e1

Browse files
Deploying to gh-pages from @ 4ea996a 🚀
1 parent a77e0f5 commit 0cbf7e1

File tree

86 files changed

+1041
-1040
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+1041
-1040
lines changed

.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ dist/lato-latin-700-normal-2XVSBPG4.woff2
427427
dist/lato-latin-ext-400-normal-N27NCBWW.woff2
428428
dist/lato-latin-ext-700-normal-Q2L5DVMW.woff2
429429
dist/remixicon-QPNJX265.woff2
430-
dist/search_data-CF0D7C64.js
430+
dist/search_data-DFB60825.js
431431
dist/sidebar_items-420843F5.js
432432
index.html
433433
provisioning.html

Lightning.Accounts.html

Lines changed: 74 additions & 74 deletions
Large diffs are not rendered by default.

Lightning.AdaptorRegistry.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ <h1>
9696
<p>Registry process to query and maintain a list of adaptors available for
9797
writing jobs.</p><p>Currently it queries NPM for all modules in the <code class="inline">@openfn</code> organization and
9898
filters out modules that are known not to be adaptors.</p><p><strong>Usage</strong></p><pre><code class="makeup elixir" translate="no"><span class="c1"># Starting the process</span><span class="w">
99-
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="2087457861-1">(</span><span class="p" data-group-id="2087457861-1">)</span><span class="w">
99+
</span><span class="nc">AdaptorRegistry</span><span class="o">.</span><span class="n">start_link</span><span class="p" data-group-id="7441447425-1">(</span><span class="p" data-group-id="7441447425-1">)</span><span class="w">
100100
</span><span class="c1"># Getting a list of all adaptors</span><span class="w">
101-
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="2087457861-2">(</span><span class="p" data-group-id="2087457861-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
101+
</span><span class="nc">Lightning.AdaptorRegistry.AdaptorRegistry</span><span class="o">.</span><span class="n">all</span><span class="p" data-group-id="7441447425-2">(</span><span class="p" data-group-id="7441447425-2">)</span></code></pre><p><strong>Caching</strong></p><p>By default the results are cached to disk, and will be reused every start.</p><p>In order to disable or configure caching pass see: <a href="#start_link/1"><code class="inline">start_link/1</code></a>.</p><p>The process uses <code class="inline">:continue</code> to return before the adaptors have been queried.
102102
This does mean that the first call to the process will be delayed until
103103
the <code class="inline">handle_continue/2</code> has finished.</p><p><strong>Timeouts</strong></p><p>There is a 'general' timeout of 30s, this is used for GenServer calls like
104104
<a href="#all/1"><code class="inline">all/1</code></a> and also internally when the modules are being queried. NPM can
@@ -420,10 +420,10 @@ <h1 class="signature" translate="no">resolve_package_name(package_name)</h1>
420420

421421
</div>
422422

423-
<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="7149249780-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="7149249780-1">)</span><span class="w">
424-
</span><span class="p" data-group-id="7149249780-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="7149249780-2">}</span><span class="w">
425-
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="7149249780-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="7149249780-3">)</span><span class="w">
426-
</span><span class="p" data-group-id="7149249780-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="7149249780-4">}</span></code></pre>
423+
<p>Destructures an NPM style package name into module name and version.</p><p><strong>Example</strong></p><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="3896549900-1">(</span><span class="s">&quot;@openfn/language-salesforce@1.2.3&quot;</span><span class="p" data-group-id="3896549900-1">)</span><span class="w">
424+
</span><span class="p" data-group-id="3896549900-2">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;1.2.3&quot;</span><span class="w"> </span><span class="p" data-group-id="3896549900-2">}</span><span class="w">
425+
</span><span class="gp unselectable">iex&gt; </span><span class="n">resolve_package_name</span><span class="p" data-group-id="3896549900-3">(</span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p" data-group-id="3896549900-3">)</span><span class="w">
426+
</span><span class="p" data-group-id="3896549900-4">{</span><span class="w"> </span><span class="s">&quot;@openfn/language-salesforce&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">nil</span><span class="w"> </span><span class="p" data-group-id="3896549900-4">}</span></code></pre>
427427
</section>
428428
</section>
429429
<section class="detail" id="resolve_package_name!/1">

Lightning.AiAssistant.ChatMessage.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -333,10 +333,10 @@ <h1 class="signature" translate="no">status_changeset(chat_message, status)</h1>
333333

334334
<p>Creates a changeset for updating message status.</p><p>This is a focused changeset that only updates the status field,
335335
useful for updating message state during processing.</p><h2 id="status_changeset/2-parameters" class="section-heading"><a href="#status_changeset/2-parameters" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Parameters</span></h2><ul><li><code class="inline">chat_message</code> - The existing ChatMessage struct</li><li><code class="inline">status</code> - New status (<code class="inline">:pending</code>, <code class="inline">:success</code>, <code class="inline">:error</code>, or <code class="inline">:cancelled</code>)</li></ul><h2 id="status_changeset/2-examples" class="section-heading"><a href="#status_changeset/2-examples" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Examples</span></h2><pre><code class="makeup elixir" translate="no"><span class="c1"># Mark message as successful</span><span class="w">
336-
</span><span class="nc">ChatMessage</span><span class="o">.</span><span class="n">status_changeset</span><span class="p" data-group-id="0781784359-1">(</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="ss">:success</span><span class="p" data-group-id="0781784359-1">)</span><span class="w">
336+
</span><span class="nc">ChatMessage</span><span class="o">.</span><span class="n">status_changeset</span><span class="p" data-group-id="9189122621-1">(</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="ss">:success</span><span class="p" data-group-id="9189122621-1">)</span><span class="w">
337337

338338
</span><span class="c1"># Mark message as failed</span><span class="w">
339-
</span><span class="nc">ChatMessage</span><span class="o">.</span><span class="n">status_changeset</span><span class="p" data-group-id="0781784359-2">(</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="ss">:error</span><span class="p" data-group-id="0781784359-2">)</span></code></pre>
339+
</span><span class="nc">ChatMessage</span><span class="o">.</span><span class="n">status_changeset</span><span class="p" data-group-id="9189122621-2">(</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="ss">:error</span><span class="p" data-group-id="9189122621-2">)</span></code></pre>
340340
</section>
341341
</section>
342342

Lightning.AiAssistant.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -470,8 +470,8 @@ <h1 class="signature" translate="no">cleanup_unsaved_job_sessions(workflow)</h1>
470470

471471
</div>
472472

473-
<p>Cleans up unsaved job data in AI sessions after workflow is saved.</p><p>When a workflow is saved and jobs get database IDs, this function:</p><ol><li>Finds all sessions with matching Y.Doc job IDs in meta[&quot;unsaved_job&quot;]</li><li>Updates those sessions to set job_id to the real database ID</li><li>Removes the meta[&quot;unsaved_job&quot;] data</li></ol><h2 id="cleanup_unsaved_job_sessions/1-parameters" class="section-heading"><a href="#cleanup_unsaved_job_sessions/1-parameters" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Parameters</span></h2><ul><li><code class="inline">workflow</code> - The saved <code class="inline">%Workflow{}</code> with jobs that have database IDs</li></ul><h2 id="cleanup_unsaved_job_sessions/1-returns" class="section-heading"><a href="#cleanup_unsaved_job_sessions/1-returns" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Returns</span></h2><ul><li><code class="inline">{:ok, updated_count}</code> - Number of sessions updated</li><li><code class="inline">{:error, reason}</code> - If update fails</li></ul><h2 id="cleanup_unsaved_job_sessions/1-example" class="section-heading"><a href="#cleanup_unsaved_job_sessions/1-example" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Example</span></h2><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">cleanup_unsaved_job_sessions</span><span class="p" data-group-id="3197305686-1">(</span><span class="n">workflow</span><span class="p" data-group-id="3197305686-1">)</span><span class="w">
474-
</span><span class="p" data-group-id="3197305686-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p" data-group-id="3197305686-2">}</span><span class="w"> </span><span class="c1"># Updated 3 sessions</span></code></pre>
473+
<p>Cleans up unsaved job data in AI sessions after workflow is saved.</p><p>When a workflow is saved and jobs get database IDs, this function:</p><ol><li>Finds all sessions with matching Y.Doc job IDs in meta[&quot;unsaved_job&quot;]</li><li>Updates those sessions to set job_id to the real database ID</li><li>Removes the meta[&quot;unsaved_job&quot;] data</li></ol><h2 id="cleanup_unsaved_job_sessions/1-parameters" class="section-heading"><a href="#cleanup_unsaved_job_sessions/1-parameters" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Parameters</span></h2><ul><li><code class="inline">workflow</code> - The saved <code class="inline">%Workflow{}</code> with jobs that have database IDs</li></ul><h2 id="cleanup_unsaved_job_sessions/1-returns" class="section-heading"><a href="#cleanup_unsaved_job_sessions/1-returns" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Returns</span></h2><ul><li><code class="inline">{:ok, updated_count}</code> - Number of sessions updated</li><li><code class="inline">{:error, reason}</code> - If update fails</li></ul><h2 id="cleanup_unsaved_job_sessions/1-example" class="section-heading"><a href="#cleanup_unsaved_job_sessions/1-example" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Example</span></h2><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">cleanup_unsaved_job_sessions</span><span class="p" data-group-id="0580968799-1">(</span><span class="n">workflow</span><span class="p" data-group-id="0580968799-1">)</span><span class="w">
474+
</span><span class="p" data-group-id="0580968799-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">3</span><span class="p" data-group-id="0580968799-2">}</span><span class="w"> </span><span class="c1"># Updated 3 sessions</span></code></pre>
475475
</section>
476476
</section>
477477
<section class="detail" id="cleanup_unsaved_workflow_sessions/1">
@@ -500,8 +500,8 @@ <h1 class="signature" translate="no">cleanup_unsaved_workflow_sessions(workflow)
500500

501501
</div>
502502

503-
<p>Cleans up unsaved workflow data in AI sessions after workflow is saved.</p><p>When a workflow in create mode is saved for the first time, this function:</p><ol><li>Finds all sessions with matching temporary workflow IDs in meta[&quot;unsaved_workflow&quot;]</li><li>Updates those sessions to set workflow_id to the real database ID</li><li>Removes the meta[&quot;unsaved_workflow&quot;] data</li></ol><h2 id="cleanup_unsaved_workflow_sessions/1-parameters" class="section-heading"><a href="#cleanup_unsaved_workflow_sessions/1-parameters" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Parameters</span></h2><ul><li><code class="inline">workflow</code> - The saved <code class="inline">%Workflow{}</code> with a database ID</li></ul><h2 id="cleanup_unsaved_workflow_sessions/1-returns" class="section-heading"><a href="#cleanup_unsaved_workflow_sessions/1-returns" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Returns</span></h2><ul><li><code class="inline">{:ok, updated_count}</code> - Number of sessions updated</li><li><code class="inline">{:error, reason}</code> - If update fails</li></ul><h2 id="cleanup_unsaved_workflow_sessions/1-example" class="section-heading"><a href="#cleanup_unsaved_workflow_sessions/1-example" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Example</span></h2><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">cleanup_unsaved_workflow_sessions</span><span class="p" data-group-id="3722223398-1">(</span><span class="n">workflow</span><span class="p" data-group-id="3722223398-1">)</span><span class="w">
504-
</span><span class="p" data-group-id="3722223398-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="3722223398-2">}</span><span class="w"> </span><span class="c1"># Updated 2 sessions</span></code></pre>
503+
<p>Cleans up unsaved workflow data in AI sessions after workflow is saved.</p><p>When a workflow in create mode is saved for the first time, this function:</p><ol><li>Finds all sessions with matching temporary workflow IDs in meta[&quot;unsaved_workflow&quot;]</li><li>Updates those sessions to set workflow_id to the real database ID</li><li>Removes the meta[&quot;unsaved_workflow&quot;] data</li></ol><h2 id="cleanup_unsaved_workflow_sessions/1-parameters" class="section-heading"><a href="#cleanup_unsaved_workflow_sessions/1-parameters" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Parameters</span></h2><ul><li><code class="inline">workflow</code> - The saved <code class="inline">%Workflow{}</code> with a database ID</li></ul><h2 id="cleanup_unsaved_workflow_sessions/1-returns" class="section-heading"><a href="#cleanup_unsaved_workflow_sessions/1-returns" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Returns</span></h2><ul><li><code class="inline">{:ok, updated_count}</code> - Number of sessions updated</li><li><code class="inline">{:error, reason}</code> - If update fails</li></ul><h2 id="cleanup_unsaved_workflow_sessions/1-example" class="section-heading"><a href="#cleanup_unsaved_workflow_sessions/1-example" class="hover-link"><i class="ri-link-m" aria-hidden="true"></i></a><span class="text">Example</span></h2><pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex&gt; </span><span class="n">cleanup_unsaved_workflow_sessions</span><span class="p" data-group-id="7646298327-1">(</span><span class="n">workflow</span><span class="p" data-group-id="7646298327-1">)</span><span class="w">
504+
</span><span class="p" data-group-id="7646298327-2">{</span><span class="ss">:ok</span><span class="p">,</span><span class="w"> </span><span class="mi">2</span><span class="p" data-group-id="7646298327-2">}</span><span class="w"> </span><span class="c1"># Updated 2 sessions</span></code></pre>
505505
</section>
506506
</section>
507507
<section class="detail" id="create_session/4">

0 commit comments

Comments
 (0)