lightspeed-retail-sdk 3.2.1 → 3.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/README.md +4 -3
  2. package/dist/index.cjs +71 -1852
  3. package/dist/index.mjs +70 -2189
  4. package/dist/src/core/LightspeedSDK.cjs +111 -6
  5. package/dist/src/core/LightspeedSDK.mjs +111 -3
  6. package/dist/src/endpoints/account.js +32 -0
  7. package/dist/src/endpoints/category.js +73 -0
  8. package/dist/src/endpoints/customer.js +96 -0
  9. package/dist/src/endpoints/customertype.js +44 -0
  10. package/dist/src/endpoints/employee.js +105 -0
  11. package/dist/src/endpoints/giftcard.js +60 -0
  12. package/dist/src/endpoints/image.js +113 -0
  13. package/dist/src/endpoints/item.js +134 -0
  14. package/dist/src/endpoints/itemattribute.js +43 -0
  15. package/dist/src/endpoints/manufacturer.js +77 -0
  16. package/dist/src/endpoints/matrix.js +77 -0
  17. package/dist/src/endpoints/order.js +77 -0
  18. package/dist/src/endpoints/paymenttype.js +27 -0
  19. package/dist/src/endpoints/register.js +27 -0
  20. package/dist/src/endpoints/sale.js +134 -0
  21. package/dist/src/endpoints/saleline.js +62 -0
  22. package/dist/src/endpoints/specialorder.js +27 -0
  23. package/dist/src/endpoints/taxclass.js +27 -0
  24. package/dist/src/endpoints/vendor.js +77 -0
  25. package/package.json +4 -2
package/README.md CHANGED
@@ -2,10 +2,11 @@
2
2
 
3
3
  A modern JavaScript SDK for interacting with the Lightspeed Retail API. This SDK provides a convenient, secure, and flexible way to access Lightspeed Retail's features—including customer, item, and order management.
4
4
 
5
- **Current Version: 3.2.1** — Now with secure encrypted token storage using Node.js crypto. Useful CLI tools, database tools & email warnings on auth failure.
5
+ **Current Version: 3.3.0** — Refactor: extract endpoints for maintainability and improve endpoint testing. Enhanced query param encoding and pagination logic for consistency.
6
6
 
7
- ## **🆕 Recent Updates (v3.2.0)**
7
+ ## **🆕 Recent Updates (v3.3.0)**
8
8
 
9
+ - **Add centralized query param builder for API requests**: Add centralized query param builder for API requests. Supports input as object, string, or array, and manages relations/load_relations. Ensures no double-encoding of parameters and handles special cases for 'or' and 'timeStamp'.
9
10
  - **🎯 Enhanced Parameter Support**: All main getter methods now support both legacy and new object-based parameters with full backward compatibility
10
11
  - **🔄 Flexible Method Signatures**: New object-based parameters support `{ relations, limit, timeStamp, sort }` for all collection methods
11
12
  - **⚡ Improved Performance**: Smart pagination with single-page requests when `limit` is specified
@@ -65,7 +66,7 @@ const items = await sdk.getItems({
65
66
  ## Table of Contents
66
67
 
67
68
  - [Another Unofficial Lightspeed Retail V3 API SDK](#another-unofficial-lightspeed-retail-v3-api-sdk)
68
- - [**🆕 Recent Updates (v3.2.0)**](#-recent-updates-v320)
69
+ - [**🆕 Recent Updates (v3.3.0)**](#-recent-updates-v330)
69
70
  - [🚀 Key Features](#-key-features)
70
71
  - [🔄 Migrating from 3.1.x](#-migrating-from-31x)
71
72
  - [Backward Compatibility](#backward-compatibility)