@antlur/backstage 1.0.8 → 1.0.10

package/src/config.ts

@@ -0,0 +1,31 @@
+import { AxiosError } from "axios";
+
+const ROOT = process.cwd();
+const CONFIG_PATH = process.env.BACKSTAGE_CONFIG_PATH || "./backstage.config";
+const DEFAULT_BASE_URL = "https://bckstg.app/api";
+
+export interface BackstageUserConfig {
+  accountId?: string | undefined;
+  token?: string | undefined;
+  baseURL?: string;
+  onError?: (error: AxiosError) => void;
+}
+
+let globalConfig: BackstageUserConfig = {
+  baseURL: process.env.BACKSTAGE_API_URL ?? DEFAULT_BASE_URL,
+  token: process.env.BACKSTAGE_API_KEY ?? undefined,
+  accountId: process.env.BACKSTAGE_ACCOUNT_ID ?? undefined,
+};
+
+export function defineConfig(config: BackstageUserConfig): BackstageUserConfig {
+  globalConfig = {
+    ...globalConfig,
+    ...config,
+  };
+  return globalConfig;
+}
+
+export function getGlobalConfig(): BackstageUserConfig {
+  // read the config from the project root
+  return globalConfig;
+}

package/src/constants/google-events.ts

@@ -0,0 +1,13 @@
+export const GAEvents = {
+  CLICK_TO_MAP: "click_to_map",
+  CLICK_TO_CALL: "click_to_call",
+  CLICK_TO_SOCIAL: "click_to_social",
+  CLICK_TO_WAITLIST: "click_to_waitlist",
+  FIND_LOCATION: "find_location",
+  CLICK_TO_ORDER: "click_to_order",
+};
+
+export const GALocations = {
+  LOCATION_CARD: "location_card",
+  TOPBAR: "topbar",
+};

package/src/endpoints/alerts.ts

@@ -0,0 +1,7 @@
+import { client } from "../client";
+import { ApiCollectionResponse, Alert } from "../types";
+
+export async function getAlerts() {
+  const { data } = await client().get<ApiCollectionResponse<Alert>>("/alerts");
+  return data;
+}

package/src/endpoints/events.ts

@@ -0,0 +1,20 @@
+import { client } from "../client";
+import { ApiCollectionResponse, Event } from "../types";
+
+export async function getEvents(): Promise<Event[]> {
+  const res = await client().get<ApiCollectionResponse<Event>>("/events");
+  const pages = res.data;
+  return pages;
+}
+
+export async function getEvent(id: string): Promise<Event> {
+  const res = await client().get<ApiCollectionResponse<Event>>("/events" + "?filter[id]=" + id);
+  const pages = res.data?.[0];
+  return pages;
+}
+
+export async function getEventBySlug(slug: string): Promise<Event> {
+  const res = await client().get<ApiCollectionResponse<Event>>("/events" + "?filter[slug]=" + slug);
+  const pages = res.data?.[0];
+  return pages;
+}

package/src/endpoints/locations.ts

@@ -0,0 +1,25 @@
+import { client } from "../client";
+import { ApiCollectionResponse, Location } from "../types";
+
+export async function getLocations(): Promise<Location[]> {
+  const res = await client().get<ApiCollectionResponse<Location>>("/locations");
+  let locations = res.data;
+  locations = locations.sort((a: any, b: any) => {
+    if (a.name < b.name) {
+      return -1;
+    }
+    return 1;
+  });
+  return locations;
+}
+
+export async function getLocationBySlug(slug: string) {
+  const res = await client().get<ApiCollectionResponse<Location>>(`/locations?filter[slug]=${slug}`);
+  const data = res.data;
+
+  if (Array.isArray(data) && data.length > 0) {
+    return data[0];
+  }
+
+  return data;
+}

package/src/endpoints/menus.ts

@@ -0,0 +1,30 @@
+import { client } from "../client";
+import { ApiCollectionResponse, Menu } from "../types";
+
+export async function getMenus(): Promise<Menu[]> {
+  const res = await client().get<ApiCollectionResponse<Menu>>("/menus");
+  const menus = res.data;
+  return menus;
+}
+
+export async function getMenu(id: string) {
+  const res = await client().get<ApiCollectionResponse<Menu>>(`/menus?filter[id]=${id}&include=categories.items`);
+  const data = res.data;
+
+  if (Array.isArray(data) && data.length > 0) {
+    return data[0];
+  }
+
+  return data;
+}
+
+export async function getMenuBySlug(slug: string) {
+  const res = await client().get<ApiCollectionResponse<Menu>>(`/menus?filter[slug]=${slug}&include=categories.items`);
+  const data = res.data;
+
+  if (Array.isArray(data) && data.length > 0) {
+    return data[0];
+  }
+
+  return data;
+}

package/src/endpoints/navigation.ts

