@ecomiq/core 0.1.9 → 1.1.0

package/dist/services/product.service.d.ts

@@ -0,0 +1,256 @@
+import { Api } from "../api.js";
+import { ProductBySlugOptions, ProductsParamsInput, RelatedProductsParams } from "../models/products.js";
+export declare function getProducts(api: Api, params?: ProductsParamsInput): Promise<{
+  pageIndex: number;
+  pageSize: number;
+  totalCount: number;
+  totalPages: number;
+  products: {
+    id: string;
+    name: string;
+    slug: string;
+    url: string;
+    productType: string;
+    imageUrl: string;
+    price: number;
+    compareAtPrice: number | null;
+    variantCount: number;
+    isAvailable: boolean;
+    totalInventory: number;
+    bundleItemsCount: number;
+    brand: string;
+    category: string;
+    status: string;
+    collections: string[];
+    tags: string[];
+    seller: {
+      id: string;
+      name: string;
+      slug: string;
+    } | null;
+    options: {
+      key: string;
+      name: string;
+      type?: "checkbox" | "colorPicker" | "datePicker" | "dateTimePicker" | "file" | "input" | "number" | "select" | "textArea" | "timePicker" | "url" | undefined;
+      values: {
+        key: string;
+        name: string;
+        value: string;
+        valueId?: string | null | undefined;
+        valueName?: string | null | undefined;
+        type?: "checkbox" | "colorPicker" | "datePicker" | "dateTimePicker" | "file" | "input" | "number" | "select" | "textArea" | "timePicker" | "url" | undefined;
+        color?: string | null | undefined;
+        imageUrl?: string | null | undefined;
+        unit?: string | null | undefined;
+      }[];
+    }[];
+    images: {
+      url: string;
+      name: string;
+      order: number;
+      type: "image" | "video";
+    }[];
+    availableVariantId: string | null;
+    hasModifierGroups: boolean;
+  }[];
+  filters: {
+    id: string;
+    label: string;
+    type: "list" | "price_range";
+    values: {
+      value: string;
+      count: number;
+      label: string | null;
+      selected: boolean;
+    }[];
+    min: number | null;
+    max: number | null;
+    selectedMin: number | null;
+    selectedMax: number | null;
+  }[];
+}>;
+export declare function getProductBySlug(api: Api, slug: string, options?: ProductBySlugOptions): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  url: string;
+  description: string;
+  productType: string;
+  status: string;
+  imageUrl: string;
+  price: number;
+  compareAtPrice: number | null;
+  isAvailable: boolean;
+  totalInventory: number;
+  brand: string;
+  category: string;
+  categoryId: string | null;
+  tags: string[];
+  specifications: {
+    key: string;
+    name: string;
+    value: string;
+    valueId?: string | null | undefined;
+    valueName?: string | null | undefined;
+    type?: "checkbox" | "colorPicker" | "datePicker" | "dateTimePicker" | "file" | "input" | "number" | "select" | "textArea" | "timePicker" | "url" | undefined;
+    color?: string | null | undefined;
+    imageUrl?: string | null | undefined;
+    unit?: string | null | undefined;
+  }[];
+  variants: {
+    id: string | null;
+    sku: string;
+    status: string;
+    price: number;
+    compareAtPrice: number | null;
+    quantity: number;
+    isAvailable: boolean | null;
+    requiresShipping: boolean;
+    options: {
+      key: string;
+      name: string;
+      value: string;
+      valueId?: string | null | undefined;
+      valueName?: string | null | undefined;
+      type?: "checkbox" | "colorPicker" | "datePicker" | "dateTimePicker" | "file" | "input" | "number" | "select" | "textArea" | "timePicker" | "url" | undefined;
+      color?: string | null | undefined;
+      imageUrl?: string | null | undefined;
+      unit?: string | null | undefined;
+    }[];
+    images: {
+      url: string;
+      name: string;
+      order: number;
+      type: "image" | "video";
+    }[];
+  }[];
+  images: {
+    url: string;
+    name: string;
+    order: number;
+    type: "image" | "video";
+  }[];
+  bundleItems: {
+    productId: string;
+    variantId: string;
+    productName: string;
+    variantName: string | null;
+    sku: string | null;
+    brand: string | null;
+    imageUrl: string | null;
+    quantity: number;
+    available: number;
+    allowBackorders: boolean;
+    requiresShipping: boolean;
+  }[];
+  sizeGuide: {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    imageUrl: string | null;
+    gender: string;
+    measurementType: string;
+    unit: string;
+    notes: string | null;
+    rows: {
+      label: string;
+      sizeKey: string;
+      order: number;
+      measurements: {
+        key: string;
+        name: string;
+        min: number | null;
+        max: number | null;
+        value: number | null;
+        description: string | null;
+      }[];
+    }[];
+  } | null;
+  priceTiers: {
+    variantId: string;
+    minQuantity: number;
+    maxQuantity: number | null;
+    unitPrice: number;
+  }[];
+  modifierGroups: {
+    id: string;
+    name: string;
+    description: string | null;
+    selectionType: "multiple" | "single" | "text";
+    display: "color" | "font" | "image" | "list";
+    isRequired: boolean;
+    minSelections: number;
+    maxSelections: number | null;
+    maxLength: number | null;
+    priceDelta: number;
+    options: {
+      id: string;
+      name: string;
+      priceDelta: number;
+      isDefault: boolean;
+      color: string | null;
+      fileUrl: string | null;
+      fileName: string | null;
+      tag: string | null;
+      maxQuantity: number;
+    }[];
+  }[];
+  createdAt: string | null;
+  updatedAt: string | null;
+  seller: {
+    id: string;
+    name: string;
+    slug: string;
+  } | null;
+  isPreview: boolean;
+  template: string | null;
+}>;
+export declare function getRelatedProducts(api: Api, params: RelatedProductsParams): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  url: string;
+  productType: string;
+  imageUrl: string;
+  price: number;
+  compareAtPrice: number | null;
+  variantCount: number;
+  isAvailable: boolean;
+  totalInventory: number;
+  bundleItemsCount: number;
+  brand: string;
+  category: string;
+  status: string;
+  collections: string[];
+  tags: string[];
+  seller: {
+    id: string;
+    name: string;
+    slug: string;
+  } | null;
+  options: {
+    key: string;
+    name: string;
+    type?: "checkbox" | "colorPicker" | "datePicker" | "dateTimePicker" | "file" | "input" | "number" | "select" | "textArea" | "timePicker" | "url" | undefined;
+    values: {
+      key: string;
+      name: string;
+      value: string;
+      valueId?: string | null | undefined;
+      valueName?: string | null | undefined;
+      type?: "checkbox" | "colorPicker" | "datePicker" | "dateTimePicker" | "file" | "input" | "number" | "select" | "textArea" | "timePicker" | "url" | undefined;
+      color?: string | null | undefined;
+      imageUrl?: string | null | undefined;
+      unit?: string | null | undefined;
+    }[];
+  }[];
+  images: {
+    url: string;
+    name: string;
+    order: number;
+    type: "image" | "video";
+  }[];
+  availableVariantId: string | null;
+  hasModifierGroups: boolean;
+}[]>;

