Have ideas to improve npm?Join in the discussion! »

    microapp-service-layer
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.26 • Public • Published

    microapp-service-layer

    Example

    import MSL, { microappId } from 'microapp-service-layer';
    import MicroappEventBus, { Events } from 'microapp-service-layer/lib/eventbus';
     
    MSL.createApp({ elementOrSelector: `#${microappId}` });
    MicroappEventBus.emit(Events.DID_UPDATE, { created: true });

    Api

    interface MicroappServiceLayer {
      microappInstance: MicroappInstance | null;
     
      isMicroappInstanceRegistered: boolean;
     
      registerMicroappInstance(): Promise<Result>;
     
      unregisterMicroappInstance(): void;
     
      createTemplate(options: CreateTemplateOptions): Promise<Template>;
     
      createApp(options: CreateAppOptions): Promise<App | null>;
    }
     
    type MicroappInstance = {
      createApp: (options: CreateAppOptions) => Promise<App | null>;
      getInitialOptions?: () => Record<string, unknown>;
    };
     
    type CreateAppOptions = {
      appId?: string;
      elementOrSelector: Element | string;
      eventbus?: unknown;
      mount?: boolean;
      state?: Record<string, any>;
      beforeCreate?: (...args: unknown[]) => void;
    };
     
    type CreateTemplateOptions = {
      path: string;
      [key: string]: any;
    };
     
    type Template = {
      html: string;
      state: string;
      styles: string;
      template?: string;
    };
     
    type Result = {
      ok: boolean;
    };
     
    export type App = {
      app: unknown;
      router: unknown;
      store: unknown;
    };

    .envs

    MSL_API_URL || VUE_APP_MSL_API_URL || http://localhost:5000
    

    Keywords

    none

    Install

    npm i microapp-service-layer

    DownloadsWeekly Downloads

    30

    Version

    0.0.26

    License

    none

    Unpacked Size

    20.8 kB

    Total Files

    24

    Last publish

    Collaborators

    • avatar