@strapi2front/generators 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,32 +1,105 @@
 import { ParsedSchema, StrapiLocale } from '@strapi2front/core';
 
+/**
+ * Shared types for generators
+ * Generated by strapi2front
+ */
+
+/**
+ * Supported output formats
+ */
+type OutputFormat = 'typescript' | 'jsdoc';
+/**
+ * Supported frameworks
+ */
+type Framework = 'astro' | 'nextjs' | 'nuxt' | 'generic';
+/**
+ * Supported Strapi versions
+ */
+type StrapiVersion = 'v4' | 'v5';
+/**
+ * Base generator options
+ */
+interface BaseGeneratorOptions {
+    outputDir: string;
+    strapiVersion?: StrapiVersion;
+}
+/**
+ * Generator context passed to all generators
+ */
+interface GeneratorContext {
+    schema: ParsedSchema;
+    options: BaseGeneratorOptions;
+    outputFormat: OutputFormat;
+    strapiVersion: StrapiVersion;
+}
+/**
+ * Generator result
+ */
+interface GeneratorResult {
+    files: string[];
+    warnings?: string[];
+}
+
+/**
+ * Type generator
+ * Supports TypeScript (.ts) and JSDoc (.js) output formats
+ */
+
 interface TypeGeneratorOptions {
     outputDir: string;
     blocksRendererInstalled?: boolean;
-    strapiVersion?: "v4" | "v5";
+    strapiVersion?: StrapiVersion;
+    /**
+     * Output format: 'typescript' for .ts files, 'jsdoc' for .js with JSDoc annotations
+     * @default 'typescript'
+     */
+    outputFormat?: OutputFormat;
 }
 /**
- * Generate TypeScript types from parsed schema
+ * Generate types from parsed schema
+ * Supports both TypeScript and JSDoc output formats
  */
 declare function generateTypes(schema: ParsedSchema, options: TypeGeneratorOptions): Promise<string[]>;
 
+/**
+ * Service generator
+ * Supports TypeScript (.ts) and JSDoc (.js) output formats
+ */
+
 interface ServiceGeneratorOptions {
     outputDir: string;
     typesImportPath: string;
-    strapiVersion?: "v4" | "v5";
+    strapiVersion?: StrapiVersion;
+    /**
+     * Output format: 'typescript' for .ts files, 'jsdoc' for .js with JSDoc annotations
+     * @default 'typescript'
+     */
+    outputFormat?: OutputFormat;
 }
 /**
  * Generate service files from parsed schema
  */
 declare function generateServices(schema: ParsedSchema, options: ServiceGeneratorOptions): Promise<string[]>;
 
+/**
+ * Actions generator
+ * Re-exports from frameworks/astro for backwards compatibility
+ *
+ * For framework-specific generators, import directly from:
+ * - '@strapi2front/generators/frameworks/astro'
+ * - '@strapi2front/generators/frameworks/nextjs' (coming soon)
+ * - '@strapi2front/generators/frameworks/nuxt' (coming soon)
+ */
+
 interface ActionsGeneratorOptions {
     outputDir: string;
     servicesImportPath: string;
-    strapiVersion?: "v4" | "v5";
+    strapiVersion?: StrapiVersion;
 }
 /**
  * Generate Astro Actions from parsed schema
+ * @deprecated Use generateAstroActions from '@strapi2front/generators/frameworks/astro' instead
  */
 declare function generateActions(schema: ParsedSchema, options: ActionsGeneratorOptions): Promise<string[]>;
 
@@ -58,6 +131,11 @@ interface ByFeatureGeneratorOptions {
     blocksRendererInstalled?: boolean;
     strapiVersion?: "v4" | "v5";
     apiPrefix?: string;
+    /**
+     * Output format: 'typescript' for .ts files, 'jsdoc' for .js with JSDoc annotations
+     * @default 'typescript'
+     */
+    outputFormat?: "typescript" | "jsdoc";
 }
 /**
  * Generate all files using 'by-feature' structure
@@ -82,6 +160,152 @@ interface ByFeatureGeneratorOptions {
  */
 declare function generateByFeature(schema: ParsedSchema, locales: StrapiLocale[], options: ByFeatureGeneratorOptions): Promise<string[]>;
 
