@bbq-chat/widgets-angular 1.0.1 → 1.0.3

package/src/custom-widget-renderer.types.ts

@@ -1,120 +0,0 @@
-import { Type, TemplateRef } from '@angular/core';
-import { ChatWidget } from '@bbq-chat/widgets';
-
-/**
- * Context provided to template-based custom widget renderers
- */
-export interface WidgetTemplateContext {
-  /**
-   * The widget instance being rendered
-   */
-  $implicit: ChatWidget;
-  
-  /**
-   * The widget instance (alternative access)
-   */
-  widget: ChatWidget;
-  
-  /**
-   * Emit a widget action
-   */
-  emitAction: (actionName: string, payload: unknown) => void;
-}
-
-/**
- * Interface for component-based custom widget renderers
- */
-export interface CustomWidgetComponent {
-  /**
-   * The widget instance to render
-   */
-  widget: ChatWidget;
-  
-  /**
-   * Event emitter for widget actions (optional, will be set by the renderer)
-   */
-  widgetAction?: (actionName: string, payload: unknown) => void;
-}
-
-/**
- * Type for custom widget renderer functions that return HTML strings
- */
-export type CustomWidgetHtmlRenderer = (widget: ChatWidget) => string;
-
-/**
- * Type for custom widget renderer configurations
- */
-export type CustomWidgetRenderer =
-  | CustomWidgetHtmlRenderer
-  | Type<CustomWidgetComponent>
-  | TemplateRef<WidgetTemplateContext>;
-
-/**
- * Configuration for registering a custom widget renderer
- */
-export interface CustomWidgetRendererConfig {
-  /**
-   * The widget type identifier
-   */
-  type: string;
-  
-  /**
-   * The renderer: can be a function returning HTML, an Angular Component class, or a TemplateRef
-   */
-  renderer: CustomWidgetRenderer;
-}
-
-/**
- * Type guard to check if a renderer is a TemplateRef
- */
-export function isTemplateRenderer(
-  renderer: CustomWidgetRenderer
-): renderer is TemplateRef<WidgetTemplateContext> {
-  return (
-    renderer !== null &&
-    typeof renderer === 'object' &&
-    'createEmbeddedView' in renderer
-  );
-}
-
-/**
- * Type guard to check if a renderer is an Angular Component
- * 
- * Note: This uses a heuristic check based on the following assumptions:
- * 1. Components are constructor functions
- * 2. Components have a prototype with a constructor property
- * 3. Components typically use dependency injection (no required constructor params)
- * 
- * Limitation: This may not detect components with required constructor parameters.
- * For edge cases, explicitly check your component's constructor signature.
- * 
- * Alternative: You can always register a wrapper component that has no required params.
- */
-export function isComponentRenderer(
-  renderer: CustomWidgetRenderer
-): renderer is Type<CustomWidgetComponent> {
-  // Check if it's a function (constructor) but not a regular function renderer
-  if (typeof renderer !== 'function') {
-    return false;
-  }
-  
-  // Check for Angular component characteristics
-  // Components typically have prototype with constructor property
-  return (
-    renderer.prototype !== undefined &&
-    renderer.prototype.constructor === renderer &&
-    renderer.length === 0 // Constructor with no required params (Angular DI)
-  );
-}
-
-/**
- * Type guard to check if a renderer is an HTML function
- * 
- * Note: This should be checked AFTER checking for component and template renderers
- * since components are also functions but with additional properties.
- */
-export function isHtmlRenderer(
-  renderer: CustomWidgetRenderer
-): renderer is CustomWidgetHtmlRenderer {
-  return typeof renderer === 'function';
-}

package/src/index.ts

@@ -1,75 +0,0 @@
-/**
- * @bbq-chat/widgets-angular
- * 
- * Angular components and services for BbQ ChatWidgets
- * 
- * This package provides Angular-native components and services that wrap
- * the core @bbq-chat/widgets library, making it easy to integrate chat
- * widgets into Angular applications.
- * 
- * @packageDocumentation
- */
-
-// Export components
-export { WidgetRendererComponent } from './widget-renderer.component';
-
-// Export services
-export { WidgetRegistryService } from './widget-registry.service';
-
-// Export DI tokens and factories
-export {
-  WIDGET_EVENT_MANAGER_FACTORY,
-  SSR_WIDGET_RENDERER,
-  widgetEventManagerFactoryProvider,
-  ssrWidgetRendererFactory,
-} from './widget-di.tokens';
-
-export type { WidgetEventManagerFactory } from './widget-di.tokens';
-
-// Export custom widget renderer types
-export type {
-  CustomWidgetComponent,
-  CustomWidgetRenderer,
-  CustomWidgetHtmlRenderer,
-  CustomWidgetRendererConfig,
-  WidgetTemplateContext,
-} from './custom-widget-renderer.types';
-
-export {
-  isHtmlRenderer,
-  isComponentRenderer,
-  isTemplateRenderer,
-} from './custom-widget-renderer.types';
-
-// Re-export commonly used types and classes from core package
-export {
-  ChatWidget,
-} from '@bbq-chat/widgets';
-
-export type {
-  ButtonWidget,
-  CardWidget,
-  FormWidget,
-  InputWidget,
-  TextAreaWidget,
-  DropdownWidget,
-  SliderWidget,
-  ToggleWidget,
-  FileUploadWidget,
-  DatePickerWidget,
-  MultiSelectWidget,
-  ProgressBarWidget,
-  ThemeSwitcherWidget,
-  ImageWidget,
-  ImageCollectionWidget,
-} from '@bbq-chat/widgets';
-
-// Re-export utilities
-export {
-  SsrWidgetRenderer,
-  WidgetEventManager,
-  customWidgetRegistry,
-} from '@bbq-chat/widgets';
-
-// Version
-export const VERSION = '1.0.1';

