@bagelink/blox 1.5.15 → 1.5.17

package/dist/setup.d.ts

@@ -1,24 +1,132 @@
+import { App } from 'vue';
+import { Router } from 'vue-router';
 import { ComponentConfig } from './config/baseComponents';
+export interface BloxInstance {
+    /**
+     * Register one or more components with the Blox library
+     * Accepts either a single component config or an array of component configs
+     */
+    registerComponents: (components: ComponentConfig | ComponentConfig[], options?: RegisterOptions) => BloxInstance;
+    /**
+     * Register routes for preview pages with your Vue Router
+     */
+    registerRoutes: (router: Router, options?: RouteOptions) => BloxInstance;
+    /**
+     * Get all registered component configurations
+     */
+    getRegisteredComponents: () => ComponentConfig[];
+    /**
+     * Get components by category
+     */
+    getComponentsByCategory: (category: string) => ComponentConfig[];
+    /**
+     * Get a list of registered component IDs
+     */
+    getComponentIds: () => string[];
+    /**
+     * Check if a component is registered
+     */
+    hasComponent: (id: string) => boolean;
+    /**
+     * Install the Blox plugin into your Vue app
+     */
+    install: (app: App) => void;
+}
+export interface RegisterOptions {
+    /**
+     * Category to assign to the components
+     */
+    category?: string;
+    /**
+     * Skip validation for component configs
+     * @default false
+     */
+    skipValidation?: boolean;
+}
+export interface RouteOptions {
+    /**
+     * Base path for the preview routes
+     * @default '/blox'
+     */
+    basePath?: string;
+    /**
+     * Path for the external preview route
+     * @default '/preview/:pageId?'
+     */
+    previewPath?: string;
+    /**
+     * Path for the render page route
+     * @default '/render/:pageId?'
+     */
+    renderPath?: string;
+    /**
+     * Additional route meta properties
+     */
+    meta?: Record<string, any>;
+}
+export interface BloxOptions {
+    /**
+     * Enable debug mode for additional logging
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Automatically register base components on first registerComponents call
+     * @default true
+     */
+    autoRegisterBaseComponents?: boolean;
+}
 /**
- * Register all base components from the library
- * Call this in your project's setup to make base components available
+ * Validation error class
  */
-export declare function registerBaseComponents(): void;
+export declare class ComponentValidationError extends Error {
+    componentId?: string | undefined;
+    constructor(message: string, componentId?: string | undefined);
+}
+/**
+ * Create a new Blox instance with a fluent API
+ *
+ * @param options - Configuration options for the Blox instance
+ *
+ * @example
+ * ```ts
+ * import { createBlox, ButtonConfig, TextConfig } from '@bagelink/blox'
+ * import { MyCustomComp } from './components'
+ *
+ * const blox = createBlox({ debug: true })
+ * blox.registerComponents([ButtonConfig, TextConfig, MyCustomComp])
+ * blox.registerRoutes(router)
+ *
+ * app.use(blox)
+ * ```
+ */
+export declare function createBlox(options?: BloxOptions): BloxInstance;
+/**
+ * Helper to create a custom component configuration with better TypeScript inference
+ */
+export declare function createComponentConfig<T extends ComponentConfig>(config: T): T;
 /**
  * Get all component configurations (base + custom)
  * This returns both the Vue components and their editor schemas
  */
 export declare function getAllComponentConfigs(customConfigs?: ComponentConfig[]): ComponentConfig[];
 /**
- * Helper to create a custom component configuration
+ * Register all base components from the library
+ * Call this in your project's setup to make base components available
+ *
+ * @deprecated Use `createBlox().registerComponents()` instead for a simpler API
  */
-export declare function createComponentConfig(config: ComponentConfig): ComponentConfig;
+export declare function registerBaseComponents(): void;
 /**
  * Register a single custom component
+ *
+ * @deprecated Use `createBlox().registerComponents()` instead for a simpler API
  */
 export declare function registerCustomComponent(config: ComponentConfig): void;
 /**
  * Register multiple custom components
+ *
+ * @deprecated Use `createBlox().registerComponents()` instead for a simpler API
  */
 export declare function registerCustomComponents(configs: ComponentConfig[]): void;
 //# sourceMappingURL=setup.d.ts.map

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../setup.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAwB,KAAK,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAGpF;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAS7C;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,GAAE,eAAe,EAAO,GAAG,eAAe,EAAE,CAE/F;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAE9E;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAGrE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,CAIzE"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../setup.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAC9B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAwB,KAAK,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAKpF,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,kBAAkB,EAAE,CACnB,UAAU,EAAE,eAAe,GAAG,eAAe,EAAE,EAC/C,OAAO,CAAC,EAAE,eAAe,KACrB,YAAY,CAAA;IAEjB;;OAEG;IACH,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,KAAK,YAAY,CAAA;IAExE;;OAEG;IACH,uBAAuB,EAAE,MAAM,eAAe,EAAE,CAAA;IAEhD;;OAEG;IACH,uBAAuB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,eAAe,EAAE,CAAA;IAEhE;;OAEG;IACH,eAAe,EAAE,MAAM,MAAM,EAAE,CAAA;IAE/B;;OAEG;IACH,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAA;IAErC;;OAEG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,eAAe;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC1B;AAED,MAAM,WAAW,WAAW;IAC3B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAA;CACpC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;IACd,WAAW,CAAC,EAAE,MAAM;gBAA5C,OAAO,EAAE,MAAM,EAAS,WAAW,CAAC,EAAE,MAAM,YAAA;CAIxD;AAoGD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,UAAU,CAAC,OAAO,GAAE,WAAgB,GAAG,YAAY,CA2LlE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,eAAe,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAE7E;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,aAAa,GAAE,eAAe,EAAO,GAAG,eAAe,EAAE,CAE/F;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,IAAI,IAAI,CAS7C;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAGrE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,IAAI,CAIzE"}

