Skip to content
This repository was archived by the owner on Apr 6, 2023. It is now read-only.
/frameworkPublic archive

fix(schema): add back PublicRuntimeConfig interface for augmentation#4849

Merged
pi0 merged 3 commits into from
May 6, 2022
Merged

fix(schema): add back PublicRuntimeConfig interface for augmentation #4849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cc7b94
fix(schema): add back `PublicRuntimeConfig` interface for augmentation
danielroe May 6, 2022
fdfaac2
style: removes tray space
danielroe May 6, 2022
b59e1e8
chore: add todo comment
danielroe May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion packages/nuxt/src/core/templates.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -135,14 +135,22 @@ export const schemaTemplate = {
` [${genString(meta.configKey)}]?: typeof ${genDynamicImport(meta.importName, { wrapper: false })}.default extends NuxtModule<infer O> ? Partial<O> : Record<string, any>`
),
' }',
generateTypes(resolveSchema(nuxt.options.runtimeConfig),
generateTypes(resolveSchema(Object.fromEntries(Object.entries(nuxt.options.runtimeConfig).filter(([key]) => key !== 'public'))),
{
interfaceName: 'RuntimeConfig',
addExport: false,
addDefaults: false,
allowExtraKeys: false,
indentation: 2
}),
generateTypes(resolveSchema(nuxt.options.runtimeConfig.public),
{
interfaceName: 'PublicRuntimeConfig',
addExport: false,
addDefaults: false,
allowExtraKeys: false,
indentation: 2
}),
'}'
].join('\n')
}
Expand Down
11 changes: 4 additions & 7 deletions packages/schema/src/types/config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,15 +16,12 @@ export interface NuxtOptions extends ConfigSchema {

type RuntimeConfigNamespace = Record<string, any>

/** @deprecated use RuntimeConfig interface */
export interface PublicRuntimeConfig extends RuntimeConfigNamespace { }

// TODO: remove before release of 3.0.0
/** @deprecated use RuntimeConfig interface */
export interface PrivateRuntimeConfig extends PublicRuntimeConfig { }

type LegacyRuntimeConfig = PublicRuntimeConfig & Partial<PrivateRuntimeConfig>
export interface PrivateRuntimeConfig extends RuntimeConfigNamespace { }
Comment thread
pi0 marked this conversation as resolved.

export interface RuntimeConfig extends LegacyRuntimeConfig, RuntimeConfigNamespace {
app: RuntimeConfigNamespace
public: RuntimeConfigNamespace
export interface RuntimeConfig extends PrivateRuntimeConfig, RuntimeConfigNamespace {
public: PublicRuntimeConfig
}