mindcache 3.5.3 → 3.6.0

package/dist/index.d.mts

@@ -1,8 +1,42 @@
-import { e as MindCacheOptions, M as MindCache } from './CloudAdapter-DK4YecbV.mjs';
-export { A as AccessLevel, a as CloudAdapter, c as CloudAdapterEvents, C as CloudConfig, b as ConnectionState, h as ContextRules, n as DEFAULT_KEY_ATTRIBUTES, G as GlobalListener, H as HistoryEntry, k as HistoryOptions, K as KeyAttributes, j as KeyEntry, f as KeyType, L as Listener, l as MindCacheCloudOptions, m as MindCacheIndexedDBOptions, i as STM, j as STMEntry, g as SystemTag, o as SystemTagHelpers } from './CloudAdapter-DK4YecbV.mjs';
+import { e as CustomTypeDefinition, f as MindCacheOptions, M as MindCache } from './CloudAdapter-PLGvGjoA.mjs';
+export { A as AccessLevel, a as CloudAdapter, c as CloudAdapterEvents, C as CloudConfig, b as ConnectionState, i as ContextRules, o as CustomTypeField, p as DEFAULT_KEY_ATTRIBUTES, G as GlobalListener, H as HistoryEntry, l as HistoryOptions, K as KeyAttributes, k as KeyEntry, g as KeyType, L as Listener, m as MindCacheCloudOptions, n as MindCacheIndexedDBOptions, j as STM, k as STMEntry, h as SystemTag, q as SystemTagHelpers } from './CloudAdapter-PLGvGjoA.mjs';
 export { IndexedDBAdapter, IndexedDBConfig } from './server.mjs';
 import 'yjs';
 
+/**
+ * Parses markdown-based schema definitions into structured CustomTypeDefinition objects.
+ *
+ * Schema format:
+ * ```
+ * #TypeName
+ * * fieldName: description of the field
+ * * anotherField: description
+ * ```
+ */
+declare class SchemaParser {
+    /**
+     * Parse a markdown schema string into a CustomTypeDefinition
+     * @param schema - Markdown schema string
+     * @returns Parsed type definition
+     * @throws Error if schema format is invalid
+     */
+    static parse(schema: string): CustomTypeDefinition;
+    /**
+     * Generate a markdown representation of a type definition
+     * Useful for including in LLM prompts
+     */
+    static toMarkdown(typeDef: CustomTypeDefinition): string;
+    /**
+     * Generate a prompt-friendly description of the type
+     * More verbose than toMarkdown, better for LLM guidance
+     */
+    static toPromptDescription(typeDef: CustomTypeDefinition): string;
+    /**
+     * Generate an example value structure based on the type definition
+     */
+    static generateExample(typeDef: CustomTypeDefinition): string;
+}
+
 /**
  * MindCache OAuth Client
  *
@@ -12,23 +46,17 @@ import 'yjs';
 interface OAuthConfig {
     /** Client ID from developer portal */
     clientId: string;
+    /**
+     * MindCache API base URL - REQUIRED!
+     * All OAuth endpoints are derived from this.
+     * - Production: 'https://api.mindcache.dev'
+     * - Local dev:  'http://localhost:8787'
+     */
+    baseUrl: string;
     /** Redirect URI (defaults to current URL) */
     redirectUri?: string;
     /** Scopes to request (default: ['read', 'write']) */
     scopes?: string[];
-    /**
-     * MindCache API base URL (default: 'https://api.mindcache.dev')
-     * This is the ONLY URL you need to set! All OAuth endpoints are derived from this.
-     * - authUrl = baseUrl + '/oauth/authorize'
-     * - tokenUrl = baseUrl + '/oauth/token'
-     */
-    baseUrl?: string;
-    /** @deprecated Use baseUrl instead. MindCache authorize URL */
-    authUrl?: string;
-    /** @deprecated Use baseUrl instead. MindCache token URL */
-    tokenUrl?: string;
-    /** @deprecated Use baseUrl instead. MindCache API URL */
-    apiUrl?: string;
     /** Use PKCE for security (default: true) */
     usePKCE?: boolean;
     /** Storage key prefix (default: 'mindcache_oauth') */
