order3000 0.20.0 → 0.22.0

package/dist/client.cjs

@@ -134,6 +134,38 @@ class BaseResource {
     }
     return response.json();
   }
+  /**
+   * Multipart counterpart to `request`. Skips the JSON Content-Type
+   * default — `fetch` sets `multipart/form-data; boundary=…`
+   * automatically when the body is a `FormData`. Use for binary uploads
+   * (e.g. article feature image).
+   */
+  async requestMultipart(method, path, formData) {
+    const token = await this.tokenManager.getToken();
+    const venueId = this.tokenManager.getVenueId();
+    const url = `${this.baseUrl}/venues/${venueId}${this.resourcePath}${path}`;
+    const response = await fetch(url, {
+      method,
+      headers: {
+        Authorization: `Bearer ${token}`
+        // Intentionally NO Content-Type — fetch sets the boundary.
+      },
+      body: formData,
+      cache: "no-store",
+      signal: AbortSignal.timeout(36e4)
+    });
+    if (!response.ok) {
+      let body = "";
+      try {
+        body = await response.text();
+      } catch {
+      }
+      throw new Error(
+        `HTTP ${response.status}: ${response.statusText}${body ? ` \u2014 ${body}` : ""}`
+      );
+    }
+    return response.json();
+  }
 }
 
 class AreasResource extends BaseResource {
@@ -211,6 +243,79 @@ class ArticlesResource extends BaseResource {
     const path = qs ? `?${qs}` : "";
     return this.request("GET", path);
   }
+  /**
+   * Fetch a single article by id or accessor within the active venue.
+   * Returns the full row including the TipTap `content` document.
+   */
+  async getByAccessor(idOrAccessor) {
+    return this.request("GET", `/${encodeURIComponent(idOrAccessor)}`);
+  }
+  /**
+   * Partial-update an article. Locale-keyed fields (slug, title, excerpt)
+   * merge at the locale level — `{ slug: { en: 'foo' } }` updates `en`
+   * without touching `de`. Plain scalar / array fields fully replace.
+   * Returns the resulting article.
+   */
+  async patch(idOrAccessor, body) {
+    return this.request(
+      "PATCH",
+      `/${encodeURIComponent(idOrAccessor)}`,
+      body
+    );
+  }
+  /**
+   * Read the article's resolved feature image — asset id, public URL,
+   * matched locale, plus the FULL per-locale caption + alt records.
+   * Returns null when the article has no feature image yet (the wire
+   * 404 is mapped here for ergonomic null-checking on the caller side).
+   */
+  async getFeatureImage(idOrAccessor, options) {
+    const params = new URLSearchParams();
+    if (options?.locale) params.set("locale", options.locale);
+    const qs = params.toString();
+    const path = `/${encodeURIComponent(idOrAccessor)}/feature-image${qs ? `?${qs}` : ""}`;
+    try {
+      return await this.request("GET", path);
+    } catch (err) {
+      if (err instanceof Error && err.message.includes("HTTP 404")) {
+        return null;
+      }
+      throw err;
+    }
+  }
+  /**
+   * Upload a new feature image. Replaces any existing feature image
+   * for the venue's primary locale (the previous one is demoted to
+   * `role='inline'`). The SDK builds the multipart body internally —
+   * pass a Buffer/Uint8Array, the original filename, and the MIME
+   * type.
+   */
+  async uploadFeatureImage(idOrAccessor, file) {
+    const form = new FormData();
+    form.append(
+      "file",
+      new Blob([new Uint8Array(file.data)], { type: file.contentType }),
+      file.filename
+    );
+    return this.requestMultipart(
+      "POST",
+      `/${encodeURIComponent(idOrAccessor)}/feature-image`,
+      form
+    );
+  }
+  /**
+   * Update per-locale caption / alt on the article's feature image.
+   * Locale-keyed merge — `{ caption: { en: '…' } }` does not touch
+   * `de`. Plain-string locale values are server-side wrapped into
+   * minimal TipTap docs (the storage shape).
+   */
+  async patchFeatureImage(idOrAccessor, body) {
+    return this.request(
+      "PATCH",
+      `/${encodeURIComponent(idOrAccessor)}/feature-image`,
+      body
+    );
+  }
 }
 
 class BasketsResource extends BaseResource {
@@ -796,6 +901,44 @@ class TeamOrdersResource {
   }
 }
 
