fix: clarify types

src/cache.ts

@@ -2,14 +2,14 @@ import {readFileSync} from 'node:fs'
 import {join} from 'node:path'
 
 import {Config} from './config/config'
-import {Configuration, Plugin} from './interfaces'
+import {OclifConfiguration, Plugin} from './interfaces'
 
 type OclifCoreInfo = {name: string; version: string}
 
 type CacheContents = {
   rootPlugin: Plugin
   config: Config
-  exitCodes: Configuration['exitCodes']
+  exitCodes: OclifConfiguration['exitCodes']
   '@oclif/core': OclifCoreInfo
 }
 
@@ -36,7 +36,7 @@ export default class Cache extends Map<keyof CacheContents, ValueOf<CacheContent
   public get(key: 'config'): Config | undefined
   public get(key: '@oclif/core'): OclifCoreInfo
   public get(key: 'rootPlugin'): Plugin | undefined
-  public get(key: 'exitCodes'): Configuration['exitCodes'] | undefined
+  public get(key: 'exitCodes'): OclifConfiguration['exitCodes'] | undefined
   public get(key: keyof CacheContents): ValueOf<CacheContents> | undefined {
     return super.get(key)
   }

src/config/config.ts

@@ -8,7 +8,7 @@ import Cache from '../cache'
 import {Command} from '../command'
 import {CLIError, error, exit, warn} from '../errors'
 import {getHelpFlagAdditions} from '../help/util'
-import {Configuration, Hook, Hooks, PJSON, S3Templates, Topic, UserPJSON} from '../interfaces'
+import {Hook, Hooks, OclifConfiguration, PJSON, S3Templates, Topic, UserPJSON} from '../interfaces'
 import {ArchTypes, Config as IConfig, LoadOptions, PlatformTypes, VersionDetails} from '../interfaces/config'
 import {Plugin as IPlugin, Options} from '../interfaces/plugin'
 import {Theme} from '../interfaces/theme'
@@ -104,7 +104,7 @@ export class Config implements IConfig {
   public shell!: string
   public theme?: Theme | undefined
   public topicSeparator: ' ' | ':' = ':'
-  public updateConfig!: NonNullable<Configuration['update']>
+  public updateConfig!: NonNullable<OclifConfiguration['update']>
   public userAgent!: string
   public userPJSON?: UserPJSON | undefined
   public valid!: boolean
@@ -601,7 +601,7 @@ export class Config implements IConfig {
   ): string {
     if (typeof ext === 'object') options = ext
     else if (ext) options.ext = ext
-    const template = this.updateConfig.s3.templates?.[options.platform ? 'target' : 'vanilla'][type] ?? ''
+    const template = this.updateConfig.s3?.templates?.[options.platform ? 'target' : 'vanilla'][type] ?? ''
     return ejs.render(template, {...(this as any), ...options})
   }
 

src/interfaces/config.ts

@@ -1,6 +1,6 @@
 import {Command} from '../command'
 import {Hook, Hooks} from './hooks'
-import {Configuration, PJSON, S3Templates} from './pjson'
+import {OclifConfiguration, PJSON, S3Templates} from './pjson'
 import {Options, Plugin} from './plugin'
 import {Theme} from './theme'
 import {Topic} from './topic'
@@ -115,7 +115,7 @@ export interface Config {
   readonly theme?: Theme | undefined
   topicSeparator: ' ' | ':'
   readonly topics: Topic[]
-  readonly updateConfig: NonNullable<Configuration['update']>
+  readonly updateConfig: NonNullable<OclifConfiguration['update']>
   /**
    * user agent to use for http calls
    *

src/interfaces/index.ts

@@ -8,7 +8,7 @@ export type {Hook, Hooks} from './hooks'
 export type {Logger} from './logger'
 export type {Manifest} from './manifest'
 export type {Arg, BooleanFlag, CustomOptions, Deprecation, Flag, FlagDefinition, OptionFlag} from './parser'
-export type {Configuration, PJSON, S3, S3Templates, UserPJSON} from './pjson'
+export type {OclifConfiguration, PJSON, S3, S3Templates, UserPJSON} from './pjson'
 export type {Options, Plugin, PluginOptions} from './plugin'
 export type {S3Manifest} from './s3-manifest'
 export type {Theme} from './theme'

src/interfaces/pjson.ts

@@ -107,6 +107,7 @@ export type S3 = {
   folder?: string | undefined
   gz?: boolean | undefined
   host?: string | undefined
+  indexVersionLimit?: number | undefined
   templates?:
     | {
         target: S3Templates
@@ -116,7 +117,7 @@ export type S3 = {
   xz?: boolean | undefined
 }
 
-export type Configuration = {
+export type OclifConfiguration = {
   /**
    * Flags in addition to --help that should trigger help output.
    */
@@ -241,7 +242,7 @@ export type Configuration = {
     [k: string]: {
       description?: string
       hidden?: boolean
-      subtopics?: Configuration['topics']
+      subtopics?: OclifConfiguration['topics']
     }
   }
   update?: {
@@ -250,12 +251,12 @@ export type Configuration = {
       rollout?: number
     }
     disableNpmLookup?: boolean
-    node: {
+    node?: {
       targets?: string[]
       version?: string
       options?: string | string[]
     }
-    s3: S3
+    s3?: S3
   }
   'warn-if-update-available'?: {
     authorization?: string
@@ -299,6 +300,6 @@ export type PJSON = {
   dependencies?: {[name: string]: string}
   devDependencies?: {[name: string]: string}
   name: string
-  oclif: Configuration
+  oclif: OclifConfiguration
   version: string
 }

test/config/config.test.ts

@@ -227,7 +227,6 @@ describe('Config', () => {
         ...pjson,
         oclif: {
           ...pjson.oclif,
-          // @ts-expect-error - not worth stubbing out every single required prop on s3
           update: {
             s3: {
               host: 'https://bar.com/a/',