package/dist/services/review.service-CO2icjpu.cjs

@@ -0,0 +1,46 @@
+const require_models_storefront_reviews = require("../models/storefront-reviews.cjs");
+// src/services/review.service.ts
+async function listProductReviews(api, params) {
+	const input = require_models_storefront_reviews.ListProductReviewsParamsSchema.parse(params);
+	return api.get(`products/${encodeURIComponent(input.productId)}/reviews`, require_models_storefront_reviews.StorefrontReviewsSchema, { query: {
+		limit: input.limit,
+		cursor: input.cursor,
+		search: input.search,
+		sortBy: input.sortBy,
+		sortDirection: input.sortDirection,
+		rating: input.rating
+	} });
+}
+async function listStoreReviews(api, params = {}) {
+	const input = require_models_storefront_reviews.ListStoreReviewsParamsSchema.parse(params);
+	return api.get("reviews", require_models_storefront_reviews.StorefrontStoreReviewSchema.array(), { query: {
+		limit: input.limit,
+		minRating: input.minRating
+	} });
+}
+async function createProductReview(api, params) {
+	const input = require_models_storefront_reviews.CreateProductReviewParamsSchema.parse(params);
+	return api.post(`products/${encodeURIComponent(input.productId)}/reviews`, {
+		rating: input.rating,
+		content: input.content,
+		title: input.title,
+		reviewerName: input.reviewerName,
+		reviewerEmail: input.reviewerEmail,
+		orderId: input.orderId,
+		reviewToken: input.reviewToken
+	}, require_models_storefront_reviews.StorefrontReviewSchema);
+}
+async function createCustomerProductReview(api, params, options) {
+	const input = require_models_storefront_reviews.CreateCustomerProductReviewParamsSchema.parse(params);
+	return api.post("customer/reviews", {
+		productId: input.productId,
+		rating: input.rating,
+		content: input.content,
+		title: input.title,
+		reviewerName: input.reviewerName
+	}, require_models_storefront_reviews.StorefrontReviewSchema, options);
+}
+exports.createCustomerProductReview = createCustomerProductReview;
+exports.createProductReview = createProductReview;
+exports.listProductReviews = listProductReviews;
+exports.listStoreReviews = listStoreReviews;

