@tstdl/base 0.93.36 → 0.93.38

package/generate-readmes.ts

@@ -1,340 +0,0 @@
-#!/usr/bin/env -S deno run --allow-env=GEMINI_API_KEY --allow-run=code2prompt --allow-read
-import { exists } from 'jsr:@std/fs';
-import { join } from 'jsr:@std/path';
-
-import packageJson from './package.json' with { type: 'json' };
-
-const allModules = Object.keys(packageJson.exports).map((key) => key.slice(2)).filter((key) => (key.length > 0) && !key.endsWith('json') && !key.endsWith('js'));
-
-const GEMINI_API_KEY = Deno.env.get('GEMINI_API_KEY');
-
-// List of module directories to process, relative to the project root.
-const MODULE_SUBDIRS: string[] = [
-  'ai',
-  'api',
-  'application',
-  'audit',
-  'authentication',
-  'browser',
-  'cancellation',
-  'data-structures',
-  'document-management',
-  'enumerable',
-  'enumeration',
-  'errors',
-  'http',
-  'injector',
-  'key-value-store',
-  'lock',
-  'logger',
-  'mail',
-  'message-bus',
-  'module',
-  'object-storage',
-  'orm',
-  'password',
-  'pdf',
-  'process',
-  'promise',
-  'queue',
-  'reflection',
-  'rpc',
-  'schema',
-  'serializer',
-  'sse',
-  'templates',
-  'text',
-  'types',
-  'utils',
-];
-
-const GEMINI_API_URL = `https://generativelanguage.googleapis.com/v1beta/models/gemini-2.5-pro:generateContent`;
-
-const agentsMd = await packDirectoryWithCode2Prompt(`../AGENTS.md`);
-const exampleSourceCode1 = await packDirectoryWithCode2Prompt(`./source/examples`);
-const exampleSourceCode2 = await packDirectoryWithCode2Prompt(`./source/document-management`);
-
-let exampleSourceCode3: string | null = null;
-const featuresFilePath = './tstdl-features.xml';
-
-if (await exists(featuresFilePath)) {
-  console.log('📖 Found tstdl-features.xml, including it in the example context.');
-  exampleSourceCode3 = await Deno.readTextFile(featuresFilePath);
-}
-else {
-  console.log('📖 tstdl-features.xml not found, skipping.');
-}
-
-const exampleSourceCode = [exampleSourceCode1, exampleSourceCode2, exampleSourceCode3].filter(Boolean).join('\n\n---\n\n');
-
-// --- HELPER FUNCTIONS ---
-
-/**
- * Packs a directory's contents into a single string using the `repomix` CLI tool.
- * @param dirPath The path to the directory to pack.
- * @returns The packed content as a string.
- */
-async function packDirectoryWithRepomix(dirPath: string): Promise<string> {
-  console.log(`  📦 Packing directory with repomix...`);
-  const command = new Deno.Command('repomix', {
-    args: ['--style', 'markdown', '--ignore', 'README.md', '-o', '-', dirPath],
-    stdout: 'piped',
-    stderr: 'piped',
-  });
-
-  const { code, stdout, stderr } = await command.output();
-
-  if (code !== 0) {
-    const errorOutput = new TextDecoder().decode(stderr);
-    throw new Error(
-      `repomix failed with exit code ${code}:\n${errorOutput}\nIs 'repomix' installed and in your PATH?`,
-    );
-  }
-
-  return new TextDecoder().decode(stdout);
-}
-
-async function packDirectoryWithCode2Prompt(dirPath: string): Promise<string> {
-  console.log(`  📦 Packing directory ${dirPath} with code2prompt...`);
-  const command = new Deno.Command('code2prompt', {
-    args: ['--no-clipboard', '--exclude', '**/drizzle/meta,**/drizzle/*.sql,README.md', '--output-file', '/dev/stdout', dirPath],
-    stdout: 'piped',
-    stderr: 'piped',
-  });
-
-  const { code, stdout, stderr } = await command.output();
-
-  if (code !== 0) {
-    const errorOutput = new TextDecoder().decode(stderr);
-    throw new Error(
-      `code2prompt failed with exit code ${code}:\n${errorOutput}\nIs 'code2prompt' installed and in your PATH?`,
-    );
-  }
-
-  return new TextDecoder().decode(stdout);
-}
-
-/**
- * Reads the content of an existing README.md file.
- * @param readmePath The full path to the README.md file.
- * @returns The content of the file, or null if it doesn't exist.
- */
-async function getExistingReadme(readmePath: string): Promise<string | null> {
-  if (await exists(readmePath)) {
-    console.log('  📄 Found existing README.md.');
-    return await Deno.readTextFile(readmePath);
-  }
-  console.log('  📄 No existing README.md found.');
-  return null;
-}
-
-/**
- * Builds the prompt for the Gemini API based on whether a README already exists.
- * @param packedCode The code context from repomix.
- * @param existingReadme The content of the existing README, or null.
- * @returns The complete prompt string.
- */
-function buildPrompt(module: string, packedCode: string, existingReadme: string | null): string {
-  const baseInstruction = `
-You are an expert software developer creating high-quality, developer-focused documentation.
-The output must be ONLY the raw Markdown content for the README.md file. Do not include any surrounding text, explanations, or code fences like \`\`\`markdown.
-
-The README should include:
-- A clear and concise title and a short description of the module's purpose.
-- A "Table of Contents" section for easy navigation.
-- A "Features" section if applicable.
-- A "Core Concepts" section explaining the main ideas and architecture.
-- A "Usage" section with a comprehensive list of simple code examples. If there are multiple ways to use a feature, provide examples for each.
-- An "API Summary" section briefly listing the main exported functions/classes. Include their arguments, return type and a short description. Format as a markdown table.
-
-Study the example usage source code provided to understand how the module is typically used.
-Follow the GENERAL GUIDELINES provided below when appropriate for a README to ensure consistency and best practices.
-
-Use package import statements instead of relative paths in your examples:
-Example: \`import { SomeService } from '@tstdl/base/some-module';\` instead of \`import { FooService } from '#/some-module/index.js';\`
-
-Use generic examples like User, Car, Pet, Product, etc. instead of the specific ones from the example source code.
-
-Available modules to import from: ${allModules.join(', ')}
-`.trim();
-
-  if (existingReadme) {
-    // --- UPDATE PROMPT ---
-    return `
-**GENERAL GUIDELINES:**
-\`\`\`markdown
-${agentsMd}
-\`\`\`
-
-**EXAMPLE USAGE SOURCE CODE:**
-\`\`\`markdown
-${exampleSourceCode}
-\`\`\`
-
-**MODULE SOURCE CODE:**
-\`\`\`markdown
-${packedCode}
-\`\`\`
-
-**EXISTING README.MD:**
-\`\`\`markdown
-${existingReadme}
-\`\`\`
-
-${baseInstruction}
-
-Your task is to UPDATE and IMPROVE an existing README.md file for the TypeScript ${module} module based on its source code.
-The existing README.md may be outdated and include incorrect code. Make sure you fully understand the current module functionality from the source code.
-Make sure the README is accurate, reflects any new or changed features, and follows best practices for developer documentation.
-Remove any content that is no longer relevant.
-Verify that all code examples are correct and up-to-date to the current code signatures.
-You can add, remove, or rewrite sections as needed for clarity and completeness.
-Avoid unnecessary changes that do not improve the documentation like renaming an existing model when its current name adheres to previous instructions or changing its properties without good reason.
-
-Now, provide the complete, final, and updated README.md content.
-`.trim();
-  }
-  else {
-    // --- GENERATE NEW PROMPT ---
-    return `
-**GENERAL GUIDELINES:**
-\`\`\`markdown
-${agentsMd}
-\`\`\`
-
-**EXAMPLE USAGE SOURCE CODE:**
-\`\`\`markdown
-${exampleSourceCode}
-\`\`\`
-
-**MODULE SOURCE CODE:**
-\`\`\`markdown
-${packedCode}
-\`\`\`
-
-${baseInstruction}
-
-Your task is to GENERATE a new, comprehensive, developer-focused README.md file for a TypeScript module based on its source code.
-
-Now, generate the complete README.md content.
-`.trim();
-  }
-}
-
-/**
- * Calls the Gemini API to generate or update the README content.
- * @param prompt The prompt to send to the API.
- * @returns The Markdown content from the API response.
- */
-async function generateReadmeContent(prompt: string): Promise<string> {
-  console.log('  🧠 Calling Gemini API...');
-  const response = await fetch(GEMINI_API_URL, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-      'x-goog-api-key': GEMINI_API_KEY,
-    },
-    body: JSON.stringify({
-      contents: [{ parts: [{ text: prompt }] }],
-    }),
-  });
-
-  if (!response.ok) {
-    const errorBody = await response.text();
-    throw new Error(
-      `Gemini API request failed: ${response.status} ${response.statusText}\n${errorBody}`,
-    );
-  }
-
-  const data = await response.json();
-  const content = data?.candidates?.[0]?.content?.parts?.[0]?.text;
-
-  if (!content) {
-    console.log('content: ', content);
-    throw new Error('Failed to extract content from Gemini API response.');
-  }
-
-  console.log('  ✅ Successfully received response from Gemini.');
-  return content.trim();
-}
-
-// --- MAIN EXECUTION ---
-
-async function main() {
-  if (!GEMINI_API_KEY) {
-    console.error('❌ ERROR: GEMINI_API_KEY not found in environment variables.');
-    Deno.exit(1);
-  }
-
-  const args = Deno.args;
-  const skipExisting = args.includes('--skip-existing');
-
-  // Filter for all arguments that are not flags (i.e., don't start with '-')
-  const targetModules = args.filter((arg) => !arg.startsWith('-'));
-
-  let modulesToProcess: string[];
-
-  if (targetModules.length > 0) {
-    // One or more specific modules were provided
-    const invalidModules = targetModules.filter((module) => !MODULE_SUBDIRS.includes(module));
-
-    if (invalidModules.length > 0) {
-      console.error(`❌ ERROR: Invalid module name(s) provided: ${invalidModules.join(', ')}`);
-      console.error(`👉 Available modules are: ${MODULE_SUBDIRS.join(', ')}`);
-      Deno.exit(1);
-    }
-
-    modulesToProcess = targetModules;
-    console.log(`🚀 Processing specified modules: ${modulesToProcess.join(', ')}`);
-  }
-  else {
-    // No specific modules provided, process all
-    modulesToProcess = MODULE_SUBDIRS;
-    if (skipExisting) {
-      console.log('🚀 Starting README generation process... (Mode: New files only)');
-    }
-    else {
-      console.log('🚀 Starting README generation process... (Mode: Update all files)');
-    }
-  }
-
-  for (const module of modulesToProcess) {
-    const dir = `source/${module}`;
-    const modulePath = join(Deno.cwd(), dir);
-    const readmePath = join(modulePath, 'README.md');
-    console.log(`\nProcessing module: ${module}`);
-
-    // If the flag is set and the README exists, skip this module
-    if (skipExisting && (await exists(readmePath))) {
-      console.log(`  ⏩ Skipping module as README.md already exists.`);
-      continue;
-    }
-
-    try {
-      // 1. Pack the directory
-      const packedCode = await packDirectoryWithCode2Prompt(modulePath);
-
-      // 2. Check for an existing README
-      const existingReadme = await getExistingReadme(readmePath);
-
-      // 3. Build the appropriate prompt
-      const prompt = buildPrompt(module, packedCode, existingReadme);
-
-      // 4. Call Gemini API
-      const newReadmeContent = await generateReadmeContent(prompt);
-
-      // 5. Write the new/updated README.md file
-      await Deno.writeTextFile(readmePath, newReadmeContent);
-      console.log(`  💾 Successfully wrote README.md to ${readmePath}`);
-    }
-    catch (error) {
-      console.error(`❌ Failed to process directory ${dir}:`, error.message);
-    }
-  }
-
-  console.log('\n✨ All modules processed!');
-}
-
-if (import.meta.main) {
-  await main();
-}

