@strapi2front/generators 0.4.1 → 0.5.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ParsedSchema, StrapiLocale } from '@strapi2front/core';
+import { ParsedSchema, StrapiLocale, Attribute } from '@strapi2front/core';
 
 /**
  * Shared types for generators
@@ -127,6 +127,27 @@ interface ByFeatureGeneratorOptions {
         types: boolean;
         services: boolean;
         actions: boolean;
+        /**
+         * Generate Zod schemas for validation
+         * Useful for React Hook Form, TanStack Form, Formik, etc.
+         * @default true for TypeScript, false for JSDoc
+         */
+        schemas?: boolean;
+        /**
+         * Generate upload helpers (upload-client + upload-action)
+         * @default false
+         */
+        upload?: boolean;
+    };
+    /**
+     * Schema generation options
+     */
+    schemaOptions?: {
+        /**
+         * Use advanced relation format with connect/disconnect/set operations
+         * @default false
+         */
+        advancedRelations?: boolean;
     };
     blocksRendererInstalled?: boolean;
     strapiVersion?: "v4" | "v5";
@@ -150,17 +171,21 @@ interface ByFeatureGeneratorOptions {
  *   collections/
  *     article/
  *       types.ts
+ *       schemas.ts
  *       service.ts
  *       actions.ts
  *   singles/
  *     homepage/
  *       types.ts
+ *       schemas.ts
  *       service.ts
  *   components/
  *     seo.ts
  *   shared/
  *     utils.ts
  *     client.ts
+ *     upload-client.ts   (when features.upload)
+ *     upload-action.ts   (when features.upload + actions + TypeScript)
  *     locales.ts
  */
 declare function generateByFeature(schema: ParsedSchema, locales: StrapiLocale[], options: ByFeatureGeneratorOptions): Promise<string[]>;
@@ -178,6 +203,8 @@ interface AstroActionsOptions {
     outputDir: string;
     servicesImportPath: string;
     strapiVersion?: StrapiVersion;
+    /** Use typed Zod schemas instead of generic z.record(z.unknown()) */
+    useTypedSchemas?: boolean;
 }
 /**
  * Check if Astro Actions are supported
@@ -311,6 +338,93 @@ interface JSDocServicesOptions {
  */
 declare function generateJSDocServices(schema: ParsedSchema, options: JSDocServicesOptions): Promise<string[]>;
 
+/**
+ * Zod Schemas generator
+ * Generates Zod validation schemas for Strapi content types
+ */
+
+interface ZodSchemasOptions {
+    outputDir: string;
+    /** Generate schemas alongside types in by-feature structure */
+    byFeature?: boolean;
+    /** Strapi version - affects ID types for relations (v4: number, v5: string) */
+    strapiVersion?: 'v4' | 'v5';
+}
+interface GeneratedSchemaInfo {
+    /** File path where schema was written */
+    filePath: string;
+    /** Schema names generated */
+    schemas: string[];
+}
+/**
+ * Generate Zod schemas from parsed schema
+ */
+declare function generateZodSchemas(schema: ParsedSchema, options: ZodSchemasOptions): Promise<GeneratedSchemaInfo[]>;
+
+/**
+ * Zod Schema mapping utilities
+ * Converts Strapi attributes to Zod schema strings
+ *
+ * Note: This mapper generates Zod schema code as strings
+ * that will be written to generated files.
+ */
+
+/**
+ * Options for schema generation
+ */
+interface ZodMapperOptions {
+    /** Whether this is for an update schema (all fields optional) */
+    isUpdate?: boolean;
+    /** Whether to include relation fields */
+    includeRelations?: boolean;
+    /** Whether to include media fields */
+    includeMedia?: boolean;
+    /** Whether to include component fields */
+    includeComponents?: boolean;
+    /** Strapi version - affects ID types (v4: number, v5: string documentId) */
+    strapiVersion?: 'v4' | 'v5';
+    /**
+     * Use advanced relation format with connect/disconnect/set
+     * @default false - uses simple ID arrays
+     */
+    useAdvancedRelations?: boolean;
+    /**
+     * Map of component UIDs to their schema variable names
+     * e.g. { 'curse.resource': 'resourceSchema' }
+     * When provided, component fields reference imported schemas instead of z.record(z.unknown())
+     */
+    componentSchemaNames?: Map<string, string>;
+}
+/**
+ * Result of mapping an attribute to Zod
+ */
+interface ZodMappedAttribute {
+    /** The Zod schema string (e.g., "z.string().min(1)") */
+    schema: string;
+    /** Whether this field should be skipped in generation */
+    skip: boolean;
+    /** Reason for skipping (if skip is true) */
+    skipReason?: string;
+}
+/**
+ * Check if a field is a system field
+ */
+declare function isSystemField(fieldName: string): boolean;
+/**
+ * Map a Strapi attribute to a Zod schema string
+ */
+declare function mapAttributeToZodSchema(attr: Attribute, options?: ZodMapperOptions): ZodMappedAttribute;
+/**
+ * Generate a complete Zod object schema from attributes
+ */
+declare function generateZodObjectSchema(attributes: Record<string, Attribute>, options?: ZodMapperOptions): {
+    schema: string;
+    skippedFields: Array<{
+        name: string;
+        reason: string;
+    }>;
+};
+
 /**
  * Format TypeScript code using Prettier
  */
@@ -362,4 +476,4 @@ declare function toKebabCase(str: string): string;
  */
 declare function pluralize(word: string): string;
 
-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 };
+export { type ActionsGeneratorOptions, type AstroActionsOptions, type BaseGeneratorOptions, type ByFeatureGeneratorOptions, type ClientGeneratorOptions, type Framework, type GeneratedSchemaInfo, 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, type ZodMappedAttribute, type ZodMapperOptions, type ZodSchemasOptions, deleteFile, ensureDir, fileExists, formatCode, formatJson, frameworkSupport, generateActions, generateAstroActions, generateByFeature, generateClient, generateJSDocServices, generateJSDocTypes, generateLocales, generateNextJsActions, generateNuxtServerRoutes, generateServices, generateTypeScriptTypes, generateTypes, generateZodObjectSchema, generateZodSchemas, isAstroActionsSupported, isNextJsActionsSupported, isNuxtServerRoutesSupported, isSystemField, listFiles, mapAttributeToZodSchema, pluralize, readFile, toCamelCase, toKebabCase, toPascalCase, writeFile };