package/dist/services/review.service-De1YkhFp.js

@@ -0,0 +1,43 @@
+import { CreateCustomerProductReviewParamsSchema, CreateProductReviewParamsSchema, ListProductReviewsParamsSchema, ListStoreReviewsParamsSchema, StorefrontReviewSchema, StorefrontReviewsSchema, StorefrontStoreReviewSchema } from "../models/storefront-reviews.js";
+// src/services/review.service.ts
+async function listProductReviews(api, params) {
+	const input = ListProductReviewsParamsSchema.parse(params);
+	return api.get(`products/${encodeURIComponent(input.productId)}/reviews`, StorefrontReviewsSchema, { query: {
+		limit: input.limit,
+		cursor: input.cursor,
+		search: input.search,
+		sortBy: input.sortBy,
+		sortDirection: input.sortDirection,
+		rating: input.rating
+	} });
+}
+async function listStoreReviews(api, params = {}) {
+	const input = ListStoreReviewsParamsSchema.parse(params);
+	return api.get("reviews", StorefrontStoreReviewSchema.array(), { query: {
+		limit: input.limit,
+		minRating: input.minRating
+	} });
+}
+async function createProductReview(api, params) {
+	const input = CreateProductReviewParamsSchema.parse(params);
+	return api.post(`products/${encodeURIComponent(input.productId)}/reviews`, {
+		rating: input.rating,
+		content: input.content,
+		title: input.title,
+		reviewerName: input.reviewerName,
+		reviewerEmail: input.reviewerEmail,
+		orderId: input.orderId,
+		reviewToken: input.reviewToken
+	}, StorefrontReviewSchema);
+}
+async function createCustomerProductReview(api, params, options) {
+	const input = CreateCustomerProductReviewParamsSchema.parse(params);
+	return api.post("customer/reviews", {
+		productId: input.productId,
+		rating: input.rating,
+		content: input.content,
+		title: input.title,
+		reviewerName: input.reviewerName
+	}, StorefrontReviewSchema, options);
+}
+export { createCustomerProductReview, createProductReview, listProductReviews, listStoreReviews };

package/dist/services/review.service.d.cts

@@ -0,0 +1,28 @@
+import { Api } from "../api.cjs";
+import { CreateProductReviewParams, ListProductReviewsParams } from "../models/storefront-reviews.cjs";
+import "./customer.service.cjs";
+export declare function listProductReviews(api: Api, params: ListProductReviewsParams): Promise<{
+  data: {
+    id: string;
+    productId: string;
+    isVerifiedPurchase: boolean;
+    rating: number;
+    title: string | null;
+    content: string;
+    reviewerName: string | null;
+    createdOn: string;
+  }[];
+  hasNextPage: boolean;
+  nextCursor: string | null;
+  totalCount: number | null;
+}>;
+export declare function createProductReview(api: Api, params: CreateProductReviewParams): Promise<{
+  id: string;
+  productId: string;
+  isVerifiedPurchase: boolean;
+  rating: number;
+  title: string | null;
+  content: string;
+  reviewerName: string | null;
+  createdOn: string;
+}>;

