@storecraft/sdk 1.0.16 → 1.0.17

package/README.md

@@ -187,6 +187,15 @@ const collections: CollectionType[] = await sdk.collections.list(
 
 ```
 
+## Testing
+
+most of the tests for this package are done in the `storecraft` `core` package,
+as part of the **REST API** tests.
+
+This package will hold more `unit` tests for the `sdk` itself, which include
+side effects and particular behaviours.
+
+
 ```text
 Author: Tomer Shalev (tomer.shalev@gmail.com)
 ```

package/index.js

@@ -16,7 +16,7 @@ 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 Reference from './src/reference.js'
 import Notifications from './src/notifications.js'
 import Storage from './src/storage.js'
 import AI from './src/ai.js'
@@ -27,7 +27,8 @@ import {
 import Email from './src/email.js'
 
 /**
- * @description The official `storecraft` universal **SDK** for `javascript`
+ * @description The official `storecraft` universal 
+ * **SDK** for `javascript`
  */
 export class StorecraftSDK {
 
@@ -64,13 +65,13 @@ export class StorecraftSDK {
     this.posts = new Posts(this);
     this.payments = new Payments(this);
     this.checkout = new Checkout(this);
-    this.settings = new Settings(this);
+    this.reference = new Reference(this);
     this.notifications = new Notifications(this);
     this.emails = new Email(this);
   }
 
   get fetcher() {
-    return this.#fetcher
+    return this.#fetcher;
   }
   
   /**

package/package.json

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

package/src/auth.js

@@ -10,7 +10,7 @@
 
 import { 
   api_query_to_searchparams 
-} from '@storecraft/core/api/utils.query.js';
+} from '@storecraft/core/api/query.js';
 import { StorecraftSDK } from '../index.js';
 import { 
   count_query_of_resource, fetchApiWithAuth, url 

package/src/orders.js

@@ -1,7 +1,7 @@
 /**
  * @import { OrderDataUpsert, OrderData, ApiQuery } from '@storecraft/core/api'
  */
-import { api_query_to_searchparams } from '@storecraft/core/api/utils.query.js';
+import { api_query_to_searchparams } from '@storecraft/core/api/query.js';
 import { StorecraftSDK } from '../index.js'
 import { collection_base, fetchApiWithAuth } from './utils.api.fetch.js';
 

package/src/reference.js

@@ -0,0 +1,46 @@
+/**
+ * @import { StorecraftConfig } from '@storecraft/core'
+ * @import { StorecraftAppPublicInfo } from '@storecraft/core/api'
+ */
+import { StorecraftSDK } from '../index.js'
+import { fetchApiWithAuth } from './utils.api.fetch.js';
+
+/**
+ * @description Reference
+ */
+export default class Reference {
+
+  /**
+   * @param {StorecraftSDK} sdk 
+   */
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * @returns {Promise<StorecraftConfig>}
+   */
+  settings = async () => {
+    /** @type {StorecraftConfig} */
+    const json = await fetchApiWithAuth(
+      this.sdk,
+      'reference/settings',
+      { method: 'get' },
+    );
+    return json;
+  }
+
+  /**
+   * @returns {Promise<StorecraftAppPublicInfo>}
+   */
+  info = async () => {
+    /** @type {StorecraftAppPublicInfo} */
+    const json = await fetchApiWithAuth(
+      this.sdk,
+      'reference/info',
+      { method: 'get' },
+    );
+    return json;
+  }
+
+}

package/src/search.js

@@ -6,10 +6,10 @@
 
 import { 
   api_query_to_searchparams, object_to_search_params, 
-  string_array_to_string 
-} from '@storecraft/core/api/utils.query.js';
+} from '@storecraft/core/api/query.js';
 import { StorecraftSDK } from '../index.js'
 import { fetchApiWithAuth, url } from './utils.api.fetch.js';
+import { string_array_to_string } from '@storecraft/core/api/query.utils.js';
 
 /**
  * @description **Search** API (two options):

package/src/statistics.js

@@ -6,7 +6,7 @@ import { StorecraftSDK } from '../index.js'
 import { fetchApiWithAuth } from './utils.api.fetch.js';
 import { 
   api_query_to_searchparams 
-} from '@storecraft/core/api/utils.query.js';
+} from '@storecraft/core/api/query.js';
 
 /**
  * @description statistics endpoint

package/src/utils.api.fetch.js

@@ -5,7 +5,7 @@
  */
 import { 
   api_query_to_searchparams 
-} from '@storecraft/core/api/utils.query.js';
+} from '@storecraft/core/api/query.js';
 
 
 /**

package/src/settings.js

@@ -1,18 +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, 'reference/settings');
-  }
-
-}