@carter-rmn/cpix-js 1.0.0-alpha.1

package/dist/types/common.types.d.ts

@@ -0,0 +1,330 @@
+/**
+ * Represents the initialization options for the application.
+ */
+export interface InitOptions {
+    debug?: boolean;
+    tracker_server_url: string;
+}
+/**
+ * Represents the initialization options for the application.
+ */
+export interface Init {
+    /**
+     * The client ID for the application.
+     */
+    client_id: string;
+    /**
+     * Additional options for the application.
+     */
+    options: Record<string, unknown>;
+}
+/**
+ * Represents the event properties.
+ */
+export interface EventProperties {
+    [key: string]: unknown;
+}
+/**
+ * Represents the user properties.
+ */
+export interface UserProperties {
+    /**
+     * The user ID.
+     */
+    user_id: string;
+    [key: string]: unknown;
+}
+/**
+ * Represents the location information.
+ */
+export interface Location {
+    /**
+     * The country.
+     */
+    country: string;
+    /**
+     * The region.
+     */
+    region: string;
+    /**
+     * The city.
+     */
+    city: string;
+    /**
+     * The location.
+     */
+    loc: string;
+    /**
+     * The timezone.
+     */
+    timezone: string;
+}
+/**
+ * Represents the device information.
+ */
+export interface Device {
+    /**
+     * The category of the device.
+     */
+    category: string;
+    /**
+     * The brand of the device.
+     */
+    brand: string;
+    /**
+     * The IP address of the device.
+     */
+    ip_address: string;
+    /**
+     * The platform of the device.
+     */
+    platform: string;
+}
+/**
+ * Represents the meta parameters for an event.
+ */
+export interface MetaParameters {
+    /**
+     * The client ID.
+     */
+    client_id?: string;
+    /**
+     * The session ID.
+     */
+    session?: string;
+    /**
+     * The location information.
+     */
+    location?: Location;
+    /**
+     * The device information.
+     */
+    device?: Device;
+    /**
+     * The timestamp of the event.
+     */
+    timestamp?: number;
+    /**
+     * The referrer URL.
+     */
+    referrer?: string;
+    /**
+     * The UTM parameters.
+     */
+    utm_params?: unknown;
+}
+/**
+ * Represents an event.
+ */
+export interface Event {
+    /**
+     * The event name.
+     */
+    event: string;
+    /**
+     * The event properties.
+     */
+    event_properties?: EventProperties;
+    /**
+     * The user properties.
+     */
+    user_properties?: UserProperties;
+}
+export interface EnrichedEvent extends Event, MetaParameters {
+}
+/**
+ * Represents the properties of a product.
+ */
+export interface ProductProperties {
+    /**
+     * The ID of the product.
+     */
+    id: string;
+    /**
+     * The SKU ID of the product.
+     */
+    sku_id?: string;
+    /**
+     * The price of the product.
+     */
+    price: number;
+    /**
+     * The currency of the product price.
+     */
+    currency: string;
+    /**
+     * The title of the product.
+     */
+    title: string;
+    /**
+     * The image URL of the product.
+     */
+    image_url?: string;
+    /**
+     * The product URL.
+     */
+    product_url?: string;
+    /**
+     * The affiliation of the product.
+     */
+    affiliation?: unknown;
+    /**
+     * The first-level category of the product.
+     */
+    product_category_1?: string;
+    /**
+     * The second-level category of the product.
+     */
+    product_category_2?: string;
+    /**
+     * The third-level category of the product.
+     */
+    product_category_3?: string;
+    /**
+     * The fourth-level category of the product.
+     */
+    product_category_4?: string;
+    /**
+     * The fifth-level category of the product.
+     */
+    product_category_5?: string;
+    [key: string]: unknown;
+}
+/**
+ * Represents the properties of a cart item.
+ */
+export interface CartProperties {
+    /**
+     * The ID of the cart item.
+     */
+    id: string;
+    /**
+     * The SKU ID of the cart item.
+     */
+    sku_id?: string;
+    /**
+     * The price of the cart item.
+     */
+    price: number;
+    /**
+     * The currency of the cart item price.
+     */
+    currency: string;
+    /**
+     * The title of the cart item.
+     */
+    title: string;
+    /**
+     * The image URL of the cart item.
+     */
+    image_url?: string;
+    /**
+     * The product URL.
+     */
+    product_url?: string;
+    /**
+     * The affiliation of the cart item.
+     */
+    affiliation?: unknown;
+    /**
+     * The first-level category of the cart item.
+     */
+    product_category_1?: string;
+    /**
+     * The second-level category of the cart item.
+     */
+    product_category_2?: string;
+    /**
+     * The third-level category of the cart item.
+     */
+    product_category_3?: string;
+    /**
+     * The fourth-level category of the cart item.
+     */
+    product_category_4?: string;
+    /**
+     * The fifth-level category of the cart item.
+     */
+    product_category_5?: string;
+    /**
+     * The quantity of the cart item.
+     */
+    quantity: number;
+    /**
+     * The discount applied to the cart item.
+     */
+    discount: number;
+    /**
+     * The total amount of the cart item.
+     */
+    amount: number;
+}
+/**
+ * Represents the properties of an address.
+ */
+export interface AddressProperties {
+    /**
+     * The address line 1.
+     */
+    address_line_1: string;
+    /**
+     * The address line 2.
+     */
+    address_line_2: string;
+    /**
+     * The city.
+     */
+    city: string;
+    /**
+     * The province.
+     */
+    province: string;
+    /**
+     * The province code.
+     */
+    province_code: string;
+    /**
+     * The Country.
+     */
+    country: string;
+    /**
+     * The country code.
+     */
+    country_code: string;
+    /**
+     * The first name.
+     */
+    first_name: string;
+    /**
+     * The last name.
+     */
+    last_name: string;
+    /**
+     * The phone number.
+     */
+    phone: string;
+}
+/**
+ * Represents the properties of a discount.
+ */
+export interface DiscountProperties {
+    /**
+     * The application of the discount.
+     */
+    application: string;
+    /**
+     * The discount code.
+     */
+    code: string;
+    /**
+     * The amount of the discount.
+     */
+    amount: number;
+    /**
+     * The target of the discount.
+     */
+    target: string;
+}
+export interface DeviceNetworkParameters extends Location {
+    ip_address: string;
+}

