merchi_sdk_ts 1.0.69 → 1.0.71

package/README.md

@@ -1,22 +1,217 @@
-# merchi_cart
-Merchi's cart
+# Merchi TypeScript SDK
 
+A TypeScript SDK for interacting with the Merchi API.
+
+[![npm version](https://img.shields.io/npm/v/merchi_sdk_ts.svg)](https://www.npmjs.com/package/merchi_sdk_ts)
+[![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
 ## Table of Contents
 
 - [Installation](#installation)
-- [Usage](#usage)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+- [Authentication](#authentication)
+- [Basic Usage](#basic-usage)
+  - [Entity Operations](#entity-operations)
+  - [Embedding Related Entities](#embedding-related-entities)
+- [Available Entities](#available-entities)
+- [Examples](#examples)
+- [TypeScript Support](#typescript-support)
+- [License](#license)
 
 ## Installation
 
 ```bash
+# Using npm
 npm install merchi_sdk_ts
 
-or
-
+# Using yarn
 yarn add merchi_sdk_ts
 ```
 
-### Usage
-  The sdk by default is set up to make request to the Merchi production server 'https://api.merchi.co/'.
-  You can set the API URI by setting `process.env.MERCHI_BACKEND_URI` in your environment or `window.merchiBackendUri` on the client.
+## Quick Start
+
+```typescript
+import { Merchi, Product } from 'merchi_sdk_ts';
+
+// Initialize the SDK
+const merchi = new Merchi();
+
+// Fetch a product by ID
+Product.get(123).then(product => {
+  console.log(product.name);
+});
+```
+
+## Configuration
+
+The SDK by default is set up to make requests to the Merchi production server at `https://api.merchi.co/`.
+
+You can customize the API endpoint by setting:
+- `process.env.MERCHI_BACKEND_URI` in your Node.js environment
+- `window.merchiBackendUri` in the browser
+
+## Authentication
+
+The SDK supports several authentication methods:
+
+```typescript
+// Session token authentication (most common)
+const merchi = new Merchi('your-session-token');
+
+// Alternative methods
+const merchi = new Merchi(
+  'your-session-token',     // Session token
+  'your-client-token',      // Client token
+  'your-invoice-token',     // Invoice token
+  'your-cart-token'         // Cart token
+);
+
+// The SDK will also attempt to read session_token from cookies
+// if no token is provided
+```
+
+## Basic Usage
+
+### Entity Operations
+
+Each entity supports standard CRUD operations:
+
+```typescript
+// Fetch a single entity
+Product.get(123).then(product => {
+  console.log(product);
+});
+
+// List entities with filtering
+Product.list({
+  limit: 10,
+  offset: 0,
+  q: 'search-term'
+}).then(response => {
+  console.log(response.items);        // Array of products
+  console.log(response.metadata);     // Metadata including count, limit, offset
+});
+
+// Create a new entity
+const product = new Product();
+product.name = 'New Product';
+product.description = 'Product description';
+product.create().then(newProduct => {
+  console.log(newProduct.id);
+});
+
+// Update an entity
+product.name = 'Updated Product Name';
+product.save().then(updatedProduct => {
+  console.log(updatedProduct);
+});
+
+// Delete an entity
+product.delete().then(() => {
+  console.log('Product deleted');
+});
+```
+
+### Embedding Related Entities
+
+You can request related entities be included in responses:
+
+```typescript
+Product.get(123, {
+  embed: {
+    domain: {},
+    variations: {
+      variationFields: {}
+    }
+  }
+}).then(product => {
+  console.log(product.domain);            // Domain entity is included
+  console.log(product.variations);        // Variations are included
+  console.log(product.variations[0].variationFields);  // Fields are included
+});
+```
+
+## Available Entities
+
+The SDK provides access to all Merchi entities, including but not limited to:
+
+- User, Company, Domain
+- Product, Category, Variation
+- Cart, CartItem
+- Job, Assignment, Invoice
+- File, Draft, DraftTemplate
+- Payment, Shipment
+- And many more...
+
+Each entity maps directly to the corresponding API endpoint and data structure.
+
+## Examples
+
+### Working with Products
+
+```typescript
+import { Merchi, Product } from 'merchi_sdk_ts';
+
+// Initialize Merchi
+const merchi = new Merchi('your-session-token');
+
+// Create a new product
+const product = new Product();
+product.name = 'Custom T-Shirt';
+product.description = 'High-quality custom printed t-shirt';
+product.public = true;
+
+product.create().then(newProduct => {
+  console.log(`Created product with ID: ${newProduct.id}`);
+});
+```
+
+### Managing a Cart
+
+```typescript
+import { Merchi, Cart, CartItem } from 'merchi_sdk_ts';
+
+// Initialize Merchi
+const merchi = new Merchi('your-session-token');
+
+// Create a new cart
+const cart = new Cart();
+cart.create().then(newCart => {
+  // Add an item to the cart
+  const cartItem = new CartItem();
+  cartItem.productId = 123;
+  cartItem.quantity = 2;
+  cartItem.cartId = newCart.id;
+  
+  return cartItem.create();
+}).then(newCartItem => {
+  console.log('Item added to cart!');
+});
+```
+
+## TypeScript Support
+
+This SDK is built with TypeScript and provides full type definitions for all entities and operations.
+
+```typescript
+import { Product, EmbedDescriptor } from 'merchi_sdk_ts';
+
+// TypeScript will provide intellisense for all properties
+const product = new Product();
+product.name = 'New Product';
+
+// Type checking for embed options
+const embedOptions: EmbedDescriptor = {
+  domain: {},
+  variations: {
+    variationFields: {}
+  }
+};
+
+Product.get(123, { embed: embedOptions });
+```
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.

package/dist/entities/cart_item.js

@@ -116,6 +116,10 @@ var CartItem = /** @class */ (function (_super) {
         CartItem.property({ arrayType: 'DomainTag' }),
         __metadata("design:type", Array)
     ], CartItem.prototype, "tags", void 0);
+    __decorate([
+        CartItem.property({ arrayType: 'Draft' }),
+        __metadata("design:type", Array)
+    ], CartItem.prototype, "ownDrafts", void 0);
     return CartItem;
 }(Entity));
 export { CartItem };

package/dist/entities/product.js

@@ -550,6 +550,10 @@ var Product = /** @class */ (function (_super) {
         Product.property({ arrayType: 'DraftTemplate' }),
         __metadata("design:type", Array)
     ], Product.prototype, "draftTemplates", void 0);
+    __decorate([
+        Product.property({ arrayType: 'DraftPreview' }),
+        __metadata("design:type", Array)
+    ], Product.prototype, "draftPreviews", void 0);
     return Product;
 }(Entity));
 export { Product };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merchi_sdk_ts",
-  "version": "1.0.69",
+  "version": "1.0.71",
   "main": "dist/index.js",
   "type": "module",
   "repository": "git@github.com:merchisdk/merchi_sdk_ts.git",

package/src/entities/cart_item.ts

@@ -6,6 +6,7 @@ import { RequestOptions } from '../request.js';
 import { Variation } from './variation.js';
 import { VariationsGroup } from './variations_group.js';
 import { DomainTag } from './domain_tag.js';
+import { Draft } from './draft.js';
 
 export class CartItem extends Entity {
   protected static resourceName = 'cart_items';
@@ -57,6 +58,9 @@ export class CartItem extends Entity {
   @CartItem.property({arrayType: 'DomainTag'})
   public tags?: DomainTag[];
 
+  @CartItem.property({arrayType: 'Draft'})
+  public ownDrafts?: Draft[];
+
   public requiresShipment = () => {
     if (this.product === undefined) {
       throw 'product is undefined, did you forget to embed it?';

package/src/entities/product.ts

@@ -7,6 +7,7 @@ import { CountryTax } from './country_tax.js';
 import { DiscountGroup } from './discount_group.js';
 import { Domain } from './domain.js';
 import { DomainTag } from './domain_tag.js';
+import { DraftPreview } from './draft_preview.js';
 import { DraftTemplate } from './draft_template.js';
 import { Entity } from '../entity.js';
 import { MerchiFile } from './file.js';
@@ -310,6 +311,9 @@ export class Product extends Entity {
   @Product.property({arrayType: 'DraftTemplate'})
   public draftTemplates?: DraftTemplate[];
 
+  @Product.property({arrayType: 'DraftPreview'})
+  public draftPreviews?: DraftPreview[];
+
   public duplicate = () => {
     /* create a clone of this product on the backend, returning it. */
     const constructor = this.constructor as typeof Product;