+class VenuesResource {
+  constructor(tokenManager, baseUrl) {
+    this.tokenManager = tokenManager;
+    this.baseUrl = baseUrl;
+  }
+  /**
+   * Fetch a venue by its UUID or its accessor (slug). The path accepts
+   * either form; the server resolves transparently.
+   *
+   * Powers the order3000-cli's `venues use <accessor>` validation step
+   * — the CLI hits this to prove the accessor exists and to cache the
+   * resolved UUID + display fields locally.
+   */
+  async getByAccessor(idOrAccessor) {
+    const token = await this.tokenManager.getToken();
+    const url = `${this.baseUrl}/venues/${encodeURIComponent(idOrAccessor)}`;
+    const response = await fetch(url, {
+      method: "GET",
+      headers: {
+        Authorization: `Bearer ${token}`,
+        "Content-Type": "application/json"
+      },
+      cache: "no-store"
+    });
+    if (!response.ok) {
+      let body = "";
+      try {
+        body = await response.text();
+      } catch {
+      }
+      throw new Error(
+        `HTTP ${response.status}: ${response.statusText}${body ? ` \u2014 ${body}` : ""}`
+      );
+    }
+    return response.json();
+  }
+}
+
 var __defProp$2 = Object.defineProperty;
 var __defNormalProp$2 = (obj, key, value) => key in obj ? __defProp$2(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __publicField$2 = (obj, key, value) => __defNormalProp$2(obj, typeof key !== "symbol" ? key + "" : key, value);
@@ -1130,6 +1273,7 @@ class Order3000Client {
     __publicField(this, "reservations");
     __publicField(this, "subscriptions");
     __publicField(this, "teamOrders");
+    __publicField(this, "venues");
     __publicField(this, "realtime");
     __publicField(this, "baseUrl");
     __publicField(this, "tokenManager");
@@ -1160,6 +1304,7 @@ class Order3000Client {
       this.baseUrl
     );
     this.teamOrders = new TeamOrdersResource(this.tokenManager, this.baseUrl);
+    this.venues = new VenuesResource(this.tokenManager, this.baseUrl);
     this.realtime = new RealtimeManager(this.tokenManager, this.baseUrl);
   }
 }

package/dist/client.d.cts

@@ -50,7 +50,14 @@ declare abstract class BaseResource {
     protected readonly baseUrl: string;
     protected readonly resourcePath: string;
     constructor(tokenManager: TokenManager, baseUrl: string, resourcePath: string);
-    protected request<T>(method: 'GET' | 'POST' | 'DELETE', path: string, data?: unknown, cacheOptions?: RequestCacheOptions): Promise<T>;
+    protected request<T>(method: 'GET' | 'POST' | 'PATCH' | 'DELETE', path: string, data?: unknown, cacheOptions?: RequestCacheOptions): Promise<T>;
+    /**
+     * Multipart counterpart to `request`. Skips the JSON Content-Type
+     * default — `fetch` sets `multipart/form-data; boundary=…`
+     * automatically when the body is a `FormData`. Use for binary uploads
+     * (e.g. article feature image).
+     */
+    protected requestMultipart<T>(method: 'POST' | 'PATCH' | 'PUT', path: string, formData: FormData): Promise<T>;
 }
 
 interface components {
@@ -218,9 +225,24 @@ interface components {
             createdAt: string | null;
             updatedAt: string | null;
         };
+        /**
+         * FeatureImage
+         * @description An article's resolved feature image. `caption` / `alt` are per-locale TipTap docs (PATCH accepts plain strings — server normalises).
+         */
+        FeatureImage: {
+            id: string;
+            publicUrl: string | null;
+            locale: string;
+            caption: {
+                [key: string]: unknown;
+            } | null;
+            alt: {
+                [key: string]: unknown;
+            } | null;
+        };
         /**
          * Article
-         * @description A venue's article. `content` is a TipTap JSON document; treat it as opaque on the wire.
+         * @description A venue's article. `content` is a TipTap JSON document; treat it as opaque on the wire. `featureImage` is resolved per-locale with a fallback to the venue's primary locale.
          */
         Article: {
             id: string;
@@ -234,21 +256,115 @@ interface components {
             };
             excerpt: {
                 [key: string]: string;
-            };
+            } | null;
             content: {
                 [key: string]: unknown;
-            };
+            } | null;
             tags: string[];
