@weaverse/core 5.17.1 → 5.18.0

package/src/types.ts

@@ -0,0 +1,264 @@
+import type { CSSProperties, ForwardRefExoticComponent } from 'react'
+import type { IconName } from './icon-name'
+
+/** Actions that can be displayed in an element's Studio toolbar. */
+export type ToolbarAction =
+  | 'general-settings'
+  | 'settings-level-2'
+  | 'duplicate'
+  | 'delete'
+  | 'global-sections'
+
+/** Advanced style groups available in the Studio settings panel. */
+export type AdvancedGroupType =
+  | 'border'
+  | 'alignment'
+  | 'background'
+  | 'dimensions'
+  | 'spacing'
+  | 'typography'
+  | 'visibility'
+  | 'shadows-and-effects'
+  | 'layout-background'
+
+/** Preset positions supported by position inputs. */
+export type PositionInputValue =
+  | 'top left'
+  | 'top center'
+  | 'top right'
+  | 'center left'
+  | 'center center'
+  | 'center right'
+  | 'bottom left'
+  | 'bottom center'
+  | 'bottom right'
+
+/**
+ * Input controls supported by legacy Core schemas.
+ *
+ * @remarks Prefer the equivalent input types from `@weaverse/schema` for new
+ * schemas. This type remains available for backward compatibility.
+ */
+export type InputType =
+  | 'blog'
+  | 'collection'
+  | 'collection-list'
+  | 'color'
+  | 'datepicker'
+  | 'image'
+  | 'video'
+  | 'map-autocomplete'
+  | 'position'
+  | 'product'
+  | 'product-list'
+  | 'range'
+  | 'richtext'
+  | 'select'
+  | 'switch'
+  | 'text'
+  | 'textarea'
+  | 'toggle-group'
+  | 'metaobject'
+  | 'url'
+
+/** CSS properties accepted by Weaverse elements. */
+export type WeaverseCSSProperties = CSSProperties
+
+/** Nested CSS rules keyed by a child selector. */
+export type ChildElementCSS = Partial<{
+  /** Styles for a nested child selector. */
+  [selector: string]: WeaverseCSSProperties & ChildElementCSS
+}>
+
+/** A resource selected by its numeric identifier and handle. */
+export type WeaverseResourcePickerData = {
+  /** The resource's numeric identifier. */
+  id: number
+  /** The resource's URL-friendly handle. */
+  handle: string
+}
+
+/** Image metadata returned by a Weaverse image input. */
+export type WeaverseImage = {
+  /** The image identifier. */
+  id: string
+  /** The image URL. */
+  url: string
+  /** Alternative text for the image. */
+  altText: string
+  /** The intrinsic image width in pixels. */
+  width: number
+  /** The intrinsic image height in pixels. */
+  height: number
+  /** A lightweight URL suitable for previews. */
+  previewSrc: string
+}
+
+/** Video metadata returned by a Weaverse video input. */
+export type WeaverseVideo = {
+  /** The video identifier. */
+  id: string
+  /** The video URL. */
+  url: string
+  /** Alternative text for the video. */
+  altText: string
+  /** The intrinsic video width in pixels. */
+  width: number
+  /** The intrinsic video height in pixels. */
+  height: number
+  /** A lightweight URL suitable for previews. */
+  previewSrc: string
+}
+
+/** Additional configuration accepted by configurable input controls. */
+export type AdditionalInputConfigs =
+  | SelectInputConfigs
+  | ToggleGroupConfigs
+  | RangeInputConfigs
+
+/** Responsive CSS assigned to a Weaverse element. */
+export type ElementCSS = {
+  /** Styles applied at the desktop breakpoint. */
+  '@desktop'?: WeaverseCSSProperties | ChildElementCSS
+  /** Styles applied at the mobile breakpoint. */
+  '@mobile'?: WeaverseCSSProperties | ChildElementCSS
+}
+
+/** Serialized data for one element in a Weaverse project. */
+export type ElementData = {
+  /** The unique element identifier. */
+  id: string
+  /** The registered element type. */
+  type: string
+  /** Component-specific settings and metadata. */
+  [key: string]: any
+}
+
+/** Runtime metadata attached to a rendered Weaverse element. */
+export type WeaverseElement = {
+  /** The React component registered for the element. */
+  Component: ForwardRefExoticComponent<any>
+  /** The registered element type. */
+  type: string
+  /** The unique element identifier used in rendered markup. */
+  'data-wv-id': string
+  /** The element type used in rendered markup. */
+  'data-wv-type': string
+}
+
+/**
+ * Minimal legacy schema metadata for an element.
+ *
+ * @remarks Prefer `SchemaType` from `@weaverse/schema` for new schemas. This
+ * type remains available for backward compatibility.
+ */
+export type ElementSchema = {
+  /** The human-readable element title. */
+  title: string
+  /** The unique element type. */
+  type: string
+}
+
+/** Media query values used for responsive element styles. */
+export type BreakPoints = {
+  /** The media query used for mobile styles. */
+  mobile: string
+  /** The media query used for desktop styles. */
+  desktop: string
+}
+
+/** Serialized project data consumed by the Core runtime. */
+export type WeaverseProjectDataType = {
+  /** The optional project or page identifier. */
+  id?: string
+  /** All serialized elements in the project. */
+  items: ElementData[]
+  /** The identifier of the project's root element. */
+  rootId: string
+}
+
+/** Options used to initialize the Weaverse Core runtime. */
+export type WeaverseCoreParams = {
+  /** Custom media queries for responsive element styles. */
+  mediaBreakPoints?: BreakPoints
+  /** Base URL of the Weaverse Studio host. */
+  weaverseHost?: string
+  /** Weaverse runtime version exposed to integrations. */
+  weaverseVersion?: string
+  /** Identifier of the project being rendered. */
+  projectId: string
+  /** Initial serialized project data. */
+  data: WeaverseProjectDataType
+  /** Whether the runtime is connected to Studio design mode. */
+  isDesignMode?: boolean
+}
+
+/** Describes a legacy Studio input bound to element data or styles. */
+export type BasicInput<ConfigsType = AdditionalInputConfigs> = {
+  /** The input control to render. */
+  type: InputType
+  /** The element data or style property updated by the input. */
+  name: string
+  /** The label shown in Studio. */
+  label?: string
+  /** Additional control-specific configuration. */
+  configs?: ConfigsType
+  /** An expression controlling whether the input is displayed. */
+  condition?: string
+  /** The value used when the setting has not been customized. */
+  defaultValue?:
+    | string
+    | number
+    | boolean
+    | Partial<WeaverseImage>
+    | {
+        /** Structured input data keyed by field name. */
+        [x: string]: any
+      }
+  /** Placeholder text shown by supported controls. */
+  placeholder?: string
+  /** Supporting text shown alongside the input. */
+  helpText?: string
+}
+
+/** Configuration for a legacy select input. */
+export type SelectInputConfigs = {
+  /** Choices displayed by the input. */
+  options?: {
+    /** The value stored when the option is selected. */
+    value: string
+    /** The option label shown in Studio. */
+    label: string
+  }[]
+}
+
+/** Configuration for a legacy toggle-group input. */
+export type ToggleGroupConfigs = {
+  /** Choices displayed by the input. */
+  options?: {
+    /** The value stored when the option is selected. */
+    value: string
+    /** The option label shown in Studio. */
+    label: string
+    /** An optional icon displayed with the option. */
+    icon?: IconName
+  }[]
+}
+
+/** Configuration for a legacy range input. */
+export type RangeInputConfigs = {
+  /** The smallest selectable value. */
+  min?: number
+  /** The largest selectable value. */
+  max?: number
+  /** The increment between selectable values. */
+  step?: number
+  /** The unit displayed beside the value. */
+  unit?: string
+}
+
+declare global {
+  interface Window {
+    weaverseStudio: any
+  }
+}

