@antlur/backstage 1.12.15 → 1.13.0

package/src/endpoints/layouts.ts

@@ -1,16 +1,18 @@
-import type { ApiCollectionResponse, ApiSingleResponse, AccountLayout } from "../types/index";
+import type { AccountLayout, AccountLayoutSchema, AccountLayoutValues, ApiCollectionResponse, ApiSingleResponse } from "../types/index";
 import { BaseService } from "./base.js";
 
 export interface CreateLayoutParams {
   name: string;
   slug: string;
-  schema: any;
+  schema: AccountLayoutSchema;
+  values?: AccountLayoutValues;
 }
 
 export interface UpdateLayoutParams {
   name?: string;
   slug?: string;
-  schema?: any;
+  schema?: AccountLayoutSchema;
+  values?: AccountLayoutValues;
 }
 
 export class LayoutService extends BaseService {

package/src/endpoints/media.ts

@@ -20,7 +20,7 @@ export class MediaService extends BaseService {
     const { data } = await this.client.post<ApiSingleResponse<Media>>(
       "/media",
       { source_url, name: options?.name, alt: options?.alt },
-      options
+      options,
     );
     return data;
   }
@@ -41,6 +41,25 @@ export class MediaService extends BaseService {
     return data;
   }
 
+  async uploadToMediaEndpoint(
+    file: Blob,
+    options?: { name?: string; alt?: string; request?: RequestInit },
+  ): Promise<Media> {
+    const formData = new FormData();
+    formData.append("file", file);
+
+    if (options?.name) {
+      formData.append("name", options.name);
+    }
+
+    if (options?.alt) {
+      formData.append("alt", options.alt);
+    }
+
+    const { data } = await this.client.post<ApiSingleResponse<Media>>("/media/upload", formData, options?.request);
+    return data;
+  }
+
   async update(id: string, params: { name?: string; alt?: string }, options?: RequestInit): Promise<Media> {
     const { data } = await this.client.put<ApiSingleResponse<Media>>(`/media/${id}`, params, options);
     return data;

package/src/endpoints/modules.ts

@@ -0,0 +1,14 @@
+import type { AccountModule, AccountModuleKey, ApiCollectionResponse } from "../types/index";
+import { BaseService } from "./base.js";
+
+export class ModulesService extends BaseService {
+  async list(options?: RequestInit): Promise<AccountModule[]> {
+    const { data } = await this.client.get<ApiCollectionResponse<AccountModule>>("/modules", options);
+    return data;
+  }
+
+  async isEnabled(moduleKey: AccountModuleKey, options?: RequestInit): Promise<boolean> {
+    const modules = await this.list(options);
+    return modules.some((module) => module.key === moduleKey && module.enabled);
+  }
+}

package/src/endpoints/navigation.ts

@@ -1,16 +1,47 @@
-import type { ApiSingleResponse, ApiCollectionResponse, Navigation } from "../types/index";
+import type { ApiSingleResponse, ApiCollectionResponse, Navigation, NavigationItem } from "../types/index";
 import { BaseService } from "./base.js";
 
+export interface CreateNavigationParams {
+  name: string;
+  items?: Array<Partial<NavigationItem> & { parent_id?: string | null }>;
+  [key: string]: any;
+}
+
+export interface UpdateNavigationParams extends Partial<CreateNavigationParams> {}
+
 export class NavigationService extends BaseService {
-  async getNavigations(options?: RequestInit): Promise<Navigation[]> {
+  async list(options?: RequestInit): Promise<Navigation[]> {
     const res = await this.client.get<ApiCollectionResponse<Navigation>>("/navigations", options);
-    const navigations = res.data;
+    return res.data;
+  }
+
+  async getById(id: string, options?: RequestInit): Promise<Navigation | null> {
+    try {
+      const res = await this.client.get<ApiSingleResponse<Navigation>>(`/navigations/${id}`, options);
+      return res.data;
+    } catch (error) {
+      return null;
+    }
+  }
+
+  async createNavigation(params: CreateNavigationParams, options?: RequestInit): Promise<Navigation> {
+    const { data } = await this.client.post<ApiSingleResponse<Navigation>>("/navigations", params, options);
+    return data;
+  }
+
+  async updateNavigation(id: string, params: UpdateNavigationParams, options?: RequestInit): Promise<Navigation> {
+    const { data } = await this.client.put<ApiSingleResponse<Navigation>>(`/navigations/${id}`, params, options);
+    return data;
+  }
+
+  async getNavigations(options?: RequestInit): Promise<Navigation[]> {
+    const navigations = await this.list(options);
 
     return Promise.all(
       navigations.map(async (navigation: any) => {
         const res = await this.client.get<ApiCollectionResponse<Navigation>>("/navigations/" + navigation.id, options);
         return res.data[0];
-      })
+      }),
     );
   }
 

package/src/endpoints/reviews.ts

@@ -0,0 +1,57 @@
+import type {
+  ApiCollectionResponse,
+  ApiSingleResponse,
+  Review,
+} from "../types/index";
+import { BaseService } from "./base.js";
+
+export interface CreateReviewParams {
+  response_text: string;
+}
+
+export interface ReviewFilters {
+  source?: string;
+  location_id?: string;
+}
+
+export class ReviewService extends BaseService {
+  async getReviews(filters?: ReviewFilters, options?: RequestInit): Promise<Review[]> {
+    const query = new URLSearchParams();
+    if (filters?.source) query.append("source", filters.source);
+    if (filters?.location_id) query.append("location_id", filters.location_id);
+
+    const queryString = query.toString();
+    const url = queryString ? `/reviews?${queryString}` : "/reviews";
+
+    const { data } = await this.client.get<ApiCollectionResponse<Review>>(
+      url,
+      options
+    );
+    return data;
+  }
+
+  async getReview(id: string, options?: RequestInit): Promise<Review | null> {
+    try {
+      const { data } = await this.client.get<ApiSingleResponse<Review>>(
+        `/reviews/${id}`,
+        options
+      );
+      return data;
+    } catch {
+      return null;
+    }
+  }
+
+  async updateReview(id: string, params: CreateReviewParams, options?: RequestInit): Promise<Review> {
+    const { data } = await this.client.put<ApiSingleResponse<Review>>(
+      `/reviews/${id}`,
+      params,
+      options
+    );
+    return data;
+  }
+
+  async pullReviews(options?: RequestInit): Promise<{ message: string }> {
+    return this.client.post<{ message: string }>("/reviews/pull", {}, options);
+  }
+}

package/src/endpoints/website.ts

@@ -19,6 +19,15 @@ export class WebsiteService extends BaseService {
     return data;
   }
 
+  async getWebsiteById(id: string, options?: RequestInit): Promise<Website | null> {
+    try {
+      const { data } = await this.client.get<ApiSingleResponse<Website>>(`/websites/${id}`, options);
+      return data;
+    } catch (error) {
+      return null;
+    }
+  }
+
   async getWebsite(options?: RequestInit): Promise<Website> {
     // Handle case where id might be an object (e.g., RequestInit passed as first param)
     // if (id && typeof id === "string") {
@@ -39,9 +48,12 @@ export class WebsiteService extends BaseService {
     return data;
   }
 
+  async getWebsiteRoutes(websiteId: string, options?: RequestInit): Promise<string[]> {
+    return this.client.get<string[]>(`/websites/${websiteId}/routes`, options);
+  }
+
   async routes(options?: RequestInit): Promise<string[]> {
-    // const id = websiteId || (await this.getWebsite()).id;
-    const website = await this.getWebsite();
-    return this.client.get<string[]>(`/websites/${website.id}/routes`, options);
+    const website = await this.getWebsite(options);
+    return this.getWebsiteRoutes(website.id, options);
   }
 }

package/src/index.ts

@@ -12,16 +12,19 @@ export * from "./endpoints/blueprints.js";
 export * from "./endpoints/entries.js";
 export * from "./endpoints/events.js";
 export * from "./endpoints/forms.js";
+export * from "./endpoints/frontstage.js";
 export * from "./endpoints/instagram.js";
 export * from "./endpoints/layouts.js";
 export * from "./endpoints/locations.js";
 export * from "./endpoints/media.js";
 export * from "./endpoints/menus.js";
 export * from "./endpoints/menu-items.js";
+export * from "./endpoints/modules.js";
 export * from "./endpoints/navigation.js";
 export * from "./endpoints/pages.js";
 export * from "./endpoints/press.js";
 export * from "./endpoints/redirects.js";
+export * from "./endpoints/reviews.js";
 export * from "./endpoints/routes.js";
 export * from "./endpoints/website.js";
 

package/src/studio/define-block.ts

@@ -1,10 +1,12 @@
 import { BlockSchema, BlockDefinition, BlockComponent, Field } from "./types";
+import type { BlockFrontstageConfig } from "./types/block";
 
 export function defineBlock<TFields extends readonly Field[]>(options: {
   name: string;
   slug: string;
   description?: string;
   schema: BlockSchema<TFields>;
+  frontstage?: BlockFrontstageConfig;
   component: BlockComponent<BlockSchema<TFields>>;
 }): BlockDefinition<TFields> {
   // Runtime validation

package/src/studio/types/block.ts

@@ -1,5 +1,6 @@
 import { Field, FieldType, FieldTypeToValue } from "./field";
 import { Entry } from "../../types/entry";
+import type { FrontstageStandardBlockType, FrontstageStandardBlockVariant } from "../../types/frontstage";
 
 type Nullable<T> = T | null;
 
@@ -28,6 +29,7 @@ export interface BlockDefinition<TFields extends readonly Field[]> {
   slug: string;
   description?: string;
   schema: BlockSchema<TFields>;
+  frontstage?: BlockFrontstageConfig;
   component: BlockComponent<BlockSchema<TFields>>;
 }
 
@@ -35,6 +37,14 @@ export interface BlockProperties {
   customClassName?: string;
 }
 
+export interface BlockFrontstageConfig {
+  enabled?: boolean;
+  type?: FrontstageStandardBlockType | string;
+  defaultVariant?: FrontstageStandardBlockVariant | string;
+  variants?: Array<FrontstageStandardBlockVariant | string>;
+  category?: string;
+}
+
 export interface BuilderBlock<TSchema extends BlockSchema<readonly Field[]>> {
   id: string;
   type: string;

package/src/types/account-block.ts

@@ -1,9 +1,30 @@
+import type { FrontstageBlockDefinition } from "./frontstage";
+import type { Field } from "../studio/types/field";
+
+export interface AccountBlockSchema {
+  fields?: readonly Field[];
+}
+
+export interface AccountBlockFrontstageConfig {
+  enabled?: boolean;
+  type?: FrontstageBlockDefinition["frontstage"] extends infer T
+    ? T extends { type: infer Type }
+      ? Type
+      : string
+    : string;
+  defaultVariant?: string;
+  variants?: string[];
+  category?: string;
+}
+
 export interface AccountBlock {
   id: string;
   account_id: string;
   slug: string;
   name: string;
-  schema: any;
+  description?: string | null;
+  schema: AccountBlockSchema;
+  frontstage?: AccountBlockFrontstageConfig | null;
   created_at: string;
   updated_at: string;
 }

package/src/types/account-layout.ts

@@ -1,14 +1,37 @@
+import type { Field } from "../studio/types/field";
+import type { FrontstageBlock, FrontstageNavItem, FrontstageTheme } from "./frontstage";
+
+export interface AccountLayoutSchema {
+  fields: Field[];
+  [key: string]: unknown;
+}
+
+export interface AccountLayoutValues {
+  theme?: Partial<FrontstageTheme["layout"]>;
+  navigation?: {
+    primary?: FrontstageNavItem[];
+    footer?: FrontstageNavItem[];
+  };
+  regions?: {
+    beforeHeader?: FrontstageBlock[];
+    afterHeader?: FrontstageBlock[];
+    beforeMain?: FrontstageBlock[];
+    afterMain?: FrontstageBlock[];
+    beforeFooter?: FrontstageBlock[];
+    footer?: FrontstageBlock[];
+    afterFooter?: FrontstageBlock[];
+  };
+  [key: string]: unknown;
+}
+
 export interface AccountLayout {
   id: string;
+  account_id?: string;
   name: string;
   slug: string;
-  schema: {
-    fields: Array<{
-      slug: string;
-      name: string;
-      type: string;
-      [key: string]: any;
-    }>;
-  };
-  data: Record<string, any>;
+  schema: AccountLayoutSchema;
+  values?: AccountLayoutValues;
+  data?: AccountLayoutValues;
+  created_at?: string;
+  updated_at?: string;
 }

package/src/types/account-module.ts

@@ -0,0 +1,38 @@
+export type AccountModuleKey =
+  | "core.modules"
+  | "core.media"
+  | "core.change_management"
+  | "core.deployments"
+  | "cms.site_builder"
+  | "cms.custom_blocks"
+  | "cms.custom_layouts"
+  | "restaurant.menus"
+  | "engagement.events"
+  | "engagement.press"
+  | (string & {});
+
+export interface AccountModule {
+  key: AccountModuleKey;
+  label: string;
+  category: string;
+  description: string;
+  default_enabled: boolean;
+  dependencies: AccountModuleKey[];
+  plan_entitlement: string | null;
+  active: boolean;
+  entitled: boolean;
+  enabled: boolean;
+}
+
+export const AccountModules = {
+  CoreModules: "core.modules",
+  CoreMedia: "core.media",
+  CoreChangeManagement: "core.change_management",
+  CoreDeployments: "core.deployments",
+  CmsSiteBuilder: "cms.site_builder",
+  CmsCustomBlocks: "cms.custom_blocks",
+  CmsCustomLayouts: "cms.custom_layouts",
+  RestaurantMenus: "restaurant.menus",
+  EngagementEvents: "engagement.events",
+  EngagementPress: "engagement.press",
+} as const satisfies Record<string, AccountModuleKey>;

package/src/types/frontstage.ts

@@ -0,0 +1,254 @@
+export type FrontstageContractVersion = "2026-05-frontstage-v1";
+
+export interface FrontstageImage {
+  url: string;
+  alt?: string;
+  width?: number;
+  height?: number;
+}
+
+export interface FrontstageNavItem {
+  label: string;
+  href: string;
+  variant?: "link" | "button";
+}
+
+export type FrontstageThemePreset = "classic-restaurant" | "premium-hospitality" | "fast-casual" | (string & {});
+export type FrontstageAlertType = "banner" | "popup";
+export type FrontstageAlertPosition = "top" | "bottom" | "center" | "bottom-right";
+
+export interface FrontstageHourRow {
+  label: string;
+  value: string;
+}
+
+export interface FrontstageSpecialHour {
+  id?: string;
+  date: string;
+  label: string;
+  title?: string;
+  value?: string;
+  notes?: string;
+}
+
+export interface FrontstageAlert {
+  id: string;
+  title: string;
+  type: FrontstageAlertType;
+  position?: FrontstageAlertPosition;
+  dismissible: boolean;
+  content?: string;
+  media?: FrontstageImage;
+  cta?: {
+    label: string;
+    href: string;
+  };
+  analytics?: {
+    name?: string;
+    category?: string;
+    label?: string;
+  };
+}
+
+export interface FrontstageBlock<TProps = Record<string, unknown>> {
+  id: string;
+  type: FrontstageStandardBlockType | string;
+  variant?: string;
+  props: TProps;
+}
+
+export type FrontstageStandardBlockType =
+  | "hero"
+  | "content"
+  | "feature-grid"
+  | "gallery"
+  | "media-feature"
+  | "menu-preview"
+  | "menu-section"
+  | "locations"
+  | "hours"
+  | "ordering"
+  | "cta"
+  | "events"
+  | "event-spotlight"
+  | "private-events"
+  | "contact-form"
+  | "testimonials"
+  | "press"
+  | "awards"
+  | "reviews"
+  | "newsletter"
+  | "faq"
+  | "html-embed";
+
+export type FrontstageStandardBlockVariant =
+  | "default"
+  | "full-bleed-image"
+  | "background-video"
+  | "image-collage"
+  | "masonry"
+  | "carousel"
+  | "editorial-strip"
+  | "mixed-media"
+  | "full-width"
+  | "inline";
+
+export interface FrontstageTheme {
+  preset?: FrontstageThemePreset;
+  colors: {
+    background: string;
+    foreground: string;
+    primary: string;
+    primaryForeground: string;
+    muted: string;
+    mutedForeground: string;
+    border: string;
+    secondary?: string;
+    secondaryForeground?: string;
+    accent?: string;
+    accentForeground?: string;
+    topbar?: string;
+    topbarForeground?: string;
+  };
+  fonts: {
+    heading: FrontstageFont;
+    body: FrontstageFont;
+  };
+  radius: string;
+  layout: {
+    container: "narrow" | "default" | "wide" | "full";
+    header: "default" | "centered-logo" | "split-nav" | "minimal";
+    footer: "simple" | "multi-column" | "location-heavy";
+  };
+}
+
+export interface FrontstageFont {
+  source: "system" | "google" | "custom";
+  name: string;
+  family: string;
+}
+
+export interface FrontstageSiteResponse {
+  contractVersion: FrontstageContractVersion;
+  site: {
+    id: string;
+    accountId: string;
+    name: string;
+    baseUrl: string;
+    locale: string;
+    timezone: string;
+    description?: string | null;
+    status: "draft" | "published" | "archived";
+  };
+  brand: {
+    logo?: FrontstageImage;
+    favicon?: { url: string };
+    social?: Record<string, string>;
+  };
+  contact?: {
+    address?: string;
+    mapUrl?: string;
+    phone?: string;
+    email?: string;
+    neighborhood?: string;
+    hours?: FrontstageHourRow[];
+    specialHours?: FrontstageSpecialHour[];
+  };
+  theme: FrontstageTheme;
+  navigation: {
+    primary: FrontstageNavItem[];
+    footer: FrontstageNavItem[];
+  };
+  alerts?: FrontstageAlert[];
+  integrations?: {
+    analytics?: { gtmId?: string };
+    ordering?: { provider?: string; url?: string };
+    reservations?: { provider?: string; url?: string };
+  };
+}
+
+export interface FrontstageResolvedLayout {
+  id: string | null;
+  name: string | null;
+  slug: string | null;
+  source?: "page" | "site" | "fallback" | "preview" | "override" | null;
+  theme?: Partial<FrontstageTheme["layout"]>;
+  navigation?: {
+    primary?: FrontstageNavItem[];
+    footer?: FrontstageNavItem[];
+  };
+  regions?: {
+    beforeHeader?: FrontstageBlock[];
+    afterHeader?: FrontstageBlock[];
+    beforeMain?: FrontstageBlock[];
+    afterMain?: FrontstageBlock[];
+    beforeFooter?: FrontstageBlock[];
+    footer?: FrontstageBlock[];
+    afterFooter?: FrontstageBlock[];
+  };
+}
+
+export interface FrontstageSeo {
+  title: string;
+  description?: string;
+  canonical?: string;
+  noindex?: boolean;
+  image?: FrontstageImage;
+}
+
+export interface FrontstagePageResponse {
+  contractVersion: FrontstageContractVersion;
+  page: {
+    id: string;
+    title: string;
+    slug: string;
+    status: "draft" | "published" | "archived";
+    seo: FrontstageSeo;
+    blocks: FrontstageBlock[];
+    layout?: FrontstageResolvedLayout;
+    alerts?: FrontstageAlert[];
+  };
+}
+
+export interface FrontstageRoute {
+  id?: string | null;
+  path: string;
+  slug?: string;
+  type?: string | null;
+  model?: string | null;
+  modelId?: string | null;
+  title?: string | null;
+  lastModified?: string | null;
+  changeFrequency?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never";
+  priority?: number;
+}
+
+export interface FrontstageRoutesResponse {
+  routes: FrontstageRoute[];
+}
+
+export interface FrontstageBlockDefinition {
+  id: string;
+  name: string;
+  type: FrontstageStandardBlockType | string;
+  category: string;
+  description: string;
+  variants: FrontstageStandardBlockVariant[] | string[];
+  fields: unknown[];
+  frontstage?: {
+    enabled: boolean;
+    type: FrontstageStandardBlockType | string;
+    defaultVariant?: FrontstageStandardBlockVariant | string;
+    variants: FrontstageStandardBlockVariant[] | string[];
+    category: string;
+  };
+}
+
+export interface FrontstageBlocksResponse {
+  blocks: FrontstageBlockDefinition[];
+}
+
+export interface FrontstagePreviewParams {
+  preview?: boolean;
+  previewId?: string;
+}

package/src/types/index.ts

@@ -5,6 +5,7 @@ export type * from "./api";
 export type * from "./blueprint";
 export type * from "./entry";
 export type * from "./event";
+export type * from "./frontstage";
 export type * from "./instagram";
 export type * from "./location";
 export type * from "./media-item";
@@ -12,10 +13,13 @@ export type * from "./menu-category-item";
 export type * from "./menu-category";
 export type * from "./menu-item";
 export type * from "./menu";
+export { AccountModules } from "./account-module";
+export type * from "./account-module";
 export type * from "./navigation";
 export type * from "./page";
 export type * from "./press";
 export type * from "./redirect";
+export type * from "./review";
 export type * from "./route";
 export type * from "./website";
 

package/src/types/location.ts

@@ -35,6 +35,7 @@ export interface Location {
     date: string;
     openTime: string;
     closeTime: string;
+    title?: string | null;
     open24Hours: boolean;
     closed24Hours: boolean;
     notes: string;