@@ -0,0 +1,34 @@
+import { client } from "../client";
+import { ApiSingleResponse, ApiCollectionResponse, Navigation } from "../types";
+
+export async function getDefaultNavigation(): Promise<Navigation> {
+  const navigations = await getNavigations();
+  return navigations[0];
+}
+
+export async function getNavigations(): Promise<Navigation[]> {
+  const res = await client().get<ApiCollectionResponse<Navigation>>("/navigations");
+  const navigations = res.data;
+
+  return Promise.all(
+    navigations.map(async (navigation: any) => {
+      const res = await client().get<ApiCollectionResponse<Navigation>>("/navigations/" + navigation.id);
+      return res.data[0];
+    })
+  );
+}
+
+export async function getNavigation(id: string): Promise<Navigation> {
+  const res = await client().get<ApiSingleResponse<Navigation>>(`/navigations/${id}`);
+  const navigation = res.data;
+
+  const topLevelItems = navigation.items.filter((item: any) => item.parent_id === null);
+
+  topLevelItems.forEach((item: any) => {
+    item.children = navigation.items.filter((child: any) => child.parent_id === item.id);
+  });
+
+  navigation.items = topLevelItems;
+
+  return navigation;
+}

package/src/endpoints/pages.ts

@@ -0,0 +1,23 @@
+import { client } from "../client";
+import { Page } from "../types/page";
+import { ApiCollectionResponse } from "../types/api";
+
+export async function getPage(slug: string): Promise<Page> {
+  const res = await client().get<ApiCollectionResponse<Page>>(`/pages/?filter[slug]=${slug}`);
+  return res.data[0];
+}
+
+export async function getPages() {
+  const { data } = await client().get<ApiCollectionResponse<Page>>("/pages");
+  return data;
+}
+
+export async function getHomePage() {
+  const res = await client().get<ApiCollectionResponse<Page>>("/pages?filter[slug]=/");
+  return res.data[0];
+}
+
+export async function getPageBySlug(slug: string) {
+  const res = await client().get<ApiCollectionResponse<Page>>("/pages?filter[slug]=" + slug);
+  return res.data[0];
+}

package/src/endpoints/press.ts

@@ -0,0 +1,7 @@
+import { client } from "../client";
+import { ApiCollectionResponse, Press } from "../types";
+
+export async function getPress(): Promise<Press[]> {
+  const { data } = await client().get<ApiCollectionResponse<Press>>("/press");
+  return data;
+}

package/src/endpoints/website.ts

@@ -0,0 +1,7 @@
+import { client } from "../client";
+import { ApiCollectionResponse, Website } from "../types";
+
+export async function getWebsite(): Promise<Website> {
+  const res = await client().get<ApiCollectionResponse<Website>>("/websites");
+  return res.data[0];
+}

package/src/index.ts

@@ -0,0 +1,18 @@
+// Re-export config
+export { defineConfig, getGlobalConfig } from "./config";
+
+// Re-export the client class
+export { BackstageClient } from "./client";
+
+// Re-export endpoints
+export * from "./endpoints/alerts";
+export * from "./endpoints/events";
+export * from "./endpoints/locations";
+export * from "./endpoints/menus";
+export * from "./endpoints/navigation";
+export * from "./endpoints/pages";
+export * from "./endpoints/press";
+export * from "./endpoints/website";
+
+// Re-export domain types
+export * from "./types";

package/src/types/alert.ts

@@ -0,0 +1,11 @@
+export interface Alert {
+  id: string;
+  title: string;
+  type: string;
+  is_global: boolean;
+  published: boolean;
+  pages: {
+    id: string;
+    slug: string;
+  }[];
+}

package/src/types/api.ts

@@ -0,0 +1,12 @@
+export interface ApiCollectionResponse<T> {
+  data: T[];
+  meta: {
+    current_page: number;
+    from: number;
+    last_page: number;
+  };
+}
+
+export interface ApiSingleResponse<T> {
+  data: T;
+}

package/src/types/event.ts

@@ -0,0 +1,14 @@
+import { MediaItem } from "./media-item";
+
+export interface Event {
+  id: number;
+  title: string;
+  short_description: string;
+  description: string;
+  start_time: string; // or Date if the date is being converted before being used in TypeScript
+  end_time: string; // or Date if the date is being converted before being used in TypeScript
+  timezone: string;
+  cover_media_id: number;
+  cover_media: MediaItem; // Replace 'any' with the actual type of the cover_media
+  account_id: number;
+}

package/src/types/index.ts

@@ -0,0 +1,13 @@
+export * from "./alert";
+export * from "./api";
+export * from "./event";
+export * from "./location";
+export * from "./media-item";
+export * from "./menu-category-item";
+export * from "./menu-category";
+export * from "./menu-item";
+export * from "./menu";
+export * from "./navigation";
+export * from "./page";
+export * from "./press";
+export * from "./website";