package/dist/types/core.types.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Represents the properties for a search operation.
+ */
+export interface SearchProperties {
+    /**
+     * The search query.
+     */
+    query: string;
+}
+/**
+ * Represents the properties for a signup operation.
+ */
+export interface SignupProperties {
+    /**
+     * The signup method.
+     */
+    method: string;
+    /**
+     * The user ID.
+     */
+    user_id: string;
+}
+/**
+ * Represents the properties for a login operation.
+ */
+export interface LoginProperties {
+    /**
+     * The login method.
+     */
+    method: string;
+    /**
+     * The user ID.
+     */
+    user_id: string;
+}

package/dist/types/shopping.cart.types.d.ts

@@ -0,0 +1,69 @@
+import * as commonType from './common.types';
+/**
+ * Represents the properties for adding items to a cart.
+ */
+export interface AddToCartProperties {
+    /**
+     * The total amount of the cart.
+     */
+    cart_amount: number;
+    /**
+     * The currency of the cart amount.
+     */
+    currency: string;
+    /**
+     * The array of cart items.
+     */
+    cart_items: Array<commonType.CartProperties>;
+}
+/**
+ * Represents the properties for removing items from a cart.
+ */
+export interface RemoveFromCartProperties {
+    /**
+     * The total amount of the cart.
+     */
+    cart_amount: number;
+    /**
+     * The currency of the cart amount.
+     */
+    currency: string;
+    /**
+     * The array of cart items.
+     */
+    cart_items: Array<commonType.CartProperties>;
+}
+/**
+ * Represents the properties for updating a cart.
+ */
+export interface UpdateCartProperties {
+    /**
+     * The total amount of the cart.
+     */
+    cart_amount: number;
+    /**
+     * The currency of the cart amount.
+     */
+    currency: string;
+    /**
+     * The array of cart items.
+     */
+    cart_items: Array<commonType.CartProperties>;
+}
+/**
+ * Represents the properties for viewing a cart.
+ */
+export interface ViewCartProperties {
+    /**
+     * The total amount of the cart.
+     */
+    cart_amount: number;
+    /**
+     * The currency of the cart amount.
+     */
+    currency: string;
+    /**
+     * The array of cart items.
+     */
+    cart_items: Array<commonType.CartProperties>;
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@carter-rmn/cpix-js",
+  "version": "1.0.0-alpha.1",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/cpix.umd.cjs",
+  "module": "dist/cpix.js",
+  "types": "dist/cpix.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/cpix.js",
+      "require": "./dist/cpix.umd.cjs"
+    }
+  },
+  "devDependencies": {
+    "picocolors": "^1.0.0",
+    "rollup-plugin-visualizer": "^5.12.0",
+    "typescript": "^5.2.2",
+    "vite": "^5.2.0",
+    "vite-plugin-progress": "^0.0.7"
+  },
+  "dependencies": {
+    "vite-plugin-dts": "^3.8.1"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
+  }
+}