@shopperlabs/shopper-types 1.0.0

package/README.md

@@ -0,0 +1,67 @@
+<p align="center">
+  <img src="https://github.com/shopperlabs/art/blob/main/logomark.svg" alt="Shopper Logo" height="150" />
+</p>
+
+# Shopper Types definitions
+
+TypeScript types derived from the OpenAPI Spec (OAS) to be used in API clients for Laravel Shopper.
+
+## Install
+
+```bash
+npm install @shopper/types
+# or
+yarn add @shopper/types
+```
+
+## Usage
+
+```typescript
+import type { Product, Order, Customer } from '@shopper/types'
+
+const product: Product = {
+  id: 1,
+  name: 'My Product',
+  slug: 'my-product',
+  // ...
+}
+```
+
+## Available Types
+
+### Models
+- `Product`
+- `ProductVariant`
+- `Category`
+- `Brand`
+- `Collection`
+- `Order`
+- `OrderItem`
+- `Customer`
+- `Address`
+- `Inventory`
+- `Discount`
+- `Review`
+- `Channel`
+- `Currency`
+- `PaymentMethod`
+- `Attribute`
+- `AttributeValue`
+- `Media`
+
+### Enums
+- `ProductType`
+- `CollectionType`
+- `CollectionCondition`
+- `AddressType`
+- `GenderType`
+- `Weight`
+- `Length`
+- `Volume`
+
+### Common Interfaces
+- `Entity`
+- `DateEntity`
+- `Price`
+- `ShippingFields`
+- `SEOFields`

package/dist/address.d.ts

@@ -0,0 +1,43 @@
+import type { Entity } from './common';
+import type { Country } from './country';
+export declare enum AddressType {
+    BILLING = "billing",
+    SHIPPING = "shipping"
+}
+/**
+ * The Address interface
+ */
+export interface Address extends Entity {
+    /** The first name of the address. */
+    first_name: string | null;
+    /** The last name of the address. */
+    last_name: string;
+    /** The full name (first_name + last_name). */
+    full_name: string;
+    /** The company name of the address. */
+    company_name: string | null;
+    /** The street address. */
+    street_address: string;
+    /** The additional street address. */
+    street_address_plus?: string | null;
+    /** The postal code. */
+    postal_code: string;
+    /** The city. */
+    city: string;
+    /** The state/province. */
+    state: string | null;
+    /** The phone number. */
+    phone_number?: string | null;
+    /** The type of the customer address. */
+    type: AddressType;
+    /** Whether this is the default shipping address. */
+    shipping_default: boolean;
+    /** Whether this is the default billing address. */
+    billing_default: boolean;
+    /** ID of the user this address belongs to. */
+    user_id: number;
+    /** ID of the country this address belongs to. */
+    country_id: number;
+    /** The country of the address. */
+    country?: Country;
+}

package/dist/address.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddressType = void 0;
+var AddressType;
+(function (AddressType) {
+    AddressType["BILLING"] = "billing";
+    AddressType["SHIPPING"] = "shipping";
+})(AddressType || (exports.AddressType = AddressType = {}));

package/dist/attribute.d.ts

@@ -0,0 +1,51 @@
+import type { Entity } from './common';
+export declare enum FieldType {
+    TEXT = "text",
+    NUMBER = "number",
+    RICH_TEXT = "richtext",
+    SELECT = "select",
+    CHECKBOX = "checkbox",
+    COLOR_PICKER = "colorpicker",
+    DATE_PICKER = "datepicker"
+}
+/**
+ * Attribute model.
+ */
+export interface Attribute extends Entity {
+    /** The name of the attribute. */
+    name: string;
+    /** The slug of the attribute. */
+    slug: string;
+    /** The type of the attribute field. */
+    type: FieldType;
+    /** The icon of the attribute. */
+    icon: string | null;
+    /** The description of the attribute. */
+    description: string | null;
+    /** Whether the attribute is enabled. */
+    is_enabled: boolean;
+    /** Whether the attribute is searchable. */
+    is_searchable: boolean;
+    /** Whether the attribute is filterable. */
+    is_filterable: boolean;
+    /** The computed formatted type. */
+    type_formatted?: string;
+    /** The values of the attribute. */
+    values?: AttributeValue[];
+}
+/**
+ * AttributeValue model.
+ */
+export interface AttributeValue {
+    id: number;
+    /** The display value. */
+    value: string;
+    /** The key identifier. */
+    key: string;
+    /** The position/order. */
+    position: number;
+    /** The attribute ID this value belongs to. */
+    attribute_id: number;
+    /** The attribute this value belongs to. */
+    attribute?: Attribute;
+}