package/src/types/location.ts

@@ -0,0 +1,69 @@
+export interface Location {
+  id: string;
+  account_id: string;
+  google_my_business_id: string | null;
+  name: string;
+  slug: string | null;
+  description: string | null;
+  featured_media_id: number;
+  address: string;
+  address2: string;
+  city: string;
+  state: string;
+  zip: string;
+  map_link: string | null;
+  map_embed: string | null;
+  latitude: number | null;
+  longitude: number | null;
+  phone: string;
+  email: string;
+  timezone: string | null;
+  hours: {
+    day: string;
+    openTime: string;
+    closeTime: string;
+    open24Hours: boolean;
+    closed24Hours: boolean;
+    notes: string;
+  }[];
+  special_hours: {
+    id: string;
+    date: string;
+    openTime: string;
+    closeTime: string;
+    open24Hours: boolean;
+    closed24Hours: boolean;
+    notes: string;
+  }[];
+  ordering_links: {
+    service: string;
+    url: string;
+  }[];
+  delivery_links: {
+    service: string;
+    url: string;
+  }[];
+  reservation_links: {
+    service: string;
+    url: string;
+  }[];
+  waitlist_links: {
+    service: string;
+    url: string;
+  }[];
+  loyalty_url: string | null;
+  created_at: string;
+  updated_at: string;
+  featured_media: {
+    id: number;
+    file_name: string;
+    url: string;
+    transform_url: string;
+    path: string;
+    width: number;
+    height: number;
+    alt: string;
+  };
+  status: string;
+  status_text: string;
+}

package/src/types/media-item.ts

@@ -0,0 +1,10 @@
+export interface MediaItem {
+  id: string;
+  file_name: string;
+  url: string;
+  transform_url: string;
+  path: string;
+  width: number;
+  height: number;
+  alt: string;
+}

package/src/types/menu-category-item.ts

@@ -0,0 +1,18 @@
+import { MenuItem } from "./menu-item";
+
+export interface MenuCategoryItem {
+  id: string;
+  menu_category_id: string;
+  menu_item_id: string;
+  title: string;
+  post_title: string | null;
+  subtitle: string | null;
+  description: string | null;
+  price: number | null;
+  order: number;
+  price2: number | null;
+  image_id: string | null;
+  created_at: string;
+  updated_at: string;
+  menu_item: MenuItem;
+}

package/src/types/menu-category.ts

@@ -0,0 +1,15 @@
+import { MenuCategoryItem } from "./menu-category-item";
+
+export interface MenuCategory {
+  id: string;
+  title: string;
+  subtitle: string | null;
+  description: string | null;
+  after_description: string | null;
+  column_count: number | null;
+  menu_id: string;
+  order: number;
+  created_at: string;
+  updated_at: string;
+  items: MenuCategoryItem[];
+}

package/src/types/menu-item.ts

@@ -0,0 +1,15 @@
+export interface MenuItem {
+  id: string;
+  account_id: string;
+  title: string;
+  post_title: string | null;
+  subtitle: string | null;
+  description: string | null;
+  price: number | null;
+  price2: number | null;
+  image_id: string | null;
+  type: string | null;
+  overrides: string | null;
+  created_at: string;
+  updated_at: string;
+}

package/src/types/menu.ts

@@ -0,0 +1,12 @@
+export interface Menu {
+  id: string;
+  slug: string;
+  is_default: boolean;
+  title: string;
+  subtitle: string | null;
+  account_id: string;
+  pdf_url: string | null;
+  categories: string[]; // You can replace this with the actual type for categories if needed
+  created_at: string;
+  updated_at: string;
+}

package/src/types/navigation.ts

@@ -0,0 +1,17 @@
+export interface NavigationItem {
+  id: string;
+  text: string;
+  url: string;
+  html: string;
+  new_window: boolean;
+  type: string;
+  style: string;
+  parent_id: string;
+  children: NavigationItem[];
+}
+
+export interface Navigation {
+  id: string;
+  name: string;
+  items: NavigationItem[];
+}

package/src/types/page.ts

@@ -0,0 +1,24 @@
+export interface Block {
+  id: string;
+  block: string;
+  data: any;
+}
+
+export interface Settings {
+  background_color: string;
+}
+
+export interface Meta {
+  title: string;
+  description: string;
+}
+
+export interface Page {
+  id: string;
+  title: string;
+  slug: string;
+  blocks: Block[];
+  settings: Settings;
+  meta: Meta;
+  is_home: boolean;
+}

package/src/types/press.ts

@@ -0,0 +1,13 @@
+import { MediaItem } from "./media-item";
+
+export interface Press {
+  id: string;
+  slug: string;
+  title: string;
+  source: string;
+  url: string;
+  published_at: string;
+  featured_media?: MediaItem;
+  excerpt: string;
+  content: string;
+}

