Skip to content

Commit f031a06

Browse files
joeluong-sfccjoeluong-sfcc
committed
update docs
1 parent e9931e3 commit f031a06

File tree

8 files changed

+94
-22
lines changed

8 files changed

+94
-22
lines changed

‎docs/assets/js/search.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/classes/clientconfig.clientconfig-1.html‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ <h3>Constructors</h3>
112112
<h3>Properties</h3>
113113
<ul class="tsd-index-list">
114114
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientconfig.clientconfig-1.html#baseuri" class="tsd-kind-icon">base<wbr>Uri</a></li>
115+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientconfig.clientconfig-1.html#fetch" class="tsd-kind-icon">fetch</a></li>
115116
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientconfig.clientconfig-1.html#fetchoptions" class="tsd-kind-icon">fetch<wbr>Options</a></li>
116117
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientconfig.clientconfig-1.html#headers" class="tsd-kind-icon">headers</a></li>
117118
<li class="tsd-kind-property tsd-parent-kind-class"><a href="clientconfig.clientconfig-1.html#parameters" class="tsd-kind-icon">parameters</a></li>
@@ -141,7 +142,7 @@ <h3>constructor</h3>
141142
<li class="tsd-description">
142143
<aside class="tsd-sources">
143144
<ul>
144-
<li>Defined in src/lib/clientConfig.ts:62</li>
145+
<li>Defined in src/lib/clientConfig.ts:68</li>
145146
</ul>
146147
</aside>
147148
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -164,7 +165,18 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> base<wbr>Uri</h3>
164165
<aside class="tsd-sources">
165166
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#baseuri">baseUri</a></p>
166167
<ul>
167-
<li>Defined in src/lib/clientConfig.ts:48</li>
168+
<li>Defined in src/lib/clientConfig.ts:52</li>
169+
</ul>
170+
</aside>
171+
</section>
172+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
173+
<a name="fetch" class="tsd-anchor"></a>
174+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> fetch</h3>
175+
<div class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">:</span> <a href="../modules/clientconfig.html#fetchfunction" class="tsd-signature-type">FetchFunction</a></div>
176+
<aside class="tsd-sources">
177+
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#fetch">fetch</a></p>
178+
<ul>
179+
<li>Defined in src/lib/clientConfig.ts:62</li>
168180
</ul>
169181
</aside>
170182
</section>
@@ -175,7 +187,7 @@ <h3>fetch<wbr>Options</h3>
175187
<aside class="tsd-sources">
176188
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#fetchoptions">fetchOptions</a></p>
177189
<ul>
178-
<li>Defined in src/lib/clientConfig.ts:56</li>
190+
<li>Defined in src/lib/clientConfig.ts:60</li>
179191
</ul>
180192
</aside>
181193
</section>
@@ -186,7 +198,7 @@ <h3>headers</h3>
186198
<aside class="tsd-sources">
187199
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#headers">headers</a></p>
188200
<ul>
189-
<li>Defined in src/lib/clientConfig.ts:52</li>
201+
<li>Defined in src/lib/clientConfig.ts:56</li>
190202
</ul>
191203
</aside>
192204
<div class="tsd-type-declaration">
@@ -205,7 +217,7 @@ <h3>parameters</h3>
205217
<aside class="tsd-sources">
206218
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#parameters">parameters</a></p>
207219
<ul>
208-
<li>Defined in src/lib/clientConfig.ts:54</li>
220+
<li>Defined in src/lib/clientConfig.ts:58</li>
209221
</ul>
210222
</aside>
211223
</section>
@@ -216,7 +228,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy</h3>
216228
<aside class="tsd-sources">
217229
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#proxy">proxy</a></p>
218230
<ul>
219-
<li>Defined in src/lib/clientConfig.ts:50</li>
231+
<li>Defined in src/lib/clientConfig.ts:54</li>
220232
</ul>
221233
</aside>
222234
</section>
@@ -227,7 +239,7 @@ <h3>throw<wbr>OnBad<wbr>Response</h3>
227239
<aside class="tsd-sources">
228240
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#throwonbadresponse">throwOnBadResponse</a></p>
229241
<ul>
230-
<li>Defined in src/lib/clientConfig.ts:62</li>
242+
<li>Defined in src/lib/clientConfig.ts:68</li>
231243
</ul>
232244
</aside>
233245
</section>
@@ -238,7 +250,7 @@ <h3>transform<wbr>Request</h3>
238250
<aside class="tsd-sources">
239251
<p>Implementation of <a href="../interfaces/clientconfig.clientconfiginit.html">ClientConfigInit</a>.<a href="../interfaces/clientconfig.clientconfiginit.html#transformrequest">transformRequest</a></p>
240252
<ul>
241-
<li>Defined in src/lib/clientConfig.ts:58</li>
253+
<li>Defined in src/lib/clientConfig.ts:64</li>
242254
</ul>
243255
</aside>
244256
</section>
@@ -251,7 +263,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
251263
<div class="tsd-signature tsd-kind-icon">defaults<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
252264
<aside class="tsd-sources">
253265
<ul>
254-
<li>Defined in src/lib/clientConfig.ts:88</li>
266+
<li>Defined in src/lib/clientConfig.ts:96</li>
255267
</ul>
256268
</aside>
257269
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
@@ -264,7 +276,7 @@ <h3>transform<wbr>Request</h3>
264276
<li class="tsd-description">
265277
<aside class="tsd-sources">
266278
<ul>
267-
<li>Defined in src/lib/clientConfig.ts:100</li>
279+
<li>Defined in src/lib/clientConfig.ts:108</li>
268280
</ul>
269281
</aside>
270282
<div class="tsd-comment tsd-typography">
@@ -387,6 +399,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
387399
<li class=" tsd-kind-property tsd-parent-kind-class">
388400
<a href="clientconfig.clientconfig-1.html#baseuri" class="tsd-kind-icon">base<wbr>Uri</a>
389401
</li>
402+
<li class=" tsd-kind-property tsd-parent-kind-class">
403+
<a href="clientconfig.clientconfig-1.html#fetch" class="tsd-kind-icon">fetch</a>
404+
</li>
390405
<li class=" tsd-kind-property tsd-parent-kind-class">
391406
<a href="clientconfig.clientconfig-1.html#fetchoptions" class="tsd-kind-icon">fetch<wbr>Options</a>
392407
</li>

