@passly-nl/data 1.4.3 → 1.6.0

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@passly-nl/data",
     "description": "API implementation for Passly.",
-    "version": "1.4.3",
+    "version": "1.6.0",
     "type": "module",
     "license": "MIT",
     "funding": "https://github.com/sponsors/basmilius",

package/src/adapter/EventAdapter.ts

@@ -24,6 +24,7 @@ export class EventAdapter {
             data.id,
             data.name,
             data.description,
+            data.description_plaintext,
             DateTimeAdapter.parseDateTime(data.starts_on),
             DateTimeAdapter.parseDateTime(data.ends_on),
             data.minimum_age,
@@ -88,6 +89,7 @@ export class EventAdapter {
             case 'button':
                 return new ShopElementButtonDto(
                     data.id,
+                    data.page,
                     data.icon,
                     data.text,
                     data.url
@@ -96,6 +98,7 @@ export class EventAdapter {
             case 'divider':
                 return new ShopElementDividerDto(
                     data.id,
+                    data.page,
                     data.icon,
                     data.text
                 );
@@ -103,18 +106,21 @@ export class EventAdapter {
             case 'heading':
                 return new ShopElementHeadingDto(
                     data.id,
+                    data.page,
                     data.heading_level,
                     data.title
                 );
 
             case 'information':
                 return new ShopElementInformationDto(
-                    data.id
+                    data.id,
+                    data.page
                 );
 
             case 'notice':
                 return new ShopElementNoticeDto(
                     data.id,
+                    data.page,
                     data.icon,
                     data.notice_type,
                     data.title,
@@ -124,18 +130,21 @@ export class EventAdapter {
             case 'product':
                 return new ShopElementProductDto(
                     data.id,
+                    data.page,
                     ProductAdapter.parseProduct(data.product)
                 );
 
             case 'text':
                 return new ShopElementTextDto(
                     data.id,
+                    data.page,
                     data.text
                 );
         }
 
         return new ShopElementTextDto(
             'unknown',
+            data.page,
             'Unknown element type.'
         );
     }

package/src/adapter/OrderAdapter.ts

@@ -1,5 +1,5 @@
 import { adapter, ForeignData } from '@basmilius/http-client';
-import { BuyerAdapter, DateTimeAdapter, EventAdapter, MarketingAttributionAdapter, PaymentAdapter, PublicShopAdapter } from '#data/adapter';
+import { BuyerAdapter, DateTimeAdapter, EventAdapter, FileSystemAdapter, MarketingAttributionAdapter, PaymentAdapter, PublicShopAdapter } from '#data/adapter';
 import { OrderDto, OrderLineDto, OrderPaymentProviderDto, OrderProductDto } from '#data/dto';
 import { optional, optionalArray } from '#data/util';
 
@@ -54,7 +54,8 @@ export class OrderAdapter {
             data.id,
             data.name,
             data.description,
-            data.image
+            optional(data.image, FileSystemAdapter.parsePicture),
+            data.type ?? 'ticket'
         );
     }
 }

package/src/adapter/ProductAdapter.ts

@@ -11,6 +11,7 @@ export class ProductAdapter {
             data.type,
             data.name,
             data.description,
+            data.description_plaintext,
             optional(data.price, PaymentAdapter.parseCost),
             data.max_quantity,
             data.is_active,
@@ -28,7 +29,8 @@ export class ProductAdapter {
             optional(data.sale_starts_on, DateTimeAdapter.parseDateTime),
             optional(data.sale_ends_on, DateTimeAdapter.parseDateTime),
             data.availability,
-            data.sold
+            data.sold,
+            data.is_scannable ?? true
         );
     }
 }

package/src/adapter/PublicShopAdapter.ts

@@ -38,6 +38,7 @@ export class PublicShopAdapter {
             case 'button':
                 return new PublicShopElementButtonDto(
                     data.id,
+                    data.page,
                     data.icon,
                     data.text,
                     data.url
@@ -46,6 +47,7 @@ export class PublicShopAdapter {
             case 'divider':
                 return new PublicShopElementDividerDto(
                     data.id,
+                    data.page,
                     data.icon,
                     data.text
                 );
@@ -53,18 +55,21 @@ export class PublicShopAdapter {
             case 'heading':
                 return new PublicShopElementHeadingDto(
                     data.id,
+                    data.page,
                     data.heading_level,
                     data.title
                 );
 
             case 'information':
                 return new PublicShopElementInformationDto(
-                    data.id
+                    data.id,
+                    data.page
                 );
 
             case 'notice':
                 return new PublicShopElementNoticeDto(
                     data.id,
+                    data.page,
                     data.icon,
                     data.notice_type,
                     data.title,
@@ -74,12 +79,14 @@ export class PublicShopAdapter {
             case 'product':
                 return new PublicShopElementProductDto(
                     data.id,
+                    data.page,
                     PublicShopAdapter.parsePublicShopProduct(data.product)
                 );
 
             case 'text':
                 return new PublicShopElementTextDto(
                     data.id,
+                    data.page,
                     data.text
                 );
         }
@@ -92,6 +99,7 @@ export class PublicShopAdapter {
             data.id,
             data.name,
             data.description,
+            data.description_plaintext,
             data.status,
             AddressAdapter.parseAddress(data.address),
             optional(data.header_file, FileSystemAdapter.parsePicture),
@@ -114,6 +122,7 @@ export class PublicShopAdapter {
             data.type,
             data.name,
             data.description,
+            data.description_plaintext,
             PaymentAdapter.parseCost(data.price),
             data.max_quantity,
             data.is_active,

package/src/adapter/ReservationAdapter.ts

@@ -1,5 +1,5 @@
 import { adapter, ForeignData } from '@basmilius/http-client';
-import { DateTimeAdapter, FileSystemAdapter, MarketingAttributionAdapter } from '#data/adapter';
+import { DateTimeAdapter, FileSystemAdapter, MarketingAttributionAdapter, PaymentAdapter } from '#data/adapter';
 import { ReservationDto, ReservationItemDto, ReservationProductDto } from '#data/dto';
 import { optional, optionalArray } from '#data/util';
 
@@ -28,7 +28,9 @@ export class ReservationAdapter {
             data.id,
             data.name,
             data.description,
-            optional(data.image, FileSystemAdapter.parsePicture)
+            optional(data.image, FileSystemAdapter.parsePicture),
+            PaymentAdapter.parseCost(data.price),
+            data.type ?? 'ticket'
         );
     }
 }

package/src/dto/event/EventDto.ts

@@ -29,6 +29,14 @@ export class EventDto {
         this.#description = value;
     }
 
+    get descriptionPlaintext(): string {
+        return this.#descriptionPlaintext;
+    }
+
+    set descriptionPlaintext(value: string) {
+        this.#descriptionPlaintext = value;
+    }
+
     get startsOn(): DateTime {
         return this.#startsOn;
     }
@@ -96,6 +104,7 @@ export class EventDto {
     #id: string;
     #name: string;
     #description: string;
+    #descriptionPlaintext: string;
     #startsOn: DateTime;
     #endsOn: DateTime;
     #minimumAge: number;
@@ -105,10 +114,11 @@ export class EventDto {
     #createdOn: DateTime;
     #updatedOn: DateTime;
 
-    constructor(id: string, name: string, description: string, startsOn: DateTime, endsOn: DateTime, minimumAge: number, status: EventStatus, address: AddressDto, headerFile: PictureDto | null, createdOn: DateTime, updatedOn: DateTime) {
+    constructor(id: string, name: string, description: string, descriptionPlaintext: string, startsOn: DateTime, endsOn: DateTime, minimumAge: number, status: EventStatus, address: AddressDto, headerFile: PictureDto | null, createdOn: DateTime, updatedOn: DateTime) {
         this.#id = id;
         this.#name = name;
         this.#description = description;
+        this.#descriptionPlaintext = descriptionPlaintext;
         this.#startsOn = startsOn;
         this.#endsOn = endsOn;
         this.#minimumAge = minimumAge;

package/src/dto/event/ShopElementButtonDto.ts

@@ -1,6 +1,7 @@
 import { dto } from '@basmilius/http-client';
 import type { FluxIconName } from '@flux-ui/types';
 import { ShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class ShopElementButtonDto extends ShopElementDto {
@@ -32,8 +33,8 @@ export class ShopElementButtonDto extends ShopElementDto {
     #text: string;
     #url: string;
 
-    constructor(id: string, icon: FluxIconName | null, text: string, url: string) {
-        super(id, 'button');
+    constructor(id: string, page: ShopElementPage, icon: FluxIconName | null, text: string, url: string) {
+        super(id, 'button', page);
         this.#icon = icon;
         this.#text = text;
         this.#url = url;

package/src/dto/event/ShopElementDividerDto.ts

@@ -1,6 +1,7 @@
 import { dto } from '@basmilius/http-client';
 import type { FluxIconName } from '@flux-ui/types';
 import { ShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class ShopElementDividerDto extends ShopElementDto {
@@ -23,8 +24,8 @@ export class ShopElementDividerDto extends ShopElementDto {
     #icon: FluxIconName | null;
     #text: string | null;
 
-    constructor(id: string, icon: FluxIconName | null, text: string | null) {
-        super(id, 'divider');
+    constructor(id: string, page: ShopElementPage, icon: FluxIconName | null, text: string | null) {
+        super(id, 'divider', page);
         this.#icon = icon;
         this.#text = text;
     }

package/src/dto/event/ShopElementDto.ts

@@ -1,4 +1,4 @@
-import type { ShopElementType } from '#data/types';
+import type { ShopElementPage, ShopElementType } from '#data/types';
 
 export abstract class ShopElementDto {
     get id(): string {
@@ -9,6 +9,14 @@ export abstract class ShopElementDto {
         this.#id = value;
     }
 
+    get page(): ShopElementPage {
+        return this.#page;
+    }
+
+    set page(value: ShopElementPage) {
+        this.#page = value;
+    }
+
     get type(): ShopElementType {
         return this.#type;
     }
@@ -18,10 +26,12 @@ export abstract class ShopElementDto {
     }
 
     #id: string;
+    #page: ShopElementPage;
     #type: ShopElementType;
 
-    protected constructor(id: string, type: ShopElementType) {
+    protected constructor(id: string, type: ShopElementType, page: ShopElementPage) {
         this.#id = id;
+        this.#page = page;
         this.#type = type;
     }
 }

package/src/dto/event/ShopElementHeadingDto.ts

@@ -1,6 +1,6 @@
 import { dto } from '@basmilius/http-client';
 import { ShopElementDto } from '#data/dto';
-import type { HeadingLevel } from '#data/types';
+import type { HeadingLevel, ShopElementPage } from '#data/types';
 
 @dto
 export class ShopElementHeadingDto extends ShopElementDto {
@@ -23,8 +23,8 @@ export class ShopElementHeadingDto extends ShopElementDto {
     #headingLevel: HeadingLevel;
     #title: string;
 
-    constructor(id: string, headingLevel: HeadingLevel, title: string) {
-        super(id, 'heading');
+    constructor(id: string, page: ShopElementPage, headingLevel: HeadingLevel, title: string) {
+        super(id, 'heading', page);
         this.#headingLevel = headingLevel;
         this.#title = title;
     }

package/src/dto/event/ShopElementInformationDto.ts

@@ -1,9 +1,10 @@
 import { dto } from '@basmilius/http-client';
 import { ShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class ShopElementInformationDto extends ShopElementDto {
-    constructor(id: string) {
-        super(id, 'information');
+    constructor(id: string, page: ShopElementPage) {
+        super(id, 'information', page);
     }
 }

package/src/dto/event/ShopElementNoticeDto.ts

@@ -1,7 +1,7 @@
 import { dto } from '@basmilius/http-client';
 import type { FluxIconName } from '@flux-ui/types';
 import { ShopElementDto } from '#data/dto';
-import type { NoticeType } from '#data/types';
+import type { NoticeType, ShopElementPage } from '#data/types';
 
 @dto
 export class ShopElementNoticeDto extends ShopElementDto {
@@ -42,8 +42,8 @@ export class ShopElementNoticeDto extends ShopElementDto {
     #title: string | null;
     #text: string;
 
-    constructor(id: string, icon: FluxIconName, noticeType: NoticeType, title: string | null, text: string) {
-        super(id, 'notice');
+    constructor(id: string, page: ShopElementPage, icon: FluxIconName, noticeType: NoticeType, title: string | null, text: string) {
+        super(id, 'notice', page);
         this.#icon = icon;
         this.#noticeType = noticeType;
         this.#title = title;

package/src/dto/event/ShopElementProductDto.ts

@@ -1,5 +1,6 @@
 import { dto } from '@basmilius/http-client';
 import { type ProductDto, ShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class ShopElementProductDto extends ShopElementDto {
@@ -13,8 +14,8 @@ export class ShopElementProductDto extends ShopElementDto {
 
     #product: ProductDto;
 
-    constructor(id: string, product: ProductDto) {
-        super(id, 'product');
+    constructor(id: string, page: ShopElementPage, product: ProductDto) {
+        super(id, 'product', page);
         this.#product = product;
     }
 }

package/src/dto/event/ShopElementTextDto.ts

@@ -1,5 +1,6 @@
 import { dto } from '@basmilius/http-client';
 import { ShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class ShopElementTextDto extends ShopElementDto {
@@ -13,8 +14,8 @@ export class ShopElementTextDto extends ShopElementDto {
 
     #text: string;
 
-    constructor(id: string, text: string) {
-        super(id, 'text');
+    constructor(id: string, page: ShopElementPage, text: string) {
+        super(id, 'text', page);
         this.#text = text;
     }
 }

package/src/dto/order/OrderProductDto.ts

@@ -1,5 +1,6 @@
 import { dto } from '@basmilius/http-client';
 import type { PictureDto } from '#data/dto';
+import type { ProductType } from '#data/types';
 
 @dto
 export class OrderProductDto {
@@ -35,15 +36,25 @@ export class OrderProductDto {
         this.#image = value;
     }
 
+    get type(): ProductType {
+        return this.#type;
+    }
+
+    set type(value: ProductType) {
+        this.#type = value;
+    }
+
     #id: string;
     #name: string;
     #description: string;
     #image: PictureDto | null;
+    #type: ProductType;
 
-    constructor(id: string, name: string, description: string, image: PictureDto | null) {
+    constructor(id: string, name: string, description: string, image: PictureDto | null, type: ProductType) {
         this.#id = id;
         this.#name = name;
         this.#description = description;
         this.#image = image;
+        this.#type = type;
     }
 }

package/src/dto/product/ProductDto.ts

@@ -37,6 +37,14 @@ export class ProductDto {
         this.#description = value;
     }
 
+    get descriptionPlaintext(): string {
+        return this.#descriptionPlaintext;
+    }
+
+    set descriptionPlaintext(value: string) {
+        this.#descriptionPlaintext = value;
+    }
+
     get price(): CostDto {
         return this.#price;
     }
@@ -69,6 +77,14 @@ export class ProductDto {
         this.#isPersonalizationRequired = value;
     }
 
+    get isScannable(): boolean {
+        return this.#isScannable;
+    }
+
+    set isScannable(value: boolean) {
+        this.#isScannable = value;
+    }
+
     get isSwappable(): boolean {
         return this.#isSwappable;
     }
@@ -185,6 +201,7 @@ export class ProductDto {
     #type: ProductType;
     #name: string;
     #description: string;
+    #descriptionPlaintext: string;
     #price: CostDto;
     #maxQuantity: number;
     #isActive: boolean;
@@ -203,12 +220,14 @@ export class ProductDto {
     #saleEndsOn: DateTime | null;
     #availability: ProductAvailability;
     #sold: number;
+    #isScannable: boolean;
 
-    constructor(id: string, type: ProductType, name: string, description: string, price: CostDto, maxQuantity: number, isActive: boolean, isPersonalizationRequired: boolean, isSwappable: boolean, isTimeslotted: boolean, timeSlots: TimeSlotDto[], remainingStock: number, stock: StockPoolDto, hasSales: boolean, image: PictureDto, images: PictureDto[], ticketsReleasedOn: DateTime | null, showWhenUnavailable: boolean, saleStartsOn: DateTime | null, saleEndsOn: DateTime | null, availability: ProductAvailability, sold: number) {
+    constructor(id: string, type: ProductType, name: string, description: string, descriptionPlaintext: string, price: CostDto, maxQuantity: number, isActive: boolean, isPersonalizationRequired: boolean, isSwappable: boolean, isTimeslotted: boolean, timeSlots: TimeSlotDto[], remainingStock: number, stock: StockPoolDto, hasSales: boolean, image: PictureDto, images: PictureDto[], ticketsReleasedOn: DateTime | null, showWhenUnavailable: boolean, saleStartsOn: DateTime | null, saleEndsOn: DateTime | null, availability: ProductAvailability, sold: number, isScannable: boolean = true) {
         this.#id = id;
         this.#type = type;
         this.#name = name;
         this.#description = description;
+        this.#descriptionPlaintext = descriptionPlaintext;
         this.#price = price;
         this.#maxQuantity = maxQuantity;
         this.#isActive = isActive;
@@ -227,5 +246,6 @@ export class ProductDto {
         this.#saleEndsOn = saleEndsOn;
         this.#availability = availability;
         this.#sold = sold;
+        this.#isScannable = isScannable;
     }
 }

package/src/dto/publicShop/PublicShopElementButtonDto.ts

@@ -1,6 +1,7 @@
 import { dto } from '@basmilius/http-client';
 import type { FluxIconName } from '@flux-ui/types';
 import { PublicShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class PublicShopElementButtonDto extends PublicShopElementDto {
@@ -32,8 +33,8 @@ export class PublicShopElementButtonDto extends PublicShopElementDto {
     #text: string;
     #url: string;
 
-    constructor(id: string, icon: FluxIconName | null, text: string, url: string) {
-        super(id, 'button');
+    constructor(id: string, page: ShopElementPage, icon: FluxIconName | null, text: string, url: string) {
+        super(id, 'button', page);
         this.#icon = icon;
         this.#text = text;
         this.#url = url;

package/src/dto/publicShop/PublicShopElementDividerDto.ts

@@ -1,6 +1,7 @@
 import { dto } from '@basmilius/http-client';
 import type { FluxIconName } from '@flux-ui/types';
 import { PublicShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class PublicShopElementDividerDto extends PublicShopElementDto {
@@ -23,8 +24,8 @@ export class PublicShopElementDividerDto extends PublicShopElementDto {
     #icon: FluxIconName | null;
     #text: string | null;
 
-    constructor(id: string, icon: FluxIconName | null, text: string | null) {
-        super(id, 'divider');
+    constructor(id: string, page: ShopElementPage, icon: FluxIconName | null, text: string | null) {
+        super(id, 'divider', page);
         this.#icon = icon;
         this.#text = text;
     }

package/src/dto/publicShop/PublicShopElementDto.ts

@@ -1,4 +1,4 @@
-import type { PublicShopElementType } from '#data/types';
+import type { PublicShopElementType, ShopElementPage } from '#data/types';
 
 export abstract class PublicShopElementDto {
     get id(): string {
@@ -9,6 +9,14 @@ export abstract class PublicShopElementDto {
         this.#id = value;
     }
 
+    get page(): ShopElementPage {
+        return this.#page;
+    }
+
+    set page(value: ShopElementPage) {
+        this.#page = value;
+    }
+
     get type(): PublicShopElementType {
         return this.#type;
     }
@@ -18,10 +26,12 @@ export abstract class PublicShopElementDto {
     }
 
     #id: string;
+    #page: ShopElementPage;
     #type: PublicShopElementType;
 
-    protected constructor(id: string, type: PublicShopElementType) {
+    protected constructor(id: string, type: PublicShopElementType, page: ShopElementPage) {
         this.#id = id;
+        this.#page = page;
         this.#type = type;
     }
 }

package/src/dto/publicShop/PublicShopElementHeadingDto.ts

@@ -1,6 +1,6 @@
 import { dto } from '@basmilius/http-client';
 import { PublicShopElementDto } from '#data/dto';
-import type { HeadingLevel } from '#data/types';
+import type { HeadingLevel, ShopElementPage } from '#data/types';
 
 @dto
 export class PublicShopElementHeadingDto extends PublicShopElementDto {
@@ -23,8 +23,8 @@ export class PublicShopElementHeadingDto extends PublicShopElementDto {
     #headingLevel: HeadingLevel;
     #title: string;
 
-    constructor(id: string, headingLevel: HeadingLevel, title: string) {
-        super(id, 'heading');
+    constructor(id: string, page: ShopElementPage, headingLevel: HeadingLevel, title: string) {
+        super(id, 'heading', page);
         this.#headingLevel = headingLevel;
         this.#title = title;
     }

package/src/dto/publicShop/PublicShopElementInformationDto.ts

@@ -1,9 +1,10 @@
 import { dto } from '@basmilius/http-client';
 import { PublicShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class PublicShopElementInformationDto extends PublicShopElementDto {
-    constructor(id: string) {
-        super(id, 'information');
+    constructor(id: string, page: ShopElementPage) {
+        super(id, 'information', page);
     }
 }

package/src/dto/publicShop/PublicShopElementNoticeDto.ts

@@ -1,7 +1,7 @@
 import { dto } from '@basmilius/http-client';
 import type { FluxIconName } from '@flux-ui/types';
 import { PublicShopElementDto } from '#data/dto';
-import type { NoticeType } from '#data/types';
+import type { NoticeType, ShopElementPage } from '#data/types';
 
 @dto
 export class PublicShopElementNoticeDto extends PublicShopElementDto {
@@ -42,8 +42,8 @@ export class PublicShopElementNoticeDto extends PublicShopElementDto {
     #title: string | null;
     #text: string;
 
-    constructor(id: string, icon: FluxIconName, noticeType: NoticeType, title: string | null, text: string) {
-        super(id, 'notice');
+    constructor(id: string, page: ShopElementPage, icon: FluxIconName, noticeType: NoticeType, title: string | null, text: string) {
+        super(id, 'notice', page);
         this.#icon = icon;
         this.#noticeType = noticeType;
         this.#title = title;

package/src/dto/publicShop/PublicShopElementProductDto.ts

@@ -1,5 +1,6 @@
 import { dto } from '@basmilius/http-client';
 import { PublicShopElementDto, type PublicShopProductDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class PublicShopElementProductDto extends PublicShopElementDto {
@@ -13,8 +14,8 @@ export class PublicShopElementProductDto extends PublicShopElementDto {
 
     #product: PublicShopProductDto;
 
-    constructor(id: string, product: PublicShopProductDto) {
-        super(id, 'product');
+    constructor(id: string, page: ShopElementPage, product: PublicShopProductDto) {
+        super(id, 'product', page);
         this.#product = product;
     }
 }

package/src/dto/publicShop/PublicShopElementTextDto.ts

@@ -1,5 +1,6 @@
 import { dto } from '@basmilius/http-client';
 import { PublicShopElementDto } from '#data/dto';
+import type { ShopElementPage } from '#data/types';
 
 @dto
 export class PublicShopElementTextDto extends PublicShopElementDto {
@@ -13,8 +14,8 @@ export class PublicShopElementTextDto extends PublicShopElementDto {
 
     #text: string;
 
-    constructor(id: string, text: string) {
-        super(id, 'text');
+    constructor(id: string, page: ShopElementPage, text: string) {
+        super(id, 'text', page);
         this.#text = text;
     }
 }