package/dist/styles.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Blox CSS Styles
+ *
+ * Import this file to include Blox styles in your application.
+ * This file is automatically imported when cssAutoImport is enabled (default).
+ */
+export {};
+//# sourceMappingURL=styles.d.ts.map

package/dist/styles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../styles.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/views/ExternalPreview.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExternalPreview.vue.d.ts","sourceRoot":"","sources":["../../views/ExternalPreview.vue"],"names":[],"mappings":"AAAA,OA8aO,KAAK,EAAiB,QAAQ,EAAE,MAAM,eAAe,CAAA;AAQ5D,UAAU,KAAK;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,eAAe,CAAC,EAAE,QAAQ,CAAA;IAC1B,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAA;CACxB;;YAHS,MAAM;sBAEI,GAAG,EAAE;;AAoXzB,wBAQG"}
+{"version":3,"file":"ExternalPreview.vue.d.ts","sourceRoot":"","sources":["../../views/ExternalPreview.vue"],"names":[],"mappings":"AAiaA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAiB,QAAQ,EAAE,MAAM,eAAe,CAAA;AAQ5D,UAAU,KAAK;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,eAAe,CAAC,EAAE,QAAQ,CAAA;IAC1B,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAA;CACxB;;YAHS,MAAM;sBAEI,GAAG,EAAE;;AAqXzB,wBAQG"}

package/dist/views/RenderPage.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RenderPage.vue.d.ts","sourceRoot":"","sources":["../../views/RenderPage.vue"],"names":[],"mappings":"AAAA,OAwIO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAO7C,UAAU,KAAK;IACd,QAAQ,EAAE,QAAQ,CAAA;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACzB;;sBADmB,MAAM;;AAsI1B,wBAQG"}
+{"version":3,"file":"RenderPage.vue.d.ts","sourceRoot":"","sources":["../../views/RenderPage.vue"],"names":[],"mappings":"AAiIA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAO7C,UAAU,KAAK;IACd,QAAQ,EAAE,QAAQ,CAAA;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACzB;;sBADmB,MAAM;;AAsI1B,wBAQG"}

package/index.ts

@@ -5,27 +5,37 @@
 
 // Component exports
 export * from './components'
+
 // Configuration exports
 export * from './config/baseComponents'
+
+// Core exports
 export * from './core/communication'
 export * from './core/registry'
-
 export * from './core/renderer'
-// Core exports
 export * from './core/types'
 
-// Setup and registration helpers
+// Setup and registration - Main API
 export {
+	type BloxInstance,
+	type BloxOptions,
+	ComponentValidationError,
+	createBlox,
 	createComponentConfig,
+	type RegisterOptions,
+	type RouteOptions,
+} from './setup'
+
+// Legacy exports (deprecated)
+export {
 	getAllComponentConfigs,
 	registerBaseComponents,
 	registerCustomComponent,
 	registerCustomComponents,
 } from './setup'
 
-export * from './utils/normalizer'
-
 // Utility exports
+export * from './utils/normalizer'
 export * from './utils/styles'
 
 // View exports

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bagelink/blox",
   "type": "module",
-  "version": "1.5.15",
+  "version": "1.5.17",
   "description": "Blox page builder library for drag-and-drop page building and static data management",
   "author": {
     "name": "Bagel Studio",
@@ -74,7 +74,8 @@
     "access": "public"
   },
   "peerDependencies": {
-    "vue": "^3.3.0"
+    "vue": "^3.3.0",
+    "vue-router": "^4.0.0"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^5.0.0",
@@ -84,6 +85,7 @@
     "vite-plugin-dts": "^4.0.0",
     "vite-tsconfig-paths": "^5.0.0",
     "vue": "^3.5.16",
+    "vue-router": "^4.6.3",
     "vue-tsc": "^2.0.0"
   },
   "scripts": {