fix(types): Type fixes

.changeset/quiet-ghosts-judge.md

@@ -0,0 +1,5 @@
+---
+"@shopware-pwa/types": patch
+---
+
+improve typings of CustomFields

packages/helpers/src/media/getMedia.ts

@@ -14,14 +14,13 @@ type ProductMedia = {
  * @category Media
  */
 export function getMedia(lineItem: OrderLineItem) {
-  return lineItem.downloads.reduce(
-    (acc: [ProductMedia], current: Downloads) => {
+  return (
+    lineItem.downloads?.reduce((acc: ProductMedia[], current: Downloads) => {
       acc.push({
         id: current.id,
         fileName: `${current.media.fileName}.${current.media.fileExtension}`,
       });
       return acc;
-    },
-    []
+    }, []) || []
   );
 }

packages/types/shopware-6-client/models/checkout/customer/Customer.d.ts

@@ -7,7 +7,7 @@ import { BillingAddress } from "./BillingAddress";
 import { CustomerAddress } from "./CustomerAddress";
 import { Promotion } from "../promotion/Promotion";
 import { Tag } from "../../system/tag/Tag";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @beta
@@ -49,7 +49,7 @@ export type Customer = {
   autoIncrement: number;
   tags: Tag[] | null;
   promotions: Promotion[] | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
   productReviews: ProductReview[];
   doubleOptInConfirmDate: null | string;
   doubleOptInEmailSentDate: string;

packages/types/shopware-6-client/models/checkout/customer/CustomerAddress.d.ts

@@ -1,5 +1,5 @@
 import { Country } from "../../system/country/Country";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 import { Salutation } from "../../system/salutation/Salutation";
 
 /**
@@ -31,6 +31,6 @@ export type CustomerAddress = {
   countryState?: string;
   salutation?: Salutation | null;
   customer?: string;
-  customFields?: CustomField;
+  customFields?: CustomFields;
   id: string;
 };

packages/types/shopware-6-client/models/checkout/customer/CustomerGroup.d.ts

@@ -1,4 +1,4 @@
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -7,5 +7,5 @@ export type CustomerGroup = {
   id: string;
   name: string;
   displayGross: boolean;
-  customFields: CustomField[];
+  customFields: CustomFields;
 };

packages/types/shopware-6-client/models/checkout/customer/CustomerGroupTranslation.d.ts

@@ -1,5 +1,5 @@
 import { CustomerGroup } from "./CustomerGroup";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -8,5 +8,5 @@ export type CustomerGroupTranslation = {
   customerGroupId: string;
   name: string | null;
   customerGroup: CustomerGroup | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
 };

packages/types/shopware-6-client/models/checkout/delivery/Delivery.d.ts

@@ -1,14 +1,15 @@
 import { ShippingMethod } from "../shipping/ShippingMethod";
 import { StateMachineState } from "../../system/state-machine/StateMachineState";
 import { ShippingAddress } from "../customer/ShippingAddress";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
  */
 export type Delivery = {
   apiAlias: string;
   createdAt: string;
-  customFields: unknown | null;
+  customFields: CustomFields;
   extensions: unknown;
   id: string;
   orderId: string;

packages/types/shopware-6-client/models/checkout/delivery/DeliveryTime.d.ts

@@ -1,6 +1,6 @@
 import { ShippingMethod } from "../shipping/ShippingMethod";
 import { Entity } from "../../common/Entity";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -12,5 +12,5 @@ export type DeliveryTime = {
   unit: string;
   shippingMethods: ShippingMethod[] | null;
   translations: Entity[];
-  customFields: CustomField[];
+  customFields: CustomFields;
 };

packages/types/shopware-6-client/models/checkout/document/DocumentTypeTranslation.d.ts

@@ -1,4 +1,4 @@
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -7,5 +7,5 @@ export type DocumentTypeTranslation = {
   documentTypeId: string;
   documentType: DocumentType | null;
   name: string | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
 };

packages/types/shopware-6-client/models/checkout/order/Order.d.ts

@@ -53,7 +53,7 @@ interface OrderCustomer {
   customer: null;
   salutation: null;
   order: null;
-  customFields: null;
+  customFields: CustomFields;
   remoteAddress: string;
   _uniqueIdentifier: string;
   versionId: string;

packages/types/shopware-6-client/models/checkout/order/OrderDownloads.d.ts

@@ -1,5 +1,5 @@
 import { Media } from "../../content/media/Media";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -16,6 +16,6 @@ export type Downloads = {
   media: Media;
   accessGranted: boolean;
   id: string;
-  customFields: CustomField | null;
+  customFields: CustomFields | null;
   apiAlias: string;
 };

packages/types/shopware-6-client/models/checkout/order/OrderLineItem.d.ts

@@ -3,14 +3,15 @@ import { PriceDefinitionInterface } from "../cart/price/PriceDefinitionInterface
 import { Order } from "./Order";
 import { OrderDeliveryPosition } from "./OrderDeliveryPosition";
 import { Media } from "../../content/media/Media";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 import { Product } from "../../content/product/Product";
 import { Promotion } from "../promotion/Promotion";
-import { OrderDownloads } from "./OrderDownloads";
+import { Downloads } from "./OrderDownloads";
 /**
  * @public
  */
 export type OrderLineItem = {
+  id: string;
   orderId: string;
   identifier: string;
   referenceId: string | null;
@@ -30,9 +31,9 @@ export type OrderLineItem = {
   type: string | null;
   order: Order | null;
   orderDeliveryPosition: OrderDeliveryPosition[] | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
   cover: (Media & { url: string }) | null;
   children: OrderLineItem[] | null;
   apiAlias: "order_item";
-  downloads: OrderDownloads | null;
+  downloads: Downloads[] | null;
 };

packages/types/shopware-6-client/models/checkout/order/OrderState.d.ts

@@ -1,3 +1,5 @@
+import { CustomFields } from "../../common/CustomField";
+
 export type OrderState = {
   name: string;
   technicalName: string;
@@ -7,6 +9,6 @@ export type OrderState = {
   createdAt: Date;
   updatedAt: Date | null;
   extensions: unknown;
-  customFields: null | unknown;
+  customFields: CustomFields;
   apiAlias: string;
 };

packages/types/shopware-6-client/models/checkout/order/OrderTransaction.d.ts

@@ -2,7 +2,7 @@ import { Order } from "./Order";
 import { PaymentMethod } from "../payment/PaymentMethod";
 import { StateMachineState } from "../../system/state-machine/StateMachineState";
 import { CalculatedPrice } from "../cart/price/CalculatedPrice";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -15,5 +15,5 @@ export type OrderTransaction = {
   order: Order | null;
   stateMachineState: StateMachineState | null;
   stateId: string;
-  customFields: CustomField[];
+  customFields: CustomFields;
 };

packages/types/shopware-6-client/models/checkout/payment/PaymentMethod.d.ts

@@ -5,7 +5,7 @@ import { SalesChannel } from "../../system/sales-channel/SalesChannel";
 import { Rule } from "../../content/rule/Rule";
 import { PaymentMethodTranslation } from "./PaymentMethodTranslation";
 import { OrderTransaction } from "../order/OrderTransaction";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @beta
@@ -28,7 +28,7 @@ export type PaymentMethod = {
   availabilityRuleId: string;
   mediaId: string | null;
   media: Media | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
   formattedHandlerIDentifier: string;
   createdAt: string;
   updatedAt: string | null;

packages/types/shopware-6-client/models/checkout/payment/PaymentMethodTranslation.d.ts

@@ -1,5 +1,5 @@
 import { PaymentMethod } from "./PaymentMethod";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -9,5 +9,5 @@ export type PaymentMethodTranslation = {
   name: string | null;
   description: string | null;
   paymentMethod: PaymentMethod | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
 };

packages/types/shopware-6-client/models/checkout/shipping/ShippingMethod.d.ts

@@ -6,7 +6,7 @@ import { ShippingMethodPrice } from "./ShippingMethodPrice";
 import { Media } from "../../content/media/Media";
 import { Tag } from "../../system/tag/Tag";
 import { ShippingMethodTranslation } from "./ShippingMethodTranslation";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -23,7 +23,7 @@ export type ShippingMethod = {
   orderDeliveries: OrderDelivery[] | null;
   salesChannelDefaultAssignments: SalesChannel[] | null;
   salesChannels: SalesChannel[] | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
   availabilityRule: Rule | null;
   availabilityRuleId: string;
   prices: ShippingMethodPrice[];

packages/types/shopware-6-client/models/checkout/shipping/ShippingMethodPrice.d.ts

@@ -1,6 +1,6 @@
 import { Rule } from "../../content/rule/Rule";
 import { Currency } from "../../system/currency/Currency";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -13,7 +13,7 @@ export type ShippingMethodPrice = {
   quantityEnd: number | null;
   price: number;
   shippingMethod: ShippingMethodPrice | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
   rule: Rule | null;
   currency: Currency | null;
   calculationRuleId: string | null;

packages/types/shopware-6-client/models/checkout/shipping/ShippingMethodTranslation.d.ts

@@ -1,5 +1,5 @@
 import { ShippingMethod } from "./ShippingMethod";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -9,5 +9,5 @@ export type ShippingMethodTranslation = {
   name: string | null;
   description: string | null;
   shippingMethod: ShippingMethod | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
 };

packages/types/shopware-6-client/models/common/CustomField.d.ts

@@ -1,8 +1,3 @@
 export type CustomFields = {
   [key: string]: boolean | string | number | Date;
 };
-
-/**
- * @public
- */
-export type CustomField = unknown;

packages/types/shopware-6-client/models/content/category/Category.d.ts

@@ -4,7 +4,7 @@ import { Product } from "../product/Product";
 import { Entity } from "../../common/Entity";
 import { Tag } from "../../system/tag/Tag";
 import { CategoryTranslation } from "./CategoryTranslation";
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * Source: https://github.com/shopware/platform/blob/master/src/Core/Content/Category/CategoryDefinition.php#L50
@@ -33,7 +33,7 @@ export type Category = Entity & {
   products: Product[] | null;
   nestedProducts: Product[] | null;
   afterCategoryId: string | null;
-  customFields: CustomField[];
+  customFields: CustomFields;
   tags: Tag[] | null;
   cmsPageId: string | null;
   cmsPage: CmsPage | null;

packages/types/shopware-6-client/models/content/cms/CmsBlock.d.ts

@@ -7,13 +7,14 @@ import {
   SizingMode,
   CmsVisibility,
 } from "./CmsPage";
+import { CustomFields } from "../../common/CustomField";
 /**
  * @public
  */
 export type CmsBlock = {
   apiAlias: "cms_block";
   createdAt: string;
-  customFields: null | unknown;
+  customFields: CustomFields;
   extensions: unknown;
   id: string;
   locked: true;

packages/types/shopware-6-client/models/content/cms/CmsPage.d.ts

@@ -1,4 +1,4 @@
-import { CustomField } from "../../common/CustomField";
+import { CustomFields } from "../../common/CustomField";
 import { Category } from "../category/Category";
 import { Product } from "../product/Product";
 import { Aggregation } from "../../../search/Aggregation";
@@ -121,7 +121,7 @@ export type CmsPage = {
   category: Category;
   type: CmsPageType;
   name: string;
-  customFields: CustomField[] | null;
+  customFields: CustomFields | null;
   locked: boolean;
   _uniqueIdentifier: string;
   versionId: string | null;
@@ -174,7 +174,7 @@ export type CmsFieldConfig = {
  */
 export type OldSlot = {
   type: CmsSlotType;
-  customFields: CustomField[] | null;
+  customFields: CustomFields | null;
   locked: boolean;
   _uniqueIdentifier: string;
   versionId: string;
@@ -232,7 +232,7 @@ export type CmsSection = {
   backgroundMedia: null;
   backgroundMediaMode: BackgroundMediaMode;
   cssClass: string | null;
-  customFields: CustomField[] | null;
+  customFields: CustomFields | null;
   locked: false;
   _uniqueIdentifier: string;
   versionId: string | null;

packages/types/shopware-6-client/models/content/landing-page/LandingPage.d.ts

@@ -1,5 +1,6 @@
 import { CmsPage } from "../cms/CmsPage";
 import { SeoUrl } from "../navigation/Navigation";
+import { CustomFields } from "../../common/CustomField";
 
 /**
  * @public
@@ -28,7 +29,7 @@ export type LandingPage = {
   updatedAt: null | string;
   extensions: unknown;
   id: string;
-  customFields: null | unknown;
+  customFields: CustomFields;
   cmsPageVersionId: string;
   apiAlias: "landing_page";
 };