@variousjs/various 4.0.1 → 4.1.0

package/index.d.ts

@@ -3,36 +3,59 @@ declare module '@variousjs/various' {
 
   export { default as Nycticorax, Dispatch } from 'nycticorax'
 
-  type $dispatch = (name: string, method: string, value?: any) => Promise<any>
-  type $postMessage = (event: string, value?: any) => void
-  export type Intl = (key: string, params?: Record<string, string | number>) => string
+  export type ErrorType =
+    'LOADING_ERROR' |
+    'SUBMODULE_LOADING_ERROR' |
+    'NOT_DEFINED' |
+    'INVALID_COMPONENT' |
+    'SCRIPT_ERROR' |
+    'APP_ERROR' |
+    'INVALID_MODULE' |
+    'SUBMODULE_NOT_DEFINED' |
+    'SUBMODULE_SCRIPT_ERROR' |
+    'DISPATCH' |
+    'I18N'
+
+  export interface ComponentDefaultProps {
+    $silent?: boolean,
+  }
 
-  type RenderComponent = (params: {
-    name: string,
-    url?: string,
+  export interface VariousError extends Error {
+    type: ErrorType,
+    originalError: Error,
     module?: string,
-    props?: Record<string, any>,
-    target: Element | null,
-    onMounted?: () => void,
-  }) => () => void
+    name: string,
+  }
+
+  type ObjectAny = Record<string, any>
+
+  export interface ModuleDefined { name: string, module?: string }
+
+  interface Message { event: string, value: any, trigger: ModuleDefined }
+
+  type $dispatch = (args: ModuleDefined & {
+    action: string,
+    value: any,
+  }) => Promise<any>
+  type $postMessage = (event: string, value: any) => void
+
+  export type Intl = (key: string, params?: Record<string, string | number>) => string
 
   export type ENV = 'development' | 'production'
 
-  export type Invoker = (value: any, trigger: string) => any
+  export type PublicAction = (value: any, trigger: ModuleDefined) => any
 
   export type I18n = () => {
     localeKey: string,
     resources: Record<string, Record<string, string>>,
   }
 
-  export interface Message { event: string, component: string, value?: any }
-
   export type OnMessage = (message: Message) => void
 
   export interface StaticProps {
     $i18n?: I18n,
     $onMessage?: OnMessage,
-    [x: string]: Invoker,
+    [x: string]: PublicAction,
   }
 
   export type ComponentProps<
@@ -50,66 +73,56 @@ declare module '@variousjs/various' {
     P extends object = {}
   > = FC<ComponentProps<S, P>> & StaticProps
 
-  export type ErrorType = 'LOADING_ERROR' | 'DEPENDENCIES_LOADING_ERROR' | 'NOT_DEFINED' | 'INVALID_COMPONENT' | 'SCRIPT_ERROR' | 'APP_ERROR'
-  export interface ErrorProps<S extends object = {}> {
+  export interface ErrorNodeProps<S extends object = ObjectAny> {
     $reload?: () => void,
-    $type: ErrorType,
-    $message?: string,
+    $error: VariousError,
     $store: Readonly<S>,
   }
-  export type ErrorNode<S extends object = {}> = ComponentType<ErrorProps<S>>
+  export type ErrorNode<S extends object = ObjectAny> = ComponentType<ErrorNodeProps<S>>
 
-  export interface LoaderProps<S extends object = {}> { $store: Readonly<S>}
-  export type LoaderNode<S extends object = {}> = ComponentType<LoaderProps<S>>
+  export interface LoaderNodeProps<S extends object = ObjectAny> { $store: Readonly<S>}
+  export type LoaderNode<S extends object = ObjectAny> = ComponentType<LoaderNodeProps<S>>
 
-  type Dispatch<T extends object> = (
+  type Dispatch<T extends object = ObjectAny> = (
     nycticorax: {
       getStore: <K extends keyof T | undefined = undefined>(k?: K | undefined) =>
         K extends keyof T ? T[K] : T,
       emit: (next: Partial<T>) => void,
     },
     value: any,
-    trigger: string,
+    trigger: ModuleDefined,
   ) => Promise<any>
 
-  export type Actions<S extends object = {}> = Record<string, Dispatch<S>>
-
   interface MessageEventArgs {
-    trigger: string,
+    trigger: ModuleDefined,
     event: string,
-    value?: any,
+    value: any,
   }
   type MessageEventRes = boolean | Omit<MessageEventArgs, 'trigger'>
   interface DispatchEventArgs {
-    target: string,
-    trigger: string,
-    method: string,
-    value?: any,
+    target: ModuleDefined,
+    trigger: ModuleDefined,
+    action: string,
+    value: any,
   }
   type DispatchEventRes = boolean | Omit<DispatchEventArgs, 'trigger'>
-  interface LoadEventArgs {
-    name: string,
+  interface LoadEventArgs extends ModuleDefined {
     loadStart: number,
     loadEnd: number,
-    duration: number,
     beenLoaded: boolean,
   }
-  interface ErrorEventArgs {
-    name: string,
-    errorType: ErrorType | 'dispatch' | 'i18n',
-    errorMessage: string,
-  }
+
   export type MessageEvent = (e: MessageEventArgs) => Promise<MessageEventRes> | MessageEventRes
   export type DispatchEvent = (e: DispatchEventArgs) => Promise<DispatchEventRes> | DispatchEventRes
   export type LoadEvent = (e: LoadEventArgs) => void
-  export type ErrorEvent = (e: ErrorEventArgs) => void
+  export type ErrorEvent = (e: VariousError) => void
 
-  export interface App<S extends object = {}> {
+  export interface App<S extends object = ObjectAny> {
     store?: readonly S,
     Error?: ErrorNode<S>,
     Loader?: LoaderNode<S>,
-    actions?: Actions<S>,
-    Container: ComponentType,
+    actions?: Record<string, Dispatch<S>>,
+    Container: ComponentType<any>,
     middlewares?: {
       onLoad?: LoadEvent,
       onError?: ErrorEvent,
@@ -130,23 +143,36 @@ declare module '@variousjs/various' {
     earlyParallelComponents?: string[],
   }
 
-  export function createComponent<S extends object = {}> (
-    name: string, storeKeys?: (keyof S)[]
-  ): ComponentType<{
-    $silent?: boolean,
-    [key: string]: any,
-  }>
-  export const renderComponent: RenderComponent
+  export function createComponent<
+    S extends object = ObjectAny,
+    P extends object = ObjectAny
+  >(
+    config: ModuleDefined & { url?: string },
+    storeKeys?: (keyof S)[],
+  ): ComponentType<ComponentDefaultProps & P>
+
+  export function createModule<T = unknown> (params: ModuleDefined & {
+    url?: string,
+  }): Promise<T>
+
+  export function renderComponent<P extends object = ObjectAny>(params: ModuleDefined & {
+    url?: string,
+    props?: P & ComponentDefaultProps,
+    target: Element | null,
+    onMounted?: () => void,
+  }): () => void
 
-  export const isComponentLoaded: (name: string) => boolean
-  export const getMountedComponents: () => string[]
-  export const preloadComponents: (names: string[]) => Promise<void>
-  export const onComponentMounted: (name: string | string[], callback: () => void) => () => void
+  export const isModuleLoaded: (moduleDefined: ModuleDefined) => boolean
+  export const getMountedComponents: () => ModuleDefined[]
+  export const preloadPackages: (name: string | string[]) => Promise<void>
+  export const onComponentMounted: (
+    name: ModuleDefined | ModuleDefined[], callback: () => void
+  ) => () => void
 
   export const getEnv: () => ENV
-  export function getConfig<C extends object = {}>(): C
-  export function getStore<S extends object = {}>(): S
+  export function getConfig<C extends object = ObjectAny>(): C
+  export function getStore<S extends object = ObjectAny>(): S
 
-  export const createDispatch: (name: string) => $dispatch
-  export const createPostMessage: (name: string) => $postMessage
+  export const createDispatch: (m: ModuleDefined) => $dispatch
+  export const createPostMessage: (m: ModuleDefined) => $postMessage
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@variousjs/various",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "RequireJS(AMD) + React",
   "files": [
     "dist",