package/dist/services/review.service.d.ts

@@ -0,0 +1,28 @@
+import { Api } from "../api.js";
+import { CreateProductReviewParams, ListProductReviewsParams } from "../models/storefront-reviews.js";
+import "./customer.service.js";
+export declare function listProductReviews(api: Api, params: ListProductReviewsParams): Promise<{
+  data: {
+    id: string;
+    productId: string;
+    isVerifiedPurchase: boolean;
+    rating: number;
+    title: string | null;
+    content: string;
+    reviewerName: string | null;
+    createdOn: string;
+  }[];
+  hasNextPage: boolean;
+  nextCursor: string | null;
+  totalCount: number | null;
+}>;
+export declare function createProductReview(api: Api, params: CreateProductReviewParams): Promise<{
+  id: string;
+  productId: string;
+  isVerifiedPurchase: boolean;
+  rating: number;
+  title: string | null;
+  content: string;
+  reviewerName: string | null;
+  createdOn: string;
+}>;

package/dist/services/search.service-Bx1zbTHJ.cjs

@@ -0,0 +1,10 @@
+const require_models_search = require("../models/search.cjs");
+// src/services/search.service.ts
+async function autocompleteProducts(api, params) {
+	const input = require_models_search.ProductAutocompleteParamsSchema.parse(params);
+	return api.get("search/autocomplete", require_models_search.ProductSuggestionsSchema, { query: {
+		search: input.search,
+		limit: input.limit
+	} });
+}
+exports.autocompleteProducts = autocompleteProducts;

package/dist/services/search.service-DSBMhaSY.js

@@ -0,0 +1,10 @@
+import { ProductAutocompleteParamsSchema, ProductSuggestionsSchema } from "../models/search.js";
+// src/services/search.service.ts
+async function autocompleteProducts(api, params) {
+	const input = ProductAutocompleteParamsSchema.parse(params);
+	return api.get("search/autocomplete", ProductSuggestionsSchema, { query: {
+		search: input.search,
+		limit: input.limit
+	} });
+}
+export { autocompleteProducts };

package/dist/services/search.service.d.cts

@@ -0,0 +1,9 @@
+import { Api } from "../api.cjs";
+import { ProductAutocompleteParams } from "../models/search.cjs";
+export declare function autocompleteProducts(api: Api, params: ProductAutocompleteParams): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  url: string;
+  imageUrl: string;
+}[]>;

package/dist/services/search.service.d.ts

@@ -0,0 +1,9 @@
+import { Api } from "../api.js";
+import { ProductAutocompleteParams } from "../models/search.js";
+export declare function autocompleteProducts(api: Api, params: ProductAutocompleteParams): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  url: string;
+  imageUrl: string;
+}[]>;

package/dist/services/seller.service-D11WHhbC.cjs

@@ -0,0 +1,10 @@
+const require_models_sellers = require("../models/sellers.cjs");
+// src/services/seller.service.ts
+async function getSellers(api) {
+	return api.get("sellers", require_models_sellers.SellersSchema);
+}
+async function getSellerBySlug(api, slug) {
+	return api.get(`sellers/${encodeURIComponent(slug)}`, require_models_sellers.SellerProfileSchema);
+}
+exports.getSellerBySlug = getSellerBySlug;
+exports.getSellers = getSellers;

package/dist/services/seller.service-DUptDTv4.js

@@ -0,0 +1,9 @@
+import { SellerProfileSchema, SellersSchema } from "../models/sellers.js";
+// src/services/seller.service.ts
+async function getSellers(api) {
+	return api.get("sellers", SellersSchema);
+}
+async function getSellerBySlug(api, slug) {
+	return api.get(`sellers/${encodeURIComponent(slug)}`, SellerProfileSchema);
+}
+export { getSellerBySlug, getSellers };

package/dist/services/seller.service.d.cts

