@storecraft/sdk 1.0.14 → 1.0.16

package/index.js

@@ -1,5 +1,5 @@
 /**
- * @import { StorecraftSDKConfig } from './types.js'
+ * @import { Fetcher, StorecraftSDKConfig } from './types.js'
  */
 import Auth from './src/auth.js'
 import Customers from './src/customers.js'
@@ -21,7 +21,10 @@ import Notifications from './src/notifications.js'
 import Storage from './src/storage.js'
 import AI from './src/ai.js'
 import Search from './src/search.js'
-import { fetchApiWithAuth, fetchOnlyApiResponseWithAuth } from './src/utils.api.fetch.js'
+import { 
+  fetchApiWithAuth, fetchOnlyApiResponseWithAuth 
+} from './src/utils.api.fetch.js'
+import Email from './src/email.js'
 
 /**
  * @description The official `storecraft` universal **SDK** for `javascript`
@@ -29,13 +32,19 @@ import { fetchApiWithAuth, fetchOnlyApiResponseWithAuth } from './src/utils.api.
 export class StorecraftSDK {
 
   /**@type {StorecraftSDKConfig} */
-  #_config = undefined;
+  #config = undefined;
+  /**@type {Fetcher} */
+  #fetcher = undefined;
 
   /**
-   * @param {StorecraftSDKConfig} [config] 
+   * @param {StorecraftSDKConfig} [config] the `sdk` configuration
+   * @param {Fetcher} [fetcher] Alternative `fetch` implementation. 
+   * This is useful for testing purposes, or if you want to use a 
+   * different `fetch` implementation
    */  