package/scripts/generate-context7-docs.sh

@@ -1,52 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-
-SOURCE_DIR="source"
-DIST_DIR="dist"
-
-echo "Generating Context 7 documentation..."
-
-# --- Pre-flight Checks ---
-# 1. Ensure source and distribution directories exist.
-if [[ ! -d "$SOURCE_DIR" ]]; then
-  echo "Error: Source directory '$SOURCE_DIR' not found." >&2
-  exit 1
-fi
-if [[ ! -d "$DIST_DIR" ]]; then
-  echo "Error: Distribution directory '$DIST_DIR' not found." >&2
-  exit 1
-fi
-
-# --- Main Logic ---
-# 2. Find all .d.ts files and process them.
-find "$DIST_DIR" -type f -name "*.d.ts" -print0 | while IFS= read -r -d '' dts_file; do
-  # Define the new markdown filename.
-  md_file="${dts_file%.d.ts}.md"
-  echo "Processing $dts_file -> $md_file"
-
-  # Transform the .d.ts content into .md format and remove private members.
-  sed \
-    -e '1s/^/```ts\n/' \
-    -e '$s/$/\n```/' \
-    -e '/^ *#private; *$/d' \
-    -e '/^ *private .*; *$/d' \
-    "$dts_file" >"$md_file"
-
-  # 4. Remove the original .d.ts file.
-  rm -- "$dts_file"
-done
-
-# --- Final File Copying ---
-# 5. Clarified file copying logic.
-echo "Copying READMEs and directory structure from $SOURCE_DIR..."
-rsync -ahv \
-  --prune-empty-dirs \
-  --include='*/' \
-  --include='README.md' \
-  --exclude='*' \
-  "$SOURCE_DIR/" "$DIST_DIR/"
-
-echo "Copying main README.md..."
-cp -v README.md "$DIST_DIR/"
-
-echo "Context 7 documentation generated successfully."

