@storecraft/sdk 0.1.0 → 1.0.2

package/README.md

@@ -1,5 +1,10 @@
 # **Storecraft** Official Universal `Javascript` **SDK**
 
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
 This is the official `storecraft` universal javascript `SDK` which is `fetch` based,
 which means you can you it both at browser and at backend runtimes such (`node` / `bun` / `deno`)
 
@@ -9,6 +14,9 @@ convenient manner with `javascript`, such as:
 `storage`, `storefronts`, `shipping`, `statistics`, `tags`, `posts`, `notifications`,
 `templates`, `extensions` and more :)
 
+```bash
+npm i @storecraft/sdk
+```
 
 ## Authentication
 

package/index.js

@@ -11,16 +11,16 @@ import StoreFronts from './src/storefronts.js'
 import Statistics from './src/statistics.js'
 import Images from './src/images.js'
 import Posts from './src/posts.js'
+import Checkout from './src/checkout.js'
 import Payments from './src/payments.js'
 import Settings from './src/settings.js'
 import Notifications from './src/notifications.js'
-import Bots from './src/bots.js'
 import Storage from './src/storage.js'
 
 
 /**
- * @typedef {import('@storecraft/core/v-api').ApiAuthResult |
- *  import('@storecraft/core/v-api').ApiKeyResult
+ * @typedef {import('@storecraft/core/api').ApiAuthResult |
+ *  import('@storecraft/core/api').ApiKeyResult
  * } SdkConfigAuth The `storecraft` **SDK** `auth` config, represents
  * either `apikey` or `jwt` authentication
  * 
@@ -36,7 +36,7 @@ import Storage from './src/storage.js'
  */
 
 /**
- * The official `storecraft` admin **SDK** for `javascript`
+ * @description The official `storecraft` universal **SDK** for `javascript`
  */
 export class StorecraftSDK {
 
@@ -65,9 +65,9 @@ export class StorecraftSDK {
     this.images = new Images(this);
     this.posts = new Posts(this);
     this.payments = new Payments(this);
+    this.checkout = new Checkout(this);
     this.settings = new Settings(this);
     this.notifications = new Notifications(this);
-    this.bots = new Bots(this);
   }
 
   /**

package/{tsconfig.json → jsconfig.json}

@@ -1,10 +1,6 @@
 {
-  "compileOnSave": false,
   "compilerOptions": {
-    "noEmit": true,
-    "allowJs": true,
     "checkJs": true,
-    "resolveJsonModule": true,
     "target": "ESNext",
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
@@ -21,7 +17,8 @@
   },
   "include": [
     "*",
-    "**/*"
+    "**/*",
+    "src/*.js",
   ],
   "exclude": [
     "**/*.json"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/sdk",
-  "version": "0.1.0",
+  "version": "1.0.2",
   "description": "Official storecraft Universal Javascript SDK",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -18,7 +18,8 @@
   ],
   "scripts": {
     "sdk:test": "echo \"Error: no test specified\" && exit 1",
-    "sdk:publish": "npm publish --access public"
+    "test": "npm run sdk:test",
+    "prepublishOnly": "npm version patch --force"
   },
   "type": "module",
   "types": "./types.d.ts",

package/src/auth.js

@@ -1,4 +1,4 @@
-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';
 import { StorecraftSDK } from '../index.js';
 import { fetchApiWithAuth, url } from './utils.api.fetch.js';
 import { assert } from './utils.functional.js';
@@ -21,7 +21,7 @@ import { assert } from './utils.functional.js';
   
   
 /**
- * `Storecraft` authentication module:
+ * @description `Storecraft` authentication module:
  * - Supports `subscribtion` to `auth` events
  * 
  */