package/src/public_api.ts

@@ -1,75 +0,0 @@
-/**
- * @bbq-chat/widgets-angular
- * 
- * Angular components and services for BbQ ChatWidgets
- * 
- * This package provides Angular-native components and services that wrap
- * the core @bbq-chat/widgets library, making it easy to integrate chat
- * widgets into Angular applications.
- * 
- * @packageDocumentation
- */
-
-// Export components
-export { WidgetRendererComponent } from './widget-renderer.component';
-
-// Export services
-export { WidgetRegistryService } from './widget-registry.service';
-
-// Export DI tokens and factories
-export {
-  WIDGET_EVENT_MANAGER_FACTORY,
-  SSR_WIDGET_RENDERER,
-  widgetEventManagerFactoryProvider,
-  ssrWidgetRendererFactory,
-} from './widget-di.tokens';
-
-export type { WidgetEventManagerFactory } from './widget-di.tokens';
-
-// Export custom widget renderer types
-export type {
-  CustomWidgetComponent,
-  CustomWidgetRenderer,
-  CustomWidgetHtmlRenderer,
-  CustomWidgetRendererConfig,
-  WidgetTemplateContext,
-} from './custom-widget-renderer.types';
-
-export {
-  isHtmlRenderer,
-  isComponentRenderer,
-  isTemplateRenderer,
-} from './custom-widget-renderer.types';
-
-// Re-export commonly used types and classes from core package
-export {
-  ChatWidget,
-} from '@bbq-chat/widgets';
-
-export type {
-  ButtonWidget,
-  CardWidget,
-  FormWidget,
-  InputWidget,
-  TextAreaWidget,
-  DropdownWidget,
-  SliderWidget,
-  ToggleWidget,
-  FileUploadWidget,
-  DatePickerWidget,
-  MultiSelectWidget,
-  ProgressBarWidget,
-  ThemeSwitcherWidget,
-  ImageWidget,
-  ImageCollectionWidget,
-} from '@bbq-chat/widgets';
-
-// Re-export utilities
-export {
-  SsrWidgetRenderer,
-  WidgetEventManager,
-  customWidgetRegistry,
-} from '@bbq-chat/widgets';
-
-// Version
-export const VERSION = '1.0.1';

package/src/widget-di.tokens.ts

@@ -1,63 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import { SsrWidgetRenderer, WidgetEventManager, IWidgetActionHandler } from '@bbq-chat/widgets';
-
-/**
- * Injection token for WidgetEventManager factory
- * 
- * Use this token to inject a factory function that creates WidgetEventManager instances.
- * The factory accepts an optional action handler to configure the manager.
- * 
- * @example
- * ```typescript
- * constructor(@Inject(WIDGET_EVENT_MANAGER_FACTORY) private eventManagerFactory: WidgetEventManagerFactory) {
- *   const actionHandler = { handle: async (action, payload) => { ... } };
- *   this.eventManager = this.eventManagerFactory(actionHandler);
- * }
- * ```
- */
-export type WidgetEventManagerFactory = (actionHandler?: IWidgetActionHandler) => WidgetEventManager;
-
-export const WIDGET_EVENT_MANAGER_FACTORY = new InjectionToken<WidgetEventManagerFactory>(
-  'WIDGET_EVENT_MANAGER_FACTORY'
-);
-
-/**
- * Injection token for SsrWidgetRenderer
- * 
- * Use this token to inject a SsrWidgetRenderer instance in your components.
- * By default, WidgetRendererComponent provides this token with a factory that creates
- * a new instance for each component.
- * 
- * @example
- * ```typescript
- * constructor(@Inject(SSR_WIDGET_RENDERER) private renderer: SsrWidgetRenderer) {}
- * ```
- */
-export const SSR_WIDGET_RENDERER = new InjectionToken<SsrWidgetRenderer>(
-  'SSR_WIDGET_RENDERER'
-);
-
-/**
- * Factory function for creating WidgetEventManager instances
- * 
- * This factory is used by default in WidgetRendererComponent's providers array.
- * You can override this in your own providers if you need custom initialization.
- * 
- * @returns A factory function that creates WidgetEventManager instances
- */
-export function widgetEventManagerFactoryProvider(): WidgetEventManagerFactory {
-  return (actionHandler?: IWidgetActionHandler) => new WidgetEventManager(actionHandler);
-}
-
-/**
- * Factory function for creating SsrWidgetRenderer instances
- * 
- * This factory is used by default in WidgetRendererComponent's providers array.
- * You can override this in your own providers if you need custom initialization
- * or custom rendering options.
- * 
- * @returns A new SsrWidgetRenderer instance
- */
-export function ssrWidgetRendererFactory(): SsrWidgetRenderer {
-  return new SsrWidgetRenderer();
-}

