@peektravel/app-utilities 0.9.3 → 0.9.4

package/dist/index.d.cts

@@ -400,7 +400,12 @@ interface ProductMeetingLocation {
 }
 /** A single bookable sub-option (resource option or add-on item option). */
 interface ProductTicket {
-    /** Unique identifier of the ticket / option. */
+    /**
+     * Unique identifier of the ticket / option. This is also the
+     * **`resourceOptionId`** — the id passed as a ticket's `resourceOptionId` when
+     * creating a booking (see {@link CreateBookingTicket}) and reported per slot by
+     * {@link AvailabilityService.getAvailabilityTimes}.
+     */
     id: string;
     /** Human-readable name of the ticket / option. */
     name: string;
@@ -848,6 +853,11 @@ interface BookingTimeRangeSearch extends BookingReadOptions {
 type NoteMode = "append" | "overwrite";
 /** A requested ticket (resource option) and quantity for a new booking. */
 interface CreateBookingTicket {
+    /**
+     * The resource option to book — this is the {@link ProductTicket.id} from the
+     * activity's `tickets` (also reported per slot by
+     * {@link AvailabilityService.getAvailabilityTimes}).
+     */
     resourceOptionId: string;
     quantity: number;
 }
@@ -991,56 +1001,44 @@ type MetaDataVolumeUnit = "GALLON";
  * `number`; `Decimal` values are kept as strings to avoid float-precision loss;
  * `Date`/`Time` values are ISO strings.
  *
- * Every variant also carries a `displayValue` — a human-readable, display-safe
- * string rendering of the value (empty when the underlying value is absent). The
- * `html` variant's `displayValue` is HTML-escaped so it is safe to render as
- * text.
+ * A human-readable, display-safe rendering of the value lives on the parent
+ * {@link MetaData.displayValue}, not here.
  */
 type MetaDataValue = {
     kind: "age";
     age: number;
-    displayValue: string;
 } | {
     kind: "attachment";
     attachmentUrl: string;
     mime: string | null;
     name: string | null;
     size: number | null;
-    displayValue: string;
 } | {
     kind: "barcode";
     barcodeType: MetaDataBarcodeType | null;
     barcodeValue: string;
-    displayValue: string;
 } | {
     kind: "boolean";
     boolean: boolean;
-    displayValue: string;
 } | {
     kind: "checkbox";
     isChecked: boolean;
-    displayValue: string;
 } | {
     kind: "currency";
     currency: string;
-    displayValue: string;
 } | {
     kind: "date";
     date: string;
-    displayValue: string;
 } | {
     kind: "decimal";
     decimal: string | null;
-    displayValue: string;
 } | {
     kind: "duration";
     amount: number;
     unit: MetaDataDurationUnit | null;
-    displayValue: string;
 } | {
     kind: "email";
     email: string | null;
-    displayValue: string;
 } | {
     kind: "guest";
     name: string | null;
@@ -1048,19 +1046,15 @@ type MetaDataValue = {
     dateOfBirth: string | null;
     notes: string | null;
     waiverSigned: boolean | null;
-    displayValue: string;
 } | {
     kind: "html";
     html: string;
-    displayValue: string;
 } | {
     kind: "imageUrl";
     imageUrl: string;
-    displayValue: string;
 } | {
     kind: "integer";
     integer: number;
-    displayValue: string;
 } | {
     kind: "location";
     country: string | null;
@@ -1069,45 +1063,35 @@ type MetaDataValue = {
     postalCode: string | null;
     region: string | null;
     streetAddress: string | null;
-    displayValue: string;
 } | {
     kind: "longText";
     longText: string;
-    displayValue: string;
 } | {
     kind: "meta";
     meta: unknown;
-    displayValue: string;
 } | {
     kind: "percent";
     percent: string | null;
-    displayValue: string;
 } | {
     kind: "phone";
     phone: string;
-    displayValue: string;
 } | {
     kind: "shortText";
     shortText: string;
-    displayValue: string;
 } | {
     kind: "time";
     time: string;
-    displayValue: string;
 } | {
     kind: "url";
     url: string | null;
-    displayValue: string;
 } | {
     kind: "volume";
     amount: string;
     unit: MetaDataVolumeUnit | null;
-    displayValue: string;
 } | {
     kind: "weight";
     amount: string;
     unit: MetaDataWeightUnit | null;
-    displayValue: string;
 };
 /** A single booking custom-field response (one `fieldResponse`). */
 interface MetaData {
@@ -1117,8 +1101,8 @@ interface MetaData {
     name: string;
     /**
      * Field slug. When an `integrator` filter is applied, the matched
-     * `integrator:<integrator>:` prefix is stripped off (e.g.
-     * `integrator:bob:booking_url` → `booking_url`).
+     * `integrators:<integrator>:` prefix is stripped off (e.g.
+     * `integrators:bob:booking_url` → `booking_url`).
      */
     slug: string;
     /** Raw field type reported by the gateway (kept as a string). */
@@ -1131,6 +1115,12 @@ interface MetaData {
     isRequired: boolean;
     /** The response's reference id. */
     refid: string;
+    /**
+     * A human-readable, display-safe string rendering of the value. Always
+     * present — `""` when the value is absent or of an unrecognized variant. The
+     * `html` value's rendering is HTML-escaped so it is safe to render as text.
+     */
+    displayValue: string;
     /**
      * The typed response value, or `null` when absent or of an unrecognized
      * (future) variant.
@@ -1345,7 +1335,7 @@ interface BookingServiceOptions {
     accessOptions?: AccessOptions;
     /**
      * Integrator id used to scope `getMetaData` results — only fields whose slug
-     * starts with `integrator:<integrator>:` are returned. Defaults to `""` (set
+     * starts with `integrators:<integrator>:` are returned. Defaults to `""` (set
      * by the access service to the install's issuer).
      */
     integrator?: string;
@@ -1406,7 +1396,7 @@ declare class BookingService {
     /**
      * Returns a booking's custom-field metadata (its `fieldResponses`), scoped to
      * this service's integrator. Only fields whose slug starts with
-     * `integrator:<integrator>:` are returned, and that prefix is stripped from
+     * `integrators:<integrator>:` are returned, and that prefix is stripped from
      * each returned `slug`. Returns `[]` when the booking is not found or has no
      * matching fields.
      *

package/dist/index.d.ts

@@ -400,7 +400,12 @@ interface ProductMeetingLocation {
 }
 /** A single bookable sub-option (resource option or add-on item option). */
 interface ProductTicket {
-    /** Unique identifier of the ticket / option. */
+    /**
+     * Unique identifier of the ticket / option. This is also the
+     * **`resourceOptionId`** — the id passed as a ticket's `resourceOptionId` when
+     * creating a booking (see {@link CreateBookingTicket}) and reported per slot by
+     * {@link AvailabilityService.getAvailabilityTimes}.
+     */
     id: string;
     /** Human-readable name of the ticket / option. */
     name: string;
@@ -848,6 +853,11 @@ interface BookingTimeRangeSearch extends BookingReadOptions {
 type NoteMode = "append" | "overwrite";
 /** A requested ticket (resource option) and quantity for a new booking. */
 interface CreateBookingTicket {
+    /**
+     * The resource option to book — this is the {@link ProductTicket.id} from the
+     * activity's `tickets` (also reported per slot by
+     * {@link AvailabilityService.getAvailabilityTimes}).
+     */
     resourceOptionId: string;
     quantity: number;
 }
@@ -991,56 +1001,44 @@ type MetaDataVolumeUnit = "GALLON";
  * `number`; `Decimal` values are kept as strings to avoid float-precision loss;
  * `Date`/`Time` values are ISO strings.
  *
- * Every variant also carries a `displayValue` — a human-readable, display-safe
- * string rendering of the value (empty when the underlying value is absent). The
- * `html` variant's `displayValue` is HTML-escaped so it is safe to render as
- * text.
+ * A human-readable, display-safe rendering of the value lives on the parent
+ * {@link MetaData.displayValue}, not here.
  */
 type MetaDataValue = {
     kind: "age";
     age: number;
-    displayValue: string;
 } | {
     kind: "attachment";
     attachmentUrl: string;
     mime: string | null;
     name: string | null;
     size: number | null;
-    displayValue: string;
 } | {
     kind: "barcode";
     barcodeType: MetaDataBarcodeType | null;
     barcodeValue: string;
-    displayValue: string;
 } | {
     kind: "boolean";
     boolean: boolean;
-    displayValue: string;
 } | {
     kind: "checkbox";
     isChecked: boolean;
-    displayValue: string;
 } | {
     kind: "currency";
     currency: string;
-    displayValue: string;
 } | {
     kind: "date";
     date: string;
-    displayValue: string;
 } | {
     kind: "decimal";
     decimal: string | null;
-    displayValue: string;
 } | {
     kind: "duration";
     amount: number;
     unit: MetaDataDurationUnit | null;
-    displayValue: string;
 } | {
     kind: "email";
     email: string | null;
-    displayValue: string;
 } | {
     kind: "guest";
     name: string | null;
@@ -1048,19 +1046,15 @@ type MetaDataValue = {
     dateOfBirth: string | null;
     notes: string | null;
     waiverSigned: boolean | null;
-    displayValue: string;
 } | {
     kind: "html";
     html: string;
-    displayValue: string;
 } | {
     kind: "imageUrl";
     imageUrl: string;
-    displayValue: string;
 } | {
     kind: "integer";
     integer: number;
-    displayValue: string;
 } | {
     kind: "location";
     country: string | null;
@@ -1069,45 +1063,35 @@ type MetaDataValue = {
     postalCode: string | null;
     region: string | null;
     streetAddress: string | null;
-    displayValue: string;
 } | {
     kind: "longText";
     longText: string;
-    displayValue: string;
 } | {
     kind: "meta";
     meta: unknown;
-    displayValue: string;
 } | {
     kind: "percent";
     percent: string | null;
-    displayValue: string;
 } | {
     kind: "phone";
     phone: string;
-    displayValue: string;
 } | {
     kind: "shortText";
     shortText: string;
-    displayValue: string;
 } | {
     kind: "time";
     time: string;
-    displayValue: string;
 } | {
     kind: "url";
     url: string | null;
-    displayValue: string;
 } | {
     kind: "volume";
     amount: string;
     unit: MetaDataVolumeUnit | null;
-    displayValue: string;
 } | {
     kind: "weight";
     amount: string;
     unit: MetaDataWeightUnit | null;
-    displayValue: string;
 };
 /** A single booking custom-field response (one `fieldResponse`). */
 interface MetaData {
@@ -1117,8 +1101,8 @@ interface MetaData {
     name: string;
     /**
      * Field slug. When an `integrator` filter is applied, the matched
-     * `integrator:<integrator>:` prefix is stripped off (e.g.
-     * `integrator:bob:booking_url` → `booking_url`).
+     * `integrators:<integrator>:` prefix is stripped off (e.g.
+     * `integrators:bob:booking_url` → `booking_url`).
      */
     slug: string;
     /** Raw field type reported by the gateway (kept as a string). */
@@ -1131,6 +1115,12 @@ interface MetaData {
     isRequired: boolean;
     /** The response's reference id. */
     refid: string;
+    /**
+     * A human-readable, display-safe string rendering of the value. Always
+     * present — `""` when the value is absent or of an unrecognized variant. The
+     * `html` value's rendering is HTML-escaped so it is safe to render as text.
+     */
+    displayValue: string;
     /**
      * The typed response value, or `null` when absent or of an unrecognized
      * (future) variant.
@@ -1345,7 +1335,7 @@ interface BookingServiceOptions {
     accessOptions?: AccessOptions;
     /**
      * Integrator id used to scope `getMetaData` results — only fields whose slug
-     * starts with `integrator:<integrator>:` are returned. Defaults to `""` (set
+     * starts with `integrators:<integrator>:` are returned. Defaults to `""` (set
      * by the access service to the install's issuer).
      */
     integrator?: string;
@@ -1406,7 +1396,7 @@ declare class BookingService {
     /**
      * Returns a booking's custom-field metadata (its `fieldResponses`), scoped to
      * this service's integrator. Only fields whose slug starts with
-     * `integrator:<integrator>:` are returned, and that prefix is stripped from
+     * `integrators:<integrator>:` are returned, and that prefix is stripped from
      * each returned `slug`. Returns `[]` when the booking is not found or has no
      * matching fields.
      *

package/dist/index.js

@@ -939,6 +939,7 @@ function fromBookingMetaDataNode(node) {
 function fromFieldResponseNode(response) {
   const field = response.fieldLocation?.field;
   const prompt = response.fieldLocation?.prompt;
+  const { value, displayValue } = fromValueNode(response.value);
   return {
     id: field?.id || "",
     name: field?.name || "",
@@ -948,89 +949,96 @@ function fromFieldResponseNode(response) {
     promptHint: prompt?.hint ?? null,
     isRequired: Boolean(prompt?.isRequired),
     refid: response.refid || "",
-    value: fromValueNode(response.value)
+    displayValue,
+    value
   };
 }
 function fromValueNode(value) {
-  if (!value || !value.__typename) return null;
+  if (!value || !value.__typename) return { value: null, displayValue: "" };
   switch (value.__typename) {
     case "AgeFieldResponseValue": {
       const age = value.age ?? 0;
-      return { kind: "age", age, displayValue: String(age) };
+      return { value: { kind: "age", age }, displayValue: String(age) };
     }
     case "AttachmentFieldResponseValue": {
       const attachmentUrl = value.attachmentUrl ?? "";
       const name = value.name ?? null;
       return {
-        kind: "attachment",
-        attachmentUrl,
-        mime: value.mime ?? null,
-        name,
-        size: value.size ?? null,
+        value: {
+          kind: "attachment",
+          attachmentUrl,
+          mime: value.mime ?? null,
+          name,
+          size: value.size ?? null
+        },
         displayValue: name || attachmentUrl
       };
     }
     case "BarcodeFieldResponseValue": {
       const barcodeValue = value.barcodeValue ?? "";
       return {
-        kind: "barcode",
-        barcodeType: value.barcodeType ?? null,
-        barcodeValue,
+        value: {
+          kind: "barcode",
+          barcodeType: value.barcodeType ?? null,
+          barcodeValue
+        },
         displayValue: barcodeValue
       };
     }
     case "BooleanFieldResponseValue": {
       const bool = Boolean(value.boolean);
-      return { kind: "boolean", boolean: bool, displayValue: yesNo(bool) };
+      return { value: { kind: "boolean", boolean: bool }, displayValue: yesNo(bool) };
     }
     case "CheckboxFieldResponseValue": {
       const isChecked = Boolean(value.isChecked);
-      return { kind: "checkbox", isChecked, displayValue: yesNo(isChecked) };
+      return { value: { kind: "checkbox", isChecked }, displayValue: yesNo(isChecked) };
     }
     case "CurrencyFieldResponseValue": {
       const currency = value.currency ?? "";
-      return { kind: "currency", currency, displayValue: currency };
+      return { value: { kind: "currency", currency }, displayValue: currency };
     }
     case "DateFieldResponseValue": {
       const date = value.date ?? "";
-      return { kind: "date", date, displayValue: date };
+      return { value: { kind: "date", date }, displayValue: date };
     }
     case "DecimalFieldResponseValue": {
       const decimal = value.decimal ?? null;
-      return { kind: "decimal", decimal, displayValue: decimal ?? "" };
+      return { value: { kind: "decimal", decimal }, displayValue: decimal ?? "" };
     }
     case "DurationFieldResponseValue": {
       const amount = value.duration?.amount ?? 0;
       const unit = value.duration?.unit ?? null;
-      return { kind: "duration", amount, unit, displayValue: amountUnit(amount, unit) };
+      return { value: { kind: "duration", amount, unit }, displayValue: amountUnit(amount, unit) };
     }
     case "EmailFieldResponseValue": {
       const email = value.email ?? null;
-      return { kind: "email", email, displayValue: email ?? "" };
+      return { value: { kind: "email", email }, displayValue: email ?? "" };
     }
     case "GuestFieldResponseValue": {
       const name = value.name ?? null;
       return {
-        kind: "guest",
-        name,
-        email: value.email ?? null,
-        dateOfBirth: value.dateOfBirth ?? null,
-        notes: value.notes ?? null,
-        waiverSigned: value.waiverSigned ?? null,
+        value: {
+          kind: "guest",
+          name,
+          email: value.email ?? null,
+          dateOfBirth: value.dateOfBirth ?? null,
+          notes: value.notes ?? null,
+          waiverSigned: value.waiverSigned ?? null
+        },
         displayValue: name ?? ""
       };
     }
     case "HtmlFieldResponseValue": {
       const html = value.html ?? "";
-      return { kind: "html", html, displayValue: escapeHtml(html) };
+      return { value: { kind: "html", html }, displayValue: escapeHtml(html) };
     }
     case "ImageUrlFieldResponseValue": {
       const imageUrl = value.imageUrl ?? "";
-      return { kind: "imageUrl", imageUrl, displayValue: imageUrl };
+      return { value: { kind: "imageUrl", imageUrl }, displayValue: imageUrl };
     }
     case "IntegerFieldResponseValue": {
       const integer = value.integer ?? 0;
-      return { kind: "integer", integer, displayValue: String(integer) };
+      return { value: { kind: "integer", integer }, displayValue: String(integer) };
     }
     case "LocationFieldResponseValue": {
       const streetAddress = value.streetAddress ?? null;
@@ -1039,56 +1047,58 @@ function fromValueNode(value) {
       const postalCode = value.postalCode ?? null;
       const country = value.country ?? null;
       return {
-        kind: "location",
-        country,
-        county: value.county ?? null,
-        locality,
-        postalCode,
-        region,
-        streetAddress,
+        value: {
+          kind: "location",
+          country,
+          county: value.county ?? null,
+          locality,
+          postalCode,
+          region,
+          streetAddress
+        },
         displayValue: [streetAddress, locality, region, postalCode, country].filter((part) => part).join(", ")
       };
     }
     case "LongTextFieldResponseValue": {
       const longText = value.longText ?? "";
-      return { kind: "longText", longText, displayValue: longText };
+      return { value: { kind: "longText", longText }, displayValue: longText };
     }
     case "MetaFieldResponseValue": {
       const meta = value.meta ?? null;
-      return { kind: "meta", meta, displayValue: meta == null ? "" : JSON.stringify(meta) };
+      return { value: { kind: "meta", meta }, displayValue: meta == null ? "" : JSON.stringify(meta) };
     }
     case "PercentFieldResponseValue": {
       const percent = value.percent ?? null;
-      return { kind: "percent", percent, displayValue: percent == null ? "" : `${percent}%` };
+      return { value: { kind: "percent", percent }, displayValue: percent == null ? "" : `${percent}%` };
     }
     case "PhoneFieldResponseValue": {
       const phone = value.phone ?? "";
-      return { kind: "phone", phone, displayValue: phone };
+      return { value: { kind: "phone", phone }, displayValue: phone };
     }
     case "ShortTextFieldResponseValue": {
       const shortText = value.shortText ?? "";
-      return { kind: "shortText", shortText, displayValue: shortText };
+      return { value: { kind: "shortText", shortText }, displayValue: shortText };
     }
     case "TimeFieldResponseValue": {
       const time = value.time ?? "";
-      return { kind: "time", time, displayValue: time };
+      return { value: { kind: "time", time }, displayValue: time };
     }
     case "UrlFieldResponseValue": {
       const url = value.url ?? null;
-      return { kind: "url", url, displayValue: url ?? "" };
+      return { value: { kind: "url", url }, displayValue: url ?? "" };
     }
     case "VolumeFieldResponseValue": {
       const amount = value.volume?.amount ?? "0";
       const unit = value.volume?.unit ?? null;
-      return { kind: "volume", amount, unit, displayValue: amountUnit(amount, unit) };
+      return { value: { kind: "volume", amount, unit }, displayValue: amountUnit(amount, unit) };
     }
     case "WeightFieldResponseValue": {
       const amount = value.weight?.amount ?? "0";
       const unit = value.weight?.unit ?? null;
-      return { kind: "weight", amount, unit, displayValue: amountUnit(amount, unit) };
+      return { value: { kind: "weight", amount, unit }, displayValue: amountUnit(amount, unit) };
     }
     default:
-      return null;
+      return { value: null, displayValue: "" };
   }
 }
 function yesNo(value) {
@@ -1108,7 +1118,7 @@ function toSetMetaDataResult(node, bookingId) {
   };
 }
 function filterMetaDataByIntegrator(metaData, integrator) {
-  const prefix = `integrator:${integrator}:`;
+  const prefix = `integrators:${integrator}:`;
   return metaData.filter((entry) => entry.slug.startsWith(prefix)).map((entry) => ({ ...entry, slug: entry.slug.slice(prefix.length) }));
 }
 
@@ -1604,7 +1614,7 @@ var BookingService = class {
   /**
    * Returns a booking's custom-field metadata (its `fieldResponses`), scoped to
    * this service's integrator. Only fields whose slug starts with
-   * `integrator:<integrator>:` are returned, and that prefix is stripped from
+   * `integrators:<integrator>:` are returned, and that prefix is stripped from
    * each returned `slug`. Returns `[]` when the booking is not found or has no
    * matching fields.
    *
@@ -2642,7 +2652,7 @@ async function requestWithRetry(http, url, init, label, onResponse) {
 // src/internal/sdk-headers.ts
 var SDK_HEADER_NAME = "x-peek-sdk";
 var SDK_PLATFORM = "js";
-var SDK_VERSION = "0.9.3";
+var SDK_VERSION = "0.9.4";
 var SDK_HEADER_VALUE = `${SDK_PLATFORM}-${SDK_VERSION}`;
 
 // src/internal/peek/graphql-client.ts