@@ -69,8 +97,14 @@ declare class OAuthClient {
     private tokens;
     private refreshPromise;
     constructor(config: OAuthConfig);
+    /** Derived auth URL */
+    private get authUrl();
+    /** Derived token URL */
+    private get tokenUrl();
+    /** Derived userinfo URL */
+    private get userinfoUrl();
     /**
-     * Validate the API is reachable and warn about common misconfigurations
+     * Validate the API is reachable
      */
     private validateApi;
     /**
@@ -123,13 +157,12 @@ declare class OAuthClient {
     private clearAuth;
     /**
      * Token provider for MindCache cloud config
-     * This fetches a WebSocket token (short-lived) using the OAuth access token
+     * This fetches a WebSocket token using the OAuth access token
      * Use this with MindCacheCloudOptions.tokenProvider
      */
     tokenProvider: () => Promise<string>;
     /**
      * Get raw OAuth access token (for API calls, not WebSocket)
-     * Use getAccessToken() for most cases
      */
     accessTokenProvider: () => Promise<string>;
     private getStorage;
@@ -175,4 +208,4 @@ declare function useMindCache(options?: MindCacheOptions): UseMindCacheResult;
 
 declare const mindcache: MindCache;
 
-export { MindCache, MindCacheOptions, type MindCacheUser, OAuthClient, type OAuthConfig, type OAuthTokens, type UseMindCacheResult, createOAuthClient, mindcache, useMindCache };
+export { CustomTypeDefinition, MindCache, MindCacheOptions, type MindCacheUser, OAuthClient, type OAuthConfig, type OAuthTokens, SchemaParser, type UseMindCacheResult, createOAuthClient, mindcache, useMindCache };

package/dist/index.d.ts

@@ -1,8 +1,42 @@
-import { e as MindCacheOptions, M as MindCache } from './CloudAdapter-DK4YecbV.js';
-export { A as AccessLevel, a as CloudAdapter, c as CloudAdapterEvents, C as CloudConfig, b as ConnectionState, h as ContextRules, n as DEFAULT_KEY_ATTRIBUTES, G as GlobalListener, H as HistoryEntry, k as HistoryOptions, K as KeyAttributes, j as KeyEntry, f as KeyType, L as Listener, l as MindCacheCloudOptions, m as MindCacheIndexedDBOptions, i as STM, j as STMEntry, g as SystemTag, o as SystemTagHelpers } from './CloudAdapter-DK4YecbV.js';
+import { e as CustomTypeDefinition, f as MindCacheOptions, M as MindCache } from './CloudAdapter-PLGvGjoA.js';
+export { A as AccessLevel, a as CloudAdapter, c as CloudAdapterEvents, C as CloudConfig, b as ConnectionState, i as ContextRules, o as CustomTypeField, p as DEFAULT_KEY_ATTRIBUTES, G as GlobalListener, H as HistoryEntry, l as HistoryOptions, K as KeyAttributes, k as KeyEntry, g as KeyType, L as Listener, m as MindCacheCloudOptions, n as MindCacheIndexedDBOptions, j as STM, k as STMEntry, h as SystemTag, q as SystemTagHelpers } from './CloudAdapter-PLGvGjoA.js';
 export { IndexedDBAdapter, IndexedDBConfig } from './server.js';
 import 'yjs';
 
+/**
+ * Parses markdown-based schema definitions into structured CustomTypeDefinition objects.
+ *
+ * Schema format:
+ * ```
+ * #TypeName
+ * * fieldName: description of the field
+ * * anotherField: description
+ * ```
+ */
+declare class SchemaParser {
+    /**
+     * Parse a markdown schema string into a CustomTypeDefinition
+     * @param schema - Markdown schema string
+     * @returns Parsed type definition
+     * @throws Error if schema format is invalid
+     */
+    static parse(schema: string): CustomTypeDefinition;
+    /**
+     * Generate a markdown representation of a type definition
+     * Useful for including in LLM prompts
+     */
+    static toMarkdown(typeDef: CustomTypeDefinition): string;
+    /**
+     * Generate a prompt-friendly description of the type
+     * More verbose than toMarkdown, better for LLM guidance
+     */
+    static toPromptDescription(typeDef: CustomTypeDefinition): string;
+    /**
+     * Generate an example value structure based on the type definition
+     */
+    static generateExample(typeDef: CustomTypeDefinition): string;
+}
+
 /**
  * MindCache OAuth Client
  *
@@ -12,23 +46,17 @@ import 'yjs';
 interface OAuthConfig {
     /** Client ID from developer portal */
     clientId: string;
+    /**
+     * MindCache API base URL - REQUIRED!
+     * All OAuth endpoints are derived from this.
+     * - Production: 'https://api.mindcache.dev'
+     * - Local dev:  'http://localhost:8787'
+     */
+    baseUrl: string;
     /** Redirect URI (defaults to current URL) */
     redirectUri?: string;
     /** Scopes to request (default: ['read', 'write']) */
     scopes?: string[];
-    /**
-     * MindCache API base URL (default: 'https://api.mindcache.dev')
-     * This is the ONLY URL you need to set! All OAuth endpoints are derived from this.
-     * - authUrl = baseUrl + '/oauth/authorize'
-     * - tokenUrl = baseUrl + '/oauth/token'
-     */
-    baseUrl?: string;
-    /** @deprecated Use baseUrl instead. MindCache authorize URL */
-    authUrl?: string;
-    /** @deprecated Use baseUrl instead. MindCache token URL */
-    tokenUrl?: string;
-    /** @deprecated Use baseUrl instead. MindCache API URL */
-    apiUrl?: string;
     /** Use PKCE for security (default: true) */
     usePKCE?: boolean;
     /** Storage key prefix (default: 'mindcache_oauth') */
@@ -69,8 +97,14 @@ declare class OAuthClient {
     private tokens;
     private refreshPromise;
     constructor(config: OAuthConfig);
+    /** Derived auth URL */
+    private get authUrl();
+    /** Derived token URL */
+    private get tokenUrl();
+    /** Derived userinfo URL */
+    private get userinfoUrl();
     /**
-     * Validate the API is reachable and warn about common misconfigurations
+     * Validate the API is reachable
      */
     private validateApi;
     /**
@@ -123,13 +157,12 @@ declare class OAuthClient {
     private clearAuth;
     /**
      * Token provider for MindCache cloud config
-     * This fetches a WebSocket token (short-lived) using the OAuth access token
+     * This fetches a WebSocket token using the OAuth access token
      * Use this with MindCacheCloudOptions.tokenProvider
      */
     tokenProvider: () => Promise<string>;
     /**
      * Get raw OAuth access token (for API calls, not WebSocket)
-     * Use getAccessToken() for most cases
      */
     accessTokenProvider: () => Promise<string>;
     private getStorage;
@@ -175,4 +208,4 @@ declare function useMindCache(options?: MindCacheOptions): UseMindCacheResult;
 
 declare const mindcache: MindCache;
 
-export { MindCache, MindCacheOptions, type MindCacheUser, OAuthClient, type OAuthConfig, type OAuthTokens, type UseMindCacheResult, createOAuthClient, mindcache, useMindCache };
+export { CustomTypeDefinition, MindCache, MindCacheOptions, type MindCacheUser, OAuthClient, type OAuthConfig, type OAuthTokens, SchemaParser, type UseMindCacheResult, createOAuthClient, mindcache, useMindCache };