fix(aidocs): correct smartconfig file handling and tighten TypeScript typings

changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2026-05-09 - 2.0.4 - fix(aidocs)
+correct smartconfig file handling and tighten TypeScript typings
+
+- rename internal project context references from npmextra JSON to .smartconfig.json
+- fix README and description flows to read the correct smartconfig file
+- allow missing changelog and initialize AI doc properties safely
+- add explicit TypeScript annotations in typedoc and refresh package dependencies
+
 ## 2026-04-30 - 2.0.3 - fix(scripts)
 update test and build scripts for pnpm usage and stricter tsbuild defaults
 

package.json

@@ -19,31 +19,33 @@
     "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^4.3.0",
-    "@git.zone/tsrun": "^2.0.1",
-    "@git.zone/tstest": "^3.5.1",
-    "@types/node": "^25.5.0"
+    "@git.zone/tsbuild": "^4.4.0",
+    "@git.zone/tsrun": "^2.0.3",
+    "@git.zone/tstest": "^3.6.5",
+    "@types/json-schema": "^7.0.15",
+    "@types/node": "^25.6.2",
+    "@types/yargs-parser": "^21.0.3"
   },
   "dependencies": {
-    "@git.zone/tspublish": "^1.11.3",
+    "@git.zone/tspublish": "^1.11.6",
     "@push.rocks/early": "^4.0.4",
-    "@push.rocks/smartconfig": "^6.0.1",
-    "@push.rocks/qenv": "^6.1.3",
-    "@push.rocks/smartagent": "^3.0.2",
-    "@push.rocks/smartai": "^2.0.0",
-    "@push.rocks/smartcli": "^4.0.20",
-    "@push.rocks/smartdelay": "^3.0.5",
-    "@push.rocks/smartfile": "^13.1.2",
-    "@push.rocks/smartfs": "^1.5.0",
-    "@push.rocks/smartgit": "^3.3.1",
+    "@push.rocks/qenv": "^6.1.4",
+    "@push.rocks/smartagent": "^3.1.0",
+    "@push.rocks/smartai": "^2.2.0",
+    "@push.rocks/smartcli": "^4.0.21",
+    "@push.rocks/smartconfig": "^6.1.1",
+    "@push.rocks/smartdelay": "^3.1.0",
+    "@push.rocks/smartfile": "^13.1.3",
+    "@push.rocks/smartfs": "^1.5.1",
+    "@push.rocks/smartgit": "^3.3.2",
     "@push.rocks/smartinteract": "^2.0.16",
-    "@push.rocks/smartlog": "^3.2.1",
+    "@push.rocks/smartlog": "^3.2.2",
     "@push.rocks/smartlog-destination-local": "^9.0.2",
     "@push.rocks/smartpath": "^6.0.0",
     "@push.rocks/smartshell": "^3.3.8",
     "@push.rocks/smarttime": "^4.2.3",
-    "typedoc": "^0.28.18",
-    "typescript": "^6.0.2"
+    "typedoc": "^0.28.19",
+    "typescript": "^6.0.3"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -12,8 +12,8 @@ For reporting bugs, issues, or security vulnerabilities, please visit [community
 # Global installation (recommended for CLI usage)
 pnpm add -g @git.zone/tsdoc
 
-# Or use with npx (no install needed)
-npx @git.zone/tsdoc
+# Or run without installing globally
+pnpm dlx @git.zone/tsdoc
 
 # Or install locally as a project dependency
 pnpm add @git.zone/tsdoc

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@git.zone/tsdoc',
-  version: '2.0.3',
+  version: '2.0.4',
   description: 'A comprehensive TypeScript documentation tool that leverages AI to generate and enhance project documentation, including dynamic README creation, API docs via TypeDoc, and smart commit message generation.'
 }

ts/aidocs_classes/commit.ts

@@ -226,7 +226,7 @@ Analyze these changes and output the JSON commit message object.
     const resultObject: INextCommitObject = JSON.parse(jsonString);
 
     const previousChangelogPath = plugins.path.join(this.projectDir, 'changelog.md');
-    let previousChangelog: plugins.smartfile.SmartFile;
+    let previousChangelog: plugins.smartfile.SmartFile | undefined;
     if (await plugins.fsInstance.file(previousChangelogPath).exists()) {
       previousChangelog = await plugins.smartfileFactory.fromFilePath(previousChangelogPath);
     }

ts/aidocs_classes/description.ts

@@ -80,7 +80,7 @@ Don't wrap the JSON in \`\`\`json\`\`\` - just return the raw JSON object.
     const files = await projectContext.gatherFiles();
 
     // Update smartconfig.json
-    const smartconfigJson = files.smartfilesNpmextraJSON;
+    const smartconfigJson = files.smartfilesSmartconfigJSON;
     const smartconfigJsonContent = JSON.parse(smartconfigJson.contents.toString());
 
     smartconfigJsonContent['gitzone'].module.description = resultObject.description;

ts/aidocs_classes/projectcontext.ts

@@ -26,7 +26,7 @@ export class ProjectContext {
       plugins.path.join(this.projectDir, 'readme.hints.md'),
       this.projectDir,
     );
-    const smartfilesNpmextraJSON = await plugins.smartfileFactory.fromFilePath(
+    const smartfilesSmartconfigJSON = await plugins.smartfileFactory.fromFilePath(
       plugins.path.join(this.projectDir, '.smartconfig.json'),
       this.projectDir,
     );
@@ -40,7 +40,7 @@ export class ProjectContext {
       smartfilePackageJSON,
       smartfilesReadme,
       smartfilesReadmeHints,
-      smartfilesNpmextraJSON,
+      smartfilesSmartconfigJSON,
       smartfilesMod,
       smartfilesTest,
     };
@@ -80,7 +80,7 @@ ${smartfile.contents.toString()}
       files.smartfilePackageJSON,
       files.smartfilesReadme,
       files.smartfilesReadmeHints,
-      files.smartfilesNpmextraJSON,
+      files.smartfilesSmartconfigJSON,
       ...files.smartfilesMod,
       ...files.smartfilesTest,
     ]);