package/src/utils/event-emitter.ts

@@ -0,0 +1,31 @@
+/** A callback accepted by the Core runtime event system. */
+export type AnyFunction = (...args: any[]) => any
+
+/** Provides synchronous subscription and notification for runtime updates. */
+export class EventEmitter {
+  /** Functions called when an update is emitted. */
+  listeners: Set<AnyFunction>
+
+  /** Creates an emitter with no listeners. */
+  constructor() {
+    this.listeners = new Set()
+  }
+
+  /** Adds a listener and returns a function that removes it. */
+  subscribe = (fn: AnyFunction) => {
+    this.listeners.add(fn)
+    return () => this.unsubscribe(fn)
+  }
+
+  /** Removes a previously subscribed listener. */
+  unsubscribe = (fn: AnyFunction) => {
+    this.listeners.delete(fn)
+  }
+
+  /** Calls every subscribed listener with the supplied data. */
+  emit = (data) => {
+    for (const fn of this.listeners) {
+      fn(data)
+    }
+  }
+}

package/src/utils/index.ts

@@ -0,0 +1,71 @@
+/** Whether the current runtime is React Native. */
+export let isReactNative =
+  typeof navigator === 'object' && navigator.product === 'ReactNative'
+
+/** Whether the current runtime provides a browser window. */
+export let isBrowser = typeof window !== 'undefined' && !isReactNative
+
+/** Whether the current browser window is embedded in an iframe. */
+export let isIframe = isBrowser && window.top !== window.self
+
+/** An object whose properties can be recursively merged. */
+export interface MergeObject {
+  /** Property value keyed by its object field name. */
+  [key: string]: any
+}
+
+/**
+ * Recursively merges object properties from `source` into a copy of `target`.
+ * Each nested non-array object owned by `source` is mutated in place and reused
+ * in the result. Arrays and non-object values replace the target value.
+ */
+export function merge(target: MergeObject, source: MergeObject): MergeObject {
+  let t = { ...(target || {}) }
+  // Iterate through `source` properties and if an `Object` set property to merge of `target` and `source` properties
+  for (let key of Object.keys(source)) {
+    if (source[key] instanceof Object && !Array.isArray(source[key])) {
+      Object.assign(source[key], merge(t[key], source[key]))
+    }
+  }
+
+  // Join `target` and modified `source`
+  Object.assign(t || {}, source)
+  return t
+}
+
+// Cache in-flight/settled loads per src. A bare `querySelector` check is not
+// enough: the tag exists as soon as the first caller appends it, so a second
+// caller arriving before the script *executes* would resolve early and read
+// globals (e.g. `window.weaverseStudio`) that aren't set yet. See issue #451.
+let scriptLoadPromises = new Map<string, Promise<unknown>>()
+
+/**
+ * Loads a script once and reuses the same promise for concurrent callers.
+ * Failed loads are removed so a later call can retry.
+ */
+export function loadScript(src: string) {
+  let pending = scriptLoadPromises.get(src)
+  if (pending) {
+    return pending
+  }
+  let promise = new Promise((resolve, reject) => {
+    let currScript = document.querySelector(`script[src="${src}"]`)
+    if (currScript) {
+      // Tag injected outside loadScript (e.g. SSR markup) — assume executed.
+      return resolve(true)
+    }
+    let script = document.createElement('script')
+    script.src = src
+    script.onload = resolve
+    script.onerror = (error) => {
+      // Drop the cache entry and the broken tag so a later call can retry.
+      scriptLoadPromises.delete(src)
+      script.remove()
+      reject(error)
+    }
+    script.defer = true
+    document.body.appendChild(script)
+  })
+  scriptLoadPromises.set(src, promise)
+  return promise
+}