package/src/types/website.ts

@@ -0,0 +1,76 @@
+export interface SocialLink {
+  name: string;
+  url: string | null;
+}
+
+export interface FontFamily {
+  name: string;
+  value: string;
+}
+
+export interface ThemeColors {
+  primary?: string;
+  primaryForeground: string;
+  secondary?: string;
+  secondaryForeground: string;
+  tertiary?: string;
+  tertiaryForeground: string;
+  topbar?: string;
+  topbarForeground: string;
+  header?: string;
+  headerForeground: string;
+  footerLocation?: string;
+  footerLocationForeground: string;
+  footer?: string;
+  footerForeground: string;
+}
+
+export interface Theme {
+  name: string | null;
+  colors: ThemeColors;
+}
+
+export interface WebsiteMeta {
+  title: string | null;
+  description: string | null;
+}
+
+export interface OpenGraph {
+  title: string | null;
+  description: string | null;
+  image: string | null;
+}
+
+export interface Logo {
+  url: string;
+  width: number;
+  height: number;
+  thumb: string;
+}
+
+export interface Account {
+  id: string;
+  name: string;
+}
+
+export interface Website {
+  id: string;
+  app_name: string;
+  domain: string;
+  favicon_url: string | null;
+  logo: Logo | null;
+  account: Account;
+  meta: WebsiteMeta;
+  open_graph: OpenGraph;
+  theme: Theme;
+  google_analytics_id: string | null;
+  facebook_pixel_id: string | null;
+  font_urls: string[] | null;
+  font_families: FontFamily[] | null;
+  header_navigation_id: string | null;
+  footer_navigation_id: string | null;
+  social_links: SocialLink[];
+  home_cta_text: string | null;
+  home_cta_url: string | null;
+  has_accessibility_widget: boolean;
+}

package/src/util/event.ts

@@ -0,0 +1,77 @@
+import type { Event, Location, Website } from "../types";
+import { Event as SchemaEvent, WithContext } from "schema-dts";
+
+export function isMultipleDays(start: Date, end: Date) {
+  return start.getDate() !== end.getDate();
+}
+
+export function dateString(event: Event) {
+  const startTime = new Date(event.start_time);
+  const endTime = new Date(event.end_time);
+
+  if (isMultipleDays(startTime, endTime)) {
+    const startDayShort = startTime.toLocaleDateString("en-US", { weekday: "short" });
+    const startDate = startTime.toLocaleDateString("en-US", { month: "short", day: "numeric" });
+    const endDate = endTime.toLocaleDateString("en-US", { month: "short", day: "numeric" });
+
+    return `${startDayShort}, ${startDate} - ${endDate}`;
+  }
+
+  const startDay = startTime.toLocaleDateString("en-US", { weekday: "short" });
+  const startDate = startTime.toLocaleDateString("en-US", { month: "short", day: "numeric" });
+  const startTimeString = startTime.toLocaleTimeString("en-US", { hour: "numeric", minute: "numeric" });
+  const endTimeString = endTime.toLocaleTimeString("en-US", { hour: "numeric", minute: "numeric" });
+
+  return `${startDay}, ${startDate}`;
+}
+
+export function timeString(event: Event) {
+  const startTime = new Date(event.start_time);
+  const endTime = new Date(event.end_time);
+
+  const startTimeString = startTime.toLocaleTimeString("en-US", { hour: "numeric", minute: "numeric" });
+  const endTimeString = endTime.toLocaleTimeString("en-US", { hour: "numeric", minute: "numeric" });
+
+  return `${startTimeString} - ${endTimeString}`;
+}
+
+export function shortDescription(event: Event) {
+  // event.description is html
+  // strip html tags
+  //   keep newlines
+  // return first 50 chars
+
+  const shortDescription = event.description.substring(0, 100);
+  return shortDescription;
+}
+
+export function makeEventSchema(website: Website, event: Event, locations: Location[]): WithContext<SchemaEvent> {
+  return {
+    "@context": "https://schema.org",
+    "@type": "Event",
+    "@id": `https://${website.domain}/events/${event.id}//#event`,
+    eventAttendanceMode: "https://schema.org/OfflineEventAttendanceMode",
+    url: `https://${website.domain}/events/${event.id}`,
+    name: event.title,
+    description: event.description,
+    startDate: event.start_time,
+    endDate: event.end_time,
+    location: [
+      {
+        "@type": "Place",
+        address: {
+          "@type": "PostalAddress",
+          streetAddress: locations[0].address,
+          addressLocality: locations[0].city,
+          addressRegion: locations[0].state,
+          postalCode: locations[0].zip,
+          addressCountry: "US",
+        },
+      },
+    ],
+    image: {
+      "@type": "ImageObject",
+      url: event.cover_media?.transform_url,
+    },
+  };
+}