ts/aidocs_classes/readme.ts

@@ -20,7 +20,7 @@ export class Readme {
     // First check legal info before introducing any cost
     const projectContext = new ProjectContext(this.projectDir);
     const smartconfigJson = JSON.parse(
-      (await projectContext.gatherFiles()).smartfilesNpmextraJSON.contents.toString()
+      (await projectContext.gatherFiles()).smartfilesSmartconfigJSON.contents.toString()
     );
     const legalInfo = smartconfigJson?.['tsdoc']?.legal;
     if (!legalInfo) {

ts/classes.aidoc.ts

@@ -3,12 +3,12 @@ import * as plugins from './plugins.js';
 import * as aiDocsClasses from './aidocs_classes/index.js';
 
 export class AiDoc {
-  private openaiToken: string;
+  private openaiToken = '';
 
-  public smartconfigKV: plugins.smartconfig.KeyValueStore;
-  public qenvInstance: plugins.qenv.Qenv;
-  public aidocInteract: plugins.smartinteract.SmartInteract;
-  public model: plugins.smartai.LanguageModelV3;
+  public smartconfigKV?: plugins.smartconfig.KeyValueStore<{ OPENAI_TOKEN: string }>;
+  public qenvInstance!: plugins.qenv.Qenv;
+  public aidocInteract!: plugins.smartinteract.SmartInteract;
+  public model!: plugins.smartai.LanguageModelV3;
 
   argvArg: any;
 
@@ -35,7 +35,10 @@ export class AiDoc {
     // lets care about prerequisites
     this.aidocInteract = new plugins.smartinteract.SmartInteract();
     this.qenvInstance = new plugins.qenv.Qenv();
-    if (!(await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN'))) {
+    const openaiTokenFromEnv = await this.qenvInstance.getEnvVarOnDemand('OPENAI_TOKEN');
+    if (openaiTokenFromEnv) {
+      this.openaiToken = openaiTokenFromEnv;
+    } else {
       // Migrate old KV store path to new path if needed
       const homeDir = plugins.smartpath.get.home();
       const oldKvPath = plugins.path.join(homeDir, '.smartconfig/kv/tsdoc.json');

ts/classes.typedoc.ts

@@ -14,7 +14,7 @@ export class TypeDoc {
 
   // Instance
   public typedocDirectory: string;
-  constructor(dirPathArg) {
+  constructor(dirPathArg: string) {
     this.typedocDirectory = dirPathArg;
   }
 
@@ -28,9 +28,8 @@ export class TypeDoc {
         moduleResolution: 'NodeNext',
         esModuleInterop: true,
         verbatimModuleSyntax: true,
-        skipLibCheck: true,
       },
-      include: [],
+      include: [] as string[],
     };
     let startDirectory = '';
     if (await plugins.fsInstance.directory(plugins.path.join(paths.cwd, './ts')).exists()) {