@storecraft/sdk 0.1.0 → 1.0.2

package/src/discounts.js

@@ -2,11 +2,11 @@ import { StorecraftSDK } from '../index.js'
 import { collection_base } from './utils.api.fetch.js';
 
 /**
- * Base `discounts` **CRUD**
+ * @description Base `discounts` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').DiscountTypeUpsert, 
- *  import('@storecraft/core/v-api').DiscountType>
+ *  import('@storecraft/core/api').DiscountTypeUpsert, 
+ *  import('@storecraft/core/api').DiscountType>
  * }
  */
 export default class Discounts extends collection_base {
@@ -19,131 +19,131 @@ export default class Discounts extends collection_base {
     super(sdk, 'discounts');
   }
 
-  /**
-   * 
-   * @param {DiscountData} discount_data 
-   * @param {number} limit 
-   */
-  publish = async (discount_data, limit=10000) => {
-    const coll_handle = `discount-${discount_data.code}`
-    const dd = { 
-      ...discount_data,
-      _published: coll_handle
-    }
-    if(dd.info.details.meta.type==='order')
-      throw 'Exporting a discount collection is only available for \
-              Product discounts (you chose Order discount)'
-
-    // save current document, allow to fail              
-    await this.set(
-      dd.code, dd
-    )
-    // await this.update(dd.code, { _published: coll_handle })
+  // /**
+  //  * 
+  //  * @param {DiscountData} discount_data 
+  //  * @param {number} limit 
+  //  */
+  // publish = async (discount_data, limit=10000) => {
+  //   const coll_handle = `discount-${discount_data.code}`
+  //   const dd = { 
+  //     ...discount_data,
+  //     _published: coll_handle
+  //   }
+  //   if(dd.info.details.meta.type==='order')
+  //     throw 'Exporting a discount collection is only available for \
+  //             Product discounts (you chose Order discount)'
+
+  //   // save current document, allow to fail              
+  //   await this.set(
+  //     dd.code, dd
+  //   )
+  //   // await this.update(dd.code, { _published: coll_handle })
 
     
-    // first, remove all previous collection tag from previous products              
-    try {
-      const products_to_remove = 
-            await this.context.products.list([`col:${coll_handle}`], 10000)
-      // console.log('products_to_remove ', products_to_remove);
-      const batch_remove = writeBatch(this.context.firebase.db)
-      products_to_remove.forEach(it => {
-        const ref = doc(this.context.firebase.db, 'products', it[0])
-        batch_remove.update(ref, { 
-          search : arrayRemove(`col:${coll_handle}`),
-          collections : arrayRemove(coll_handle),
-          [`discounts.${dd.code}`]: deleteField()
-        })
-      })
-      await batch_remove.commit()
-
-    } catch (e) {
-      console.log('Remove old: ' + String(e))
-      console.log(e)
-    }
-
-    try {
-      // filter in product filters
-      var product_filters = dd.info.filters.filter(f => f.meta.type==='product')
-
-      // then, make a server search that will filter out as much as possible
-      /**@type {Filter} */
-      var first_guided_filter = undefined
-      /**@type {string[]} */
-      var first_guided_search_terms = undefined
-
-      if(first_guided_filter = product_filters.find(f => f.meta.op==='p-in-handles')) {
-        first_guided_search_terms = first_guided_filter.value
-      }
-      else if(first_guided_filter = product_filters.find(f => f.meta.op==='p-in-tags')) {
-        first_guided_search_terms = first_guided_filter.value.map(t => `tag:${t}`)
-      }
-      else if(first_guided_filter = product_filters.find(f => f.meta.op==='p-in-collections')) {
-        first_guided_search_terms = first_guided_filter.value.map(c => `col:${c}`)
-      }
-    } catch (e) {
-      throw 'Filter preparing error: ' + String(e)
-    }
-
-    try {
-      // then, global filtering, this helps to reduce legal products for filtering
-      var products = await 
-              this.context.products.list(first_guided_search_terms, limit)
-
-      // now local filtering (due to firebase limitations with filtering)
-      var filtered_products = 
-              this.filterProductsWithFilters(products, product_filters)
+  //   // first, remove all previous collection tag from previous products              
+  //   try {
+  //     const products_to_remove = 
+  //           await this.context.products.list([`col:${coll_handle}`], 10000)
+  //     // console.log('products_to_remove ', products_to_remove);
+  //     const batch_remove = writeBatch(this.context.firebase.db)
+  //     products_to_remove.forEach(it => {
+  //       const ref = doc(this.context.firebase.db, 'products', it[0])
+  //       batch_remove.update(ref, { 
+  //         search : arrayRemove(`col:${coll_handle}`),
+  //         collections : arrayRemove(coll_handle),
+  //         [`discounts.${dd.code}`]: deleteField()
+  //       })
+  //     })
+  //     await batch_remove.commit()
+
+  //   } catch (e) {
+  //     console.log('Remove old: ' + String(e))
+  //     console.log(e)
+  //   }
+
+  //   try {
+  //     // filter in product filters
+  //     var product_filters = dd.info.filters.filter(f => f.meta.type==='product')
+
+  //     // then, make a server search that will filter out as much as possible
+  //     /**@type {Filter} */
+  //     var first_guided_filter = undefined
+  //     /**@type {string[]} */
+  //     var first_guided_search_terms = undefined
+
+  //     if(first_guided_filter = product_filters.find(f => f.meta.op==='p-in-handles')) {
+  //       first_guided_search_terms = first_guided_filter.value
+  //     }
+  //     else if(first_guided_filter = product_filters.find(f => f.meta.op==='p-in-tags')) {
+  //       first_guided_search_terms = first_guided_filter.value.map(t => `tag:${t}`)
+  //     }
+  //     else if(first_guided_filter = product_filters.find(f => f.meta.op==='p-in-collections')) {
+  //       first_guided_search_terms = first_guided_filter.value.map(c => `col:${c}`)
+  //     }
+  //   } catch (e) {
+  //     throw 'Filter preparing error: ' + String(e)
+  //   }
+
+  //   try {
+  //     // then, global filtering, this helps to reduce legal products for filtering
+  //     var products = await 
+  //             this.context.products.list(first_guided_search_terms, limit)
+
+  //     // now local filtering (due to firebase limitations with filtering)
+  //     var filtered_products = 
+  //             this.filterProductsWithFilters(products, product_filters)
       
-      // products = products.slice(0, 400)
-    } catch (e) {
-      throw 'Filtering error: ' + String(e)
-    }
-
-    try {
-      // add collection tag to each product with batch write
-      const batch = writeBatch(this.context.firebase.db)
-      filtered_products.forEach(it => {
-        const p = it[1]
-        const isActive = p?.active==true || (p.active===undefined)
-        if(!isActive)
-          return;
-
-        const ref = doc(this.context.firebase.db, 'products', it[0])
-        const dd_mod = {...dd}
-        delete dd_mod.search
-        delete dd_mod.order
-        batch.update(ref, { 
-          collections : arrayUnion(coll_handle),
-          search : arrayUnion(`col:${coll_handle}`),
-          [`discounts.${dd_mod.code}`]: dd_mod
-        })
-      })
-      await batch.commit()
-    } catch (e) {
-      throw 'Products update failed: ' + String(e)
-    }
-
-    try {
-      // now, create a new collection
-      /**@type {import('./js-docs-types').CollectionData} */
-      const col_discount = {
-        desc : dd.desc,
-        handle : coll_handle,
-        title : dd.title,
-        media : dd.media,
-        tags : dd.tags,
-        attributes: dd.attributes,
-        createdAt: Date.now()
-      }
-
-      await this.context.collections.set(
-        col_discount.handle, col_discount
-      )
-      // await this.update(discount_data.code, { _published: coll_handle })
-    } catch (e) {
-      throw 'Collection creation failed: ' + String(e)
-    }
+  //     // products = products.slice(0, 400)
+  //   } catch (e) {
+  //     throw 'Filtering error: ' + String(e)
+  //   }
+
+  //   try {
+  //     // add collection tag to each product with batch write
+  //     const batch = writeBatch(this.context.firebase.db)
+  //     filtered_products.forEach(it => {
+  //       const p = it[1]
+  //       const isActive = p?.active==true || (p.active===undefined)
+  //       if(!isActive)
+  //         return;
+
+  //       const ref = doc(this.context.firebase.db, 'products', it[0])
+  //       const dd_mod = {...dd}
+  //       delete dd_mod.search
+  //       delete dd_mod.order
+  //       batch.update(ref, { 
+  //         collections : arrayUnion(coll_handle),
+  //         search : arrayUnion(`col:${coll_handle}`),
+  //         [`discounts.${dd_mod.code}`]: dd_mod
+  //       })
+  //     })
+  //     await batch.commit()
+  //   } catch (e) {
+  //     throw 'Products update failed: ' + String(e)
+  //   }
+
+  //   try {
+  //     // now, create a new collection
+  //     /**@type {import('./js-docs-types').CollectionData} */
+  //     const col_discount = {
+  //       desc : dd.desc,
+  //       handle : coll_handle,
+  //       title : dd.title,
+  //       media : dd.media,
+  //       tags : dd.tags,
+  //       attributes: dd.attributes,
+  //       createdAt: Date.now()
+  //     }
+
+  //     await this.context.collections.set(
+  //       col_discount.handle, col_discount
+  //     )
+  //     // await this.update(discount_data.code, { _published: coll_handle })
+  //   } catch (e) {
+  //     throw 'Collection creation failed: ' + String(e)
+  //   }
     
-  }
+  // }
 
 }