‎docs/index.html‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,44 @@ <h4>Custom APIs</h4>
276276
clientConfig,
277277
});</code></pre>
278278
<p>For more documentation about this helper function, please refer to the <a href="https://salesforcecommercecloud.github.io/commerce-sdk-isomorphic/modules/helpers.html">commerce-sdk-isomorphic docs</a>.</p>
279+
<a href="#custom-fetch-function" id="custom-fetch-function" style="color: inherit; text-decoration: none;">
280+
<h4>Custom Fetch function</h4>
281+
</a>
282+
<p>You can provide your own custom fetch function to intercept, log, or modify all SDK requests. This is useful for:</p>
283+
<ul>
284+
<li><strong>Request/Response Logging</strong>: Track all API calls for debugging and monitoring</li>
285+
<li><strong>Request Interception</strong>: Add custom headers, modify request URLs, or implement custom retry logic</li>
286+
<li><strong>Error Handling</strong>: Add custom error processing or transformation before responses reach your application</li>
287+
<li><strong>Performance Monitoring</strong>: Measure request/response times and track API performance metrics</li>
288+
</ul>
289+
<p><strong>Example with Logging:</strong></p>
290+
<pre><code class="language-javascript"><span class="hljs-comment">// Custom fetch function with detailed logging</span>
291+
<span class="hljs-keyword">const</span> customFetch = <span class="hljs-keyword">async</span> (url, options) =&gt; {
292+
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">`[SDK Request] <span class="hljs-subst">${options?.method || <span class="hljs-string">&#x27;GET&#x27;</span>}</span> <span class="hljs-subst">${url}</span>`</span>);
293+
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;[SDK Request Headers]&#x27;</span>, options?.headers);
294+
<span class="hljs-keyword">if</span> (options?.body) {
295+
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;[SDK Request Body]&#x27;</span>, options.body);
296+
}
297+
298+
<span class="hljs-keyword">const</span> startTime = <span class="hljs-built_in">Date</span>.now();
299+
<span class="hljs-keyword">const</span> response = <span class="hljs-keyword">await</span> fetch(url, options);
300+
<span class="hljs-keyword">const</span> duration = <span class="hljs-built_in">Date</span>.now() - startTime;
301+
302+
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">`[SDK Response] <span class="hljs-subst">${response.status}</span> <span class="hljs-subst">${response.statusText}</span> (<span class="hljs-subst">${duration}</span>ms)`</span>);
303+
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;[SDK Response Headers]&#x27;</span>, <span class="hljs-built_in">Object</span>.fromEntries(response.headers.entries()));
304+
305+
<span class="hljs-keyword">return</span> response;
306+
};
307+
308+
<span class="hljs-keyword">const</span> config = {
309+
<span class="hljs-attr">parameters</span>: {
310+
<span class="hljs-attr">clientId</span>: <span class="hljs-string">&#x27;&lt;your-client-id&gt;&#x27;</span>,
311+
<span class="hljs-attr">organizationId</span>: <span class="hljs-string">&#x27;&lt;your-org-id&gt;&#x27;</span>,
312+
<span class="hljs-attr">shortCode</span>: <span class="hljs-string">&#x27;&lt;your-short-code&gt;&#x27;</span>,
313+
<span class="hljs-attr">siteId</span>: <span class="hljs-string">&#x27;&lt;your-site-id&gt;&#x27;</span>,
314+
},
315+
<span class="hljs-attr">fetch</span>: customFetch,
316+
};</code></pre>
279317
<a href="#encoding-special-characters" id="encoding-special-characters" style="color: inherit; text-decoration: none;">
280318
<h4>Encoding special characters</h4>
281319
</a>

