@stamhoofd/structures 2.118.1 → 2.120.0

package/esm/dist/src/webshops/WebshopMetaData.d.ts

@@ -1,267 +0,0 @@
-import { AutoEncoder, AutoEncoderPatchType, Data, Decoder, PatchableDecoder } from '@simonbackx/simple-encoding';
-import { Address } from '../addresses/Address.js';
-import { City } from '../addresses/City.js';
-import { Country } from '../addresses/CountryDecoder.js';
-import { Province } from '../addresses/Province.js';
-import { DNSRecord } from '../DNSRecord.js';
-import { Replacement } from '../endpoints/EmailRequest.js';
-import { Image } from '../files/Image.js';
-import { RecordCategory } from '../members/records/RecordCategory.js';
-import { PaymentConfiguration, PrivatePaymentConfiguration } from '../PaymentConfiguration.js';
-import { PaymentMethod } from '../PaymentMethod.js';
-import { PermissionsByRole } from '../PermissionsByRole.js';
-import { Policy } from '../Policy.js';
-import { RichText } from '../RichText.js';
-import { SeatingPlan } from '../SeatingPlan.js';
-import { SponsorConfig } from '../SponsorConfig.js';
-import { Discount } from './Discount.js';
-import { TransferSettings } from './TransferSettings.js';
-import { WebshopField } from './WebshopField.js';
-export declare enum WebshopLayout {
-    Default = "Default",
-    Split = "Split"
-}
-export declare enum DarkMode {
-    Off = "Off",
-    On = "On",
-    Auto = "Auto"
-}
-export declare class WebshopTimeSlot extends AutoEncoder {
-    id: string;
-    /**
-     * Day. The time is ignored, and timezone should be same timezone as the webshop/organization
-     */
-    date: Date;
-    /**
-     * Saved in minutes since midnight
-     */
-    startTime: number;
-    /**
-     * Saved in minutes since midnight (so can also keep going after midnight to indicate an event that keeps going until e.g. 03:00)
-     */
-    endTime: number;
-    maxOrders: number | null;
-    usedOrders: number;
-    maxPersons: number | null;
-    usedPersons: number;
-    get remainingOrders(): number | null;
-    get remainingPersons(): number | null;
-    /**
-     * In case maxPersons and maxOrders are used at the same time, try to transform it onto 1 number of remainign 'stock' for this timeslot,
-     * which will be visible for customers
-     */
-    get listedRemainingStock(): number | null;
-    static sort(a: WebshopTimeSlot, b: WebshopTimeSlot): 0 | 1 | -1;
-    /**
-     * Index for sorting on both start and end time
-     */
-    get timeIndex(): string;
-    toString(): string;
-    dateString(): string;
-    dateStringShort(): string;
-    timeRangeString(): string;
-    clearStock(): void;
-}
-/**
- * Configuration to keep track of available time slots. Can be a fixed number or an infinite amount of time slots
- */
-export declare class WebshopTimeSlots extends AutoEncoder {
-    timeSlots: WebshopTimeSlot[];
-}
-export declare enum CheckoutMethodType {
-    OnSite = "OnSite",
-    Takeout = "Takeout",
-    Delivery = "Delivery"
-}
-export declare class CheckoutMethodTypeHelper {
-    static getName(type: CheckoutMethodType): string;
-}
-export declare class CheckoutMethod extends AutoEncoder {
-    id: string;
-    type: CheckoutMethodType;
-    name: string;
-    description: string;
-    timeSlots: WebshopTimeSlots;
-    get typeName(): string;
-    clearStock(): void;
-}
-export declare class WebshopTakeoutMethod extends CheckoutMethod {
-    type: CheckoutMethodType.Takeout;
-    address: Address;
-}
-/**
- * Choose a location and time to eat / consume the order
- */
-export declare class WebshopOnSiteMethod extends CheckoutMethod {
-    type: CheckoutMethodType.OnSite;
-    address: Address;
-}
-/**
- * If you want to have some sort of cost (e.g. delivery cost that is variable depending on the cart value)
- */
-export declare class CheckoutMethodPrice extends AutoEncoder {
-    price: number;
-    /**
-     * At what price of the cart the discount price should be used instead.
-     * If it is null, the discount price will never get used
-     */
-    minimumPrice: number | null;
-    discountPrice: number;
-}
-export declare class WebshopDeliveryMethod extends CheckoutMethod {
-    type: CheckoutMethodType.Delivery;
-    price: CheckoutMethodPrice;
-    cities: City[];
-    provinces: Province[];
-    countries: Country[];
-}
-export type AnyCheckoutMethod = WebshopTakeoutMethod | WebshopDeliveryMethod | WebshopOnSiteMethod;
-export type AnyCheckoutMethodPatch = AutoEncoderPatchType<WebshopTakeoutMethod> | AutoEncoderPatchType<WebshopDeliveryMethod> | AutoEncoderPatchType<WebshopOnSiteMethod>;
-export declare class AnyCheckoutMethodPatchDecoder {
-    static decode(data: Data): AnyCheckoutMethodPatch;
-    static patchType(): PatchableDecoder<AnyCheckoutMethodPatchDecoder>;
-}
-export declare class AnyCheckoutMethodDecoder {
-    static decode(data: Data): AnyCheckoutMethod;
-    static patchType(): PatchableDecoder<AnyCheckoutMethodPatch>;
-    static patchIdentifier(): Decoder<string>;
-}
-export declare enum WebshopType {
-    /**
-     * Simple webshop
-     */
-    Webshop = "Webshop",
-    Donations = "Donations",
-    TakeawayAndDelivery = "TakeawayAndDelivery",
-    Performance = "Performance",
-    Event = "Event",
-    Registrations = "Registrations"
-}
-export declare enum WebshopTicketType {
-    None = "None",
-    /**
-     * Create a single ticket for every order. Used to scan the order on takeout
-     */
-    SingleTicket = "SingleTicket",
-    /**
-     * Create a single ticket for every product in an order
-     * + this disables the use of checkout methods
-     * + this enables the use of locations and times on products
-     */
-    Tickets = "Tickets"
-}
-export declare enum WebshopStatus {
-    Open = "Open",
-    Closed = "Closed",
-    Archived = "Archived"
-}
-export declare enum WebshopNumberingType {
-    Continuous = "Continuous",
-    Random = "Random"
-}
-export declare enum WebshopAuthType {
-    Disabled = "Disabled",
-    Required = "Required"
-}
-export declare class WebshopMetaData extends AutoEncoder {
-    name: string;
-    title: string;
-    description: RichText;
-    /**
-     * Serves as a hint in the UI for better suggestions and UX.
-     */
-    ticketType: WebshopTicketType;
-    coverPhoto: Image | null;
-    allowComments: boolean;
-    phoneEnabled: boolean;
-    allowDiscountCodeEntry: boolean;
-    recordCategories: RecordCategory[];
-    /**
-     * @deprecated
-     */
-    customFields: WebshopField[];
-    checkoutMethods: CheckoutMethod[];
-    seatingPlans: SeatingPlan[];
-    reduceBranding: boolean;
-    defaultDiscounts: Discount[];
-    /**
-     * @deprecated
-     * Use paymentConfiguration.paymentMethods instead
-     */
-    oldPaymentMethods: PaymentMethod[];
-    /**
-     * @deprecated
-     * Use paymentConfiguration.transferSettings instead
-     */
-    oldTransferSettings: TransferSettings;
-    paymentConfiguration: PaymentConfiguration;
-    /**
-     * @deprecated
-     * Use paymentConfiguration.paymentMethods instead
-     */
-    get paymentMethods(): PaymentMethod[];
-    /**
-     * @deprecated
-     * Use paymentConfiguration.paymentMethods instead
-     */
-    get transferSettings(): TransferSettings;
-    policies: Policy[];
-    sponsors: SponsorConfig | null;
-    availableUntil: Date | null;
-    openAt: Date | null;
-    /**
-     * Manually close a webshop
-     */
-    status: WebshopStatus;
-    layout: WebshopLayout;
-    darkMode: DarkMode;
-    color: string | null;
-    horizontalLogo: Image | null;
-    squareLogo: Image | null;
-    horizontalLogoDark: Image | null;
-    squareLogoDark: Image | null;
-    useLogo: boolean;
-    expandLogo: boolean;
-    cartEnabled: boolean;
-    /**
-     * Whether the domain name has been validated and is active. Only used to know if this domain should get used emails and in the dashboard.
-     * This is to prevent invalid url's from being used in emails.
-     * Lookups for a given domain still work if not active
-     */
-    domainActive: boolean;
-    authType: WebshopAuthType;
-    customCode: string | null;
-    get hasTickets(): boolean;
-    get hasSingleTickets(): boolean;
-    getEmailReplacements(): Replacement[];
-}
-export declare class WebshopPrivateMetaData extends AutoEncoder {
-    /**
-     * Automatically has full access
-     */
-    authorId: string;
-    /**
-     * @deprecated
-     * Use role resources instead
-     */
-    permissions: PermissionsByRole;
-    /**
-     * @deprecated
-     * Use role resources instead
-     */
-    scanPermissions: PermissionsByRole;
-    startNumber: number;
-    /**
-     * DNS records that need to be set in order to activate mail domain and registration domain
-     */
-    dnsRecords: DNSRecord[];
-    defaultEmailId: string | null;
-    notificationEmails: string[];
-    numberingType: WebshopNumberingType;
-    static buildDNSRecords(domain: string): DNSRecord[];
-    paymentConfiguration: PrivatePaymentConfiguration;
-}
-export declare class WebshopServerMetaData extends AutoEncoder {
-    placeholder: string;
-}
-//# sourceMappingURL=WebshopMetaData.d.ts.map

