@team-supercharge/oasg 14.0.0-remove-instant-mapping-634c95c0.0 → 14.1.0-feature-postman-target-44c6a50d.0

package/README.md

@@ -771,12 +771,28 @@ describe('Auth', function () {
 |-|-|-|-|
 | fileName | Name of the generated file | N | `openapi.yaml` |
 
+#### `postman-collection`
+
+```json
+{
+  "id": "postman-collection",
+  "type": "postman-collection",
+  "source": "source-merged",
+  "repository": "git@gitlab.supercharge.io:example/openapi-generator-source.git",
+  "generatorCustomArgs": "--additional-properties=packageName=$packageName"
+}
+```
+
 ---
 
 # Migration Guide
 
 This section covers the breaking changes and their migrations across major version upgrades.
 
+## From `13.x.x` to `14.0.0`
+
+Several dependencies have been upgraded, and OASg now uses `node` version 20.15.0 and `npm` version 10 by default. If your project still uses `node@18`, you should upgrade first.
+
 ## From `12.x.x` to `13.0.1`
 
 > ❗ Due to version `13.0.0` has been published before erroneously (then unpublished) to the NPM registry, this version of the artifact won't be available either as an NPM package or a Docker base image. Please use the `13.0.1` patch version instead.

package/bin/oasg

@@ -49,6 +49,7 @@ const DEFAULT_GENERATOR_MAPPING = {
   "contract-testing": { version: '4.3.1',   generator: 'typescript-node' },
   "openapi":          { version: undefined, generator: undefined },
   "stubby":           { version: '4.3.1',   generator: 'stubby' },
+  "postman":          { version: '7.0.1',   generator: 'postman-collection' }
 };
 const DEFAULT_KTLINT_VERSION = '1.0.0';
 const BIN_FOLDER = 'out/.bin';

package/config.schema.yml

@@ -24,6 +24,7 @@ properties:
         - $ref: '#/targets/NestJS'
         - $ref: '#/targets/OpenAPI'
         - $ref: '#/targets/Flutter'
+        - $ref: '#/targets/Postman'
 required:
   - targets
 additionalProperties: false
@@ -346,6 +347,20 @@ targets:
         - packageName
         - repository
 
+  Postman:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^postman$"
+          packageName:
+            type: string
+          repository:
+            type: string
+        required:
+          - packageName
+          - repository
+
 definitions:
   # default
   SourceOverrides:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "14.0.0-remove-instant-mapping-634c95c0.0",
+  "version": "14.1.0-feature-postman-target-44c6a50d.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",
@@ -15,8 +15,8 @@
     "url": "git@gitlab.com:team-supercharge/oasg.git"
   },
   "engines": {
-    "node": "^18",
-    "npm": "^9"
+    "node": "^20.15",
+    "npm": "^10"
   },
   "files": [
     "bin",
@@ -28,9 +28,9 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^10.1.0",
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@redocly/cli": "1.2.0",
-    "@stoplight/prism-cli": "4.14.1",
-    "@stoplight/spectral-cli": "6.6.0",
+    "@redocly/cli": "1.17.1",
+    "@stoplight/prism-cli": "5.8.2",
+    "@stoplight/spectral-cli": "6.11.1",
     "ajv": "^8.12.0",
     "command-exists": "^1.2.9",
     "express": "^4.18.2",
@@ -39,11 +39,12 @@
     "js-yaml": "^4.1.0",
     "json-schema-merge-allof": "^0.8.1",
     "openapi-typescript-validator-ext-ref": "^3.2.0-external-ref-support",
-    "swagger-ui-express": "^4.6.2",
+    "swagger-ui-express": "^5.0.1",
     "yamljs": "^0.3.0",
     "yargs": "^17.7.1"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.12",
     "execa": "^5.0.0",
     "fs-extra": "^11.1.1",
     "jest": "^29.5.0"

package/targets/feign/generator-config.json

@@ -10,6 +10,14 @@
   "documentationProvider": "none",
   "annotationLibrary": "none",
   "useSpringBoot3": true,
+  "typeMappings": {
+    "OffsetDateTime": "java.time.Instant",
+    "Date": "java.time.LocalDate"
+  },
+  "importMappings": {
+    "java.time.OffsetDateTime": "java.time.Instant",
+    "java.util.Date": "java.time.LocalDate"
+  },
   "inlineSchemaOptions": {
     "ARRAY_ITEM_SUFFIX": "",
     "MAP_ITEM_SUFFIX": "",

package/targets/feign-kotlin/generator-config.json

@@ -8,6 +8,16 @@
   "documentationProvider": "none",
   "annotationLibrary": "none",
   "useSpringBoot3": true,
+  "typeMappings": {
+    "DateTime": "java.time.Instant",
+    "java.time.OffsetDateTime": "java.time.Instant",
+    "java.util.Date": "java.time.LocalDate"
+  },
+  "importMappings": {
+    "DateTime": "java.time.Instant",
+    "java.time.OffsetDateTime": "java.time.Instant",
+    "java.util.Date": "java.time.LocalDate"
+  },
   "inlineSchemaOptions": {
     "ARRAY_ITEM_SUFFIX": "",
     "MAP_ITEM_SUFFIX": "",

package/targets/nestjs/templates/package.mustache

@@ -15,11 +15,12 @@
   "peerDependencies": {
     "@nestjs/common": "^9.0.0 || ^10.0.0",
     "@nestjs/core": "^9.0.0 || ^10.0.0",
-    "@nestjs/platform-express": "^9.0.0 || ^10.0.0"
+    "@nestjs/platform-express": "^9.0.0 || ^10.0.0",
+    "@types/validator": "13.11.7"
   },
   "dependencies": {
     "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.0"
+    "class-validator": "0.14.0"
   },
   "devDependencies": {
     "@nestjs/common": "^9.0.0",

package/targets/nestjs/templates/pipes.ts

@@ -77,7 +77,7 @@ export class OptionalParseBoolPipe implements PipeTransform<string | boolean> {
   }
 }
 
-export class OptionalParseEnumPipe<T = any> implements PipeTransform<T> {
+export class OptionalParseEnumPipe<T extends { [key: string]: any } = any> implements PipeTransform<T> {
   constructor(private readonly enumType: T) {
     if (!enumType) {
       throw new Error(

package/targets/nestjs/templates/rewrite-path-parameters.js

@@ -12,7 +12,7 @@ function rewritePathParameters(fileName) {
     const contents = fs.readFileSync(file, 'utf-8');
 
     var result = contents.replace(/\${this\.configuration\.encodeParam\({name:\s"/g, ':');
-    result = result.replace(/".*}\)}/g, '');
+    result = result.replace(/".*?}\)}/g, '');
 
     var options = { flag : 'w', encoding: 'utf8' };
     fs.writeFileSync(file, result, options);

package/targets/postman/generate.sh

@@ -0,0 +1,17 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+java -jar $binary generate \
+  -g $generatorId \
+  -i $openApiFile \
+  -t $templateDir \
+  -o out/$targetId \
+  -c $(dirname "$0")/generator-config.json \
+  -ppubLibrary=$packageName \
+  -ppubName=$packageName \
+  -ppubRepository=$repository \
+  -ppubVersion=$version $generatorCustomArgs

package/targets/postman/generator-config.json

@@ -0,0 +1,7 @@
+{
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
+}

package/targets/postman/publish.sh

@@ -0,0 +1,26 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out
+git clone $repository generator-source
+rm -rf generator-source/$projectName
+cp -rf $targetId/* generator-source
+
+cd generator-source
+if [ $(git status --porcelain | wc -l) -eq "0" ]; then
+  echo "🟢 No changes"
+else
+  git add .
+  git commit -m "chore(release): $version"
+
+  if [ "$preRelease" == "false" ]; then git push; fi
+
+  tagVersion="v$version"
+  git tag -f $tagVersion
+  git push origin -f --tags
+fi
+
+cd ..
+rm -rf generator-source
+cd ../..

package/targets/react/generator-config.json

@@ -10,5 +10,15 @@
     "ARRAY_ITEM_SUFFIX": "",
     "MAP_ITEM_SUFFIX": "",
     "SKIP_SCHEMA_REUSE": "true"
+  },
+  "files": {
+    "hook.mustache": {
+      "destinationFilename": ".hook.ts",
+      "templateType": "API"
+    },
+    "use-api.hook.mustache": {
+      "folder": "src/apis",
+      "destinationFilename": "use-api.hook.tsx"
+    }
   }
 }

package/targets/react/templates/apis.index.mustache

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+{{#useSagaAndRecords}}
+export * from './SagaApiManager{{importFileExtension}}'
+export * from './allSagas{{importFileExtension}}'
+{{/useSagaAndRecords}}
+export * from './use-api.hook{{importFileExtension}}';
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+export * from './{{ classFilename }}{{importFileExtension}}';
+export * from './{{ classFilename }}.hook{{importFileExtension}}';
+{{#useSagaAndRecords}}
+export * from './{{{ classFilename }}}Sagas{{importFileExtension}}';
+{{/useSagaAndRecords}}
+{{/operations}}
+{{/apis}}
+{{/apiInfo}}

package/targets/react/templates/hook.mustache

@@ -0,0 +1,111 @@
+/* tslint:disable */
+/* eslint-disable */
+{{>licenseInfo}}
+
+import { useMutation, UseMutationOptions, UseMutationResult, useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
+import { useApi } from './use-api.hook';
+{{#imports.0}}
+import type {
+  {{#imports}}
+  {{className}},
+  {{/imports}}
+} from '../models/index{{importFileExtension}}';
+{{/imports.0}}
+{{#operations}}
+import {
+  {{classname}},
+{{#operation}}
+{{#allParams.0}}
+  {{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request,
+{{/allParams.0}}
+{{/operation}}
+} from './{{ classFilename }}{{importFileExtension}}';
+{{/operations}}
+
+{{#operations}}
+{{#operation}}
+
+export type {{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Parameters =
+{{^useSingleRequestParameter}}
+  { parameters: Parameters<{{classname}}['{{nickname}}']>};
+{{/useSingleRequestParameter}}
+{{#useSingleRequestParameter}}
+  {{#allParams.0}}{{#prefixParameterInterfaces}}{{classname}}{{/prefixParameterInterfaces}}{{operationIdCamelCase}}Request{{/allParams.0}}{{^allParams.0}}void{{/allParams.0}};
+{{/useSingleRequestParameter}}
+
+/**
+  {{#notes}}
+  * {{&notes}}
+  {{/notes}}
+  {{#summary}}
+  * {{&summary}}
+  {{/summary}}
+  {{#isDeprecated}}
+  * @deprecated
+  {{/isDeprecated}}
+  */
+export const use{{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Mutation = <TContext = unknown>(
+  { onSuccess, ...options }: Omit<UseMutationOptions<{{{returnType}}}{{^returnType}}void{{/returnType}}, Error, {{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Parameters, TContext>, 'mutationFn'> = {}
+): UseMutationResult<{{{returnType}}}{{^returnType}}void{{/returnType}}, Error, {{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Parameters, TContext> => {
+  const api = useApi({{classname}});
+  return useMutation<{{{returnType}}}{{^returnType}}void{{/returnType}}, Error, {{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Parameters, TContext>({
+{{^useSingleRequestParameter}}
+    mutationFn: ({ parameters }) => api.{{nickname}}(...parameters),
+{{/useSingleRequestParameter}}
+{{#useSingleRequestParameter}}
+{{#allParams.0}}
+    mutationFn: (parameters) => api.{{nickname}}(parameters),
+{{/allParams.0}}
+{{^allParams.0}}
+    mutationFn: () => api.{{nickname}}(),
+{{/allParams.0}}
+{{/useSingleRequestParameter}}
+    ...options,
+  });
+}
+/**
+  {{#notes}}
+  * {{&notes}}
+  {{/notes}}
+  {{#summary}}
+  * {{&summary}}
+  {{/summary}}
+  {{#isDeprecated}}
+  * @deprecated
+  {{/isDeprecated}}
+  */
+export const use{{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Query = (
+  options: Partial<Omit<UseQueryOptions<{{{returnType}}}{{^returnType}}void{{/returnType}}>, 'queryFn'>> = {}
+{{^useSingleRequestParameter}}
+  ,{parameters}: Partial<{{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Parameters>
+{{/useSingleRequestParameter}}
+{{#useSingleRequestParameter}}
+{{#allParams.0}}
+  ,parameter: {{classname}}{{#lambda.titlecase}}{{nickname}}{{/lambda.titlecase}}Parameters | undefined
+{{/allParams.0}}
+{{/useSingleRequestParameter}}
+): UseQueryResult<{{{returnType}}}{{^returnType}}void{{/returnType}}> => {
+  const api = useApi({{classname}});
+  return useQuery<{{{returnType}}}{{^returnType}}void{{/returnType}}>({
+{{^useSingleRequestParameter}}
+    queryKey: ['{{classname}}','{{nickname}}', ...requestParameters],
+    queryFn: ({ signal }) => api.{{nickname}}(...requestParameters.slice(0, -1), { ...requestParameters[requestParameters.length - 1], signal }),
+    enabled: !!parameters,
+{{/useSingleRequestParameter}}
+{{#useSingleRequestParameter}}
+{{#allParams.0}}
+    queryKey: ['{{classname}}','{{nickname}}', parameter],
+    queryFn: ({ signal }) => api.{{nickname}}(parameter, { signal }),
+    enabled: !!parameter,
+{{/allParams.0}}
+{{^allParams.0}}
+    queryKey: ['{{classname}}','{{nickname}}'],
+    queryFn: ({ signal }) => api.{{nickname}}({ signal }),
+{{/allParams.0}}
+{{/useSingleRequestParameter}}
+    ...options,
+  });
+}
+{{/operation}}
+
+{{/operations}}

package/targets/react/templates/package.mustache

@@ -0,0 +1,45 @@
+{
+  "name": "{{npmName}}",
+  "version": "{{npmVersion}}",
+  "description": "OpenAPI client for {{npmName}}",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}}.git"
+  },
+{{#packageAsSourceOnlyLibrary}}
+  "main": "./index.ts",
+{{/packageAsSourceOnlyLibrary}}
+{{^packageAsSourceOnlyLibrary}}
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+{{#supportsES6}}
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+{{/supportsES6}}
+  "scripts": {
+    "build": "tsc{{#supportsES6}} && tsc -p tsconfig.esm.json{{/supportsES6}}"{{^sagasAndRecords}},
+    "prepare": "npm run build"{{/sagasAndRecords}}
+  },
+{{/packageAsSourceOnlyLibrary}}
+  "devDependencies": {
+{{#sagasAndRecords}}
+    "immutable": "^4.0.0-rc.12",
+    "normalizr": "^3.6.1",
+    "redux-saga": "^1.1.3",
+    "redux-ts-simple": "^3.2.0",
+    "reselect": "^4.0.0",
+{{/sagasAndRecords}}
+    "typescript": "^4.0",
+    "@types/react": "^18.2.24"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "@tanstack/react-query": "^5.12.2"
+  }{{#npmRepository}},{{/npmRepository}}
+{{#npmRepository}}
+  "publishConfig": {
+    "registry": "{{npmRepository}}"
+  }
+{{/npmRepository}}
+}

package/targets/react/templates/tsconfig.esm.mustache

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "outDir": "dist/esm",
+    "jsx": "react-jsx"
+  }
+}

package/targets/react/templates/tsconfig.mustache

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "target": "{{#supportsES6}}es6{{/supportsES6}}{{^supportsES6}}es5{{/supportsES6}}",
+{{#sagasAndRecords}}
+    "strict": true,
+{{/sagasAndRecords}}
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "outDir": "dist",
+    {{^supportsES6}}
+    "lib": [
+      "es6",
+      "dom"
+    ],
+    {{/supportsES6}}
+    "typeRoots": [
+      "node_modules/@types"
+    ],
+    "jsx": "react-jsx",
+  },
+  "exclude": [
+    "dist",
+    "node_modules"
+  ]
+}

package/targets/react/templates/use-api.hook.mustache

@@ -0,0 +1,155 @@
+import {
+  createContext,
+  useContext,
+  useCallback,
+  useMemo,
+  FC,
+  PropsWithChildren,
+} from "react";
+import * as runtime from '../runtime';
+{{#apiInfo}}
+{{#apis}}
+{{#operations}}
+import { {{classname}} } from './{{ classFilename }}{{importFileExtension}}';
+{{/operations}}
+{{/apis}}
+
+
+type APIS_IN_ORDER = [
+  {{#apis}}
+  {{#operations}}
+  {{classname}},
+  {{/operations}}
+  {{/apis}}
+];
+
+export type APIS = APIS_IN_ORDER[number];
+
+export declare interface Type<T> extends Function {
+  new (...args: any[]): T;
+}
+
+export const ApiContext = createContext<{ getApi: <T extends APIS>(api: Type<T>) => T | undefined }>({
+  getApi: () => undefined,
+});
+
+export const getApiInstance = <TArray extends APIS[], T extends TArray[number]>(
+  api: Type<T>,
+  apis: TArray
+): T => {
+  return  apis.find((a) => a instanceof api) as T;
+};
+
+export const ApiProvider: FC<PropsWithChildren<{ apis: APIS[] }>> = ({
+  apis,
+  children,
+}) => {
+  const parent = useContext(ApiContext);
+  const getApi = useCallback(<T extends APIS>(api: Type<T>): T => {
+    const apiInstance = (apis.find((a) => a instanceof api) ?? parent.getApi(api)) as T | undefined;
+    if (!apiInstance) {
+      throw new Error(`API instance for ${api.name} not found. Please provide it using ApiProvider from '{{npmName}}'`);
+    }
+    return apiInstance;
+  }, [apis, parent.getApi]);
+  const value = useMemo(() => ({ getApi }), [getApi]);
+
+  return (
+    <ApiContext.Provider value={value}>
+      {children}
+    </ApiContext.Provider>
+  );
+};
+
+export const useApi = <T extends APIS>(api: Type<T>): T => {
+  const { getApi } = useContext(ApiContext);
+  return getApi(api);
+}
+
+export const ApiConfigContext = createContext<runtime.ConfigurationParameters>({});
+
+export const ApiConfigProvider: FC<PropsWithChildren<{ config: runtime.ConfigurationParameters }>> = ({
+  config,
+  children,
+}) => {
+  return (
+    <ApiConfigContext.Provider value={config}>
+      {children}
+    </ApiConfigContext.Provider>
+  );
+};
+
+export const ApiConfigWithInheritProvider: FC<PropsWithChildren<{ config: runtime.ConfigurationParameters }>> = ({
+  config,
+  children,
+}) => {
+  const parent = useContext(ApiConfigContext);
+  const value = useMemo(() => ({
+    ...parent,
+    ...config,
+    middleware: [...parent.middleware ?? [], ...config.middleware ?? []],
+    headers: { ...parent.headers, ...config.headers },
+  }), [parent, config]);
+
+  return (
+    <ApiConfigContext.Provider value={value}>
+      {children}
+    </ApiConfigContext.Provider>
+  );
+};
+
+export const useApiConfig = (): runtime.Configuration => {
+  const configParameters = useContext(ApiConfigContext);
+  const config = useMemo(() => new runtime.Configuration(configParameters), [configParameters]);
+  return config;
+}
+
+type ReadonlyApiConstructorToType<T> = T extends [
+  infer ARRAYFIRST,
+  ...infer ARRAYREST
+]
+  ? ARRAYFIRST extends InstanceType<infer ARRAYFIRSTTYPE>
+    ? [InstanceType<ARRAYFIRST>, ...ReadonlyApiConstructorToType<ARRAYREST>]
+    : []
+  : [];
+
+type ApiConstructorToType<T extends Array<unknown>> = T[0] extends undefined
+  ? APIS_IN_ORDER
+  : ReadonlyApiConstructorToType<T> extends []
+  ? APIS[]
+  : ReadonlyApiConstructorToType<T>;
+
+export const createApiInstances = <T extends Type<APIS>[]>(
+  config: runtime.Configuration,
+  apis: T = [] as unknown as T
+): ApiConstructorToType<T> => {
+  if (apis.length > 0) {
+    return apis.map((api) => new api(config)) as ApiConstructorToType<T>;
+  }
+  return [
+    {{#apis}}
+    {{#operations}}
+    new {{classname}}(config),
+    {{/operations}}
+    {{/apis}}
+  ] as unknown as ApiConstructorToType<T>;
+};
+
+export const useCreateApiInstances = <T extends Type<APIS>[]>(
+  apis: T = [] as unknown as T
+): ApiConstructorToType<T> => {
+  const config = useApiConfig();
+  return useMemo(() => createApiInstances(config, apis), [apis, config]);
+};
+{{/apiInfo}}
+
+export const ApiInstancesProvider: FC<PropsWithChildren<{ apis: Type<APIS>[] }>> = (
+  { apis, children }
+) => {
+  const apiInstances = useCreateApiInstances(apis);
+  return (
+    <ApiProvider apis={apiInstances}>
+      {children}
+    </ApiProvider>
+  );
+};

package/targets/spring/generator-config.json

@@ -12,6 +12,12 @@
   "documentationProvider": "none",
   "annotationLibrary": "none",
   "useSpringBoot3": true,
+  "typeMappings": {
+    "OffsetDateTime": "java.time.Instant"
+  },
+  "importMappings": {
+    "java.time.OffsetDateTime": "java.time.Instant"
+  },
   "inlineSchemaOptions": {
     "ARRAY_ITEM_SUFFIX": "",
     "MAP_ITEM_SUFFIX": "",

package/targets/spring-kotlin/generator-config.json

@@ -9,9 +9,13 @@
   "documentationProvider": "none",
   "useSpringBoot3": true,
   "typeMappings": {
+    "DateTime": "java.time.Instant",
+    "OffsetDateTime": "java.time.Instant",
     "org.springframework.core.io.Resource": "org.springframework.web.multipart.MultipartFile"
   },
   "importMappings": {
+    "DateTime": "java.time.Instant",
+    "java.time.OffsetDateTime": "java.time.Instant",
     "org.springframework.core.io.Resource": "org.springframework.web.multipart.MultipartFile"
   },
   "inlineSchemaOptions": {