package/dist/attribute.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldType = void 0;
+var FieldType;
+(function (FieldType) {
+    FieldType["TEXT"] = "text";
+    FieldType["NUMBER"] = "number";
+    FieldType["RICH_TEXT"] = "richtext";
+    FieldType["SELECT"] = "select";
+    FieldType["CHECKBOX"] = "checkbox";
+    FieldType["COLOR_PICKER"] = "colorpicker";
+    FieldType["DATE_PICKER"] = "datepicker";
+})(FieldType || (exports.FieldType = FieldType = {}));

package/dist/brand.d.ts

@@ -0,0 +1,23 @@
+import type { Entity, Metadata, SEOFields } from './common';
+import type { Media } from './media';
+/**
+ * Brand model.
+ */
+export interface Brand extends Entity, SEOFields {
+    /** The name of the brand. */
+    name: string;
+    /** The slug of the brand. */
+    slug: string | null;
+    /** The website URL of the brand. */
+    website: string | null;
+    /** The description of the brand. */
+    description: string | null;
+    /** The position of the brand. */
+    position: number;
+    /** Whether the brand is enabled. */
+    is_enabled: boolean;
+    /** The metadata of the brand. */
+    metadata: Metadata;
+    /** The image of the brand. */
+    image?: Media | null;
+}

package/dist/brand.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/carrier.d.ts

@@ -0,0 +1,51 @@
+import type { Entity, Metadata } from './common';
+import type { Media } from './media';
+import type { Zone } from './zone';
+/**
+ * Carrier model.
+ */
+export interface Carrier extends Entity {
+    /** The name of the carrier. */
+    name: string;
+    /** The slug of the carrier. */
+    slug: string | null;
+    /** The shipping driver identifier. */
+    driver: string | null;
+    /** The description of the carrier. */
+    description: string | null;
+    /** The link URL of the carrier. */
+    link_url: string | null;
+    /** The shipping amount (in cents). */
+    shipping_amount: number | null;
+    /** Whether the carrier is enabled. */
+    is_enabled: boolean;
+    /** The metadata of the carrier. */
+    metadata: Metadata;
+    /** The logo of the carrier. */
+    logo?: Media | null;
+    /** The options of this carrier. */
+    options?: CarrierOption[];
+    /** The zones this carrier belongs to. */
+    zones?: Zone[];
+}
+/**
+ * CarrierOption model.
+ */
+export interface CarrierOption extends Entity {
+    /** The name of the carrier option. */
+    name: string;
+    /** The price of the carrier option (in cents). */
+    price: number;
+    /** Whether the carrier option is enabled. */
+    is_enabled: boolean;
+    /** The zone ID this option belongs to. */
+    zone_id: number;
+    /** The carrier ID this option belongs to. */
+    carrier_id: number;
+    /** The metadata of the carrier option. */
+    metadata: Metadata;
+    /** The zone of the carrier option. */
+    zone?: Zone;
+    /** The carrier of the carrier option. */
+    carrier?: Carrier;
+}

package/dist/carrier.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/category.d.ts

@@ -0,0 +1,27 @@
+import type { Entity, Metadata } from './common';
+import type { Media } from './media';
+/**
+ * Category model.
+ */
+export interface Category extends Entity {
+    /** The name of the category. */
+    name: string;
+    /** The slug of the category. */
+    slug: string;
+    /** The description of the category. */
+    description: string | null;
+    /** Whether the category is enabled. */
+    is_enabled: boolean;
+    /** The id of the parent category. */
+    parent_id: number | null;
+    /** The metadata of the category. */
+    metadata: Metadata;
+    /** The image of the category. */
+    image?: Media | null;
+    /** The parent category. */
+    parent?: Category;
+    /** The children categories. */
+    children?: Category[];
+    /** The slug path of the category. */
+    slug_path?: string;
+}