-  constructor(config) {
-    this.#_config = config;
+  constructor(config, fetcher) {
+    this.#config = config;
+    this.#fetcher = fetcher ?? ((input, init) => fetch(input, init));
 
     this.ai = new AI(this);
     this.search = new Search(this);
@@ -57,8 +66,13 @@ export class StorecraftSDK {
     this.checkout = new Checkout(this);
     this.settings = new Settings(this);
     this.notifications = new Notifications(this);
+    this.emails = new Email(this);
   }
 
+  get fetcher() {
+    return this.#fetcher
+  }
+  
   /**
    * @description 
    * - Prepends `backend` endpoint. 
@@ -66,15 +80,11 @@ export class StorecraftSDK {
    * - Refreshed `auth` if needed. 
    * - Throws a `json` representation of the `error`, 
    * if the request is `bad`
-   * 
    * @template {any} [R=any]
-   * 
    * @param {string} path relative path in api
    * @param {RequestInit} [init] request `init` type
    * @param {URLSearchParams} [query] url search params
-   * 
    * @throws {error}
-   * 
    * @returns {Promise<R>}
    */   
   fetchApiWithAuth = (path, init, query) => {
@@ -88,11 +98,9 @@ export class StorecraftSDK {
    * - Prepends `backend` endpoint. 
    * - Fetches with `authentication` middleware. 
    * - Refreshed `auth` if needed. 
-   * 
    * @param {string} path relative path in api
    * @param {RequestInit} [init] request `init` type
    * @param {URLSearchParams} [query] url search params
-   * 
    * @returns {Promise<Response>}
    */   
   fetchOnlyApiResponseWithAuth = (path, init, query) => {
@@ -105,13 +113,14 @@ export class StorecraftSDK {
    * @param {StorecraftSDKConfig} [config] 
    */  
   updateConfig(config) {
-    this.#_config = config;
+    this.#config = {
+      ...config
+    };
   }
 
   get config() {
-    return this.#_config
+    return this.#config
   }
-
 }
 
 /**
@@ -126,7 +135,6 @@ export const validateConfig = (config) => {
  */  
 export const create = (config) => { 
   const sdk = new StorecraftSDK(config);
-  
   return sdk;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/sdk",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Official storecraft Universal Javascript SDK",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",

package/src/ai.js

@@ -21,11 +21,11 @@ const HEADER_STORECRAFT_THREAD_ID = /** @satisfies {HEADER_STORECRAFT_THREAD_ID_
 export default class AI {
 
   /**
-   * 
    * @param {StorecraftSDK} sdk 
    */
   constructor(sdk) {
     this.sdk = sdk;
+    
   }
 
   /**
@@ -36,7 +36,7 @@ export default class AI {
    * @returns {Promise<AgentRunResponse>}
    */
   speak = async (agent_handle, params) => {
-    const response = await fetch(
+    const response = await this.sdk.fetcher(
       url(this.sdk.config, `ai/agents/${agent_handle}/run`),
       {
         method: 'post',
@@ -55,8 +55,9 @@ export default class AI {
    * @param {string} agent_handle agent identifier
    * @param {AgentRunParameters} params 
    */
-  streamSpeak = async function(agent_handle, params) {
-    const response = await fetch(
+  streamSpeak = async (agent_handle, params) => {
+    
+    const response = await this.sdk.fetcher(
       url(this.sdk.config, `ai/agents/${agent_handle}/stream`),
       {
         method: 'post',
@@ -160,7 +161,6 @@ export const SSEGenerator = async function *(stream) {
  */
 
 /**
- * 
  * @param {string[]} lines 
  * @returns {SSEFrame}
  */

package/src/auth.js

@@ -8,9 +8,13 @@
  * @import { SdkConfigAuth } from '../types.js';
  */
 
-import { api_query_to_searchparams } from '@storecraft/core/api/utils.query.js';
+import { 
+  api_query_to_searchparams 
+} from '@storecraft/core/api/utils.query.js';
 import { StorecraftSDK } from '../index.js';
-import { count_query_of_resource, fetchApiWithAuth, url } from './utils.api.fetch.js';
+import { 
+  count_query_of_resource, fetchApiWithAuth, url 
+} from './utils.api.fetch.js';
 import { assert } from './utils.functional.js';
 
 
@@ -22,14 +26,12 @@ import { assert } from './utils.functional.js';
  * 
  * @typedef {(payload: SubscriberCallbackPayload) => void
  * } SubscriberCallback Subscribe to `auth` updates for `JWT` auth
- * 
  */
   
   
 /**
  * @description `Storecraft` authentication module:
  * - Supports `subscribtion` to `auth` events
- * 
  */
 export default class Auth {
 
@@ -48,13 +50,11 @@ export default class Auth {
   }
 
   /**
-   * 
    * @description Get the current `auth` config, which is one of:
-   * 
    * 1. `JWT` with `access_token`, `refresh_token`, `claims`
    * 2. `Api Key` with a single value, which can be used as is in:
-   *    - `Authorization: Basic <api-key>`, or
-   *    - `X-API-KEY: <api-key>`
+   *  - `Authorization: Basic <api-key>`, or
+   *  - `X-API-KEY: <api-key>`
    * 
    * Notes:
    * 
@@ -64,7 +64,6 @@ export default class Auth {
    * **Api Key** represents a user which always makes the `backend` to verify
    * the authentication and authorization and therefore may be slower, because
    * the `backend` will verify against the database.
-   * 
    */
   get currentAuth() {
     return this.#sdk?.config?.auth;
@@ -82,42 +81,38 @@ export default class Auth {
   }
 
   /**
-   * 
    * @description Get a working token, by the following strategy:
-   * 
    * - If you are in `JWT` strategy:
-   *    - If the current `access_token` will expire soon or is already expired
-   *    - then, use `refresh_token` to re-authenticate
-   * 
+   *  - If the current `access_token` will expire soon or is already expired
+   *  - then, use `refresh_token` to re-authenticate
    * - If you are in `Api Key` strategy, simply returns the `apikey`
-   * 
    * @param {boolean} [force_reauth=false] 
-   * 
    */
   async working_auth_token(force_reauth=false) {
-    if(this.currentAuth) {
-      if('apikey' in this.currentAuth) {
-        return this.currentAuth.apikey;
+    // console.log({currentAuthStrategy: this.currentAuthStrategy})
+
+    switch(this.currentAuthStrategy) {
+      case 'apikey': {
+        const auth = /** @type {ApiKeyResult} */(this.currentAuth);
+        return auth?.apikey;
       }
-      else if('access_token' in this.currentAuth) {
+      case 'jwt': {
+        const auth = /** @type {ApiAuthResult} */(this.currentAuth);
         if(force_reauth || !this.isAuthenticated)
           await this.reAuthenticateIfNeeded(force_reauth);
-        return this.currentAuth.access_token.token;
+        return auth?.access_token?.token;
+      }
+      default: {
       }
     }
-
     return undefined;
   }
 
 
   /**
-   * 
    * @description Perform re-authentication for `JWT` auth, which means:
-   * 
    * - use the `refresh_token` to gain a new `access_token`
-   * 
    * @param {boolean} [force=false] 
-   * 
    */
   async reAuthenticateIfNeeded(force=false) {
     if(!this.currentAuth)
@@ -127,7 +122,7 @@ export default class Auth {
       return;
 
     if('access_token' in this.currentAuth) {
-      const auth_res = await fetch(
+      const auth_res = await this.#sdk.fetcher(
         url(this.#sdk.config, '/auth/refresh'),
         {
           method: 'post',
@@ -149,7 +144,7 @@ export default class Auth {
         payload = await auth_res.json();
       }
 
-      this.#_update_and_notify_subscribers(payload);
+      this.#update_and_notify_subscribers(payload);
 
       return payload;
     }
@@ -180,49 +175,49 @@ export default class Auth {
     }
   }
 
-  get authStrategy() {
-    if(this.currentAuth) {
+  get currentAuthStrategy() {
+    // console.log({currentAuthStrategy:this.currentAuth})
+
+    if(
+      this.currentAuth && 
+      (typeof this.currentAuth === 'object')
+    ) {
       if('apikey' in this.currentAuth)
         return 'apikey';
       else if('access_token' in this.currentAuth)
         return 'jwt';
     }
-
     return 'unknown';
   }
 
   get isAuthenticated() {
-    
-    if(this.currentAuth) {
-      if('apikey' in this.currentAuth) {
-        return Boolean(this.currentAuth.apikey);
+    switch(this.currentAuthStrategy) {
+      case 'apikey': {
+        const auth = /** @type {ApiKeyResult} */(this.currentAuth);
+        return Boolean(auth.apikey);
       }
-      else if('access_token' in this.currentAuth) {
-        const exp = this.currentAuth?.access_token?.claims?.exp;
-        
-        return exp && (Date.now() < (exp - 60)*1000);
+      case 'jwt': {
+        const auth = /** @type {ApiAuthResult} */(this.currentAuth);
+        const exp = auth?.access_token?.claims?.exp;
+        return exp && (Date.now() < (exp - 60)*1000);      
       }
+      default:
+        return false;
     }
-
-    return false;
   }
 
   /**
-   * 
    * @param {ApiAuthResult} user 
    */
-  #_update_and_notify_subscribers = (user) => {
+  #update_and_notify_subscribers = (user) => {
     this.currentAuth = user
     this.notify_subscribers();
   }
 
 
   /**
-   * 
    * @param {string} email 
    * @param {string} password 
-   * 
-   * 
    * @returns {Promise<ApiAuthResult>}
    */
   signin = async (email, password) => {
@@ -233,7 +228,7 @@ export default class Auth {
       email, password
     }
 
-    const res = await fetch(
+    const res = await this.#sdk.fetcher(
       url(this.#sdk.config, `/auth/signin`),
       { 
         method: 'post',
@@ -260,24 +255,22 @@ export default class Auth {
       }
 
       throw error_payload;
-    }    
+    }
+
     // assert(res.ok, 'auth/error2');
 
     /** @type {ApiAuthResult} */
     const payload = await res.json();
-
-    // console.log('auth_result', payload)
-
-    this.#_update_and_notify_subscribers(
+    
+    this.#update_and_notify_subscribers(
       payload
     );
-
+    
     return payload;
   }
 
 
   /**
-   * 
    * @param {string} email 
    * @param {string} password 
    * @param {string} [firstname] 
@@ -290,7 +283,7 @@ export default class Auth {
       firstname, lastname
     }
 
-    const res = await fetch(
+    const res = await this.#sdk.fetcher(
       url(this.#sdk.config, `/auth/signup`),
       { 
         method: 'post',
@@ -306,7 +299,7 @@ export default class Auth {
     /** @type {ApiAuthResult} */
     const payload = await res.json();
 
-    this.#_update_and_notify_subscribers(
+    this.#update_and_notify_subscribers(
       payload
     );
 
@@ -315,13 +308,11 @@ export default class Auth {
 
 
   /**
-   * 
    * @param {ApiAuthChangePasswordType} params 
    */
-  
   changePassword = async (params) => {
 
-    const res = await fetch(
+    const res = await this.#sdk.fetcher(
       url(this.#sdk.config, `/auth/change-password`),
       { 
         method: 'post',
@@ -353,25 +344,21 @@ export default class Auth {
     /** @type {ApiAuthResult} */
     const payload = await res.json();
 
-    this.#_update_and_notify_subscribers(
+    this.#update_and_notify_subscribers(
       payload
     );
 
     return payload;
   }
 
-
-
   signout = async () => {
     console.log('signout');
 
-    this.#_update_and_notify_subscribers(
+    this.#update_and_notify_subscribers(
       undefined
     );
-
   }
 
-
   create_api_key = async () => {
     /** @type {ApiKeyResult} */
     const item = await fetchApiWithAuth(
@@ -381,14 +368,10 @@ export default class Auth {
         method: 'post',
       }
     );
-
-    return item.apikey;
+    return item;
   }
 
-
   /**
-   * 
-   * 
    * @param {string} email_or_id
    */
   get_auth_user = async (email_or_id) => {
@@ -400,15 +383,12 @@ export default class Auth {
         method: 'get'
       }
     );
-
     return item;
   }
 
   /**
-   * 
-   * 
    * @param {string} email_or_id
-   * 
+   * @returns {Promise<boolean>}
    */
   remove_auth_user = async (email_or_id) => {
     return fetchApiWithAuth(
@@ -440,7 +420,7 @@ export default class Auth {
    * @param {ApiQuery<AuthUserType>} query
    */
   count_auth_users_query = async (query) => {
-    const sq = api_query_to_searchparams(query);
+    // const sq = api_query_to_searchparams(query);
     return count_query_of_resource(
       this.#sdk,
       `/auth/users`,
@@ -448,9 +428,7 @@ export default class Auth {
     )
   }
 
-
   list_api_keys_auth_users = async () => {
-
     /** @type {AuthUserType[]} */
     const items = await fetchApiWithAuth(
       this.#sdk,
@@ -459,7 +437,6 @@ export default class Auth {
         method: 'get'
       }
     );
-
     return items;
   }
 
@@ -476,7 +453,6 @@ export default class Auth {
   }
 
   /**
-   * 
    * @param {OAuthProviderCreateURIParams} params 
    * @returns {Promise<OAuthProviderCreateURIResponse>}
    */
@@ -516,7 +492,7 @@ export default class Auth {
       }
     );
 
-    this.#_update_and_notify_subscribers(result);
+    this.#update_and_notify_subscribers(result);
 
     return result;
   }  

package/src/checkout.js

@@ -1,5 +1,8 @@
 /**
- * @import { CheckoutCreateType, OrderData, PricingData } from '@storecraft/core/api'
+ * @import { 
+ *  CheckoutCreateType, CheckoutCreateTypeAfterValidation, 
+ *  OrderData, PricingData 
+ * } from '@storecraft/core/api'
  */
 import { StorecraftSDK } from '../index.js'
 import { fetchApiWithAuth } from './utils.api.fetch.js';
@@ -28,7 +31,6 @@ export default class Checkout {
    */
   create = async (input, gateway_handle) => {
 
-    console.log('input', input)
     const result = await fetchApiWithAuth(
       this.sdk,
       `checkout/create?gateway=${gateway_handle}`,
@@ -65,11 +67,9 @@ export default class Checkout {
   }
 
   /**
-   * @description calculate the pricing of an `order`. Using auto-discounts, 
-   * coupons, shipping and line-items.
-   * 
-   * @param {Partial<OrderData>} order 
-   * 
+   * @description calculate the pricing of an `order`. 
+   * Using auto-discounts, coupons, shipping and line-items.
+   * @param {CheckoutCreateTypeAfterValidation} order 
    * @returns {Promise<Partial<PricingData>>}
    */
   pricing = async (order) => {

package/src/collections.js

@@ -17,7 +17,6 @@ import {
 export default class Collections extends collection_base {
 
   /**
-   * 
    * @param {StorecraftSDK} sdk 
    */
   constructor(sdk) {
@@ -28,12 +27,10 @@ export default class Collections extends collection_base {
    * @description Export a collection of `products` into the `storage`. This is
    * beneficial for `collections`, that hardly change and therefore can be 
    * efficiently stored in a cost-effective `storage` and **CDN** network.
-   * 
    * @param {string} collection_handle 
    * @param {number} limit 
    */
   publish = async (collection_handle, limit=1000) => {
-
     const result = await fetchApiWithAuth(
       this.sdk,
       `collections/${collection_handle}/export`,
@@ -41,7 +38,6 @@ export default class Collections extends collection_base {
         method: 'post'
       }
     );
-
     return result
   }
 
@@ -49,7 +45,6 @@ export default class Collections extends collection_base {
    * @description List all the tags of products in a collection, This is helpful 
    * for building a filter system in the frontend if you know in advance all 
    * the tags of the products in a collection
-   * 
    * @param {string} id_or_handle Collection `id` or `handle`
    * @return {Promise<string[]>} List of tags
    */
@@ -67,7 +62,6 @@ export default class Collections extends collection_base {
 
   /**
    * @description Query the `products` in a collection
-   * 
    * @param {string} id_or_handle Collection `id` or `handle`
    * @param {ApiQuery<(ProductType | VariantType)>} query query
    * @return {Promise<(ProductType | VariantType)[]>} List of products in collection
@@ -83,7 +77,6 @@ export default class Collections extends collection_base {
 
   /**
    * @description Count the number of `products` in a collection by a query
-   * 
    * @param {string} id_or_handle Collection `id` or `handle`
    * @param {ApiQuery<(ProductType | VariantType)>} query query
    * @return {Promise<number>} count

package/src/customers.js

@@ -27,7 +27,6 @@ export default class Customers extends collection_base {
   /**
    * @description Query customer orders, this is only available to admin and 
    * the customer (with auth token)
-   * 
    * @param {string} id_or_handle customer `id` or `handle` or `email`
    * @param {ApiQuery<OrderData>} query query
    * @return {Promise<OrderData[]>} List of orders of customer
@@ -44,7 +43,6 @@ export default class Customers extends collection_base {
   /**
    * @description Count the number of orders of a specific
    * customer with a query
-   * 
    * @param {string} id_or_handle customer `id` or `handle` or `email`
    * @param {ApiQuery<OrderData>} query query
    * @return {Promise<number>} count

package/src/discounts.js

@@ -1,8 +1,7 @@
 /**
  * @import { 
  *  ApiQuery, DiscountType, DiscountTypeUpsert, 
- ProductType,
- VariantType
+ *  ProductType, VariantType
  * } from '@storecraft/core/api'
  */
 import { StorecraftSDK } from '../index.js'
@@ -20,7 +19,6 @@ import {
 export default class Discounts extends collection_base {
 
   /**
-   * 
    * @param {StorecraftSDK} sdk 
    */
   constructor(sdk) {
@@ -30,7 +28,6 @@ export default class Discounts extends collection_base {
   /**
    * @description Each discount has eligible products, 
    * you can query and filter these products by discount
-   * 
    * @param {string} id_or_handle discount `id` or `handle`
    * @param {ApiQuery<ProductType | VariantType>} query query
    * @return {Promise<(ProductType | VariantType)[]>} List of discounts
@@ -47,7 +44,6 @@ export default class Discounts extends collection_base {
   /**
    * @description Each discount has eligible products, 
    * you can count the query products by discount
-   * 
    * @param {string} id_or_handle discount `id` or `handle`
    * @param {ApiQuery<ProductType | VariantType>} query query
    * @return {Promise<number>} count
@@ -64,7 +60,6 @@ export default class Discounts extends collection_base {
    * @description List all the tags of products in a collection, This is helpful 
    * for building a filter system in the frontend if you know in advance all 
    * the tags of the products in a collection
-   * 
    * @param {string} id_or_handle Discount `id` or `handle`
    * @return {Promise<string[]>} List of tags
    */
@@ -76,7 +71,6 @@ export default class Discounts extends collection_base {
         method: 'get'
       }
     );
-
     return result
   }