@storecraft/sdk 1.0.15 → 1.0.17

package/src/storage.js

@@ -1,19 +1,18 @@
 /**
- * @import { StorageFeatures, StorageSignedOperation } from '@storecraft/core/storage'
+ * @import { 
+ *  StorageFeatures, StorageSignedOperation 
+ * } from '@storecraft/core/storage'
  */
 
 import { StorecraftSDK } from '../index.js'
 import { fetchOnlyApiResponseWithAuth } from './utils.api.fetch.js'
 
 /**
- * 
  * @description `Storecraft` storage service.
- * 
  * Supports:
  * - direct `downloads` / `uploads`
  * - presigned-urls for `download` / `upload` (If supported)
  * - `delete` files
- * 
  */
 export default class Storage {
 
@@ -34,11 +33,8 @@ export default class Storage {
   }
 
   /**
-   * 
    * @description Retrieve the `features` of `storage`, which informs:
    * - Does `storage` supports `pre-signed` urls for `download` / `upload`
-   * 
-   * 
    * @returns {Promise<StorageFeatures>}
    */
   features = async () => {
@@ -75,12 +71,9 @@ export default class Storage {
   
   /**
    * @description Get a blob from `storage` driver with `presigned` urls
-   * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
-   * 
    * @return {Promise<Blob>}
-   * 
    * @throws {error}
    */
   getBlobSigned = async (key) => {
@@ -104,7 +97,7 @@ export default class Storage {
       /** @type {StorageSignedOperation} */
       const presigned_req = await r.json();
 
-      const presigned_res = await fetch(
+      const presigned_res = await this.sdk.fetcher(
         presigned_req.url, 
         {
           method: presigned_req.method,
@@ -119,13 +112,11 @@ export default class Storage {
   }
 
   /**
-   * @description Get a blob from `storage` driver, straight download. (Not recommended)
-   * 
+   * @description Get a blob from `storage` driver, 
+   * straight download. (Not recommended)
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
-   * 
    * @return {Promise<Blob>}
-   * 
    * @throws {error}
    */
   getBlobUnsigned = async (key) => {
@@ -137,10 +128,8 @@ export default class Storage {
     );
 
     const ctype = r.headers.get('Content-Type');
-
     if(!r.ok) {
       const error = await r.json();
-
       throw error;
     }
 
@@ -149,12 +138,9 @@ export default class Storage {
 
   /**
    * @description Get a blob from `storage` driver.
-   * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
-   * 
    * @return {Promise<Blob>}
-   * 
    * @throws {error}
    */
   getBlob = async (key) => {
@@ -169,32 +155,36 @@ export default class Storage {
 
   /** @param {string} path  */
   getText = (path) => 
-      this.getBlob(path).then(blob => blob.text());
+    this.getBlob(path).then(blob => blob.text());
 
   /** @param {string} path  */
   getJson = (path) => 
-      this.getBlob(path).then(blob => blob.text().then(JSON.parse));
+    this.getBlob(path).then(
+      blob => blob.text().then(JSON.parse)
+    );
 
   /** @param {string} path  */
   getImageObjectURL = (path) => 
-      this.getBlob(path).then(blob => URL.createObjectURL(blob));
+    this.getBlob(path).then(
+      blob => URL.createObjectURL(blob)
+    );
 
   /**
    * @description get file source by inspecting the url:
-   * 
    * - If it starts with `storage://`, then use `backend` 
    * storage service, to download and convert it to encoded 
    * `object-url` for `<img/>`
-   * 
    * - Else. it is assumed to be a public `url`, and will 
    * return the given url.
-   * 
    * @template {false | true} [IS_IMAGE=true]
    * @param {string} url 
    * @param {IS_IMAGE} [isImage=true]
    * @returns {Promise<IS_IMAGE extends true ? string : any>}
    */
-  getSource = async (url, isImage=(/** @type {IS_IMAGE} */ (true))) => {
+  getSource = async (
+    url, 
+    isImage=(/** @type {IS_IMAGE} */ (true))
+  ) => {
     try {
 
       const is_storage = url.startsWith('storage://');
@@ -222,12 +212,13 @@ export default class Storage {
 
 
   /**
-   * @description Put a blob into `storage` driver with `presigned` urls
-   * 
+   * @description Put a blob into `storage` driver 
+   * with `presigned` urls if supported. this means the upload
+   * is offloaded from the backend to the client straight into 
+   * other services that supports it such as s3.
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
    * @param {string | Blob | Uint8Array | ArrayBuffer | File} data 
-   * 
    */
   putBytesSigned = async (key, data) => {
 
@@ -248,7 +239,7 @@ export default class Storage {
     if(ctype === 'application/json') {
       /** @type {StorageSignedOperation} */
       const presigned_req = await r.json();
-      const presigned_res = await fetch(
+      const presigned_res = await this.sdk.fetcher(
         presigned_req.url, 
         {
           method: presigned_req.method,
@@ -264,12 +255,11 @@ export default class Storage {
   }
 
   /**
-   * @description Put a blob into `storage` driver with direct `upload` (Not Recommended)
-   * 
+   * @description Put a blob into `storage` driver with 
+   * direct `upload` (Not Recommended)
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
    * @param {string | Blob | Uint8Array | ArrayBuffer | File} data 
-   * 
    */
   putBytesUnsigned = async (key, data) => {
 
@@ -295,13 +285,10 @@ export default class Storage {
 
   /**
    * @description Put bytes into `storage` driver.
-   * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
    * @param {string | Blob | Uint8Array | ArrayBuffer | File} data 
-   * 
    * @return {Promise<boolean>}
-   * 
    * @throws {error}
    */
   putBytes = async (key, data) => {
@@ -316,7 +303,6 @@ export default class Storage {
 
   /**
    * @description Delete a `file` by key
-   * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
    */
@@ -327,6 +313,11 @@ export default class Storage {
       { method: 'delete' }
     );
 
+    if(!r.ok) {
+      const error = await r.json();
+      throw error;
+    }
+    
     return r.ok;
   }
 

package/src/storefronts.js

@@ -13,7 +13,6 @@ import { collection_base, fetchApiWithAuth } from './utils.api.fetch.js';
 export default class Storefronts extends collection_base {
 
   /**
-   * 
    * @param {StorecraftSDK} sdk 
    */
   constructor(sdk) {
@@ -24,11 +23,9 @@ export default class Storefronts extends collection_base {
    * @description Export a storefront 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 {HandleOrId} handle_or_id
    */
   publish = async (handle_or_id) => {
-
     const result = await fetchApiWithAuth(
       this.sdk,
       `storefronts/${handle_or_id}/export`,
@@ -36,6 +33,29 @@ export default class Storefronts extends collection_base {
         method: 'post'
       }
     );
+    return result
+  }
+
+  /**
+   * @description You can fetch the default auto-generated storefront. 
+   * This will fetch all active
+   * - collections
+   * - discounts 
+   * - shipping methods 
+   * - posts (latest 5) 
+   * - products(latest 10) 
+   * that are linked to the storefront. Also, all the products 
+   * tags aggregated so you can build a filter system in the frontend
+   * @returns {Promise<StorefrontType>}
+   */
+  get_default_auto_generated_storefront = async () => {
+    const result = await fetchApiWithAuth(
+      this.sdk,
+      `storefronts/auto-generated`,
+      {
+        method: 'get'
+      }
+    );
 
     return result
   }

package/src/tags.js

@@ -12,7 +12,6 @@ import { collection_base } from './utils.api.fetch.js';
 export default class Tags extends collection_base {
 
   /**
-   * 
    * @param {StorecraftSDK} sdk 
    */
   constructor(sdk) {

package/src/templates.js

@@ -12,7 +12,6 @@ import { collection_base } from './utils.api.fetch.js';
 export default class Templates extends collection_base {
 
   /**
-   * 
    * @param {StorecraftSDK} sdk 
    */
   constructor(sdk) {

package/src/utils.api.fetch.js

@@ -5,11 +5,10 @@
  */
 import { 
   api_query_to_searchparams 
-} from '@storecraft/core/api/utils.query.js';
+} from '@storecraft/core/api/query.js';
 
 
 /**
- * 
  * @param {StorecraftSDKConfig} config 
  * @param {string} path 
  * @param {URLSearchParams} [query] url search params
@@ -34,12 +33,10 @@ export const url = (config, path, query) => {
  * - Prepends `backend` endpoint. 
  * - Fetches with `authentication` middleware. 
  * - Refreshed `auth` if needed. 
- * 
  * @param {StorecraftSDK} sdk 
  * @param {string} path relative path in api
  * @param {RequestInit} [init] request `init` type
  * @param {URLSearchParams} [query] url search params
- * 
  * @returns {Promise<Response>}
  */ 
 export const fetchOnlyApiResponseWithAuth = async (
@@ -48,11 +45,11 @@ export const fetchOnlyApiResponseWithAuth = async (
 
   const auth_token = await sdk.auth.working_auth_token();
   const auth_header_value = (
-    sdk.auth.authStrategy==='apikey' ? 'Basic' : 'Bearer'
+    sdk.auth.currentAuthStrategy==='apikey' ? 'Basic' : 'Bearer'
   ) + ` ${auth_token}`;
   
 
-  const response = await fetch(
+  const response = await sdk.fetcher(
     url(sdk.config, path, query),
     {
       ...init,
@@ -74,16 +71,14 @@ export const fetchOnlyApiResponseWithAuth = async (
  * - Refreshed `auth` if needed. 
  * - Throws a `json` representation of the `error`, 
  * if the request is `bad`
- * 
+ * - returns the object according to the `content-type` header
+ *  - json, text, html, blob
  * @template {any} [R=any]
- * 
  * @param {StorecraftSDK} sdk
  * @param {string} path relative path in api
  * @param {RequestInit} [init] request `init` type
  * @param {URLSearchParams} [query] url search params
- * 
  * @throws {error}
- * 
  * @returns {Promise<R>}
  */ 
 export const fetchApiWithAuth = async (
@@ -98,15 +93,24 @@ export const fetchApiWithAuth = async (
 
   const isok = response.ok;
   let payload = undefined;
+  const ct = response?.headers?.get('content-type');
 
   try {
-    payload = await response.json();
+    if(ct?.includes('application/json'))
+      payload = await response.json();
+    else if(ct?.includes('text/plain'))
+      payload = await response.text();
+    else if(ct?.includes('text/html'))
+      payload = await response.text();
+    else
+      payload = await response.blob();
   } catch(e) {
     console.log('fetchApiWithAuth.json()', e)
   }
 
-  if(!isok)
+  if(!isok) {
     throw payload;
+  }
 
   return payload;
 }
@@ -114,16 +118,14 @@ export const fetchApiWithAuth = async (
 
 /**
  * @template {any} G Get type
- * 
- * 
  * @param {StorecraftSDK} sdk
  * @param {string} handle_or_id `handle` or `id`
  * @param {string} resource base path of resource
- * 
- * 
  * @returns {Promise<G>}
  */
-export async function get_from_collection_resource(sdk, resource, handle_or_id) {
+export async function get_from_collection_resource(
+  sdk, resource, handle_or_id
+) {
   return fetchApiWithAuth(
     sdk, 
     `${resource}/${handle_or_id}`,
@@ -135,18 +137,15 @@ export async function get_from_collection_resource(sdk, resource, handle_or_id)
 
 
 /**
- * 
  * @template {any} U the upsert type
- * 
- * 
  * @param {StorecraftSDK} sdk
  * @param {string} resource base path of resource
  * @param {U} item Item to upsert
- * 
- * 
  * @returns {Promise<string>} id
  */
-export async function upsert_to_collection_resource(sdk, resource, item) {
+export async function upsert_to_collection_resource(
+  sdk, resource, item
+) {
   return fetchApiWithAuth(
     sdk, 
     `${resource}`,
@@ -176,19 +175,18 @@ export async function count_query_of_resource(sdk, resource, query) {
     {
       method: 'get',
     }
-  ).then((result) => Number(result.count));
+  );
 }
 
 /**
- * 
  * @param {StorecraftSDK} sdk
  * @param {string} resource base path of resource
  * @param {string} handle_or_id `handle` or `id`
- * 
- * 
  * @returns {Promise<boolean>}
  */
-export async function remove_from_collection_resource(sdk, resource, handle_or_id) {
+export async function remove_from_collection_resource(
+  sdk, resource, handle_or_id
+) {
   return fetchApiWithAuth(
     sdk, 
     `${resource}/${handle_or_id}`,
@@ -202,19 +200,15 @@ export async function remove_from_collection_resource(sdk, resource, handle_or_i
 /**
  * @description Invoke `api` endpoint that requires use of `query`
  * object. I named it `list` because it usually entails list op.
- * 
- * 
  * @template {any} G Get type
- * 
- * 
  * @param {StorecraftSDK} sdk
  * @param {string} resource base path of resource
  * @param {ApiQuery<G>} [query] 
- * 
- * 
  * @returns {Promise<G[]>}
  */
-export async function list_from_collection_resource(sdk, resource, query={}) {
+export async function list_from_collection_resource(
+  sdk, resource, query={}
+) {
   const sq = api_query_to_searchparams(query);
 
   // console.log('sq', sq.toString())
@@ -230,7 +224,6 @@ export async function list_from_collection_resource(sdk, resource, query={}) {
 
 /**
  * @description A simple resource base `class` with `CRUD` helpers
- * 
  * @template {any} U upsert type
  * @template {any} G get type
  */
@@ -243,7 +236,6 @@ export class collection_base {
   #base_name = undefined;
 
   /**
-   * 
    * @param {StorecraftSDK} sdk storecraft sdk
    * @param {string} base_name base path of resource type
    */
@@ -254,36 +246,33 @@ export class collection_base {
 
   
   /**
-   * 
    * @param {string} handle_or_id `handle` or `id`
-   * 
-   * 
    * @returns {Promise<G>}
    */
   async get(handle_or_id) {
-    return get_from_collection_resource(this.sdk, this.base_name, handle_or_id);
+    return get_from_collection_resource(
+      this.sdk, this.base_name, handle_or_id
+    );
   }
 
   /**
-   * 
    * @param {U} item Item to upsert
-   * 
-   * 
    * @returns {Promise<string>} id
    */
   async upsert(item) {
-    return upsert_to_collection_resource(this.sdk, this.base_name, item);
+    return upsert_to_collection_resource(
+      this.sdk, this.base_name, item
+    );
   }
 
   /**
-   * 
    * @param {string} handle_or_id `handle` or `id`
-   * 
-   * 
    * @returns {Promise<boolean>}
    */
   async remove(handle_or_id) {
-    return remove_from_collection_resource(this.sdk, this.base_name, handle_or_id);
+    return remove_from_collection_resource(
+      this.sdk, this.base_name, handle_or_id
+    );
   }
 
   /**
@@ -291,7 +280,9 @@ export class collection_base {
    * @returns {Promise<G[]>}
    */
   async list(query) {
-    return list_from_collection_resource(this.sdk, this.base_name, query);
+    return list_from_collection_resource(
+      this.sdk, this.base_name, query
+    );
   }
 
   /**
@@ -299,7 +290,9 @@ export class collection_base {
    * @param {ApiQuery<G>} query Query object
    */
   async count_query(query) {
-    return count_query_of_resource(this.sdk, this.base_name, query);
+    return count_query_of_resource(
+      this.sdk, this.base_name, query
+    );
   }
 
   get base_name() {

package/src/utils.functional.js

@@ -9,7 +9,6 @@ export const select_fields = (...fields) => {
 }
 
 /**
- * 
  * @param  {...any} fields 
  */
 export const filter_fields = (...fields) => {
@@ -20,7 +19,6 @@ export const filter_fields = (...fields) => {
 }
 
 /**
- * 
  * @param {object} o 
  */
 export const select_unused_fields = o => Object.keys(o).reduce((p, c) => { 
@@ -33,7 +31,6 @@ export const select_unused_fields = o => Object.keys(o).reduce((p, c) => {
 }, {});
 
 /**
- * 
  * @param {any[]} items 
  */
 export const filter_unused = items => 
@@ -55,7 +52,6 @@ export const delete_keys = (...keys) => {
 
 
 /**
- * 
  * @param {string} text 
  */
 export const text2tokens_unsafe = (text) => {
@@ -79,7 +75,6 @@ export const STOP_WORDS = [
 ]
 
 /**
- * 
  * @param {string} text 
  * @returns {string[] | undefined}
  */
@@ -101,7 +96,6 @@ export const text2tokens = (text) => {
 
 
 /**
- * 
  * @param {any[]} arrA 
  * @param {any[]} arrB 
  * @returns 

package/types.d.ts

@@ -3,8 +3,8 @@ import type { ApiAuthResult, ApiKeyResult } from '@storecraft/core/api';
 export * from './index.js';
 
 /**
- * @description The `storecraft` **SDK** 
- * `auth` config, represents either `apikey` or `jwt` authentication
+ * @description The `storecraft` **SDK** `auth` config, 
+ * represents either `apikey` or `jwt` authentication
  */
 export type SdkConfigAuth = ApiAuthResult | ApiKeyResult;
 
@@ -13,9 +13,22 @@ export type SdkConfigAuth = ApiAuthResult | ApiKeyResult;
  */
 export type StorecraftSDKConfig = {
 
-  /** Endpoint of `backend` */
+  /** 
+   * @description Endpoint of `backend` 
+   */
   endpoint?: string;
 
-  /** `auth` info, may be either `apikey` or `jwt` results */
+  /** 
+   * @description `auth` info, may be either `apikey` or `jwt` results.
+   * This will be setup automatically when performing `login` or 
+   * `apikey` operations if
+   * - the {@link StorecraftSDKConfig.persist_auth} is set to `true`.
+   * - This us used by the sdk to re-authenticate the user when 
+   * the token expires.
+   */
   auth?: SdkConfigAuth;
 }
+
+export type Fetcher = (
+  input: RequestInfo, init?: RequestInit
+) => Promise<Response>

package/src/settings.js

@@ -1,19 +0,0 @@
-import { StorecraftSDK } from '../index.js'
-import { collection_base } from './utils.api.fetch.js';
-
-/**
- * @description Base `settings` **CRUD**
- * 
- * @extends {collection_base<any, any>}
- */
-export default class Settings extends collection_base {
-
-  /**
-   * 
-   * @param {StorecraftSDK} sdk 
-   */
-  constructor(sdk) {
-    super(sdk, 'settings');
-  }
-
-}