package/src/widget-registry.service.ts

@@ -1,128 +0,0 @@
-import { Injectable } from '@angular/core';
-import { customWidgetRegistry, ChatWidget } from '@bbq-chat/widgets';
-import { CustomWidgetRenderer } from './custom-widget-renderer.types';
-
-/**
- * Service for registering custom widget factories and renderers
- * 
- * This service provides a centralized way to register custom widget types
- * that extend the base widget functionality, including support for
- * Angular components and templates as custom renderers.
- * 
- * @example
- * ```typescript
- * constructor(private widgetRegistry: WidgetRegistryService) {
- *   // Register a widget factory
- *   this.widgetRegistry.registerFactory('myWidget', (obj) => {
- *     if (obj.type === 'myWidget') {
- *       return new MyCustomWidget(obj.label, obj.action);
- *     }
- *     return null;
- *   });
- * 
- *   // Register a component-based renderer
- *   this.widgetRegistry.registerRenderer('myWidget', MyWidgetComponent);
- * }
- * ```
- */
-@Injectable({
-  providedIn: 'root',
-})
-export class WidgetRegistryService {
-  private readonly customRenderers = new Map<string, CustomWidgetRenderer>();
-  /**
-   * Register a custom widget factory function
-   * 
-   * @param type - The widget type identifier
-   * @param factory - Factory function that creates widget instances from plain objects
-   */
-  registerFactory(
-    type: string,
-    factory: (obj: unknown) => ChatWidget | null
-  ): void {
-    customWidgetRegistry.registerFactory(type, factory);
-  }
-
-  /**
-   * Register a widget class with automatic factory creation
-   * 
-   * @param type - The widget type identifier
-   * @param ctor - Widget class constructor
-   */
-  registerClass(type: string, ctor: any): void {
-    customWidgetRegistry.registerClass(type, ctor);
-  }
-
-  /**
-   * Get a factory for a specific widget type
-   * 
-   * @param type - The widget type identifier
-   * @returns The factory function if registered, undefined otherwise
-   */
-  getFactory(type: string): ((obj: any) => ChatWidget | null) | undefined {
-    return customWidgetRegistry.getFactory(type);
-  }
-
-  /**
-   * Register a custom renderer for a specific widget type
-   * 
-   * The renderer can be:
-   * - A function that returns HTML string
-   * - An Angular Component class
-   * - An Angular TemplateRef
-   * 
-   * @param type - The widget type identifier
-   * @param renderer - The custom renderer (function, Component, or TemplateRef)
-   * 
-   * @example
-   * ```typescript
-   * // HTML function renderer
-   * widgetRegistry.registerRenderer('weather', (widget) => `<div>${widget.label}</div>`);
-   * 
-   * // Component renderer
-   * widgetRegistry.registerRenderer('weather', WeatherWidgetComponent);
-   * 
-   * // Template renderer (from @ViewChild or elsewhere)
-   * widgetRegistry.registerRenderer('weather', this.weatherTemplate);
-   * ```
-   */
-  registerRenderer(type: string, renderer: CustomWidgetRenderer): void {
-    if (!type || typeof type !== 'string') {
-      throw new Error('type must be a non-empty string');
-    }
-    if (!renderer) {
-      throw new Error('renderer is required');
-    }
-    this.customRenderers.set(type, renderer);
-  }
-
-  /**
-   * Get a custom renderer for a specific widget type
-   * 
-   * @param type - The widget type identifier
-   * @returns The custom renderer if registered, undefined otherwise
-   */
-  getRenderer(type: string): CustomWidgetRenderer | undefined {
-    return this.customRenderers.get(type);
-  }
-
-  /**
-   * Check if a custom renderer is registered for a widget type
-   * 
-   * @param type - The widget type identifier
-   * @returns True if a custom renderer is registered, false otherwise
-   */
-  hasRenderer(type: string): boolean {
-    return this.customRenderers.has(type);
-  }
-
-  /**
-   * Unregister a custom renderer for a widget type
-   * 
-   * @param type - The widget type identifier
-   * @returns True if a renderer was removed, false if none was registered
-   */
-  unregisterRenderer(type: string): boolean {
-    return this.customRenderers.delete(type);
-  }
-}