@@ -43,7 +43,7 @@ export default class Auth {
 
   /**
    * 
-   * Get the current `auth` config, which is one of:
+   * @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:
@@ -77,7 +77,7 @@ export default class Auth {
 
   /**
    * 
-   * Get a working token, by the following strategy:
+   * @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
@@ -106,7 +106,7 @@ export default class Auth {
 
   /**
    * 
-   * Perform re-authentication for `JWT` auth, which means:
+   * @description Perform re-authentication for `JWT` auth, which means:
    * 
    * - use the `refresh_token` to gain a new `access_token`
    * 
@@ -136,7 +136,7 @@ export default class Auth {
         }
       );
 
-      /** @type {import('@storecraft/core/v-api').ApiAuthResult} */
+      /** @type {import('@storecraft/core/api').ApiAuthResult} */
       let payload = undefined;
 
       if(auth_res.ok) {
@@ -203,7 +203,7 @@ export default class Auth {
 
   /**
    * 
-   * @param {import('@storecraft/core/v-api').ApiAuthResult} user 
+   * @param {import('@storecraft/core/api').ApiAuthResult} user 
    */
   #_update_and_notify_subscribers = (user) => {
     this.currentAuth = user
@@ -217,12 +217,12 @@ export default class Auth {
    * @param {string} password 
    * 
    * 
-   * @returns {Promise<import('@storecraft/core/v-api').ApiAuthResult>}
+   * @returns {Promise<import('@storecraft/core/api').ApiAuthResult>}
    */
   signin = async (email, password) => {
     // console.log('ep ', email, password)
 
-    /** @type {import('@storecraft/core/v-api').ApiAuthSigninType} */
+    /** @type {import('@storecraft/core/api').ApiAuthSigninType} */
     const info = {
       email, password
     }
@@ -238,9 +238,26 @@ export default class Auth {
       }
     );
     
-    assert(res.ok, 'auth/error');
+    if(!res.ok) {
+      /** @type {import('@storecraft/core/api').error} */
+      let error_payload = {
+        messages: [
+          {
+            message: 'auth/error'
+          }
+        ]
+      };
+
+      try {
+        error_payload = await res.json();
+      } catch (e) {
+      }
+
+      throw error_payload;
+    }    
+    // assert(res.ok, 'auth/error2');
 
-    /** @type {import('@storecraft/core/v-api').ApiAuthResult} */
+    /** @type {import('@storecraft/core/api').ApiAuthResult} */
     const payload = await res.json();
 
     // console.log('auth_result', payload)
@@ -257,11 +274,14 @@ export default class Auth {
    * 
    * @param {string} email 
    * @param {string} password 
+   * @param {string} [firstname] 
+   * @param {string} [lastname] 
    */
-  signup = async (email, password) => {
-    /** @type {import('@storecraft/core/v-api').ApiAuthSignupType} */
+  signup = async (email, password, firstname, lastname) => {
+    /** @type {import('@storecraft/core/api').ApiAuthSignupType} */
     const info = {
-      email, password
+      email, password,
+      firstname, lastname
     }
 
     const res = await fetch(
@@ -277,7 +297,7 @@ export default class Auth {
     
     assert(res.ok, 'auth/error');
 
-    /** @type {import('@storecraft/core/v-api').ApiAuthResult} */
+    /** @type {import('@storecraft/core/api').ApiAuthResult} */
     const payload = await res.json();
 
     this.#_update_and_notify_subscribers(
@@ -288,6 +308,54 @@ export default class Auth {
   }
 
 
+  /**
+   * 
+   * @param {import('@storecraft/core/api').ApiAuthChangePasswordType} params 
+   */
+  
+  changePassword = async (params) => {
+
+    const res = await fetch(
+      url(this.#sdk.config, `/auth/change-password`),
+      { 
+        method: 'post',
+        body: JSON.stringify(params),
+        headers: {
+          'Content-Type' : 'application/json'
+        }
+      }
+    );
+    
+    if(!res.ok) {
+      /** @type {import('@storecraft/core/api').error} */
+      let error_payload = {
+        messages: [
+          {
+            message: 'auth/error'
+          }
+        ]
+      };
+
+      try {
+        error_payload = await res.json();
+      } catch (e) {
+      }
+
+      throw error_payload;
+    }
+
+    /** @type {import('@storecraft/core/api').ApiAuthResult} */
+    const payload = await res.json();
+
+    this.#_update_and_notify_subscribers(
+      payload
+    );
+
+    return payload;
+  }
+
+
+
   signout = async () => {
     console.log('signout');
 
@@ -299,7 +367,7 @@ export default class Auth {
 
 
   create_api_key = async () => {
-    /** @type {import('@storecraft/core/v-api').ApiKeyResult} */
+    /** @type {import('@storecraft/core/api').ApiKeyResult} */
     const item = await fetchApiWithAuth(
       this.#sdk,
       '/auth/apikeys',
@@ -318,7 +386,7 @@ export default class Auth {
    * @param {string} email_or_id
    */
   get_auth_user = async (email_or_id) => {
-    /** @type {import('@storecraft/core/v-api').AuthUserType} */
+    /** @type {import('@storecraft/core/api').AuthUserType} */
     const item = await fetchApiWithAuth(
       this.#sdk,
       `/auth/users/${email_or_id}`,
@@ -349,7 +417,7 @@ export default class Auth {
   /**
    * 
    * 
-   * @param {import('@storecraft/core/v-api').ApiQuery} query
+   * @param {import('@storecraft/core/api').ApiQuery} query
    * 
    */
   list_auth_users = async (query) => {
@@ -367,7 +435,7 @@ export default class Auth {
 
   list_api_keys_auth_users = async () => {
 
-    /** @type {import('@storecraft/core/v-api').AuthUserType[]} */
+    /** @type {import('@storecraft/core/api').AuthUserType[]} */
     const items = await fetchApiWithAuth(
       this.#sdk,
       '/auth/apikeys',

package/src/checkout.js

@@ -0,0 +1,88 @@
+import { StorecraftSDK } from '../index.js'
+import { fetchApiWithAuth } from './utils.api.fetch.js';
+
+/**
+ * @description Base `checkout` **api**
+ * 
+ */
+export default class Checkout {
+
+  /**
+   * 
+   * @param {StorecraftSDK} sdk 
+   */
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * @description Create a `checkout`
+   * 
+   * @param {import('@storecraft/core/api').CheckoutCreateType} input 
+   * @param {string} gateway_handle 
+   * 
+   * @returns {Promise<Partial<import('@storecraft/core/api').OrderData>>}
+   */
+  create = async (input, gateway_handle) => {
+
+    console.log('input', input)
+    const result = await fetchApiWithAuth(
+      this.sdk,
+      `checkout/create?gateway=${gateway_handle}`,
+      {
+        method: 'post',
+        body: JSON.stringify(input),
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      }
+    );
+
+    return result
+  }
+
+  /**
+   * @description Complete a `checkout`
+   * 
+   * @param {string} order_id 
+   * 
+   * @returns {Promise<Partial<import('@storecraft/core/api').OrderData>>}
+   */
+  complete = async (order_id) => {
+
+    const result = await fetchApiWithAuth(
+      this.sdk,
+      `checkout/${order_id}/complete`,
+      {
+        method: 'post',
+      }
+    );
+
+    return result
+  }
+
+  /**
+   * @description calculate the pricing of an `order`. Using auto-discounts, coupons, shipping and line-items.
+   * 
+   * @param {Partial<import('@storecraft/core/api').OrderData>} order 
+   * 
+   * @returns {Promise<Partial<import('@storecraft/core/api').PricingData>>}
+   */
+  pricing = async (order) => {
+
+    const result = await fetchApiWithAuth(
+      this.sdk,
+      `checkout/pricing`,
+      {
+        method: 'post',
+        body: JSON.stringify(order),
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      }
+    );
+
+    return result
+  }
+
+}

package/src/collections.js

@@ -1,13 +1,13 @@
 import { StorecraftSDK } from '../index.js'
-import { collection_base } from './utils.api.fetch.js';
+import { collection_base, fetchApiWithAuth } from './utils.api.fetch.js';
 import { filter_fields, filter_unused } from './utils.functional.js';
 
 /**
- * Base `collections` **CRUD**
+ * @description Base `collections` **CRUD**
  * 
  * @extends {collection_base<
- *  import('@storecraft/core/v-api').CollectionTypeUpsert, 
- *  import('@storecraft/core/v-api').CollectionType>
+ *  import('@storecraft/core/api').CollectionTypeUpsert, 
+ *  import('@storecraft/core/api').CollectionType>
  * }
  */
 export default class Collections extends collection_base {
@@ -21,79 +21,24 @@ 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) => {
-    throw new Error('Implement me !!!')
-    // extra filtering for validation
 
-    try {
-      // fetch collection
-      var [exists, id, collection] = await this.get(collection_handle)
-    } catch (e) {
-      throw 'Collection read error: ' + String(e)
-    }
-
-    // get all products in collection
-    try {
-      var pick_data = items => items.map(item => item[1])
-      /** @param {ProductData[]} items */
-      var filter_hard_on_collection = items => items.filter(
-        item => (
-          item.collections && 
-          item.collections.indexOf(collection_handle)>=0 && 
-          item.qty>0 && 
-          (item.active || item.active===undefined) &&
-          (!item.parent_handle)
-        )
-      )
-      const filter_fields_in = filter_fields(
-        'title', 'handle', 'media', 'desc', 'price', 'attributes', 
-        'video', 'tags', 'updatedAt', 'compareAtPrice', 'discounts',
-        'parent_handle', 'variants_options', 'variants_products'
-        )
-      var products = await this.context.products.list(
-        [`col:${collection_handle}`], limit
-        )
-      // console.log('products', products)
-      products = pick_data(products)
-      products = filter_hard_on_collection(products)
-      products = filter_fields_in(products)
-      products = filter_unused(products)
-    } catch (e) {
-      throw 'products read error: ' + String(e)
-    }
-
-    try {
-      // upload collection export
-      const metadata = {
-        contentType: 'application/json',
-        contentEncoding: 'gzip',
-        cacheControl: `max-age=${60*60*1}, must-revalidate`
-        // cacheControl: `private, max-age=${60*60*1}`
-        // cacheControl: `max-age=${60*60*5}, must-revalidate`
+    const result = await fetchApiWithAuth(
+      this.sdk,
+      `collections/${collection_handle}/export`,
+      {
+        method: 'post'
       }
-      var [url, ref] = await this.context.storage.uploadBytes(
-        `collections/${collection_handle}.json`, 
-        pako.gzip(
-          JSON.stringify({ 
-            ...collection, 
-            products 
-          })
-        ), 
-        metadata
-      )
-    } catch(e) {
-      throw 'Collection upload error: ' + String(e)
-    }
+    );
 
-    try {
-      await this.update(collection_handle, { _published: url })
-    } catch (e) {
-      throw 'Collection update error: ' + String(e)
-    }
+    return result
   }
 
   // /**

package/src/customers.js

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