package/src/images.js

@@ -2,11 +2,11 @@ import { StorecraftSDK } from '../index.js'
 import { collection_base } from './utils.api.fetch.js';
 
 /**
- * Base `images` **CRUD**
+ * @description Base `images` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').ImageTypeUpsert, 
- *  import('@storecraft/core/v-api').ImageType>
+ *  import('@storecraft/core/api').ImageTypeUpsert, 
+ *  import('@storecraft/core/api').ImageType>
  * }
  */
 export default class Images extends collection_base {

package/src/notifications.js

@@ -4,11 +4,11 @@ import {
 } from './utils.api.fetch.js';
 
 /**
- * Base `notifications` **CRUD**
+ * @description Base `notifications` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').NotificationTypeUpsert, 
- *  import('@storecraft/core/v-api').NotificationType>
+ *  import('@storecraft/core/api').NotificationTypeUpsert, 
+ *  import('@storecraft/core/api').NotificationType>
  * }
  */
 export default class Notifications extends collection_base {
@@ -23,7 +23,7 @@ export default class Notifications extends collection_base {
 
   /**
    * 
-   * @param {import('@storecraft/core/v-api').NotificationTypeUpsert[]} items 
+   * @param {import('@storecraft/core/api').NotificationTypeUpsert[]} items 
    */
   upsertBulk = items => {
     return fetchApiWithAuth(
@@ -43,60 +43,4 @@ export default class Notifications extends collection_base {
     return this.get('_meta')
   }
 
-  /**
-   * Test if backend moght have new data economically
-   * @returns {Promise<boolean>}
-   */
-  hasChanged = async () => {
-    try {
-      // try cache
-      const cached = await this.list([], 50, true, false)
-      if (cached.length==0)
-        return true
-
-      // compute how many latest updates with max timestamp in cache  
-      const max_updated = cached.reduce(
-        (p, c) => {
-          const updatedAt = c[1]?.updatedAt
-
-          if(updatedAt==p.timestamp)
-            p.count+=1
-          else if(updatedAt>p.timestamp)
-            p.count=1
-
-          p.timestamp = Math.max(updatedAt ?? -1, p.timestamp)
-          return p
-        },
-        {
-          timestamp: 0,
-          count: 0
-        }
-      )
-
-      // now, use a light count query to the database
-      const count = await this.context.db.col(NAME).count(
-        {
-          where: [
-            ['updatedAt', '>=', max_updated.timestamp]
-          ]
-        }
-      )
-
-      // console.log(cached)
-      // console.log('count ', count)
-      // console.log('max_updated ', max_updated)
-
-      if(count > max_updated.count)
-        return true
-      
-      return false
-      
-    } catch (e) {
-      // error
-      console.error(e)
-      return true
-    }
-    
-  }
-
 }

package/src/orders.js

@@ -1,13 +1,12 @@
-import { calculate_pricing } from '@storecraft/core/v-api/con.pricing.logic.js';
 import { StorecraftSDK } from '../index.js'
 import { collection_base } from './utils.api.fetch.js';
 
 /**
- * Base `orders` **CRUD**
+ * @description Base `orders` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').OrderDataUpsert, 
- *  import('@storecraft/core/v-api').OrderData>
+ *  import('@storecraft/core/api').OrderDataUpsert, 
+ *  import('@storecraft/core/api').OrderData>
  * }
  */
 export default class Orders extends collection_base {
@@ -20,28 +19,4 @@ export default class Orders extends collection_base {
     super(sdk, 'orders');
   }
 
-  /**
-   * calculate pricing of line items
-   * 
-   * @param {import('@storecraft/core/v-api').LineItem[]} line_items 
-   * @param {import('@storecraft/core/v-api').DiscountType[]} coupons 
-   * @param {import('@storecraft/core/v-api').ShippingMethodType} shipping_method 
-   * @param {string} [uid] 
-   */
-  calculatePricing = async (
-    line_items, coupons=[], shipping_method, uid
-  ) => {
-    // fetch auto discounts
-    const auto_discounts = await this.sdk.discounts.list(
-      {
-        limit: 100, 
-        vql: 'app:automatic'
-      }
-    );
-
-    return calculate_pricing(
-      line_items, auto_discounts, coupons, shipping_method, uid
-    );
-  }
-
 }

package/src/payments.js

@@ -4,7 +4,7 @@ import {
 } from './utils.api.fetch.js';
 
 /**
- * 
+ * @description payment gateways
  */
 export default class Payments {
 
@@ -24,7 +24,7 @@ export default class Payments {
    * @param {string} handle payment gateway `handle`
    * 
    * 
-   * @returns {Promise<import('@storecraft/core/v-api').PaymentGatewayItemGet>}
+   * @returns {Promise<import('@storecraft/core/api').PaymentGatewayItemGet>}
    */
   get(handle) {
     return get(this.sdk, 'payments/gateways', handle);
@@ -33,7 +33,7 @@ export default class Payments {
   /**
    * 
    * 
-   * @returns {Promise<import('@storecraft/core/v-api').PaymentGatewayItemGet[]>}
+   * @returns {Promise<import('@storecraft/core/api').PaymentGatewayItemGet[]>}
    */
   list() {
     return list(this.sdk, 'payments/gateways');
@@ -48,7 +48,7 @@ export default class Payments {
    * 
    * @param {string} order_id 
    * 
-   * @returns {Promise<import('@storecraft/core/v-api').PaymentGatewayStatus>}
+   * @returns {Promise<import('@storecraft/core/api').PaymentGatewayStatus>}
    */
   paymentStatusOfOrder(order_id) {
     return fetchApiWithAuth(
@@ -69,7 +69,7 @@ export default class Payments {
    * @param {string} order_id the `id` of the `order`
    * 
    * 
-   * @returns {Promise<import('@storecraft/core/v-api').PaymentGatewayStatus>}
+   * @returns {Promise<import('@storecraft/core/api').PaymentGatewayStatus>}
    */
   invokeAction(action_handle, order_id) {
     return fetchApiWithAuth(

package/src/posts.js

@@ -2,11 +2,11 @@ import { StorecraftSDK } from '../index.js'
 import { collection_base } from './utils.api.fetch.js';
 
 /**
- * Base `posts` **CRUD**
+ * @description Base `posts` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').PostTypeUpsert, 
- *  import('@storecraft/core/v-api').PostType>
+ *  import('@storecraft/core/api').PostTypeUpsert, 
+ *  import('@storecraft/core/api').PostType>
  * }
  */
 export default class Posts extends collection_base {

package/src/products.js

@@ -4,11 +4,11 @@ import {
 } from './utils.api.fetch.js';
 
 /**
- * Base `products` **CRUD**
+ * @description Base `products` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').ProductTypeUpsert, 
- *  import('@storecraft/core/v-api').ProductType>
+ *  import('@storecraft/core/api').ProductTypeUpsert, 
+ *  import('@storecraft/core/api').ProductType>
  * }
  */
 export default class Products extends collection_base {
@@ -44,8 +44,8 @@ export default class Products extends collection_base {
   /**
    * Add `products` to `collection`
    * 
-   * @param {import('@storecraft/core/v-api').ProductType[]} products 
-   * @param {import('@storecraft/core/v-api').CollectionType} collection 
+   * @param {import('@storecraft/core/api').ProductType[]} products 
+   * @param {import('@storecraft/core/api').CollectionType} collection 
    */
   batchAddProductsToCollection = async (products, collection) => {
     for (const pr of products) {
@@ -59,8 +59,8 @@ export default class Products extends collection_base {
   /**
    * Remove `products` from `collection`
    * 
-   * @param {import('@storecraft/core/v-api').ProductType[]} products 
-   * @param {import('@storecraft/core/v-api').CollectionType} collection 
+   * @param {import('@storecraft/core/api').ProductType[]} products 
+   * @param {import('@storecraft/core/api').CollectionType} collection 
    */
   batchRemoveProductsFromCollection = async (products, collection) => {
     for (const pr of products) {

package/src/settings.js

@@ -2,7 +2,7 @@ import { StorecraftSDK } from '../index.js'
 import { collection_base } from './utils.api.fetch.js';
 
 /**
- * Base `settings` **CRUD**
+ * @description Base `settings` **CRUD**
  * 
  * @extends {collection_base<any, any>}
  */

package/src/shipping.js

@@ -2,11 +2,11 @@ import { StorecraftSDK } from '../index.js'
 import { collection_base } from './utils.api.fetch.js';
 
 /**
- * Base `shipping` **CRUD**
+ * @description Base `shipping` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').ShippingMethodTypeUpsert, 
- *  import('@storecraft/core/v-api').ShippingMethodType>
+ *  import('@storecraft/core/api').ShippingMethodTypeUpsert, 
+ *  import('@storecraft/core/api').ShippingMethodType>
  * }
  */
 export default class Shipping extends collection_base {

package/src/statistics.js

@@ -1,8 +1,11 @@
 import { App } from '@storecraft/core';
 import { StorecraftSDK } from '../index.js'
 import { fetchApiWithAuth } from './utils.api.fetch.js';
-import { api_query_to_searchparams } from '@storecraft/core/v-api/utils.query.js';
+import { api_query_to_searchparams } from '@storecraft/core/api/utils.query.js';
 
+/**
+ * @description statistics endpoint
+ */
 export default class Statistics  {
   /** @type {StorecraftSDK} */
   #sdk;
@@ -35,7 +38,7 @@ export default class Statistics  {
   /**
    * 
    * @param {string} key 
-   * @returns {import('@storecraft/core/v-api').OrdersStatisticsType}
+   * @returns {import('@storecraft/core/api').OrdersStatisticsType}
    */
   fromCache = (key) => {
     if(this.isCacheValid(key))
@@ -46,7 +49,7 @@ export default class Statistics  {
   /**
    * 
    * @param {string} key 
-   * @param {import('@storecraft/core/v-api').OrdersStatisticsType} value
+   * @param {import('@storecraft/core/api').OrdersStatisticsType} value
    */
   putCache = (key, value) => {
     this.#cache[key] = value
@@ -54,12 +57,12 @@ export default class Statistics  {
 
 
   /**
-   * Load **Orders** `statistics`
+   * @description Load **Orders** `statistics`
    * 
    * @param {string | number | Date} [from_day] `ISO` string | `UTC` | `timestamp` | `Date`
    * @param {string | number | Date} [to_day] `ISO` string | `UTC` | `timestamp` | `Date`
    * 
-   * @returns {Promise<import('@storecraft/core/v-api').OrdersStatisticsType>}
+   * @returns {Promise<import('@storecraft/core/api').OrdersStatisticsType>}
    */
   orders = async (from_day, to_day) => {
     const search = new URLSearchParams();
@@ -76,10 +79,10 @@ export default class Statistics  {
   }
 
   /**
-   * Load **count** `statistics`
+   * @description Load **count** `statistics`
    * 
    * @param {keyof App["db"]["resources"]} table 
-   * @param {import('@storecraft/core/v-api').ApiQuery} [query]
+   * @param {import('@storecraft/core/api').ApiQuery} [query]
    * 
    * 
    * @returns {Promise<number>}