-            featuredImageId: string | null;
             isActive: boolean;
             isFeatured: boolean;
             priority: number;
-            publishedAt: string | null;
-            createdAt: string | null;
-            updatedAt: string | null;
+            publishedAt: unknown;
+            createdAt: unknown;
+            updatedAt: unknown;
+            featureImage: components["schemas"]["FeatureImage"] | null;
         };
         /** ListArticlesResponse */
         ListArticlesResponse: components["schemas"]["Article"][];
+        /**
+         * GetArticleResponse
+         * @description A venue's article. `content` is a TipTap JSON document; treat it as opaque on the wire. `featureImage` is resolved per-locale with a fallback to the venue's primary locale.
+         */
+        GetArticleResponse: {
+            id: string;
+            venueId: string;
+            accessor: string;
+            slug: {
+                [key: string]: string;
+            };
+            title: {
+                [key: string]: string;
+            };
+            excerpt: {
+                [key: string]: string;
+            } | null;
+            content: {
+                [key: string]: unknown;
+            } | null;
+            tags: string[];
+            isActive: boolean;
+            isFeatured: boolean;
+            priority: number;
+            publishedAt: unknown;
+            createdAt: unknown;
+            updatedAt: unknown;
+            featureImage: components["schemas"]["FeatureImage"] | null;
+        };
+        /** PatchArticleRequest */
+        PatchArticleRequest: {
+            slug?: {
+                [key: string]: string;
+            };
+            title?: {
+                [key: string]: string;
+            };
+            excerpt?: {
+                [key: string]: string;
+            };
+            content?: {
+                [key: string]: unknown;
+            };
+            tags?: string[];
+            isActive?: boolean;
+            isFeatured?: boolean;
+            priority?: number;
+        };
+        /**
+         * PatchArticleResponse
+         * @description A venue's article. `content` is a TipTap JSON document; treat it as opaque on the wire. `featureImage` is resolved per-locale with a fallback to the venue's primary locale.
+         */
+        PatchArticleResponse: {
+            id: string;
+            venueId: string;
+            accessor: string;
+            slug: {
+                [key: string]: string;
+            };
+            title: {
+                [key: string]: string;
+            };
+            excerpt: {
+                [key: string]: string;
+            } | null;
+            content: {
+                [key: string]: unknown;
+            } | null;
+            tags: string[];
+            isActive: boolean;
+            isFeatured: boolean;
+            priority: number;
+            publishedAt: unknown;
+            createdAt: unknown;
+            updatedAt: unknown;
+            featureImage: components["schemas"]["FeatureImage"] | null;
+        };
+        /** UploadFeatureImageRequest */
+        UploadFeatureImageRequest: {
+            /** @description Image file (multipart/form-data field) */
+            file: unknown;
+        };
+        /**
+         * PatchFeatureImageRequest
+         * @description Locale-keyed merge of the asset-side `caption` and `alt` records. Each locale value may be a plain string OR a TipTap doc; strings are wrapped server-side. Setting `en` does not touch `de`.
+         */
+        PatchFeatureImageRequest: {
+            caption?: {
+                [key: string]: unknown;
+            };
+            alt?: {
+                [key: string]: unknown;
+            };
+        };
         /**
          * AddToBasketRequest
          * @description Add an item to the shopping basket
@@ -1097,6 +1213,23 @@ interface components {
             teamOrderId: string;
             deliveryAddressId: string;
         };
+        /**
+         * GetVenueResponse
+         * @description A venue. The public API exposes only the minimal id + accessor + naming + locale fields the CLI's `venues use` / `auth whoami` consume.
+         */
+        GetVenueResponse: {
+            id: string;
+            accessor: string;
+            officialName: string;
+            legalName: string;
+            shortName: string;
+            brandName: string;
+            primaryLocale: string;
+            supportedLocales: string[];
+            timezone: string;
+            createdAt: unknown;
+            updatedAt: unknown;
+        };
     };
     responses: never;
     parameters: never;