@@ -0,0 +1,42 @@
+import { Api } from "../api.cjs";
+export declare function getSellers(api: Api): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  logo: string | null;
+  banner: string | null;
+  tagline: string | null;
+  verified: boolean;
+  rating: {
+    average: number;
+    totalReviews: number;
+  };
+}[]>;
+export declare function getSellerBySlug(api: Api, slug: string): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  logo: string | null;
+  banner: string | null;
+  tagline: string | null;
+  verified: boolean;
+  rating: {
+    average: number;
+    totalReviews: number;
+  };
+  description: string | null;
+  links: {
+    website: string | null;
+    facebook: string | null;
+    instagram: string | null;
+    tikTok: string | null;
+    youTube: string | null;
+    twitter: string | null;
+    linkedIn: string | null;
+    whatsApp: string | null;
+  };
+  linkStyle: "icons" | "text";
+  memberSince: string;
+  deliveryPolicy: string | null;
+  privacyAndSecurityPolicy: string | null;
+}>;

package/dist/services/seller.service.d.ts

@@ -0,0 +1,42 @@
+import { Api } from "../api.js";
+export declare function getSellers(api: Api): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  logo: string | null;
+  banner: string | null;
+  tagline: string | null;
+  verified: boolean;
+  rating: {
+    average: number;
+    totalReviews: number;
+  };
+}[]>;
+export declare function getSellerBySlug(api: Api, slug: string): Promise<{
+  id: string;
+  name: string;
+  slug: string;
+  logo: string | null;
+  banner: string | null;
+  tagline: string | null;
+  verified: boolean;
+  rating: {
+    average: number;
+    totalReviews: number;
+  };
+  description: string | null;
+  links: {
+    website: string | null;
+    facebook: string | null;
+    instagram: string | null;
+    tikTok: string | null;
+    youTube: string | null;
+    twitter: string | null;
+    linkedIn: string | null;
+    whatsApp: string | null;
+  };
+  linkStyle: "icons" | "text";
+  memberSince: string;
+  deliveryPolicy: string | null;
+  privacyAndSecurityPolicy: string | null;
+}>;

package/dist/services/tracking.service-CPK1B69N.js

@@ -0,0 +1,11 @@
+import { PublicOrderTrackingSchema } from "../models/tracking-CiIAhQW0.js";
+// src/services/tracking.service.ts
+async function getOrderTracking(api, trackingNumber, options = {}) {
+	const code = trackingNumber.trim();
+	if (!code) throw new Error("trackingNumber requerido");
+	return api.get(`tracking/${encodeURIComponent(code)}`, PublicOrderTrackingSchema, {
+		headers: options.headers,
+		signal: options.signal
+	});
+}
+export { getOrderTracking };

package/dist/services/tracking.service-DqOoi8qr.cjs

@@ -0,0 +1,11 @@
+const require_tracking = require("../models/tracking-wNyzQ6Bp.cjs");
+// src/services/tracking.service.ts
+async function getOrderTracking(api, trackingNumber, options = {}) {
+	const code = trackingNumber.trim();
+	if (!code) throw new Error("trackingNumber requerido");
+	return api.get(`tracking/${encodeURIComponent(code)}`, require_tracking.PublicOrderTrackingSchema, {
+		headers: options.headers,
+		signal: options.signal
+	});
+}
+exports.getOrderTracking = getOrderTracking;

package/dist/services/tracking.service.d.cts

@@ -0,0 +1,7 @@
+import { Api } from "../api.cjs";
+import { PublicOrderTracking } from "../models/tracking.cjs";
+export type TrackingRequestOptions = {
+  headers?: Record<string, string>;
+  signal?: AbortSignal;
+};
+export declare function getOrderTracking(api: Api, trackingNumber: string, options?: TrackingRequestOptions): Promise<PublicOrderTracking>;

package/dist/services/tracking.service.d.ts

@@ -0,0 +1,7 @@
+import { Api } from "../api.js";
+import { PublicOrderTracking } from "../models/tracking.js";
+export type TrackingRequestOptions = {
+  headers?: Record<string, string>;
+  signal?: AbortSignal;
+};
+export declare function getOrderTracking(api: Api, trackingNumber: string, options?: TrackingRequestOptions): Promise<PublicOrderTracking>;

package/dist/services/url.service-B-nC14Ue.cjs

