@haus-storefront-react/shared-types 0.0.6-0 → 0.0.7-0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.0.6 (2025-07-01)
+
+This was a version bump only for shared/types to align it with other projects, there were no code changes.
+
+## 0.0.6-0 (2025-07-01)
+
+This was a version bump only for shared/types to align it with other projects, there were no code changes.
+
 ## 0.0.5 (2025-07-01)
 
 This was a version bump only for shared/types to align it with other projects, there were no code changes.

package/index.d.ts

@@ -3,8 +3,11 @@ import { default as React, HTMLAttributes, ReactNode, JSX, CSSProperties } from
 export type ErrorResult = {
     errorCode: ErrorCode;
     message: string;
+    code?: string;
 };
-export type GenericEcomError = Maybe<AxiosError | ErrorResult | Error | undefined>;
+export type GenericEcomError = Maybe<AxiosError | ErrorResult | Error | (Error & {
+    code: string;
+}) | undefined>;
 export type Maybe<T> = T | null;
 export type Exact<T extends {
     [key: string]: unknown;
@@ -30,6 +33,46 @@ export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
 }[Keys];
 export type ArrayElement<A> = A extends readonly (infer T)[] ? T : never;
+export type ObtainKeys<Obj, Type> = {
+    [Prop in keyof Obj]: Obj[Prop] extends Type ? Prop : never;
+}[keyof Obj];
+export interface PluginFeatureMappings {
+}
+type PluginFeatureNames = ObtainKeys<PluginFeatureMappings, unknown>;
+export type PluginFeatures = Partial<{
+    [K in PluginFeatureNames]: PluginFeatureMappings[K];
+}>;
+type PluginName = 'packageSize' | 'productPopularity' | 'badges' | 'campaign' | string;
+type ProviderData = {
+    wraps?: string;
+    provider: React.ComponentType<{
+        children: ReactNode;
+    }>;
+};
+export type ProviderDataMap = Array<ProviderData>;
+export interface IVendurePluginConfig<Features extends PluginFeatures, R, S, T> {
+    readonly name: PluginName;
+    enabled?: boolean;
+    enableFeatures?: Partial<Record<keyof Features, boolean>> | Partial<Features>;
+    queryUpdates: BuilderQueryUpdates;
+    requests?: R;
+    providers?: ProviderDataMap;
+    settings?: S;
+    setSdk: (sdk: T) => void;
+    setProviders: (providers: ProviderDataMap) => void;
+    setEnabled: (enabled: boolean) => void;
+    setEnableFeatures: (enableFeatures: Partial<Record<keyof Features, boolean>> | Partial<Features>) => void;
+    setQueryUpdates: (queryUpdates: BuilderQueryUpdates) => void;
+    setRequests: (requests: R) => void;
+    setSettings: (settings: S) => void;
+    getSdk: () => T;
+    getProviders: () => ProviderDataMap;
+    getEnabled: () => boolean;
+    getEnabledFeatures: () => Partial<Record<keyof Features, boolean>> | Partial<Features>;
+    getQueryUpdates: () => BuilderQueryUpdates;
+    getRequests: () => R;
+    getSettings: () => S;
+}
 export type FacetValueFilterType = {
     type?: 'facet';
     facetCode: string;
@@ -182,16 +225,16 @@ export type SinglePrice = {
     value: number;
 };
 export type Price = PriceRange | SinglePrice | number;
-export type SearchResultAsset = {
+export interface SearchResultAsset {
     id: string;
     preview: string;
-};
+}
 export type FilterInputs = {
     filters: FacetValueFilterInput[];
     priceRange?: PriceRangeInput;
     priceRangeWithTax?: PriceRangeInput;
 };
-export type SearchResult = Node & {
+export interface SearchResult {
     collectionIds: Array<string>;
     currencyCode: CurrencyCode;
     description: string;
@@ -209,47 +252,45 @@ export type SearchResult = Node & {
     score: number;
     sku: string;
     slug: string;
-    badges?: Maybe<Array<Badge>>;
-    ordinaryPrice?: Price;
-};
+}
 type ResponseResult = {
     count: number;
 };
-export type CollectionList = {
+export interface CollectionList {
     items: Array<Collection>;
     totalItems: number;
-};
-export type CollectionResult = ResponseResult & {
+}
+export interface CollectionResult extends ResponseResult {
     collection: Collection;
-};
-export type FacetValueResult = ResponseResult & {
+}
+export interface FacetValueResult extends ResponseResult {
     facetValue: FacetValue;
-};
-export type SearchResponsePriceData = {
+}
+export interface SearchResponsePriceData {
     range: PriceRange;
     rangeWithTax: PriceRange;
-};
-export type SearchResponse = {
+}
+export interface SearchResponse {
     collections: Array<CollectionResult>;
     facetValues: Array<FacetValueResult>;
     items: Array<SearchResult>;
     prices: SearchResponsePriceData;
     totalItems: number;
-};
-export type ProductResponse = {
+}
+export interface ProductResponse {
     items: Array<Product>;
-};
+}
 export interface GroupedFacetValues {
     [key: string]: FacetValue[];
 }
 export type SearchInputProps = Pick<SearchInput, 'term' | 'collectionId' | 'facetValueIds' | 'facetValueOperator' | 'facetValueFilters' | 'groupByProduct' | 'sort' | 'take' | 'skip' | 'priceRange' | 'priceRangeWithTax'>;
-export type Node = {
+export interface Node {
     id: string;
     createdAt: string;
     updatedAt: string;
     customFields?: Record<string, unknown>;
-};
-export type Channel = Node & {
+}
+export interface Channel extends Node {
     availableCurrencyCodes: Array<CurrencyCode>;
     availableLanguageCodes?: Maybe<Array<LanguageCode>>;
     code: string;
@@ -262,8 +303,8 @@ export type Channel = Node & {
     /** Not yet used - will be implemented in a future release. */
     trackInventory?: string;
     updatedAt: string;
-};
-export type Asset = Node & {
+}
+export interface Asset extends Node {
     name: string;
     type: AssetType;
     fileSize: number;
@@ -272,29 +313,22 @@ export type Asset = Node & {
     height: number;
     source: string;
     preview: string;
-};
-export type CollectionBreadcrumb = {
-    id: string;
-    name: string;
-    slug: string;
-    breadcrumbs: Array<CollectionBreadcrumb>;
-};
-export type PaginatedList<T = Node> = {
+}
+export interface PaginatedList<T = Node> {
     items: Array<T>;
     totalItems: number;
-};
-export type ProductVariantList = PaginatedList & {
+}
+export interface ProductVariantList extends PaginatedList {
     items: Array<ProductVariant>;
-};
-export type FacetList = PaginatedList & {
+}
+export interface FacetList extends PaginatedList {
     items: Array<Facet>;
-};
-export type FacetValueList = PaginatedList & {
+}
+export interface FacetValueList extends PaginatedList {
     items: Array<FacetValue>;
-};
-export type Collection = Node & {
+}
+export interface Collection extends Node {
     assets: Array<Asset>;
-    breadcrumbs: Array<CollectionBreadcrumb>;
     children?: Maybe<Array<Collection>>;
     description: string;
     featuredAsset?: Maybe<Asset>;
@@ -304,40 +338,40 @@ export type Collection = Node & {
     parentId: string;
     productVariants: ProductVariantList;
     slug: string;
-};
-export type Facet = Node & {
+}
+export interface Facet extends Node {
     code: string;
     languageCode: LanguageCode;
     name: string;
     valueList: FacetValueList;
     values: Array<FacetValue>;
-};
-export type FacetValue = Node & {
+}
+export interface FacetValue extends Node {
     code: string;
     facet: Facet;
     facetId: string;
     languageCode: LanguageCode;
     name: string;
-};
-export type ProductOption = Node & {
+}
+export interface ProductOption extends Node {
     code: string;
     group: ProductOptionGroup;
     groupId: string;
     languageCode: LanguageCode;
     name: string;
-};
-export type ProductOptionGroup = Node & {
+}
+export interface ProductOptionGroup extends Node {
     code: string;
     languageCode: LanguageCode;
     name: string;
     options: Array<ProductOption>;
-};
-export type BriefProduct = Node & {
+}
+export interface BriefProduct extends Node {
     name: string;
     slug: string;
     variants: Array<ProductVariant>;
-};
-export type Product = BriefProduct & {
+}
+export interface Product extends BriefProduct {
     assets: Array<Asset>;
     collections: Array<Collection>;
     description: string;
@@ -346,24 +380,17 @@ export type Product = BriefProduct & {
     languageCode: LanguageCode;
     optionGroups: Array<ProductOptionGroup>;
     variantList: ProductVariantList;
-    badges?: Maybe<Array<Badge>>;
-    price: Price;
-    priceWithTax: Price;
     currencyCode: CurrencyCode;
-    breadCrumbs: string;
-    ordinaryPrice?: PriceRange;
-};
-export type BriefProductVariant = Node & {
+}
+export interface BriefProductVariant extends Node {
     name: string;
     sku: string;
     price: Price;
     priceWithTax: Price;
     currencyCode: CurrencyCode;
     stockLevel: string;
-    packageSize?: number;
-    ordinaryPrice?: Price;
-};
-export type ProductVariant = BriefProductVariant & {
+}
+export interface ProductVariant extends BriefProductVariant {
     product: Product;
     productId: string;
     languageCode: LanguageCode;
@@ -375,15 +402,14 @@ export type ProductVariant = BriefProductVariant & {
     options: Array<ProductOption>;
     facetValues: Array<FacetValue>;
     customFields: Record<string, unknown>;
-    badges?: Maybe<Array<Badge>>;
-};
-export type Country = Node & {
+}
+export interface Country extends Node {
     code: LanguageCode;
     name: string;
     type: string;
     enabled: boolean;
-};
-export type Address = Node & {
+}
+export interface Address extends Node {
     fullName?: Maybe<string>;
     company?: Maybe<string>;
     streetLine1?: Maybe<string>;
@@ -395,24 +421,24 @@ export type Address = Node & {
     defaultShippingAddress?: Maybe<boolean>;
     defaultBillingAddress?: Maybe<boolean>;
     country?: Maybe<Country>;
-};
-export type CreateAddressInput = Omit<Address, 'id' | 'createdAt' | 'updatedAt' | 'country'> & {
+}
+export interface CreateAddressInput extends Omit<Address, 'id' | 'createdAt' | 'updatedAt' | 'country'> {
     streetLine1: string;
     countryCode: string;
-};
-export type OrderAddress = Omit<Address, 'id' | 'createdAt' | 'updatedAt'> & {
+}
+export interface OrderAddress extends Omit<Address, 'id' | 'createdAt' | 'updatedAt'> {
     countryCode?: Maybe<string>;
-};
-export type Customer = Node & {
+}
+export interface Customer extends Node {
     title?: Maybe<string>;
     firstName: string;
     lastName: string;
     phoneNumber?: Maybe<string>;
     emailAddress: string;
     addresses?: Maybe<Array<Address>>;
-};
+}
 export type CreateCustomerInput = Omit<Customer, 'id' | 'createdAt' | 'updatedAt' | 'addresses'>;
-export type OrderLine = Node & {
+export interface OrderLine extends Node {
     unitPrice: Price;
     unitPriceWithTax: Price;
     linePrice: Price;
@@ -428,37 +454,36 @@ export type OrderLine = Node & {
     quantity: number;
     featuredAsset?: Maybe<Asset>;
     productVariant: ProductVariant;
-    ordinaryPrice?: Price;
-};
-export type Payment = Node & {
+}
+export interface Payment extends Node {
     method: string;
     state: string;
     transactionId?: Maybe<string>;
     amount: Price;
     metadata?: Maybe<JSON>;
-};
-export type PaymentMethodQuote = Omit<Node, 'createdAt' | 'updatedAt'> & {
+}
+export interface PaymentMethodQuote extends Omit<Node, 'createdAt' | 'updatedAt'> {
     code: string;
     name: string;
     description: string;
     isEligible: boolean;
     eligibilityMessage: string;
-};
-export type ShippingMethodQuote = Omit<Node, 'createdAt' | 'updatedAt'> & {
+}
+export interface ShippingMethodQuote extends Omit<Node, 'createdAt' | 'updatedAt'> {
     price: Price;
     priceWithTax: Price;
     code: string;
     name: string;
     description: string;
     metadata: JSON;
-};
-export type OrderTaxSummary = {
+}
+export interface OrderTaxSummary {
     description: string;
     taxBase: number;
     taxRate: number;
     taxTotal: number;
-};
-export type OrderPriceData = {
+}
+export interface OrderPriceData {
     subTotal: number;
     subTotalWithTax: number;
     total: number;
@@ -467,8 +492,8 @@ export type OrderPriceData = {
     shippingWithTax: number;
     currencyCode: CurrencyCode;
     taxSummary: Array<OrderTaxSummary>;
-};
-export type Order = Node & OrderPriceData & {
+}
+export interface Order extends Node, OrderPriceData {
     code: string;
     active: boolean;
     state: string;
@@ -482,35 +507,35 @@ export type Order = Node & OrderPriceData & {
     discounts: Discount[];
     shippingLines: ShippingLine[];
     orderPlacedAt: string;
-};
-export type UpdateOrderInput = {
+}
+export interface UpdateOrderInput {
     billingAddress?: Maybe<CreateAddressInput>;
     shippingAddress?: Maybe<CreateAddressInput>;
     shippingMethodId?: Maybe<string>;
     paymentMethodCode?: Maybe<string>;
     customer?: Maybe<CreateCustomerInput>;
     customFields?: Record<string, unknown>;
-};
-export type ShippingMethod = {
+}
+export interface ShippingMethod {
     id: string;
     name: string;
-};
-export type ShippingLine = {
+}
+export interface ShippingLine {
     priceWithTax: Price;
     price: Price;
     shippingMethod: ShippingMethod;
-};
-export type HistoryEntryList = {
+}
+export interface HistoryEntryList {
     items: Array<HistoryEntry>;
     totalItems: number;
-};
-export type Discount = {
+}
+export interface Discount {
     type: string;
     description: string;
     amount: Price;
     amountWithTax: Price;
-};
-export type HistoryEntry = Node & {
+}
+export interface HistoryEntry extends Node {
     id: string;
     type: string;
     data: {
@@ -518,8 +543,8 @@ export type HistoryEntry = Node & {
         to: string;
         [key: string]: string;
     };
-};
-export type OrderFilterParameter = {
+}
+export interface OrderFilterParameter {
     CustomerMessage?: Maybe<StringOperators>;
     active?: Maybe<BooleanOperators>;
     code?: Maybe<StringOperators>;
@@ -538,8 +563,8 @@ export type OrderFilterParameter = {
     totalWithTax?: Maybe<NumberOperators>;
     type?: Maybe<StringOperators>;
     updatedAt?: Maybe<DateOperators>;
-};
-export type OrderSortParameter = {
+}
+export interface OrderSortParameter {
     CustomerMessage?: Maybe<SortOrder>;
     code?: Maybe<SortOrder>;
     createdAt?: Maybe<SortOrder>;
@@ -555,41 +580,41 @@ export type OrderSortParameter = {
     totalQuantity?: Maybe<SortOrder>;
     totalWithTax?: Maybe<SortOrder>;
     updatedAt?: Maybe<SortOrder>;
-};
-export type FacetFilterParameter = {
+}
+export interface FacetFilterParameter {
     code?: Maybe<StringOperators>;
     createdAt?: Maybe<DateOperators>;
     id?: Maybe<IdOperators>;
     languageCode?: Maybe<StringOperators>;
     name?: Maybe<StringOperators>;
     updatedAt?: Maybe<DateOperators>;
-};
-export type FacetSortParameter = {
+}
+export interface FacetSortParameter {
     code?: Maybe<SortOrder>;
     createdAt?: Maybe<SortOrder>;
     id?: Maybe<SortOrder>;
     name?: Maybe<SortOrder>;
     updatedAt?: Maybe<SortOrder>;
-};
-export type FacetListOptions = {
+}
+export interface FacetListOptions {
     filter?: Maybe<FacetFilterParameter>;
     filterOperator?: Maybe<LogicalOperator>;
     skip?: Maybe<number>;
     sort?: Maybe<FacetSortParameter>;
     take?: Maybe<number>;
-};
-export type OrderListOptions = {
+}
+export interface OrderListOptions {
     filter?: Maybe<OrderFilterParameter>;
     filterOperator?: Maybe<LogicalOperator>;
     skip?: Maybe<number>;
     sort?: Maybe<OrderSortParameter>;
     take?: Maybe<number>;
-};
-export type OrderList = PaginatedList & {
+}
+export interface OrderList extends PaginatedList {
     items: Array<Order>;
     totalItems: number;
-};
-export type Badge = {
+}
+export interface Badge {
     id: string;
     createdAt: string;
     updatedAt: string;
@@ -598,7 +623,7 @@ export type Badge = {
     position: string;
     asset: Asset;
     assetId: string;
-};
+}
 export interface CollectionSearchResponse extends Collection {
     hierarchySlug: string;
 }
@@ -608,26 +633,26 @@ export interface UseSearchFieldResponse {
     totalItems: number;
     facets: GroupedFacetValues;
 }
-export type AddItemToOrderInput = {
+export interface AddItemToOrderInput {
     productVariantId: string;
     quantity: number;
-};
-export type AdjustOrderLineInput = {
+}
+export interface AdjustOrderLineInput {
     orderLineId: string;
     quantity: number;
-};
-export type LoginInput = {
+}
+export interface LoginInput {
     username: string;
     password: string;
     rememberMe?: boolean;
-};
-export type RequestPasswordResetInput = {
+}
+export interface RequestPasswordResetInput {
     email: string;
-};
-export type ResetPasswordInput = {
+}
+export interface ResetPasswordInput {
     token: string;
     password: string;
-};
+}
 export declare enum QueryKeys {
     ACTIVE_ORDER = "activeOrder",
     ACTIVE_CHANNEL = "activeChannel",
@@ -1322,4 +1347,26 @@ export interface AsChildProps {
     style?: CSSProperties;
     children?: ReactNode;
 }
+export interface PersistOptions {
+    enabled: boolean;
+    storage?: Storage;
+    maxAge?: number;
+}
+export interface IGraphQLSDK {
+    setUpdates(updates: BuilderQueryUpdates): void;
+    getQueries(): BuilderQueries;
+    createRequest<T = unknown, Vars extends Record<string, unknown> = Record<string, unknown>>(json: BuilderQuery<Vars>, variables: ExpectedVariables<Vars>, mutation?: boolean): Promise<AxiosResponse<T>>;
+    createGraphQLQuery(json: BuilderQuery, variables?: Record<string, unknown>): {
+        query: string;
+        variables: unknown;
+        operationName: string;
+    };
+    createGraphQLMutation(json: BuilderQuery, variables?: Record<string, unknown>): {
+        query: string;
+        variables: unknown;
+        operationName: string;
+    };
+    updateFields(source: BuilderQueries, updates: BuilderQueryUpdates): BuilderQueries;
+    replaceChildObjectVariables(json: unknown, variables?: Record<string, unknown>): void;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haus-storefront-react/shared-types",
-  "version": "0.0.6-0",
+  "version": "0.0.7-0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {