@evinvest/sites-contract 0.0.0-stage → 0.1.1

package/dist/generated/types.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Adds `addCents` to the base.
+ */
+export type AddOption = {
+    id: string;
+    labels: {
+        [key in string]: string;
+    };
+    addCents: number;
+};
+/**
+ * A storefront's address; its region and country are the site's.
+ */
+export type Address = {
+    street: string;
+    /**
+     * A French postal code: five digits.
+     */
+    postalCode: string;
+    locality: string;
+};
+/**
+ * A place's `booking` setting: the providers it has a page on, and the one it offers by
+ * default — `manual` or one of them. `manual` is always there, so never configured.
+ */
+export type BookingConfig = {
+    default: BookingProvider;
+    providers: {
+        [key in PageProvider]?: BookingPage;
+    };
+};
+/**
+ * A provider's booking page.
+ */
+export type BookingPage = {
+    url: string;
+};
+/**
+ * Where a slot is booked.
+ */
+export type BookingProvider = "manual" | "link" | "google_calendar" | "cal_com";
+/**
+ * A day of the week, as the hours name it.
+ */
+export type DayOfWeek = "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday";
+/**
+ * `discountBp` taken off the subtotal, in basis points: 1 000 is 10 % off.
+ */
+export type DiscountOption = {
+    id: string;
+    labels: {
+        [key in string]: string;
+    };
+    discountBp: number;
+};
+/**
+ * Degrees, on the globe.
+ */
+export type Geo = {
+    lat: number;
+    lng: number;
+};
+/**
+ * What a landing reads of its brand's experiments: the overrides of the current ones, by key.
+ */
+export type LiveExperiments = {
+    experiments: {
+        [key in string]: LiveOverride;
+    };
+};
+/**
+ * The fields of an override a landing takes, as it is sent them: only those set, each valid
+ * against the experiment's current declaration.
+ */
+export type LiveOverride = {
+    enabled?: boolean;
+    weights?: Array<number>;
+    holdout?: number;
+};
+/**
+ * A messenger the customer writes the brand on.
+ */
+export type Messenger = "whatsapp" | "telegram";
+/**
+ * The subtotal times `multiplyBp`, in basis points: 11 000 is ×1.1.
+ */
+export type MultiplyOption = {
+    id: string;
+    labels: {
+        [key in string]: string;
+    };
+    multiplyBp: number;
+};
+/**
+ * How one need is priced.
+ */
+export type NeedPricing = {
+    "kind": "estimate";
+    baseCents: number;
+    inputs: Array<string>;
+} | {
+    "kind": "fixed";
+    cents: number;
+};
+/**
+ * A row of opening hours, in the place's local time (Europe/Paris for every place in v1).
+ */
+export type OpeningHours = {
+    /**
+     * One at least, each once, in week order.
+     */
+    days: Array<DayOfWeek>;
+    /**
+     * `HH:MM`.
+     */
+    opens: string;
+    /**
+     * After `opens`: a night across midnight is two rows.
+     */
+    closes: string;
+};
+/**
+ * A provider with a page of its own, which a place configures: every one but `manual`,
+ * which is always available.
+ */
+export type PageProvider = "link" | "google_calendar" | "cal_com";
+/**
+ * A place's live settings: only the fields that are set. Empty: the site serves its baked
+ * config.
+ */
+export type PlaceLive = {
+    phone?: string;
+    whatsapp?: string;
+    /**
+     * The place's Telegram bot: its username, without the `@`.
+     */
+    telegram?: string;
+    /**
+     * The landing's messenger buttons switched off where `false`; a messenger left out is on.
+     */
+    messengers?: {
+        [key in Messenger]?: boolean;
+    };
+    hours?: Array<OpeningHours>;
+    /**
+     * Commune names.
+     */
+    serviceArea?: Array<string>;
+    address?: Address;
+    geo?: Geo;
+    storefrontPhoto?: string;
+    /**
+     * A text per locale; a site keeps it only when every locale it speaks is there.
+     */
+    landmark?: {
+        [key in string]: string;
+    };
+    rating?: Rating;
+    booking?: BookingConfig;
+    /**
+     * Where the place asks for a Google review.
+     */
+    reviewUrl?: string;
+};
+/**
+ * An enum the visitor answers: bedrooms, a surface band, a zone, a frequency. Its kind says
+ * what its options do, and when: every `add` first, then every `multiply`, then every
+ * `discount`.
+ */
+export type PricingInput = {
+    "kind": "add";
+    id: string;
+    labels: {
+        [key in string]: string;
+    };
+    options: Array<AddOption>;
+} | {
+    "kind": "multiply";
+    id: string;
+    labels: {
+        [key in string]: string;
+    };
+    options: Array<MultiplyOption>;
+} | {
+    "kind": "discount";
+    id: string;
+    labels: {
+        [key in string]: string;
+    };
+    options: Array<DiscountOption>;
+};
+/**
+ * A checked model, in its wire shape: every value within the limits, which keeps a price
+ * within an `i64` and a double alike. Only [`PricingModel::parse`] makes one.
+ */
+export type PricingModel = {
+    format: 1;
+    currency: "EUR";
+    /**
+     * `YYYY-MM-DD`, a day the calendar has: when the prices hold from. Stored with every lead
+     * priced by it.
+     */
+    validFrom: string;
+    /**
+     * The estimate's total is rounded half up to a multiple of this (1 = to the cent).
+     */
+    roundToCents: number;
+    /**
+     * An estimate never comes out below this, after the rounding.
+     */
+    minimumCents: number;
+    inputs: Array<PricingInput>;
+    /**
+     * By the brand's need slug; a need not here is a quote.
+     */
+    needs: {
+        [key in string]: NeedPricing;
+    };
+};
+/**
+ * Google's rating for the place, with when it was read: the API's terms cap how long a copy
+ * may be shown.
+ */
+export type Rating = {
+    /**
+     * 1 to 5.
+     */
+    value: number;
+    count: number;
+    /**
+     * An RFC 3339 instant, as sent.
+     */
+    fetchedAt: string;
+};

package/dist/generated/types.js

@@ -0,0 +1,2 @@
+// AUTO-GENERATED by `nix run .#gen` — do not edit.
+export {};