‎docs/interfaces/clientconfig.clientconfiginit.html‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ <h2>Index</h2>
106106
<h3>Properties</h3>
107107
<ul class="tsd-index-list">
108108
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="clientconfig.clientconfiginit.html#baseuri" class="tsd-kind-icon">base<wbr>Uri</a></li>
109+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="clientconfig.clientconfiginit.html#fetch" class="tsd-kind-icon">fetch</a></li>
109110
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="clientconfig.clientconfiginit.html#fetchoptions" class="tsd-kind-icon">fetch<wbr>Options</a></li>
110111
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="clientconfig.clientconfiginit.html#headers" class="tsd-kind-icon">headers</a></li>
111112
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="clientconfig.clientconfiginit.html#parameters" class="tsd-kind-icon">parameters</a></li>
@@ -125,7 +126,17 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> base<wbr>Uri</h3>
125126
<div class="tsd-signature tsd-kind-icon">base<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
126127
<aside class="tsd-sources">
127128
<ul>
128-
<li>Defined in src/lib/clientConfig.ts:25</li>
129+
<li>Defined in src/lib/clientConfig.ts:33</li>
130+
</ul>
131+
</aside>
132+
</section>
133+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
134+
<a name="fetch" class="tsd-anchor"></a>
135+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> fetch</h3>
136+
<div class="tsd-signature tsd-kind-icon">fetch<span class="tsd-signature-symbol">:</span> <a href="../modules/clientconfig.html#fetchfunction" class="tsd-signature-type">FetchFunction</a></div>
137+
<aside class="tsd-sources">
138+
<ul>
139+
<li>Defined in src/lib/clientConfig.ts:38</li>
129140
</ul>
130141
</aside>
131142
</section>
@@ -135,7 +146,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> fetch<wbr>Options</h3
135146
<div class="tsd-signature tsd-kind-icon">fetch<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="../modules/clientconfig.html#fetchoptions" class="tsd-signature-type">FetchOptions</a></div>
136147
<aside class="tsd-sources">
137148
<ul>
138-
<li>Defined in src/lib/clientConfig.ts:29</li>
149+
<li>Defined in src/lib/clientConfig.ts:37</li>
139150
</ul>
140151
</aside>
141152
</section>
@@ -145,7 +156,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
145156
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span></div>
146157
<aside class="tsd-sources">
147158
<ul>
148-
<li>Defined in src/lib/clientConfig.ts:27</li>
159+
<li>Defined in src/lib/clientConfig.ts:35</li>
149160
</ul>
150161
</aside>
151162
</section>
@@ -155,7 +166,7 @@ <h3>parameters</h3>
155166
<div class="tsd-signature tsd-kind-icon">parameters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Params</span></div>
156167
<aside class="tsd-sources">
157168
<ul>
158-
<li>Defined in src/lib/clientConfig.ts:28</li>
169+
<li>Defined in src/lib/clientConfig.ts:36</li>
159170
</ul>
160171
</aside>
161172
</section>
@@ -165,7 +176,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy</h3>
165176
<div class="tsd-signature tsd-kind-icon">proxy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
166177
<aside class="tsd-sources">
167178
<ul>
168-
<li>Defined in src/lib/clientConfig.ts:26</li>
179+
<li>Defined in src/lib/clientConfig.ts:34</li>
169180
</ul>
170181
</aside>
171182
</section>
@@ -175,7 +186,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> throw<wbr>OnBad<wbr>R
175186
<div class="tsd-signature tsd-kind-icon">throw<wbr>OnBad<wbr>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
176187
<aside class="tsd-sources">
177188
<ul>
178-
<li>Defined in src/lib/clientConfig.ts:34</li>
189+
<li>Defined in src/lib/clientConfig.ts:43</li>
179190
</ul>
180191
</aside>
181192
</section>
@@ -185,7 +196,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> transform<wbr>Request
185196
<div class="tsd-signature tsd-kind-icon">transform<wbr>Request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, headers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">FetchOptions</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"body"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span></div>
186197
<aside class="tsd-sources">
187198
<ul>
188-
<li>Defined in src/lib/clientConfig.ts:30</li>
199+
<li>Defined in src/lib/clientConfig.ts:39</li>
189200
</ul>
190201
</aside>
191202
</section>
@@ -278,6 +289,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> transform<wbr>Request
278289
<li class=" tsd-kind-property tsd-parent-kind-interface">
279290
<a href="clientconfig.clientconfiginit.html#baseuri" class="tsd-kind-icon">base<wbr>Uri</a>
280291
</li>
292+
<li class=" tsd-kind-property tsd-parent-kind-interface">
293+
<a href="clientconfig.clientconfiginit.html#fetch" class="tsd-kind-icon">fetch</a>
294+
</li>
281295
<li class=" tsd-kind-property tsd-parent-kind-interface">
282296
<a href="clientconfig.clientconfiginit.html#fetchoptions" class="tsd-kind-icon">fetch<wbr>Options</a>
283297
</li>