@@ -1110,6 +1243,22 @@ type CreateEventRequest = schemas['CreateEventRequest'];
 type CreateEventResponse = schemas['CreateEventResponse'];
 type Article = schemas['Article'];
 type ListArticlesResponse = schemas['ListArticlesResponse'];
+type GetArticleResponse = schemas['GetArticleResponse'];
+type PatchArticleRequest = schemas['PatchArticleRequest'];
+type PatchArticleResponse = schemas['PatchArticleResponse'];
+type FeatureImage = schemas['FeatureImage'];
+type PatchFeatureImageRequest = schemas['PatchFeatureImageRequest'];
+/**
+ * Args for `client.articles.uploadFeatureImage()`. The SDK accepts a
+ * `Buffer` or `Uint8Array` payload + filename + content-type — it
+ * builds the FormData internally so callers don't have to know about
+ * multipart wire encoding.
+ */
+interface UploadFeatureImageArgs {
+    data: Buffer | Uint8Array;
+    filename: string;
+    contentType: string;
+}
 interface ListArticlesOptions {
     /** Only return articles whose `tags` array contains this value. */
     tag?: string;
@@ -1118,6 +1267,8 @@ interface ListArticlesOptions {
     /** When `true`, include articles whose `isActive` is `false`. Default `false`. */
     includeInactive?: boolean;
 }
+type Venue = schemas['Venue'];
+type GetVenueResponse = schemas['GetVenueResponse'];
 /**
  * Order fulfillment type - matches order_fulfillment_type enum in order3000 database.
  * Keep in sync with apps/order3000/src/drizzle/enums.ts
@@ -1907,6 +2058,42 @@ declare class ArticlesResource extends BaseResource {
      * for human-friendly node addressing.
      */
     list(options?: ListArticlesOptions): Promise<ListArticlesResponse>;
+    /**
+     * Fetch a single article by id or accessor within the active venue.
+     * Returns the full row including the TipTap `content` document.
+     */
+    getByAccessor(idOrAccessor: string): Promise<Article>;
+    /**
+     * Partial-update an article. Locale-keyed fields (slug, title, excerpt)
+     * merge at the locale level — `{ slug: { en: 'foo' } }` updates `en`
+     * without touching `de`. Plain scalar / array fields fully replace.
+     * Returns the resulting article.
+     */
+    patch(idOrAccessor: string, body: PatchArticleRequest): Promise<Article>;
+    /**
+     * Read the article's resolved feature image — asset id, public URL,
+     * matched locale, plus the FULL per-locale caption + alt records.
+     * Returns null when the article has no feature image yet (the wire
+     * 404 is mapped here for ergonomic null-checking on the caller side).
+     */
+    getFeatureImage(idOrAccessor: string, options?: {
+        locale?: string;
+    }): Promise<FeatureImage | null>;
+    /**
+     * Upload a new feature image. Replaces any existing feature image
+     * for the venue's primary locale (the previous one is demoted to
+     * `role='inline'`). The SDK builds the multipart body internally —
+     * pass a Buffer/Uint8Array, the original filename, and the MIME
+     * type.
+     */
+    uploadFeatureImage(idOrAccessor: string, file: UploadFeatureImageArgs): Promise<FeatureImage>;
+    /**
+     * Update per-locale caption / alt on the article's feature image.
+     * Locale-keyed merge — `{ caption: { en: '…' } }` does not touch
+     * `de`. Plain-string locale values are server-side wrapped into
+     * minimal TipTap docs (the storage shape).
+     */
+    patchFeatureImage(idOrAccessor: string, body: PatchFeatureImageRequest): Promise<FeatureImage>;
 }
 
 declare class BasketsResource extends BaseResource {
@@ -2592,6 +2779,27 @@ declare class TeamOrdersResource {
     }): Promise<UpdateDeliveryAddressResponse>;
 }
 