package/scripts/manage-orm.sh

@@ -1,63 +0,0 @@
-#!/bin/bash
-
-set -eo pipefail
-
-ACTION="$1" # "generate" or "copy"
-MODULE_TARGET="$2"
-SOURCE_DIR="source"
-DIST_DIR="dist"
-
-# --- Main Logic ---
-
-echo "Running ORM management script..."
-echo "Action: ${ACTION}"
-if [ -n "$MODULE_TARGET" ]; then
-  echo "Targeting module: ${MODULE_TARGET}"
-fi
-echo "-----------------------------------"
-
-if [ "$ACTION" == "generate" ]; then
-  npm run build
-
-  CONFIG_FILES=$(find "$DIST_DIR" -name "drizzle.config.js")
-
-  for config_file in $CONFIG_FILES; do
-    if [ -n "$MODULE_TARGET" ] && [[ "$config_file" != *"/$MODULE_TARGET/"* ]]; then
-      continue
-    fi
-
-    echo "▶️ Generating migration for ${config_file}..."
-    drizzle-kit generate --config "$config_file"
-    echo "✅ Done."
-  done
-
-elif [ "$ACTION" == "copy" ]; then
-  DRIZZLE_DIRS=$(find "$SOURCE_DIR" -type d -name "drizzle")
-
-  for source_drizzle_dir in $DRIZZLE_DIRS; do
-    # Construct the destination path by replacing 'source' with 'dist'
-    relative_path=${source_drizzle_dir#"$SOURCE_DIR/"}
-    dist_path=$(dirname "$DIST_DIR/$relative_path")
-
-    if [ -n "$MODULE_TARGET" ] && [[ "$dist_path" != *"/$MODULE_TARGET/"* ]]; then
-      continue
-    fi
-
-    if [ -f "$source_drizzle_dir/meta/_journal.json" ]; then
-      echo "▶️ Copying ORM files for ${relative_path}..."
-      rm -rf "$dist_path/drizzle"
-      cp -rv "$source_drizzle_dir" "$dist_path/"
-      echo "✅ Done."
-    else
-      echo "⏩ Skipping ${relative_path} (missing meta/_journal.json, not a valid migration folder)."
-    fi
-
-  done
-
-else
-  echo "Error: Invalid action '$ACTION'. Use 'generate' or 'copy'."
-  exit 1
-fi
-
-echo "-----------------------------------"
-echo "ORM script finished successfully."