@onlistify/storefront 0.1.0

package/README.md

@@ -0,0 +1,41 @@
+# ONlistify Storefront
+
+App y SDK para mostrar el storefront de un tenant (tema, bloques, listado de propiedades).
+
+## SDK
+
+Build de la librería: `pnpm run build:sdk`. Salida en `dist/` (ESM, CJS y `.d.ts`).
+
+### Uso rápido
+
+```ts
+import { bootSiteRuntime } from 'onlistify-storefront';
+
+const app = document.getElementById('app');
+if (app) {
+  await bootSiteRuntime(app);
+}
+```
+
+La URL debe ser `/tienda/:slug` (ej. `/tienda/mi-inmobiliaria`). El SDK obtiene el slug del pathname.
+
+### Configuración
+
+- **API base:** variable de entorno `VITE_PUBLIC_API_URL` o `bootSiteRuntime(app, { baseUrl: 'https://api.ejemplo.com' })`. También `setApiBase(url)` antes de cualquier `fetch*`.
+- **Entorno:** `bootSiteRuntime(app, { environment: 'draft' | 'live' })`. Por defecto usa `?environment=draft` en la URL o `live`.
+- **Slug custom:** `bootSiteRuntime(app, { getSlugFromPath: (pathname) => 'mi-tenant' })`.
+- **Errores:** `bootSiteRuntime(app, { onError: (err) => console.error(err) })`.
+
+### API pública
+
+- `bootSiteRuntime(app, options?)` — monta la UI en el elemento.
+- `fetchSiteConfig(slug, environment?)` — configuración del sitio.
+- `fetchProperties(slug, params?)` — listado de propiedades.
+- `fetchPlugins(slug)` — plugins/bloques.
+- `setApiBase(url)` — define la base de la API.
+- Tipos: `SiteConfig`, `BlockDef`, `PageDef`, `PublicPropertySummary`, `ListPropertiesParams`, `BootSiteRuntimeOptions`, `StorefrontConfigError`, `StorefrontNetworkError`, etc.
+
+### Errores
+
+- `StorefrontConfigError`: fallo HTTP de configuración o propiedades (`status` opcional).
+- `StorefrontNetworkError`: fallo de red (`cause` con el error original).