package/esm/dist/src/webshops/WebshopMetaData.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebshopMetaData.d.ts","sourceRoot":"","sources":["../../../../src/webshops/WebshopMetaData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAAE,oBAAoB,EAAkB,IAAI,EAAe,OAAO,EAA6D,gBAAgB,EAAiB,MAAM,6BAA6B,CAAC;AAKtO,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAkB,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,SAAS,EAAiB,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAC/F,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,oBAAY,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;CAClB;AAED,oBAAY,QAAQ;IAChB,GAAG,QAAQ;IACX,EAAE,OAAO;IACT,IAAI,SAAS;CAChB;AAED,qBAAa,eAAgB,SAAQ,WAAW;IAE5C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IAEH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IAEH,SAAS,EAAE,MAAM,CAAW;IAE5B;;OAEG;IAEH,OAAO,EAAE,MAAM,CAAW;IAG1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAQ;IAGhC,UAAU,SAAK;IAGf,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IAGjC,WAAW,SAAK;IAEhB,IAAI,eAAe,IAAI,MAAM,GAAG,IAAI,CAKnC;IAED,IAAI,gBAAgB,IAAI,MAAM,GAAG,IAAI,CAKpC;IAED;;;OAGG;IACH,IAAI,oBAAoB,IAAI,MAAM,GAAG,IAAI,CAqBxC;IAED,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,eAAe;IAYlD;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,QAAQ;IAIR,UAAU;IAIV,eAAe;IAIf,eAAe;IAIf,UAAU;CAIb;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE7C,SAAS,EAAE,eAAe,EAAE,CAAM;CACrC;AAED,oBAAY,kBAAkB;IAC1B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACxB;AAED,qBAAa,wBAAwB;IACjC,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,GAAG,MAAM;CAUnD;AAED,qBAAa,cAAe,SAAQ,WAAW;IAE3C,EAAE,EAAE,MAAM,CAAC;IAGX,IAAI,EAAE,kBAAkB,CAAC;IAGzB,IAAI,SAAM;IAGV,WAAW,SAAM;IAGjB,SAAS,EAAE,gBAAgB,CAA+B;IAE1D,IAAI,QAAQ,WAEX;IAED,UAAU;CAKb;AAED,qBAAa,oBAAqB,SAAQ,cAAc;IAEpD,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAA8B;IAG9D,OAAO,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,cAAc;IAWnD,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAA6B;IAI5D,OAAO,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAGhD,KAAK,SAAK;IAEV;;;OAGG;IAGH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAQ;IAInC,aAAa,SAAK;CACrB;AAED,qBAAa,qBAAsB,SAAQ,cAAc;IAErD,IAAI,EAAE,kBAAkB,CAAC,QAAQ,CAA+B;IAGhE,KAAK,EAAE,mBAAmB,CAAkC;IAG5D,MAAM,EAAE,IAAI,EAAE,CAAM;IAGpB,SAAS,EAAE,QAAQ,EAAE,CAAM;IAG3B,SAAS,EAAE,OAAO,EAAE,CAAM;CAC7B;AAED,MAAM,MAAM,iBAAiB,GAAG,oBAAoB,GAAG,qBAAqB,GAAG,mBAAmB,CAAC;AACnG,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,GAAG,oBAAoB,CAAC,qBAAqB,CAAC,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;AAE1K,qBAAa,6BAA6B;IACtC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,sBAAsB;IAqBjD,MAAM,CAAC,SAAS,IAAI,gBAAgB,CAAC,6BAA6B,CAAC;CAItE;AAED,qBAAa,wBAAwB;IACjC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,iBAAiB;IAqB5C,MAAM,CAAC,SAAS,IAAI,gBAAgB,CAAC,sBAAsB,CAAC;IAK5D,MAAM,CAAC,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;CAI5C;AAED,oBAAY,WAAW;IACnB;;OAEG;IACH,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,mBAAmB,wBAAwB;IAE3C,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,aAAa,kBAAkB;CAElC;AAED,oBAAY,iBAAiB;IACzB,IAAI,SAAS;IAEb;;OAEG;IACH,YAAY,iBAAiB;IAE7B;;;;OAIG;IACH,OAAO,YAAY;CACtB;AAED,oBAAY,aAAa;IACrB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,QAAQ,aAAa;CACxB;AAED,oBAAY,oBAAoB;IAC5B,UAAU,eAAe;IACzB,MAAM,WAAW;CACpB;AAED,oBAAY,eAAe;IACvB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACxB;AAED,qBAAa,eAAgB,SAAQ,WAAW;IAE5C,IAAI,SAAM;IAGV,KAAK,SAAM;IAIX,WAAW,WAAuB;IAElC;;OAEG;IAgDH,UAAU,oBAA0B;IAGpC,UAAU,EAAE,KAAK,GAAG,IAAI,CAAQ;IAGhC,aAAa,UAAS;IAGtB,YAAY,UAAQ;IAGpB,sBAAsB,UAAS;IAG/B,gBAAgB,EAAE,cAAc,EAAE,CAAM;IAExC;;OAEG;IAEH,YAAY,EAAE,YAAY,EAAE,CAAM;IAGlC,eAAe,EAAE,cAAc,EAAE,CAAM;IAGvC,YAAY,EAAE,WAAW,EAAE,CAAM;IAGjC,cAAc,UAAS;IAGvB,gBAAgB,EAAE,QAAQ,EAAE,CAAM;IAElC;;;OAGG;IAiBH,iBAAiB,EAAE,aAAa,EAAE,CAA4B;IAE9D;;;OAGG;IAiBH,mBAAmB,mBAA+B;IAYlD,oBAAoB,uBAAmC;IAEvD;;;OAGG;IACH,IAAI,cAAc,IAAI,aAAa,EAAE,CAEpC;IAED;;;OAGG;IACH,IAAI,gBAAgB,IAAI,gBAAgB,CAEvC;IAGD,QAAQ,EAAE,MAAM,EAAE,CAAM;IAGxB,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAQ;IAGtC,cAAc,EAAE,IAAI,GAAG,IAAI,CAAQ;IAGnC,MAAM,EAAE,IAAI,GAAG,IAAI,CAAQ;IAE3B;;OAEG;IAEH,MAAM,gBAAsB;IAG5B,MAAM,gBAAyB;IAG/B,QAAQ,WAAgB;IAGxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAQ;IAG5B,cAAc,EAAE,KAAK,GAAG,IAAI,CAAQ;IAGpC,UAAU,EAAE,KAAK,GAAG,IAAI,CAAQ;IAGhC,kBAAkB,EAAE,KAAK,GAAG,IAAI,CAAQ;IAGxC,cAAc,EAAE,KAAK,GAAG,IAAI,CAAQ;IAGpC,OAAO,UAAS;IAGhB,UAAU,UAAS;IAGnB,WAAW,UAAQ;IAEnB;;;;OAIG;IAEH,YAAY,UAAS;IAGrB,QAAQ,EAAE,eAAe,CAA4B;IAGrD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEjC,IAAI,UAAU,YAEb;IAED,IAAI,gBAAgB,YAEnB;IAED,oBAAoB;CAiBvB;AAED,qBAAa,sBAAuB,SAAQ,WAAW;IACnD;;OAEG;IAEH,QAAQ,SAAM;IAEd;;;OAGG;IAEH,WAAW,oBAAgC;IAE3C;;;OAGG;IAEH,eAAe,oBAAgC;IAG/C,WAAW,SAAK;IAEhB;;OAEG;IAEH,UAAU,EAAE,SAAS,EAAE,CAAM;IAG7B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAQ;IAGrC,kBAAkB,EAAE,MAAM,EAAE,CAAM;IAGlC,aAAa,uBAAmC;IAEhD,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE;IAoBnD,oBAAoB,8BAA0C;CACjE;AAED,qBAAa,qBAAsB,SAAQ,WAAW;IAElD,WAAW,SAAM;CACpB"}