@@ -0,0 +1,19 @@
+const require_api = require("../api.cjs");
+const require_urls = require("../models/urls-B0ZODOwH.cjs");
+// src/services/url.service.ts
+async function resolveUrl(api, path, options = {}) {
+	try {
+		return await api.get("urls/resolve", require_urls.UrlResolutionSchema, { query: {
+			path,
+			previewKey: options.previewKey
+		} });
+	} catch (error) {
+		if (error instanceof require_api.ApiError && error.status === 404) return null;
+		throw error;
+	}
+}
+async function getSitemap(api, page) {
+	return api.get("sitemap", require_urls.SitemapPageSchema, { query: { page } });
+}
+exports.getSitemap = getSitemap;
+exports.resolveUrl = resolveUrl;

package/dist/services/url.service-CLW0Tc7S.js

@@ -0,0 +1,18 @@
+import { ApiError } from "../api.js";
+import { SitemapPageSchema, UrlResolutionSchema } from "../models/urls-Dt_dTt4Q.js";
+// src/services/url.service.ts
+async function resolveUrl(api, path, options = {}) {
+	try {
+		return await api.get("urls/resolve", UrlResolutionSchema, { query: {
+			path,
+			previewKey: options.previewKey
+		} });
+	} catch (error) {
+		if (error instanceof ApiError && error.status === 404) return null;
+		throw error;
+	}
+}
+async function getSitemap(api, page) {
+	return api.get("sitemap", SitemapPageSchema, { query: { page } });
+}
+export { getSitemap, resolveUrl };

package/dist/storefront-cache-revision.cjs

@@ -0,0 +1,23 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let zod = require("zod");
+// src/storefront-cache-revision.ts
+const STOREFRONT_CACHE_REVISION_HEADER = "x-ecomiq-cache-revision";
+const STOREFRONT_CACHE_TTL_SECONDS = 30;
+const StorefrontCacheRevisionSchema = zod.z.string().regex(/^[1-9]\d{0,18}$/);
+const StorefrontCacheRevisionDocumentSchema = zod.z.object({
+	schemaVersion: zod.z.literal(1),
+	storeId: zod.z.string().regex(/^[1-9]\d{0,18}$/),
+	revision: StorefrontCacheRevisionSchema
+}).strict();
+const StorefrontCacheTokenSchema = zod.z.string().regex(/^[1-9]\d{0,18}\.(?:0|[1-9]\d{0,11})$/);
+function storefrontCacheToken({ storeId, revision, now }) {
+	const windowMs = 3e4;
+	const offsetMs = Number(BigInt(storeId) % BigInt(windowMs));
+	return `${revision}.${Math.floor((now + offsetMs) / windowMs)}`;
+}
+exports.STOREFRONT_CACHE_REVISION_HEADER = STOREFRONT_CACHE_REVISION_HEADER;
+exports.STOREFRONT_CACHE_TTL_SECONDS = STOREFRONT_CACHE_TTL_SECONDS;
+exports.StorefrontCacheRevisionDocumentSchema = StorefrontCacheRevisionDocumentSchema;
+exports.StorefrontCacheRevisionSchema = StorefrontCacheRevisionSchema;
+exports.StorefrontCacheTokenSchema = StorefrontCacheTokenSchema;
+exports.storefrontCacheToken = storefrontCacheToken;

package/dist/storefront-cache-revision.d.cts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+export declare const STOREFRONT_CACHE_REVISION_HEADER = "x-ecomiq-cache-revision";
+export declare const STOREFRONT_CACHE_TTL_SECONDS = 30;
+export declare const StorefrontCacheRevisionSchema: z.ZodString;
+export declare const StorefrontCacheRevisionDocumentSchema: z.ZodObject<{
+  schemaVersion: z.ZodLiteral<1>;
+  storeId: z.ZodString;
+  revision: z.ZodString;
+}, z.core.$strict>;
+export declare const StorefrontCacheTokenSchema: z.ZodString;
+export type StorefrontCacheRevisionDocument = z.infer<typeof StorefrontCacheRevisionDocumentSchema>;
+export declare function storefrontCacheToken({ storeId, revision, now }: {
+  storeId: string;
+  revision: string;
+  now: number;
+}): string;