+/**
+ * Reads at the venue level. Doesn't extend `BaseResource` because that
+ * class hard-codes a `/venues/{venueId}/<resourcePath>` URL template,
+ * which assumes a venue-scoped sub-resource. Venues themselves are AT
+ * `/venues/:venueIdOrAccessor` directly.
+ */
+declare class VenuesResource {
+    private readonly tokenManager;
+    private readonly baseUrl;
+    constructor(tokenManager: TokenManager, baseUrl: string);
+    /**
+     * Fetch a venue by its UUID or its accessor (slug). The path accepts
+     * either form; the server resolves transparently.
+     *
+     * Powers the order3000-cli's `venues use <accessor>` validation step
+     * — the CLI hits this to prove the accessor exists and to cache the
+     * resolved UUID + display fields locally.
+     */
+    getByAccessor(idOrAccessor: string): Promise<Venue>;
+}
+
 type RealtimeEvent = 'INSERT' | 'UPDATE' | 'DELETE' | '*';
 type RealtimeRow = {
     [key: string]: any;
@@ -2763,6 +2971,7 @@ declare class Order3000Client {
     reservations: ReservationsResource;
     subscriptions: SubscriptionsResource;
     teamOrders: TeamOrdersResource;
+    venues: VenuesResource;
     realtime: RealtimeManager;
     private readonly baseUrl;
     private readonly tokenManager;
@@ -2770,4 +2979,4 @@ declare class Order3000Client {
 }
 
 export { Order3000Client, fulfillmentTypeEnum, getScheduleInfo, participantStatusEnum, paymentMethodEnum, teamOrderStatusEnum };
-export type { AddToBasketRequest, AddToBasketResponse, Area, AreaAsset, AreaAvailabilityResponse, AreaAvailabilityWindow, AreaBookingMode, AreaBookingRequestResponse, AreaBookingRequestSource, AreaBookingRequestStatus, AreaBookingStatus, AreaFeature, Article, Basket, BasketItem, BasketItemDeposit, BasketItemMenuItemRef, BasketItemMetadata, BasketStatus, BasketTotals, CancelTeamOrderResponse, ConfirmOrderRequest, ConfirmOrderResponse, CreateDeltaPaymentIntentRequest, CreateDeltaPaymentIntentResponse, CreatePaymentIntentRequest, CreatePaymentIntentResponse, CreateTeamOrderRequest, CreateTeamOrderResponse, CropArea, Currency, DayOfWeek, DeclaredReturn, Event, EventByAccessor, EventMenu, EventPoster, EventRow, ExtendDeadlineResponse as ExtendTeamOrderDeadlineResponse, FetchTeamOrderResponse, GetAreaAvailabilityOptions, GetAreaOptions, GetEventOptions, GetMenuOptions, JoinTeamOrderRequest, JoinTeamOrderResponse, LatestOrder, ListArticlesOptions, ListArticlesResponse, ListEventsOptions, ListEventsResponse, Menu, MenuAsset, MenuBeverage, MenuBundle, MenuBundleDeposit, MenuDish, MenuItem, MenuItemRow, MenuItemType, MenuSubscription, MenuSubscriptionPoster, Order3000ClientConfig, OrderFulfillmentType, OrderStatus, PaymentStatus, PlaceOrderRequest, Promotion, RealtimeConfig, RealtimeEvent, RealtimeSubscription, RemoveFromBasketResponse, Schedule, ScheduleInfo, ScheduleOverride, ScheduleOverrideRow, ScheduleRow, ScheduleTimeSlot, ScheduleWithTimeSlots, SubmitAreaBookingRequestPayload, SubmitTeamOrderResponse, SubscribeRequest, SubscribeResponse, SubscriberStatus, SubscriptionCredit, SubscriptionCreditStatus, SubscriptionOptions, SubscriptionPeriod, SwitchFulfillmentResponse as SwitchTeamOrderFulfillmentResponse, TeamDeliveryAddress, TeamOrderBasketItem, TeamOrderBasketItemMenuItemRef, FulfillmentType as TeamOrderFulfillmentType, TeamOrderParticipant, ParticipantStatus as TeamOrderParticipantStatus, PaymentMethod as TeamOrderPaymentMethod, TeamOrderStatus, ThresholdCheck as TeamOrderThresholdCheck, TimeSlot, Unit, UpdateDeliveryAddressResponse as UpdateTeamOrderDeliveryAddressResponse };
+export type { AddToBasketRequest, AddToBasketResponse, Area, AreaAsset, AreaAvailabilityResponse, AreaAvailabilityWindow, AreaBookingMode, AreaBookingRequestResponse, AreaBookingRequestSource, AreaBookingRequestStatus, AreaBookingStatus, AreaFeature, Article, Basket, BasketItem, BasketItemDeposit, BasketItemMenuItemRef, BasketItemMetadata, BasketStatus, BasketTotals, CancelTeamOrderResponse, ConfirmOrderRequest, ConfirmOrderResponse, CreateDeltaPaymentIntentRequest, CreateDeltaPaymentIntentResponse, CreatePaymentIntentRequest, CreatePaymentIntentResponse, CreateTeamOrderRequest, CreateTeamOrderResponse, CropArea, Currency, DayOfWeek, DeclaredReturn, Event, EventByAccessor, EventMenu, EventPoster, EventRow, ExtendDeadlineResponse as ExtendTeamOrderDeadlineResponse, FeatureImage, FetchTeamOrderResponse, GetAreaAvailabilityOptions, GetAreaOptions, GetArticleResponse, GetEventOptions, GetMenuOptions, GetVenueResponse, JoinTeamOrderRequest, JoinTeamOrderResponse, LatestOrder, ListArticlesOptions, ListArticlesResponse, ListEventsOptions, ListEventsResponse, Menu, MenuAsset, MenuBeverage, MenuBundle, MenuBundleDeposit, MenuDish, MenuItem, MenuItemRow, MenuItemType, MenuSubscription, MenuSubscriptionPoster, Order3000ClientConfig, OrderFulfillmentType, OrderStatus, PatchArticleRequest, PatchArticleResponse, PatchFeatureImageRequest, PaymentStatus, PlaceOrderRequest, Promotion, RealtimeConfig, RealtimeEvent, RealtimeSubscription, RemoveFromBasketResponse, Schedule, ScheduleInfo, ScheduleOverride, ScheduleOverrideRow, ScheduleRow, ScheduleTimeSlot, ScheduleWithTimeSlots, SubmitAreaBookingRequestPayload, SubmitTeamOrderResponse, SubscribeRequest, SubscribeResponse, SubscriberStatus, SubscriptionCredit, SubscriptionCreditStatus, SubscriptionOptions, SubscriptionPeriod, SwitchFulfillmentResponse as SwitchTeamOrderFulfillmentResponse, TeamDeliveryAddress, TeamOrderBasketItem, TeamOrderBasketItemMenuItemRef, FulfillmentType as TeamOrderFulfillmentType, TeamOrderParticipant, ParticipantStatus as TeamOrderParticipantStatus, PaymentMethod as TeamOrderPaymentMethod, TeamOrderStatus, ThresholdCheck as TeamOrderThresholdCheck, TimeSlot, Unit, UpdateDeliveryAddressResponse as UpdateTeamOrderDeliveryAddressResponse, UploadFeatureImageArgs, Venue };