@storecraft/sdk 0.1.0 → 1.0.2

package/src/storage.js

@@ -4,7 +4,7 @@ import { fetchOnlyApiResponseWithAuth } from './utils.api.fetch.js'
 
 /**
  * 
- * `Storecraft` storage service.
+ * @description `Storecraft` storage service.
  * 
  * Supports:
  * - direct `downloads` / `uploads`
@@ -16,7 +16,7 @@ export default class Storage {
 
   /**
    * @type {{
-   *  features: import('@storecraft/core/v-storage').StorageFeatures
+   *  features: import('@storecraft/core/storage').StorageFeatures
    * }}
    */
   #cache = {
@@ -32,11 +32,11 @@ export default class Storage {
 
   /**
    * 
-   * Retrieve the `features` of `storage`, which informs:
+   * @description Retrieve the `features` of `storage`, which informs:
    * - Does `storage` supports `pre-signed` urls for `download` / `upload`
    * 
    * 
-   * @returns {Promise<import('@storecraft/core/v-storage').StorageFeatures>}
+   * @returns {Promise<import('@storecraft/core/storage').StorageFeatures>}
    */
   features = async () => {
     if(this.#cache.features)
@@ -71,14 +71,14 @@ export default class Storage {
   }
   
   /**
-   * Get a blob from `storage` driver with `presigned` urls
+   * @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 {import('@storecraft/core/v-api').error}
+   * @throws {import('@storecraft/core/api').error}
    */
   getBlobSigned = async (key) => {
 
@@ -98,7 +98,7 @@ export default class Storage {
 
     // `presigned` url instructions
     if(ctype === 'application/json') {
-      /** @type {import('@storecraft/core/v-storage').StorageSignedOperation} */
+      /** @type {import('@storecraft/core/storage').StorageSignedOperation} */
       const presigned_req = await r.json();
 
       const presigned_res = await fetch(
@@ -116,14 +116,14 @@ export default class Storage {
   }
 
   /**
-   * 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 {import('@storecraft/core/v-api').error}
+   * @throws {import('@storecraft/core/api').error}
    */
   getBlobUnsigned = async (key) => {
 
@@ -145,14 +145,14 @@ export default class Storage {
   }  
 
   /**
-   * Get a blob from `storage` driver.
+   * @description Get a blob from `storage` driver.
    * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
    * 
    * @return {Promise<Blob>}
    * 
-   * @throws {import('@storecraft/core/v-api').error}
+   * @throws {import('@storecraft/core/api').error}
    */
   getBlob = async (key) => {
 
@@ -177,7 +177,7 @@ export default class Storage {
       this.getBlob(path).then(blob => URL.createObjectURL(blob));
 
   /**
-   * get file source by inspecting the url:
+   * @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 
@@ -214,7 +214,7 @@ export default class Storage {
 
 
   /**
-   * Put a blob into `storage` driver with `presigned` urls
+   * @description Put a blob into `storage` driver with `presigned` urls
    * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
@@ -238,7 +238,7 @@ export default class Storage {
 
     // `presigned` url instructions
     if(ctype === 'application/json') {
-      /** @type {import('@storecraft/core/v-storage').StorageSignedOperation} */
+      /** @type {import('@storecraft/core/storage').StorageSignedOperation} */
       const presigned_req = await r.json();
       const presigned_res = await fetch(
         presigned_req.url, 
@@ -256,7 +256,7 @@ export default class Storage {
   }
 
   /**
-   * 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`
@@ -286,7 +286,7 @@ export default class Storage {
   }
 
   /**
-   * Put bytes into `storage` driver.
+   * @description Put bytes into `storage` driver.
    * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`
@@ -294,7 +294,7 @@ export default class Storage {
    * 
    * @return {Promise<boolean>}
    * 
-   * @throws {import('@storecraft/core/v-api').error}
+   * @throws {import('@storecraft/core/api').error}
    */
   putBytes = async (key, data) => {
 
@@ -307,7 +307,7 @@ export default class Storage {
   }
 
   /**
-   * Delete a `file` by key
+   * @description Delete a `file` by key
    * 
    * @param {string} key file path key, 
    * examples `image.png`, `collections/thumb.jpeg`

package/src/storefronts.js

@@ -1,12 +1,12 @@
 import { StorecraftSDK } from '../index.js'
-import { collection_base } from './utils.api.fetch.js';
+import { collection_base, fetchApiWithAuth } from './utils.api.fetch.js';
 
 /**
- * Base `storefronts` **CRUD**
+ * @description Base `storefronts` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').StorefrontTypeUpsert, 
- *  import('@storecraft/core/v-api').StorefrontType>
+ *  import('@storecraft/core/api').StorefrontTypeUpsert, 
+ *  import('@storecraft/core/api').StorefrontType>
  * }
  */
 export default class Storefronts extends collection_base {
@@ -20,94 +20,23 @@ 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 {StorefrontData} sf_data 
+   * @param {import('@storecraft/core/database').HandleOrId} handle_or_id
    */
-  publish = async (sf_data) => {
-    sf_data = {...sf_data}
-    try {
-      // Gather products
-      let products = await Promise.all(
-        sf_data.products.map(
-          async id => await this.context.products.get(id)
-        )
-      )
-      sf_data.products = delete_keys('search', 'createdAt')(
-        products.map(p => p[2])
-      )
-    } catch(e) {
-      throw 'products export error: ' + String(e)
-    }
+  publish = async (handle_or_id) => {
 
-    /**
-     * @param {Handle[]} sf_data_entry 
-     * @param {string} collectionId 
-     * @param {(any) => any} filter_fn 
-     */
-    const collect = async (sf_data_entry, collectionId, filter_fn=_=>true) => {
-      try {
-        // Gather collections
-        const has_all = sf_data_entry?.some(c => c==='ALL')
-        let items = []
-        if(has_all) {
-          items = await this.context[collectionId].list()
-          items = items.map(c => c[1]).filter(filter_fn)
-        }
-        else {
-          items = sf_data_entry?.map(
-            async id => {
-              const [_, __, coll] = await this.context[collectionId].get(id)
-              return coll
-            }
-          )
-          items = await Promise.all(items ?? [])     
-        }
-        items = delete_keys('search')(items)
-        return items
-      } catch(e) {
-        throw `${collectionId} export error: ` + String(e)
+    const result = await fetchApiWithAuth(
+      this.sdk,
+      `storefronts/${handle_or_id}/export`,
+      {
+        method: 'post'
       }
-    }
+    );
 
-    sf_data.collections = await collect(
-      sf_data.collections, 'collections',
-      c => c?.active || c?.active===undefined
-      )
-    sf_data.shipping_methods = await collect(
-      sf_data.shipping_methods, 'shipping_methods',
-      c => c?.active || c?.active===undefined
-      )
-    sf_data.posts = await collect(
-      sf_data.posts, 'posts'
-      )
-    sf_data.discounts = await collect(
-      sf_data.discounts, 'discounts', 
-      dis => dis.application.id===DiscountApplicationEnum.Auto.id && dis.enabled
-      )
-
-    try {
-      // Upload to bucket
-      const [url, ref] = await this.context.storage.uploadBytes(
-        `storefronts/${sf_data.handle}.json`, 
-        pako.gzip(JSON.stringify(sf_data)), 
-        {
-          contentType: 'application/json',
-          contentEncoding: 'gzip',
-          // cacheControl: `no-cache`
-          cacheControl: `public, max-age=${60*60*1}, must-revalidate`
-        }
-      )
-      await this.update(
-        sf_data.handle, 
-        { _published: url }
-      )
-
-      // console.log(url, ref);
-    } catch(e) {
-      throw 'Upload export error: ' + String(e)
-    }
-
-    console.log('sf_data ', sf_data);
+    return result
   }
 
 }

package/src/tags.js

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

package/src/templates.js

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

package/src/utils.api.fetch.js

@@ -1,7 +1,7 @@
 
 import { 
   api_query_to_searchparams 
-} from '@storecraft/core/v-api/utils.query.js';
+} from '@storecraft/core/api/utils.query.js';
 import { assert } from './utils.functional.js';
 
 
@@ -21,6 +21,7 @@ export const url = (config, path) => {
 
 
 /**
+ * @description 
  * - Prepends `backend` endpoint. 
  * - Fetches with `authentication` middleware. 
  * - Refreshed `auth` if needed. 
@@ -61,6 +62,7 @@ export const fetchOnlyApiResponseWithAuth = async (sdk, path, init={}) => {
 
 
 /**
+ * @description 
  * - Prepends `backend` endpoint. 
  * - Fetches with `authentication` middleware. 
  * - Refreshed `auth` if needed. 
@@ -74,7 +76,7 @@ export const fetchOnlyApiResponseWithAuth = async (sdk, path, init={}) => {
  * @param {RequestInit} [init] request `init` type
  * 
  * 
- * @throws {import('@storecraft/core/v-api').error}
+ * @throws {import('@storecraft/core/api').error}
  * 
  * @returns {Promise<R>}
  */ 
@@ -181,7 +183,7 @@ export async function remove(sdk, resource, handle_or_id) {
  * 
  * @param {import('../index.js').StorecraftSDK} sdk
  * @param {string} resource base path of resource
- * @param {import('@storecraft/core/v-api').ApiQuery} [query] 
+ * @param {import('@storecraft/core/api').ApiQuery} [query] 
  * 
  * 
  * @returns {Promise<G[]>}
@@ -201,8 +203,7 @@ export async function list(sdk, resource, query={}) {
 
 
 /**
- * A simple resource base `class` with `CRUD` helpers
- * 
+ * @description A simple resource base `class` with `CRUD` helpers
  * 
  * @template {any} U upsert type
  * @template {any} G get type
@@ -261,7 +262,7 @@ export class collection_base {
 
   /**
    * 
-   * @param {import('@storecraft/core/v-api').ApiQuery} query Query object
+   * @param {import('@storecraft/core/api').ApiQuery} query Query object
    * 
    * 
    * @returns {Promise<G[]>}

package/types.d.ts

@@ -1 +1 @@
-export * from './index.js'
+export * from './index.js';

package/src/bots.js

@@ -1,113 +0,0 @@
-import { StorecraftSDK } from '../index.js'
-
-export const SECOND = 1000
-export const MINUTE = SECOND*60
-
-
-/**
- * @typedef {object} BotMetaData
- * @property {number} updatedAt
- * 
- */
-
-const NAME = 'bots'
-
-export default class Bots {
-
-  /**
-   * @param {StorecraftSDK} context 
-   */
-  constructor(context) {
-    this.context = context
-    this.db = context.db
-  }
-
-  init = async () => {
-    // this.activitySpy()
-    this.activityBot()
-    setInterval(
-      this.activityBot,
-      MINUTE*10
-    )
-  }
-
-  activityBot = async () => {
-    // console.trace()
-    try {
-      const db = this.db.firebaseDB
-      const result = await runTransaction(
-        this.db.firebaseDB,
-        async t => {
-          const now = Date.now()
-          const ref = doc(db, NAME, 'shelf-activity-bot')
-          const m = await t.get(ref)
-          const updatedAt = m.data()?.updatedAt ?? 0
-  
-          const q = {
-            where: [
-              ['updatedAt', '>', updatedAt]
-            ]
-          }
-  
-          const cols = ['collections', 'products', 'users', 'tags', 'discounts']
-          const results = cols.map(
-            async c => [c, await this.db.col(c).count(q)]
-          )
-          
-          t.set(
-            m.ref,
-            {
-              updatedAt: now
-            }
-          )
-  
-          return await Promise.all(results)
-    
-        }, 
-        {
-          maxAttempts: 1
-        }
-      )
-
-      let filtered = result.filter(
-        it => it[1]
-      )
-
-      if(filtered.length==0)
-        return
-
-      const search = filtered.map(it => it[0])
-      const messages = filtered.map(
-        it => {
-          const [c, count] = it
-          return `\n* 🚀 **${count}** \`${c}\` were updated`
-        }
-      );
-
-      const message = ["**Latest Activity updates**", ...messages].join(' ')
-      /**@type {NotificationData} */
-      const noti = {
-        message,
-        search,
-        author: 'shelf-activity-bot 🤖',
-        updatedAt: Date.now()
-      }
-
-      // console.log(messages)
-      // console.log(message)
-
-      await this.context.notifications.add(
-        noti
-      )
-
-    } catch (e) {
-      // failed because another the document updated from another client
-      // this is ok
-      console.log(e)
-    }
-    
-
-
-  }
-  
-}