@storecraft/sdk 1.0.8 → 1.0.9

package/README.md

@@ -14,6 +14,8 @@ convenient manner with `javascript`, such as:
 `storage`, `storefronts`, `shipping`, `statistics`, `tags`, `posts`, `notifications`,
 `templates`, `extensions` and more :)
 
+Plus, everything is typed so you dont have to guess any parameter or queryable key
+
 ```bash
 npm i @storecraft/sdk
 ```
@@ -111,10 +113,14 @@ const auth_result = await sdk.auth.signout();
 ## Querying
 
 
-Here are some examples for querying
+Here are some examples for querying.
 
+- Every key and string in the example below is fully typed with `typescript`,
+- so you get **intellisense** out of the box for better developer experience
+- And, you don't have to guess anything
 
-```js
+
+```ts
 import { StorecraftSDK } from '@storecraft/sdk'
 
 const sdk = new StorecraftSDK();
@@ -122,10 +128,10 @@ const sdk = new StorecraftSDK();
 const products: ProductType[] = await sdk.products.list(
   {
     expand: ['collections', 'variants'],
-    sortBy: ['updated_at', 'id'],
+    sortBy: ['updated_at', 'id'], // all keys will show up in intellisense
     order: 'desc',
     startAt: [
-      ['updated_at': '2024-03-24']
+      ['updated_at': '2024-03-24'],
     ],
     limit: 5,
     vql: '(keyword1 | keyword2) -(keyword3)'
@@ -134,6 +140,21 @@ const products: ProductType[] = await sdk.products.list(
 
 ```
 
+Or, 
+
+```ts
+import { StorecraftSDK } from '@storecraft/sdk'
+
+const sdk = new StorecraftSDK();
+
+const collections: CollectionType[] = await sdk.collections.list(
+  {
+    equals: [['active': true]]
+    limit: 5,
+  }
+);
+
+```
 
 ```text
 Author: Tomer Shalev (tomer.shalev@gmail.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storecraft/sdk",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Official storecraft Universal Javascript SDK",
   "license": "MIT",
   "author": "Tomer Shalev (https://github.com/store-craft)",
@@ -19,6 +19,7 @@
   "scripts": {
     "sdk:test": "echo \"Error: no test specified\" && exit 1",
     "test": "npm run sdk:test",
+    "sc-publish": "npm publish",
     "prepublishOnly": "npm version patch --force"
   },
   "type": "module",

package/src/auth.js

@@ -1,3 +1,10 @@
+/**
+ * @import {
+ *  ApiAuthChangePasswordType, ApiAuthResult, ApiAuthSigninType, ApiAuthSignupType, 
+ *  ApiKeyResult, ApiQuery, AuthUserType, error
+ * } from '@storecraft/core/api'
+ */
+
 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';
@@ -136,7 +143,7 @@ export default class Auth {
         }
       );
 
-      /** @type {import('@storecraft/core/api').ApiAuthResult} */
+      /** @type {ApiAuthResult} */
       let payload = undefined;
 
       if(auth_res.ok) {
@@ -203,7 +210,7 @@ export default class Auth {
 
   /**
    * 
-   * @param {import('@storecraft/core/api').ApiAuthResult} user 
+   * @param {ApiAuthResult} user 
    */
   #_update_and_notify_subscribers = (user) => {
     this.currentAuth = user
@@ -217,12 +224,12 @@ export default class Auth {
    * @param {string} password 
    * 
    * 
-   * @returns {Promise<import('@storecraft/core/api').ApiAuthResult>}
+   * @returns {Promise<ApiAuthResult>}
    */
   signin = async (email, password) => {
     // console.log('ep ', email, password)
 
-    /** @type {import('@storecraft/core/api').ApiAuthSigninType} */
+    /** @type {ApiAuthSigninType} */
     const info = {
       email, password
     }
@@ -239,7 +246,7 @@ export default class Auth {
     );
     
     if(!res.ok) {
-      /** @type {import('@storecraft/core/api').error} */
+      /** @type {error} */
       let error_payload = {
         messages: [
           {
@@ -257,7 +264,7 @@ export default class Auth {
     }    
     // assert(res.ok, 'auth/error2');
 
-    /** @type {import('@storecraft/core/api').ApiAuthResult} */
+    /** @type {ApiAuthResult} */
     const payload = await res.json();
 
     // console.log('auth_result', payload)
@@ -278,7 +285,7 @@ export default class Auth {
    * @param {string} [lastname] 
    */
   signup = async (email, password, firstname, lastname) => {
-    /** @type {import('@storecraft/core/api').ApiAuthSignupType} */
+    /** @type {ApiAuthSignupType} */
     const info = {
       email, password,
       firstname, lastname
@@ -297,7 +304,7 @@ export default class Auth {
     
     assert(res.ok, 'auth/error');
 
-    /** @type {import('@storecraft/core/api').ApiAuthResult} */
+    /** @type {ApiAuthResult} */
     const payload = await res.json();
 
     this.#_update_and_notify_subscribers(
@@ -310,7 +317,7 @@ export default class Auth {
 
   /**
    * 
-   * @param {import('@storecraft/core/api').ApiAuthChangePasswordType} params 
+   * @param {ApiAuthChangePasswordType} params 
    */
   
   changePassword = async (params) => {
@@ -327,7 +334,7 @@ export default class Auth {
     );
     
     if(!res.ok) {
-      /** @type {import('@storecraft/core/api').error} */
+      /** @type {error} */
       let error_payload = {
         messages: [
           {
@@ -344,7 +351,7 @@ export default class Auth {
       throw error_payload;
     }
 
-    /** @type {import('@storecraft/core/api').ApiAuthResult} */
+    /** @type {ApiAuthResult} */
     const payload = await res.json();
 
     this.#_update_and_notify_subscribers(
@@ -367,7 +374,7 @@ export default class Auth {
 
 
   create_api_key = async () => {
-    /** @type {import('@storecraft/core/api').ApiKeyResult} */
+    /** @type {ApiKeyResult} */
     const item = await fetchApiWithAuth(
       this.#sdk,
       '/auth/apikeys',
@@ -386,7 +393,7 @@ export default class Auth {
    * @param {string} email_or_id
    */
   get_auth_user = async (email_or_id) => {
-    /** @type {import('@storecraft/core/api').AuthUserType} */
+    /** @type {AuthUserType} */
     const item = await fetchApiWithAuth(
       this.#sdk,
       `/auth/users/${email_or_id}`,
@@ -417,25 +424,26 @@ export default class Auth {
   /**
    * 
    * 
-   * @param {import('@storecraft/core/api').ApiQuery} query
+   * @param {ApiQuery<AuthUserType>} query
    * 
    */
   list_auth_users = async (query) => {
     const sq = api_query_to_searchparams(query);
-
-    return fetchApiWithAuth(
+    /** @type {AuthUserType[]} */
+    const items = await fetchApiWithAuth(
       this.#sdk,
       `/auth/users?${sq.toString()}`,
       {
         method: 'get'
       }
     );
+    return items;
   }
 
 
   list_api_keys_auth_users = async () => {
 
-    /** @type {import('@storecraft/core/api').AuthUserType[]} */
+    /** @type {AuthUserType[]} */
     const items = await fetchApiWithAuth(
       this.#sdk,
       '/auth/apikeys',

package/src/utils.api.fetch.js

@@ -183,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/api').ApiQuery} [query] 
+ * @param {import('@storecraft/core/api').ApiQuery<G>} [query] 
  * 
  * 
  * @returns {Promise<G[]>}
@@ -262,7 +262,7 @@ export class collection_base {
 
   /**
    * 
-   * @param {import('@storecraft/core/api').ApiQuery} query Query object
+   * @param {import('@storecraft/core/api').ApiQuery<G>} query Query object
    * 
    * 
    * @returns {Promise<G[]>}