fix: resolve comments

Author: jiashengguo

packages/schema/build/bundle.js

@@ -16,12 +16,6 @@ require('esbuild')
     .then(() => {
         fs.cpSync('./src/res', 'bundle/res', { force: true, recursive: true });
         fs.cpSync('../language/syntaxes', 'bundle/syntaxes', { force: true, recursive: true });
-
-        // Copy release notes HTML file
-        if (fs.existsSync('src/release-notes.html')) {
-            fs.copyFileSync('src/release-notes.html', 'bundle/release-notes.html');
-            console.log('Copied release notes HTML file to bundle');
-        }
     })
     .then(() => console.log(success))
     .catch((err) => {

packages/schema/build/post-build.js

@@ -27,14 +27,3 @@ console.log('Updating file: dist/cli/index.js');
 fs.writeFileSync('dist/cli/index.js', cliContent, {
     encoding: 'utf-8',
 });
-
-// Copy release notes HTML file to dist
-const releaseNotesSource = 'src/release-notes.html';
-const releaseNotesDest = 'dist/release-notes.html';
-
-if (fs.existsSync(releaseNotesSource)) {
-    console.log('Copying release notes HTML file to dist');
-    fs.copyFileSync(releaseNotesSource, releaseNotesDest);
-} else {
-    console.warn('Release notes HTML file not found at:', releaseNotesSource);
-}

packages/schema/package.json

@@ -27,7 +27,7 @@
         "linkDirectory": true
     },
     "engines": {
-        "vscode": "^1.90.0"
+        "vscode": "^1.102.0"
     },
     "categories": [
         "Programming Languages"
@@ -184,7 +184,6 @@
         "@types/tmp": "^0.2.3",
         "@types/uuid": "^8.3.4",
         "@types/vscode": "^1.102.0",
-        "@vscode/chat-extension-utils": "0.0.0-alpha.5",
         "@vscode/vsce": "^3.5.0",
         "@zenstackhq/runtime": "workspace:*",
         "dotenv": "^16.0.3",

packages/schema/src/documentation-cache.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode';
-import crypto from 'crypto';
+import { createHash } from 'crypto';
 
 // Cache entry interface
 interface CacheEntry {
@@ -13,7 +13,7 @@ interface CacheEntry {
  * using VS Code's globalState for cross-session persistence
  */
 export class DocumentationCache implements vscode.Disposable {
-    private static readonly CACHE_DURATION_MS = 5 * 60 * 1000; // 5 minutes cache duration
+    private static readonly CACHE_DURATION_MS = 7 * 24 * 60 * 60 * 1000; // 7 days cache duration
     private static readonly CACHE_PREFIX = 'doc-cache.';
 
     private extensionContext: vscode.ExtensionContext;
@@ -56,9 +56,8 @@ export class DocumentationCache implements vscode.Disposable {
     private generateCacheKey(requestBody: { models: string[] }): string {
         // Remove ALL whitespace characters from each model string for cache key generation
         // This ensures identical content with different formatting uses the same cache
-        const normalizedModels = requestBody.models.map((model) => model.replace(/\s/g, ''));
-        const hash = crypto
-            .createHash('sha512')
+        const normalizedModels = requestBody.models.map((model) => model.replace(/\s/g, '')).sort();
+        const hash = createHash('sha512')
             .update(JSON.stringify({ models: normalizedModels }))
             .digest('hex');
         return `${DocumentationCache.CACHE_PREFIX}${hash}`;

packages/schema/src/extension.ts

@@ -23,10 +23,12 @@ export async function requireAuth(): Promise<vscode.AuthenticationSession | unde
             try {
                 session = await vscode.authentication.getSession(AUTH_PROVIDER_ID, [], { createIfNone: true });
                 if (session) {
-                    vscode.window.showInformationMessage('ZenStack sign in successful!');
+                    vscode.window.showInformationMessage('ZenStack sign-in successful!');
                 }
-            } catch (e) {
-                vscode.window.showErrorMessage('ZenStack sign in failed: ' + String(e));
+            } catch (e: unknown) {
+                vscode.window.showErrorMessage(
+                    'ZenStack sign-in failed: ' + (e instanceof Error ? e.message : String(e))
+                );
             }
         }
     }

packages/schema/src/mermaid-generator.ts

@@ -5,11 +5,10 @@ import * as vscode from 'vscode';
  */
 export class ReleaseNotesManager implements vscode.Disposable {
     private extensionContext: vscode.ExtensionContext;
-    private releaseNoteVersionKey: string;
+    private readonly zmodelPreviewReleaseNoteKey = 'zmodel-preview-release-note-shown';
 
     constructor(context: vscode.ExtensionContext) {
         this.extensionContext = context;
-        this.releaseNoteVersionKey = `release-notes-shown:${this.extensionContext.extension.packageJSON.version}`;
         this.initialize();
     }
 
@@ -25,12 +24,12 @@ export class ReleaseNotesManager implements vscode.Disposable {
      */
     async showReleaseNotesIfFirstTime(): Promise<void> {
         // Show release notes if this is the first time activating this version
-        if (!this.extensionContext.globalState.get(this.releaseNoteVersionKey)) {
+        if (!this.extensionContext.globalState.get(this.zmodelPreviewReleaseNoteKey)) {
             await this.showReleaseNotes();
             // Update the stored version to prevent showing again
-            await this.extensionContext.globalState.update(this.releaseNoteVersionKey, true);
+            await this.extensionContext.globalState.update(this.zmodelPreviewReleaseNoteKey, true);
             // Add this key to sync keys for cross-machine synchronization
-            this.extensionContext.globalState.setKeysForSync([this.releaseNoteVersionKey]);
+            this.extensionContext.globalState.setKeysForSync([this.zmodelPreviewReleaseNoteKey]);
         }
     }
 
@@ -39,9 +38,17 @@ export class ReleaseNotesManager implements vscode.Disposable {
      */
     async showReleaseNotes(): Promise<void> {
         try {
+            // Read the release notes HTML file
+            const releaseNotesPath = vscode.Uri.joinPath(
+                this.extensionContext.extensionUri,
+                'bundle/res/zmodel-preview-release-notes.html'
+            );
+
+            const htmlBytes = await vscode.workspace.fs.readFile(releaseNotesPath);
+            const htmlContent = Buffer.from(htmlBytes).toString('utf8');
             // Create and show the release notes webview
             const panel = vscode.window.createWebviewPanel(
-                'zenstackReleaseNotes',
+                'ZenstackReleaseNotes',
                 'ZenStack - New Feature Announcement!',
                 vscode.ViewColumn.One,
                 {
@@ -50,12 +57,6 @@ export class ReleaseNotesManager implements vscode.Disposable {
                 }
             );
 
-            // Read the release notes HTML file
-            const releaseNotesPath = vscode.Uri.joinPath(this.extensionContext.extensionUri, 'src/release-notes.html');
-
-            const htmlBytes = await vscode.workspace.fs.readFile(releaseNotesPath);
-            const htmlContent = Buffer.from(htmlBytes).toString('utf8');
-
             panel.webview.html = htmlContent;
 
             // Optional: Close the panel when user clicks outside or after some time

packages/schema/src/release-notes-manager.ts

@@ -53,7 +53,7 @@ <h1>🎉 Introducing ZModel Documentation Preview</h1>
         <div class="feature">
             <h3>📖 What's New</h3>
             <p>
-                You can now preview comprehensive documentation for your ZModel files, just like you would previewing a
+                You can now preview comprehensive documentation for your ZModel files, just like you would preview a
                 markdown file.
             </p>
         </div>
@@ -64,7 +64,8 @@ <h3>🚀 How to Use</h3>
                 <li>Open your <code>.zmodel</code> file</li>
                 <li>
                     Click (<span class="codicon codicon-preview"></span>) in the editor toolbar, or simply press
-                    <code>Cmd+Shift+V</code>
+                    <code>Cmd&nbsp;+&nbsp;Shift&nbsp;+&nbsp;V</code> (Mac) or
+                    <code>Ctrl&nbsp;+&nbsp;Shift&nbsp;+&nbsp;V</code> (Windows)
                 </li>
                 <li>Sign in with ZenStack (one-time setup)</li>
                 <li>Enjoy your AI-generated documentation</li>
@@ -74,8 +75,8 @@ <h3>🚀 How to Use</h3>
         <div class="steps">
             <h3>💡 Tips</h3>
             <ul>
-                <li>Ensure your zmodel is error-free before generating</li>
-                <li>Use your main zmodel file, it will include all imported models for a complete documentation</li>
+                <li>Ensure your zmodel is error-free before generating.</li>
+                <li>Use your main zmodel file, which will include all imported models, for complete documentation.</li>
                 <li>
                     Add clear, descriptive comments in your ZModel. The more context you provide, the better the
                     results.