+/**
+ * Astro Actions generator
+ * Generates type-safe Astro Actions for Strapi content types
+ *
+ * Requirements:
+ * - Astro v4.0+ (Actions are only available in v4+)
+ * - TypeScript enabled
+ */
+
+interface AstroActionsOptions {
+    outputDir: string;
+    servicesImportPath: string;
+    strapiVersion?: StrapiVersion;
+}
+/**
+ * Check if Astro Actions are supported
+ * Requires Astro v4.0 or higher
+ */
+declare function isAstroActionsSupported(astroVersion: string | null): boolean;
+/**
+ * Generate Astro Actions from parsed schema
+ */
+declare function generateAstroActions(schema: ParsedSchema, options: AstroActionsOptions): Promise<string[]>;
+
+/**
+ * Next.js Server Actions generator
+ * Generates type-safe Server Actions for Strapi content types
+ *
+ * Requirements:
+ * - Next.js 14+ (Server Actions)
+ * - TypeScript enabled
+ *
+ * Status: COMING SOON
+ */
+
+interface NextJsActionsOptions {
+    outputDir: string;
+    servicesImportPath: string;
+    strapiVersion?: StrapiVersion;
+}
+/**
+ * Generate Next.js Server Actions from parsed schema
+ *
+ * @throws Error - Not yet implemented
+ */
+declare function generateNextJsActions(_schema: ParsedSchema, _options: NextJsActionsOptions): Promise<string[]>;
+/**
+ * Check if Next.js Server Actions are supported
+ * Requires Next.js 14+ with App Router
+ */
+declare function isNextJsActionsSupported(nextVersion: string | null): boolean;
+
+/**
+ * Nuxt Server Routes generator
+ * Generates type-safe server routes for Strapi content types
+ *
+ * Requirements:
+ * - Nuxt 3+
+ * - TypeScript enabled
+ *
+ * Status: COMING SOON
+ */
+
+interface NuxtServerRoutesOptions {
+    outputDir: string;
+    servicesImportPath: string;
+    strapiVersion?: StrapiVersion;
+}
+/**
+ * Generate Nuxt Server Routes from parsed schema
+ *
+ * @throws Error - Not yet implemented
+ */
+declare function generateNuxtServerRoutes(_schema: ParsedSchema, _options: NuxtServerRoutesOptions): Promise<string[]>;
+/**
+ * Check if Nuxt Server Routes are supported
+ * Requires Nuxt 3+
+ */
+declare function isNuxtServerRoutesSupported(nuxtVersion: string | null): boolean;
+
+/**
+ * Framework-specific generators
+ *
+ * Each framework has its own approach to server-side data fetching:
+ * - Astro: Actions (v4+)
+ * - Next.js: Server Actions (v14+) - Coming Soon
+ * - Nuxt: Server Routes (v3+) - Coming Soon
+ */
+
+/**
+ * Supported frameworks for action generation
+ */
+type SupportedFramework = 'astro' | 'nextjs' | 'nuxt';
+/**
+ * Framework support status
+ */
+declare const frameworkSupport: Record<SupportedFramework, {
+    status: 'stable' | 'coming-soon';
+    minVersion: string;
+}>;
+
+/**
+ * TypeScript type generator
+ * Generates .ts files with interfaces
+ */
+
+interface TypeScriptTypesOptions {
+    outputDir: string;
+    blocksRendererInstalled?: boolean;
+    strapiVersion?: StrapiVersion;
+}
+/**
+ * Generate TypeScript types from parsed schema
+ */
+declare function generateTypeScriptTypes(schema: ParsedSchema, options: TypeScriptTypesOptions): Promise<string[]>;
+
+/**
+ * JSDoc type generator
+ * Generates .js files with JSDoc annotations for type safety without TypeScript
+ */
+
+interface JSDocTypesOptions {
+    outputDir: string;
+    blocksRendererInstalled?: boolean;
+    strapiVersion?: StrapiVersion;
+}
+/**
+ * Generate JSDoc types from parsed schema
+ */
+declare function generateJSDocTypes(schema: ParsedSchema, options: JSDocTypesOptions): Promise<string[]>;
+
+/**
+ * JSDoc service generator
+ * Generates .js files with JSDoc annotations for services
+ */
+
+interface JSDocServicesOptions {
+    outputDir: string;
+    typesImportPath: string;
+    strapiVersion?: StrapiVersion;
+}
+/**
+ * Generate JSDoc service files from parsed schema
+ */
+declare function generateJSDocServices(schema: ParsedSchema, options: JSDocServicesOptions): Promise<string[]>;
+
 /**
  * Format TypeScript code using Prettier
  */
@@ -133,4 +357,4 @@ declare function toKebabCase(str: string): string;
  */
 declare function pluralize(word: string): string;
 
-export { type ActionsGeneratorOptions, type ByFeatureGeneratorOptions, type ClientGeneratorOptions, type LocalesGeneratorOptions, type ServiceGeneratorOptions, type TypeGeneratorOptions, deleteFile, ensureDir, fileExists, formatCode, formatJson, generateActions, generateByFeature, generateClient, generateLocales, generateServices, generateTypes, listFiles, pluralize, readFile, toCamelCase, toKebabCase, toPascalCase, writeFile };
+export { type ActionsGeneratorOptions, type AstroActionsOptions, type BaseGeneratorOptions, type ByFeatureGeneratorOptions, type ClientGeneratorOptions, type Framework, type GeneratorContext, type GeneratorResult, type JSDocServicesOptions, type JSDocTypesOptions, type LocalesGeneratorOptions, type NextJsActionsOptions, type NuxtServerRoutesOptions, type OutputFormat, type ServiceGeneratorOptions, type StrapiVersion, type SupportedFramework, type TypeGeneratorOptions, type TypeScriptTypesOptions, deleteFile, ensureDir, fileExists, formatCode, formatJson, frameworkSupport, generateActions, generateAstroActions, generateByFeature, generateClient, generateJSDocServices, generateJSDocTypes, generateLocales, generateNextJsActions, generateNuxtServerRoutes, generateServices, generateTypeScriptTypes, generateTypes, isAstroActionsSupported, isNextJsActionsSupported, isNuxtServerRoutesSupported, listFiles, pluralize, readFile, toCamelCase, toKebabCase, toPascalCase, writeFile };