Comparing version 0.3.0 to 0.4.0
@@ -6,2 +6,13 @@ # Change Log | ||
# [0.4.0](https://github.com/nuxt/framework/compare/@nuxt/kit@0.3.0...@nuxt/kit@0.4.0) (2021-04-12) | ||
### Features | ||
* add hook signatures and basic typings ([#79](https://github.com/nuxt/framework/issues/79)) ([dacde63](https://github.com/nuxt/framework/commit/dacde630634700172ccd54a1e4f1d0469b28bd30)) | ||
# [0.3.0](https://github.com/nuxt/framework/compare/@nuxt/kit@0.2.0...@nuxt/kit@0.3.0) (2021-04-09) | ||
@@ -8,0 +19,0 @@ |
@@ -0,1 +1,3 @@ | ||
import { IncomingMessage, ServerResponse } from 'http'; | ||
import { Configuration, Compiler, Stats } from 'webpack'; | ||
import * as unctx from 'unctx'; | ||
@@ -21,3 +23,3 @@ | ||
* Uses {srcDir}/app.html if exists by default otherwise nuxt default | ||
* @default "/home/pooya/tmp/framework/packages/kit/<rootDir>/.nuxt/views/app.template.html" | ||
* @default "/home/pooya/Code/framework/packages/kit/<rootDir>/.nuxt/views/app.template.html" | ||
*/ | ||
@@ -163,9 +165,9 @@ appTemplatePath: string, | ||
/** @default "/home/pooya/tmp/framework/packages/kit/<rootDir>" */ | ||
/** @default "/home/pooya/Code/framework/packages/kit/<rootDir>" */ | ||
rootDir: string, | ||
/** @default "/home/pooya/tmp/framework/packages/kit/<rootDir>" */ | ||
/** @default "/home/pooya/Code/framework/packages/kit/<rootDir>" */ | ||
srcDir: string, | ||
/** @default "/home/pooya/tmp/framework/packages/kit/<rootDir>/.nuxt" */ | ||
/** @default "/home/pooya/Code/framework/packages/kit/<rootDir>/.nuxt" */ | ||
buildDir: string, | ||
@@ -225,3 +227,3 @@ | ||
/** @default ["/home/pooya/tmp/framework/packages/kit/<rootDir>/node_modules","/home/pooya/tmp/framework/packages/kit/node_modules"] */ | ||
/** @default ["/home/pooya/Code/framework/packages/kit/<rootDir>/node_modules","/home/pooya/Code/framework/packages/kit/node_modules"] */ | ||
modulesDir: Array<string>, | ||
@@ -777,3 +779,3 @@ | ||
generate: { | ||
/** @default "/home/pooya/tmp/framework/packages/kit/<rootDir>/dist" */ | ||
/** @default "/home/pooya/Code/framework/packages/kit/<rootDir>/dist" */ | ||
dir: string, | ||
@@ -819,3 +821,3 @@ | ||
/** @default "/home/pooya/tmp/framework/packages/kit/<rootDir>/dist" */ | ||
/** @default "/home/pooya/Code/framework/packages/kit/<rootDir>/dist" */ | ||
base: string, | ||
@@ -826,3 +828,3 @@ | ||
/** @default "1617984167" */ | ||
/** @default "1618265598" */ | ||
version: string, | ||
@@ -833,8 +835,128 @@ }, | ||
declare type NuxtHook<Arg1 = any> = (arg1?: Arg1, ...args: any) => Promise<void> | void; | ||
declare type HookResult = Promise<void> | void; | ||
declare type Builder = any; | ||
declare type Generator = any; | ||
declare type Server = any; | ||
declare type TemplateFile = string | { | ||
src?: string; | ||
dst?: string; | ||
custom?: boolean; | ||
options?: any; | ||
}; | ||
declare type WatchEvent = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir'; | ||
interface NuxtHooks { | ||
[key: string]: NuxtHook; | ||
'modules:before': NuxtHook<Nuxt>; | ||
'modules:done': NuxtHook<Nuxt>; | ||
'ready': NuxtHook<Nuxt>; | ||
[key: string]: (...args: any[]) => HookResult; | ||
'build:before': (builder: Builder, buildOptions: NuxtOptions['build']) => HookResult; | ||
'builder:prepared': (builder: Builder, buildOptions: NuxtOptions['build']) => HookResult; | ||
'builder:extendPlugins': (plugins: NuxtOptions['plugins']) => HookResult; | ||
'build:templates': (templates: { | ||
templateVars: Record<string, any>; | ||
templatesFiles: TemplateFile[]; | ||
resolve: (...args: string[]) => string; | ||
}) => HookResult; | ||
'build:extendRoutes': (routes: any[], resolve: (...args: string[]) => string) => HookResult; | ||
'build:done': (builder: Builder) => HookResult; | ||
'watch:restart': (event: { | ||
event: string; | ||
path: string; | ||
}) => HookResult; | ||
'builder:watch': (event: WatchEvent, path: string) => HookResult; | ||
'cli:buildError': (error: unknown) => HookResult; | ||
'generate:cache:ignore': (ignore: string[]) => HookResult; | ||
'config': (options: NuxtConfig) => HookResult; | ||
'run:before': (options: { | ||
argv: string[]; | ||
cmd: { | ||
name: string; | ||
usage: string; | ||
description: string; | ||
options: Record<string, any>; | ||
}; | ||
rootDir: string; | ||
}) => HookResult; | ||
'ready': (nuxt: Nuxt) => HookResult; | ||
'close': (nuxt: Nuxt) => HookResult; | ||
'modules:before': (moduleContainer: ModuleContainer, modules?: any[]) => HookResult; | ||
'modules:done': (moduleContainer: ModuleContainer) => HookResult; | ||
'render:before': (server: Server, renderOptions: NuxtOptions['render']) => HookResult; | ||
'render:setupMiddleware': (app: any) => HookResult; | ||
'render:errorMiddleware': (app: any) => HookResult; | ||
'render:done': (server: Server) => HookResult; | ||
'listen': (listenerServer: any, listener: any) => HookResult; | ||
'server:nuxt:renderLoading': (req: IncomingMessage, res: ServerResponse) => HookResult; | ||
'render:route': (url: string, result: string, context: any) => HookResult; | ||
'render:routeDone': (url: string, result: string, context: any) => HookResult; | ||
'render:beforeResponse': (url: string, result: string, context: any) => HookResult; | ||
'render:resourcesLoaded': (resources: any) => HookResult; | ||
'vue-renderer:context': (renderContext: any) => HookResult; | ||
'vue-renderer:spa:prepareContext': (renderContext: any) => HookResult; | ||
'vue-renderer:spa:templateParams': (templateParams: Record<string, any>) => HookResult; | ||
'vue-renderer:ssr:prepareContext': (renderContext: any) => HookResult; | ||
'vue-renderer:ssr:context': (renderContext: any) => HookResult; | ||
'vue-renderer:ssr:csp': (cspScriptSrcHashes: string[]) => HookResult; | ||
'vue-renderer:ssr:templateParams': (templateParams: Record<string, any>, renderContext: any) => HookResult; | ||
'webpack:config': (webpackConfigs: Configuration[]) => HookResult; | ||
'build:compile': (options: { | ||
name: string; | ||
compiler: Compiler; | ||
}) => HookResult; | ||
'build:compiled': (options: { | ||
name: string; | ||
compiler: Compiler; | ||
stats: Stats; | ||
}) => HookResult; | ||
'build:resources': (mfs?: Compiler['outputFileSystem']) => HookResult; | ||
'server:devMiddleware': (middleware: (req: IncomingMessage, res: ServerResponse, next: (err?: any) => any) => any) => HookResult; | ||
'bundler:change': (shortPath: string) => void; | ||
'bundler:error': () => void; | ||
'bundler:done': () => void; | ||
'bundler:progress': (statesArray: any[]) => void; | ||
'generate:before': (generator: Generator, generateOptions: NuxtOptions['generate']) => HookResult; | ||
'generate:distRemoved': (generator: Generator) => HookResult; | ||
'generate:distCopied': (generator: Generator) => HookResult; | ||
'generate:route': ({ route, setPayload }: { | ||
route: any; | ||
setPayload: any; | ||
}) => HookResult; | ||
'generate:page': (page: { | ||
route: any; | ||
path: string; | ||
html: string; | ||
exclude: boolean; | ||
errors: string[]; | ||
}) => HookResult; | ||
'generate:routeCreated': ({ route, path, errors }: { | ||
route: any; | ||
path: string; | ||
errors: any[]; | ||
}) => HookResult; | ||
'generate:extendRoutes': (routes: any[]) => HookResult; | ||
'generate:routeFailed': ({ route, errors }: { | ||
route: any; | ||
errors: any[]; | ||
}) => HookResult; | ||
'generate:manifest': (manifest: any, generator: Generator) => HookResult; | ||
'generate:done': (generator: Generator, errors: any[]) => HookResult; | ||
'export:before': (generator: Generator) => HookResult; | ||
'export:distRemoved': (generator: Generator) => HookResult; | ||
'export:distCopied': (generator: Generator) => HookResult; | ||
'export:route': ({ route, setPayload }: { | ||
route: any; | ||
setPayload: any; | ||
}) => HookResult; | ||
'export:routeCreated': ({ route, path, errors }: { | ||
route: any; | ||
path: string; | ||
errors: any[]; | ||
}) => HookResult; | ||
'export:extendRoutes': ({ routes }: { | ||
routes: any[]; | ||
}) => HookResult; | ||
'export:routeFailed': ({ route, errors }: { | ||
route: any; | ||
errors: any[]; | ||
}) => HookResult; | ||
'export:done': (generator: Generator, { errors }: { | ||
errors: any[]; | ||
}) => HookResult; | ||
} | ||
@@ -846,5 +968,5 @@ declare type NuxtHookName = keyof NuxtHooks; | ||
hooks: { | ||
hook(hookName: NuxtHookName, callback: NuxtHook): any; | ||
callHook<T extends string>(hookbname: T, ...args: Parameters<NuxtHooks[T]>): any; | ||
addHooks(hooks: Partial<NuxtHooks>): any; | ||
hook<Hook extends NuxtHookName>(hookName: Hook, callback: NuxtHooks[Hook]): void | Promise<void>; | ||
callHook<Hook extends NuxtHookName>(hookName: Hook, ...args: Parameters<NuxtHooks[Hook]>): ReturnType<NuxtHooks[Hook]>; | ||
addHooks(hooks: Partial<NuxtHooks>): void; | ||
}; | ||
@@ -991,2 +1113,2 @@ hook: Nuxt['hooks']['hook']; | ||
export { LegacyNuxtModule, LoadDotEnvOptions, LoadNuxtConfigOptions, ModuleContainer, ModuleInstallOptions, ModuleInstallOptionsObj, ModuleMeta, ModuleOptions, ModuleSrc, Nuxt, NuxtConfig, NuxtHook, NuxtHookName, NuxtHooks, NuxtModule, NuxtOptions, PluginTemplateOpts, RequireModuleOptions, ResolveModuleOptions, ResolveOptions, TemplateOpts, TypedConfigSchema, addErrorLayout, addLayout, addPlugin, addServerMiddleware, addTemplate, clearRequireCache, defineNuxtConfig, defineNuxtModule, extendBuild, extendRoutes, getRequireCacheItem, installModule, isNodeModules, loadEnv, loadNuxtConfig, loalDotenv, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveModule, scanRequireTree, tryRequireModule, tryResolveModule, tryResolvePath, useNuxt }; | ||
export { LegacyNuxtModule, LoadDotEnvOptions, LoadNuxtConfigOptions, ModuleContainer, ModuleInstallOptions, ModuleInstallOptionsObj, ModuleMeta, ModuleOptions, ModuleSrc, Nuxt, NuxtConfig, NuxtHookName, NuxtHooks, NuxtModule, NuxtOptions, PluginTemplateOpts, RequireModuleOptions, ResolveModuleOptions, ResolveOptions, TemplateOpts, TypedConfigSchema, addErrorLayout, addLayout, addPlugin, addServerMiddleware, addTemplate, clearRequireCache, defineNuxtConfig, defineNuxtModule, extendBuild, extendRoutes, getRequireCacheItem, installModule, isNodeModules, loadEnv, loadNuxtConfig, loalDotenv, nuxtCtx, requireModule, requireModulePkg, resolveAlias, resolveModule, scanRequireTree, tryRequireModule, tryResolveModule, tryResolvePath, useNuxt }; |
{ | ||
"name": "@nuxt/kit", | ||
"version": "0.3.0", | ||
"version": "0.4.0", | ||
"repository": "nuxt/framework", | ||
@@ -32,3 +32,3 @@ "license": "MIT", | ||
}, | ||
"gitHead": "bb797fcbb6ea652fe74c62411df899a80fc3d820" | ||
"gitHead": "6a30a6fd10063b6b42cd9e0fae5b7dcc983bbc5a" | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
92422
3006