‎docs/modules/clientconfig.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,14 @@ <h3>Fetch<wbr>Function</h3>
117117
<div class="tsd-signature tsd-kind-icon">Fetch<wbr>Function<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInfo</span>, init<span class="tsd-signature-symbol">?: </span><a href="clientconfig.html#fetchoptions" class="tsd-signature-type">FetchOptions</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">&gt;</span></div>
118118
<aside class="tsd-sources">
119119
<ul>
120-
<li>Defined in src/lib/clientConfig.ts:37</li>
120+
<li>Defined in src/lib/clientConfig.ts:24</li>
121121
</ul>
122122
</aside>
123+
<div class="tsd-comment tsd-typography">
124+
<div class="lead">
125+
<p>A function that can be used to fetch data from an API</p>
126+
</div>
127+
</div>
123128
<div class="tsd-type-declaration">
124129
<h4>Type declaration</h4>
125130
<ul class="tsd-parameters">

‎docs/modules/helpers.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -931,7 +931,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> encodeSCAPISpecial<wbr>Char
931931
<li class="tsd-description">
932932
<aside class="tsd-sources">
933933
<ul>
934-
<li>Defined in src/lib/helpers/fetchHelper.ts:77</li>
934+
<li>Defined in src/lib/helpers/fetchHelper.ts:80</li>
935935
</ul>
936936
</aside>
937937
<div class="tsd-comment tsd-typography">

‎docs/modules/version.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>HEADER
9595
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
9696
<a name="user_agent_value" class="tsd-anchor"></a>
9797
<h3><span class="tsd-flag ts-flagConst">Const</span> USER_<wbr>AGENT_<wbr>VALUE</h3>
98-
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk-isomorphic@5.0.0"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk-isomorphic@5.0.0&quot;</span></div>
98+
<div class="tsd-signature tsd-kind-icon">USER_<wbr>AGENT_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"commerce-sdk-isomorphic@5.1.0"</span><span class="tsd-signature-symbol"> = &quot;commerce-sdk-isomorphic@5.1.0&quot;</span></div>
9999
<aside class="tsd-sources">
100100
<ul>
101101
<li>Defined in src/lib/version.ts:8</li>

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "commerce-sdk-isomorphic",
3-
"version": "5.0.0",
3+
"version": "5.1.0",
44
"private": false,
55
"description": "Salesforce Commerce SDK Isomorphic",
66
"bugs": {

0 commit comments

Comments
 (0)