package/dist/category.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/channel.d.ts

@@ -0,0 +1,22 @@
+import type { Entity, Metadata } from './common';
+/**
+ * Channel model.
+ */
+export interface Channel extends Entity {
+    /** The name of the channel. */
+    name: string;
+    /** The slug of the channel. */
+    slug: string | null;
+    /** The description of the channel. */
+    description: string | null;
+    /** The timezone of the channel. */
+    timezone: string | null;
+    /** The URL of the channel. */
+    url: string | null;
+    /** Whether the channel is the default. */
+    is_default: boolean;
+    /** Whether the channel is enabled. */
+    is_enabled: boolean;
+    /** The metadata of the channel. */
+    metadata: Metadata;
+}

package/dist/channel.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/collection.d.ts

@@ -0,0 +1,71 @@
+import type { DateEntity, Entity, Metadata, SEOFields } from './common';
+import type { Media } from './media';
+import type { Zone } from './zone';
+export declare enum CollectionType {
+    MANUAL = "manual",
+    AUTO = "auto"
+}
+export declare enum CollectionCondition {
+    ALL = "all",
+    ANY = "any"
+}
+export declare enum CollectionRuleType {
+    PRODUCT_TITLE = "product_title",
+    PRODUCT_PRICE = "product_price",
+    COMPARE_AT_PRICE = "compare_at_price",
+    INVENTORY_STOCK = "inventory_stock",
+    PRODUCT_CATEGORY = "product_category",
+    PRODUCT_BRAND = "product_brand"
+}
+export declare enum CollectionOperator {
+    EQUALS = "equals",
+    NOT_EQUALS = "not_equals",
+    LESS_THAN = "less_than",
+    GREATER_THAN = "greater_than",
+    STARTS_WITH = "starts_with",
+    ENDS_WITH = "ends_with",
+    CONTAINS = "contains",
+    NOT_CONTAINS = "not_contains"
+}
+/**
+ * Collection model.
+ */
+export interface Collection extends Entity, SEOFields {
+    /** The name of the collection. */
+    name: string;
+    /** The slug of the collection. */
+    slug: string;
+    /** The description of the collection. */
+    description?: string | null;
+    /** The type of the collection. */
+    type: CollectionType;
+    /** The match conditions for automatic collections. */
+    match_conditions: CollectionCondition | null;
+    /** The sort order for products. */
+    sort: string | null;
+    /** The published date of the collection. */
+    published_at: DateEntity | null;
+    /** The metadata of the collection. */
+    metadata: Metadata;
+    /** The image of the collection. */
+    image?: Media | null;
+    /** The rules for automatic collections. */
+    rules?: CollectionRule[];
+    /** The zones this collection belongs to. */
+    zones?: Zone[];
+}
+/**
+ * CollectionRule model.
+ */
+export interface CollectionRule extends Entity {
+    /** The rule type. */
+    rule: CollectionRuleType;
+    /** The operator for the rule. */
+    operator: CollectionOperator;
+    /** The value for the rule. */
+    value: string;
+    /** The collection ID this rule belongs to. */
+    collection_id: number;
+    /** The collection this rule belongs to. */
+    collection?: Collection;
+}

