swaggie 1.7.1 → 1.8.0

package/README.md

@@ -78,6 +78,8 @@ swaggie -s https://petstore3.swagger.io/api/v3/openapi.json -o ./client/petstore
 -o, --out <filePath>      Output file path (omit to print to stdout)
 -b, --baseUrl <string>    Default base URL for the generated client (default: "")
 -t, --template <string>   Template to use for code generation (default: "axios")
+ -m, --mode <mode>         Generation mode: "full" or "schemas" (default: "full")
+ -d, --schemaStyle <style> Schema object style: "interface" or "type" (default: "interface")
     --preferAny           Use "any" instead of "unknown" for untyped values (default: false)
     --skipDeprecated      Exclude deprecated operations from the output (default: false)
     --servicePrefix       Prefix for service names — useful when generating multiple APIs
@@ -119,6 +121,8 @@ swaggie -c swaggie.config.json
   "servicePrefix": "",
   "dateFormat": "Date",
   "nullableStrategy": "ignore",
+  "generationMode": "full",
+  "schemaDeclarationStyle": "interface",
   "queryParamsSerialization": {
     "arrayFormat": "repeat",
     "allowDots": true
@@ -255,6 +259,26 @@ OpenAPI 3.0 allows fields to be marked as `nullable: true`. Swaggie gives you th
 // nullableStrategy: "nullableAsOptional"  →  tenant?: string;
 ```
 
+### Generation Mode
+
+Use `generationMode` (or CLI `--mode`) to control what gets generated:
+
+| Value       | Behavior                                                                       |
+| ----------- | ------------------------------------------------------------------------------ |
+| `"full"`   | Generates full client code + used schemas (default, existing behavior)         |
+| `"schemas"`| Generates only schemas and includes all component schemas by default            |
+
+`"schemas"` mode intentionally does not run the used-schema heuristic.
+
+### Schema Declaration Style
+
+Use `schemaDeclarationStyle` (or CLI `--schemaStyle`) to control object schema output:
+
+| Value         | Behavior                                                                 |
+| ------------- | ------------------------------------------------------------------------ |
+| `"interface"`| `export interface Tag { ... }` (default)                                |
+| `"type"`     | `export type Tag = { ... };`                                             |
+
 ### Parameter Modifiers
 
 Sometimes an API spec marks a parameter as required, but your client handles it in an interceptor and you don't want it cluttering every method signature. Parameter modifiers let you override this globally without touching the spec.

package/dist/cli.js

@@ -15,6 +15,15 @@ const arrayFormatOption = new (0, _commander.Option)(
 
 const packageJson = readPackageJson();
 
+const modeOption = new (0, _commander.Option)('-m, --mode <mode>', 'Generation mode').choices([
+  'full',
+  'schemas',
+]);
+const schemaStyleOption = new (0, _commander.Option)(
+  '-d, --schemaStyle <style>',
+  'Schema object declaration style'
+).choices(['interface', 'type']);
+
 const program = new (0, _commander.Command)();
 program
   .version(packageJson.version)
@@ -53,7 +62,9 @@ program
     '--allowDots <bool>',
     'Determines if dots should be used for serialization object properties'
   )
-  .addOption(arrayFormatOption);
+  .addOption(arrayFormatOption)
+  .addOption(modeOption)
+  .addOption(schemaStyleOption);
 
 program.parse(process.argv);
 

package/dist/gen/genTypes.js

@@ -46,6 +46,7 @@ function renderSchema(
   schema,
   options
 ) {
+  const useTypeAliases = options.schemaDeclarationStyle === 'type';
   const safeName = _swagger.getSafeIdentifier.call(void 0, name);
   if (!safeName) {
     console.warn(`Skipping schema ${name} because it is not a valid identifier`);
@@ -81,11 +82,18 @@ function renderSchema(
 
   if ('allOf' in schema) {
     const types = _swagger.getRefCompositeTypes.call(void 0, schema);
+    const mergedSchema = getMergedCompositeObjects(schema);
+    const objectContents = generateObjectTypeContents(mergedSchema, options);
+
+    if (useTypeAliases) {
+      const compositeTypes = [...types, `{${objectContents ? `\n${objectContents}\n` : ''}}`].join(' & ');
+      result.push(`export type ${safeName} = ${compositeTypes};`);
+      return `${result.join('\n')}\n`;
+    }
+
     const extensions = types ? `extends ${types.join(', ')} ` : '';
     result.push(`export interface ${safeName} ${extensions}{`);
-
-    const mergedSchema = getMergedCompositeObjects(schema);
-    result.push(generateObjectTypeContents(mergedSchema, options));
+    result.push(objectContents);
   } else if ('oneOf' in schema || 'anyOf' in schema) {
     const typeDefinition = getTypesFromAnyOrOneOf(schema, options);
     result.push(`export type ${safeName} = ${typeDefinition};`);
@@ -97,11 +105,18 @@ function renderSchema(
     result.push(`export type ${safeName} = ${generateItemsType(schema.items, options)}[];`);
     return result.join('\n');
   } else {
+    const objectContents = generateObjectTypeContents(schema, options);
+    if (useTypeAliases) {
+      result.push(`export type ${safeName} = {`);
+      result.push(objectContents);
+      return `${result.join('\n')}\n};\n`;
+    }
+
     result.push(`export interface ${safeName} {`);
-    result.push(generateObjectTypeContents(schema, options));
+    result.push(objectContents);
   }
 
-  return `${result.join('\n')}}\n`;
+  return `${result.join('\n')}\n}\n`;
 }
 
 /**
@@ -198,7 +213,10 @@ function renderTypeProp(
   const type = _swagger.getTypeFromSchema.call(void 0, definition, options);
 
   if ('description' in definition || 'title' in definition) {
-    lines.push(_jsDocs.renderComment.call(void 0, _nullishCoalesce(definition.description, () => ( definition.title))));
+    const renderedComment = _jsDocs.renderComment.call(void 0, _nullishCoalesce(definition.description, () => ( definition.title)));
+    if (renderedComment) {
+      lines.push(indentComment(renderedComment, '  '));
+    }
   }
 
   const isOptional = !required || isNullableAsOptional(definition, options);
@@ -211,6 +229,13 @@ function renderTypeProp(
   return lines.join('\n');
 }
 
+function indentComment(comment, indent) {
+  return comment
+    .split('\n')
+    .map((line) => `${indent}${line}`)
+    .join('\n');
+}
+
 /**
  * When nullableAsOptional strategy is set, nullable properties are treated as optional.
  * Supports both OA3.0 (nullable: true) and OA3.1 (type: ["string", "null"]).

package/dist/gen/index.js

@@ -9,8 +9,14 @@ var _utils = require('../utils');
   spec,
   options
 ) {
-  let fileContents = await _genOperations2.default.call(void 0, spec, options);
-  fileContents += _genTypes2.default.call(void 0, spec, options);
+  let fileContents = '';
+
+  if (options.generationMode === 'schemas') {
+    fileContents = _genTypes2.default.call(void 0, spec, options, false);
+  } else {
+    fileContents = await _genOperations2.default.call(void 0, spec, options);
+    fileContents += _genTypes2.default.call(void 0, spec, options);
+  }
 
   if (options.out) {
     const destFile = _utils.prepareOutputFilename.call(void 0, options.out);

package/dist/index.js

@@ -34,7 +34,9 @@ function verifyOptions(options) {
 }
 
 function gen(spec, options) {
-  _utils.loadAllTemplateFiles.call(void 0, options.template);
+  if (options.generationMode === 'full') {
+    _utils.loadAllTemplateFiles.call(void 0, options.template);
+  }
 
   return _gen2.default.call(void 0, spec, options);
 }
@@ -76,7 +78,15 @@ function readFile(filePath) {
  * object where every defaultable field is guaranteed to be present.
  */
  function prepareAppOptions(cliOpts) {
-  const { allowDots, arrayFormat, template, queryParamsSerialization = {}, ...rest } = cliOpts;
+  const {
+    allowDots,
+    arrayFormat,
+    mode,
+    schemaStyle,
+    template,
+    queryParamsSerialization = {},
+    ...rest
+  } = cliOpts;
   const mergedQueryParamsSerialization = {
     ..._swagger.APP_DEFAULTS.queryParamsSerialization,
     ...Object.fromEntries(
@@ -91,6 +101,9 @@ function readFile(filePath) {
     template: _nullishCoalesce(template, () => ( _swagger.APP_DEFAULTS.template)),
     servicePrefix: _nullishCoalesce(rest.servicePrefix, () => ( _swagger.APP_DEFAULTS.servicePrefix)),
     nullableStrategy: _nullishCoalesce(rest.nullableStrategy, () => ( _swagger.APP_DEFAULTS.nullableStrategy)),
+    generationMode: _nullishCoalesce(_nullishCoalesce(mode, () => ( rest.generationMode)), () => ( _swagger.APP_DEFAULTS.generationMode)),
+    schemaDeclarationStyle:
+      _nullishCoalesce(_nullishCoalesce(schemaStyle, () => ( rest.schemaDeclarationStyle)), () => ( _swagger.APP_DEFAULTS.schemaDeclarationStyle)),
     queryParamsSerialization: mergedQueryParamsSerialization,
   };
 } exports.prepareAppOptions = prepareAppOptions;

package/dist/swagger/typesExtractor.js

@@ -262,6 +262,8 @@ function getTypeFromComposites(schema, options) {
   template: 'axios',
   servicePrefix: '',
   nullableStrategy: 'ignore',
+  generationMode: 'full',
+  schemaDeclarationStyle: 'interface',
   queryParamsSerialization: {
     allowDots: true,
     arrayFormat: 'repeat',
@@ -279,6 +281,8 @@ function getTypeFromComposites(schema, options) {
     template: _nullishCoalesce(opts.template, () => ( exports.APP_DEFAULTS.template)),
     servicePrefix: _nullishCoalesce(opts.servicePrefix, () => ( exports.APP_DEFAULTS.servicePrefix)),
     nullableStrategy: _nullishCoalesce(opts.nullableStrategy, () => ( exports.APP_DEFAULTS.nullableStrategy)),
+    generationMode: _nullishCoalesce(opts.generationMode, () => ( exports.APP_DEFAULTS.generationMode)),
+    schemaDeclarationStyle: _nullishCoalesce(opts.schemaDeclarationStyle, () => ( exports.APP_DEFAULTS.schemaDeclarationStyle)),
     queryParamsSerialization: {
       ...exports.APP_DEFAULTS.queryParamsSerialization,
       ...opts.queryParamsSerialization,

package/dist/types.d.ts

@@ -29,6 +29,10 @@ export interface ClientOptions {
     nullableStrategy?: NullableStrategy;
     /** Options for query parameters serialization */
     queryParamsSerialization: QueryParamsSerializationOptions;
+    /** Controls whether to generate full client code or only component schemas */
+    generationMode?: GenerationMode;
+    /** Controls whether object schemas are emitted as interfaces or type aliases */
+    schemaDeclarationStyle?: SchemaDeclarationStyle;
     /** Offers ability to adjust the OpenAPI spec before it is processed */
     modifiers?: {
         /** Global-level modifiers for parameter with a given name */
@@ -40,6 +44,8 @@ export interface ClientOptions {
 export interface CliOptions extends FullAppOptions {
     allowDots?: boolean;
     arrayFormat?: ArrayFormat;
+    mode?: GenerationMode;
+    schemaStyle?: SchemaDeclarationStyle;
 }
 export interface FullAppOptions extends ClientOptions {
     /** Path to the configuration file that contains actual config to be used */
@@ -50,6 +56,8 @@ export type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head'
 export type DateSupport = 'string' | 'Date';
 export type ArrayFormat = 'indices' | 'repeat' | 'brackets';
 export type NullableStrategy = 'include' | 'nullableAsOptional' | 'ignore';
+export type GenerationMode = 'full' | 'schemas';
+export type SchemaDeclarationStyle = 'interface' | 'type';
 /**
  * Internal options type used throughout the app after `prepareAppOptions` has run.
  * All fields that have defaults are required here so the rest of the codebase never
@@ -59,6 +67,8 @@ export interface AppOptions extends ClientOptions {
     template: Template;
     servicePrefix: string;
     nullableStrategy: NullableStrategy;
+    generationMode: GenerationMode;
+    schemaDeclarationStyle: SchemaDeclarationStyle;
     queryParamsSerialization: {
         allowDots: boolean;
         arrayFormat: ArrayFormat;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "Generate a fully typed TypeScript API client from your OpenAPI 3 spec",
   "author": {
     "name": "Piotr Dabrowski",