package/dist/collection.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionOperator = exports.CollectionRuleType = exports.CollectionCondition = exports.CollectionType = void 0;
+var CollectionType;
+(function (CollectionType) {
+    CollectionType["MANUAL"] = "manual";
+    CollectionType["AUTO"] = "auto";
+})(CollectionType || (exports.CollectionType = CollectionType = {}));
+var CollectionCondition;
+(function (CollectionCondition) {
+    CollectionCondition["ALL"] = "all";
+    CollectionCondition["ANY"] = "any";
+})(CollectionCondition || (exports.CollectionCondition = CollectionCondition = {}));
+var CollectionRuleType;
+(function (CollectionRuleType) {
+    CollectionRuleType["PRODUCT_TITLE"] = "product_title";
+    CollectionRuleType["PRODUCT_PRICE"] = "product_price";
+    CollectionRuleType["COMPARE_AT_PRICE"] = "compare_at_price";
+    CollectionRuleType["INVENTORY_STOCK"] = "inventory_stock";
+    CollectionRuleType["PRODUCT_CATEGORY"] = "product_category";
+    CollectionRuleType["PRODUCT_BRAND"] = "product_brand";
+})(CollectionRuleType || (exports.CollectionRuleType = CollectionRuleType = {}));
+var CollectionOperator;
+(function (CollectionOperator) {
+    CollectionOperator["EQUALS"] = "equals";
+    CollectionOperator["NOT_EQUALS"] = "not_equals";
+    CollectionOperator["LESS_THAN"] = "less_than";
+    CollectionOperator["GREATER_THAN"] = "greater_than";
+    CollectionOperator["STARTS_WITH"] = "starts_with";
+    CollectionOperator["ENDS_WITH"] = "ends_with";
+    CollectionOperator["CONTAINS"] = "contains";
+    CollectionOperator["NOT_CONTAINS"] = "not_contains";
+})(CollectionOperator || (exports.CollectionOperator = CollectionOperator = {}));

package/dist/common.d.ts

@@ -0,0 +1,94 @@
+import type { Currency } from './currency';
+export declare enum Weight {
+    KG = "kg",
+    G = "g",
+    LBS = "lbs"
+}
+export declare enum Length {
+    M = "m",
+    CM = "cm",
+    MM = "mm",
+    FT = "ft",
+    IN = "in"
+}
+export declare enum Volume {
+    L = "l",
+    ML = "ml",
+    GAL = "gal",
+    FLOZ = "floz"
+}
+/**
+ * Global entity for all the models.
+ */
+export interface Entity {
+    /** The id of the entity. */
+    id: number;
+    /** The created at of the entity. */
+    created_at?: DateEntity;
+    /** The updated at of the entity. */
+    updated_at?: DateEntity;
+    /** The deleted at of the entity. */
+    deleted_at?: DateEntity | null;
+}
+/**
+ * A date DTO to manage date format.
+ */
+export interface DateEntity {
+    /** The date format of the entity. */
+    date: Date;
+    /** The human readable date. Eg: 2 hours ago. */
+    human: string;
+}
+/**
+ * Price interface for entity.
+ */
+export interface Price {
+    /** The original amount for the entity. */
+    amount: number | null;
+    /** The compare_amount amount for the entity. */
+    compare_amount: number | null;
+    /** The cost_amount for the entity. */
+    cost_amount: number | null;
+    /** The currency_id for the entity. */
+    currency_id: number;
+    /** The currency_code for the entity. */
+    currency_code: string;
+    /** The currency for the entity. */
+    currency?: Currency;
+}
+/**
+ * ShippingFields interface for shipping entity.
+ */
+export interface ShippingFields {
+    /** The width_unit of the entity. */
+    width_unit: Length;
+    /** The width_value of the entity. */
+    width_value: number | null;
+    /** The weight_unit of the entity. */
+    weight_unit: Weight;
+    /** The weight_value of the entity. */
+    weight_value: number | null;
+    /** The height_unit of the entity. */
+    height_unit: Length;
+    /** The height_value of the entity. */
+    height_value: number | null;
+    /** The depth_unit of the entity. */
+    depth_unit: Length;
+    /** The depth_value of the entity. */
+    depth_value: number | null;
+    /** The volume_unit of the entity. */
+    volume_unit: Volume;
+    /** The volume_value of the entity. */
+    volume_value: number | null;
+}
+/**
+ * Seo Fields interface for entities.
+ */
+export interface SEOFields {
+    seo_title?: string | null;
+    seo_description?: string | null;
+}
+/**
+ * Metadata type for entities.
+ */
+export type Metadata = Record<string, unknown> | null;

package/dist/common.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Volume = exports.Length = exports.Weight = void 0;
+var Weight;
+(function (Weight) {
+    Weight["KG"] = "kg";
+    Weight["G"] = "g";
+    Weight["LBS"] = "lbs";
+})(Weight || (exports.Weight = Weight = {}));
+var Length;
+(function (Length) {
+    Length["M"] = "m";
+    Length["CM"] = "cm";
+    Length["MM"] = "mm";
+    Length["FT"] = "ft";
+    Length["IN"] = "in";
+})(Length || (exports.Length = Length = {}));
+var Volume;
+(function (Volume) {
+    Volume["L"] = "l";
+    Volume["ML"] = "ml";
+    Volume["GAL"] = "gal";
+    Volume["FLOZ"] = "floz";
+})(Volume || (exports.Volume = Volume = {}));

package/dist/country.d.ts

@@ -0,0 +1,33 @@
+import type { Zone } from './zone';
+/**
+ * Country model.
+ */
+export interface Country {
+    id: number;
+    /** The name of the country. */
+    name: string;
+    /** The official name of the country. */
+    name_official: string;
+    /** The region of the country. */
+    region: string;
+    /** The subregion of the country. */
+    subregion: string;
+    /** The ISO 3166-1 alpha-3 code. */
+    cca3: string;
+    /** The ISO 3166-1 alpha-2 code. */
+    cca2: string;
+    /** The flag emoji of the country. */
+    flag: string;
+    /** The SVG flag URL of the country. */
+    svg_flag: string;
+    /** The latitude of the country. */
+    latitude: number;
+    /** The longitude of the country. */
+    longitude: number;
+    /** The phone calling codes of the country. */
+    phone_calling_code: Record<string, unknown>;
+    /** The currencies of the country. */
+    currencies: Record<string, unknown>;
+    /** The zones this country belongs to. */
+    zones?: Zone[];
+}

package/dist/country.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/currency.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Currency model.
+ */
+export interface Currency {
+    id: number;
+    /** The name of the currency. */
+    name: string;
+    /** The code of the currency (e.g., USD, EUR). */
+    code: string;
+    /** The symbol of the currency (e.g., $, €). */
+    symbol: string;
+    /** The format pattern for displaying amounts. */
+    format: string;
+    /** The exchange rate relative to the base currency. */
+    exchange_rate: number;
+    /** Whether the currency is enabled. */
+    is_enabled: boolean;
+}

package/dist/currency.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/customer.d.ts

@@ -0,0 +1,48 @@
+import type { Address } from './address';
+import type { DateEntity, Entity } from './common';
+/**
+ * The Gender Type for the customer.
+ */
+export declare enum GenderType {
+    MALE = "male",
+    FEMALE = "female"
+}
+/**
+ * The Avatar interface for the customer.
+ */
+export interface AvatarType {
+    type: string;
+    url: string;
+    default: string;
+}
+/**
+ * Customer model.
+ */
+export interface Customer extends Entity {
+    /** The first name of the customer. */
+    first_name: string | null;
+    /** The last name of the customer. */
+    last_name: string;
+    /** The email of the customer. */
+    email: string;
+    /** The gender of the customer. */
+    gender: GenderType | null;
+    /** The phone number of the customer. */
+    phone_number: string | null;
+    /** The birth date of the customer. */
+    birth_date: Date | null;
+    /** The date the email was verified. */
+    email_verified_at: Date | null;
+    /** The avatar of the customer. */
+    avatar: AvatarType;
+    /** The timezone of the customer. */
+    timezone?: string | null;
+    /** Whether the customer has opted in to marketing. */
+    opt_in: boolean;
+    /** The last login date. */
+    last_login_at: DateEntity | null;
+    /** The last login IP address. */
+    last_login_ip?: string | null;
+    /** The customer's addresses. */
+    addresses?: Address[];
+}

package/dist/customer.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenderType = void 0;
+/**
+ * The Gender Type for the customer.
+ */
+var GenderType;
+(function (GenderType) {
+    GenderType["MALE"] = "male";
+    GenderType["FEMALE"] = "female";
+})(GenderType || (exports.GenderType = GenderType = {}));