saddlebackdev · romantech48 · Jan 31, 2023 · Jun 3, 2022 · Jun 8, 2022 · Jun 9, 2022
diff --git a/README.md b/README.md
@@ -1,95 +1,140 @@
-# OpenAPI Typescript Codegen
-
-[![NPM][npm-image]][npm-url]
-[![License][license-image]][license-url]
-[![Coverage][coverage-image]][coverage-url]
-[![Quality][quality-image]][quality-url]
-[![Code Climate][climate-image]][climate-url]
-[![Downloads][downloads-image]][downloads-url]
-[![Build][build-image]][build-url]
-
-> Node.js library that generates Typescript clients based on the OpenAPI specification.
-
-## Why?
-- Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds
-- Quick, lightweight, robust and framework-agnostic 🚀
-- Supports generation of TypeScript clients
-- Supports generations of Fetch, [Node-Fetch](#node-fetch-support), [Axios](#axios-support), [Angular](#angular-support) and XHR http clients
-- Supports OpenAPI specification v2.0 and v3.0
-- Supports JSON and YAML files for input
-- Supports generation through CLI, Node.js and NPX
-- Supports tsc and @babel/plugin-transform-typescript
-- Supports aborting of requests (cancelable promise pattern)
-- Supports external references using [json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser/)
+# Custom Saddleback OpenAPI Typescript Codegen
+
+> For original usage read - [original README](docs/original-readme.md)
 
 ## Install
 
 ```
-npm install openapi-typescript-codegen --save-dev
+npm install saddleback-openapi-typescript-codegen --save-dev
 ```
 
+## Step-by-step guide based on ME app
+### auto fetch
+1. install the package
+2. create config files for every microservice that you need (put it in the root project folder for example openapiEvents.config.json)
+3. inside the config file you need to specify
+   1. output folder (for Events it would be ./src/shared/api/events)
+   2. microservice that you're specifying ("Events")
+   3. environment that using for fetch ("feature")
+   4. if you don't want to generate whole microservices, you can specify filterMethod and filterArray
+4. create utility files that used in services
+   1. 'baseAxios' should export axios instance that be used for fetch
+   2. 'getBaseConfig' and 'serviceError' described here https://github.com/saddlebackdev/church-management/wiki/Services
+5. run the command where you should pass your login and pass from saddleback identity server `saddlebackApi --config openapiEvents.config.json --login login --password password`
+### local swagger
+1. same as above
+2. same as above
+3. addition specify the input path to the swagger.json file
+4. same as above
+5. run the command `saddlebackApi --config openapiEvents.config.json`
+
 ## Usage
 
+Generated folders should be untouchable. Because every generate action will delete and put generated files into the output folder.
+
 ```
-$ openapi --help
+$ saddlebackOpenapi --help
 
-  Usage: openapi [options]
+  Usage: saddlebackOpenapi [options]
 
   Options:
     -V, --version             output the version number
-    -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
-    -o, --output <value>      Output directory (required)
-    -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
-    --name <value>            Custom client class name
-    --useOptions              Use options instead of arguments
-    --useUnionTypes           Use union types instead of enums
-    --exportCore <value>      Write core files to disk (default: true)
-    --exportServices <value>  Write services to disk (default: true)
-    --exportModels <value>    Write models to disk (default: true)
-    --exportSchemas <value>   Write schemas to disk (default: false)
-    --indent <value>          Indentation options [4, 2, tab] (default: "4")
-    --postfix <value>         Service name postfix (default: "Service")
-    --request <value>         Path to custom request file
+    -i, --input <value>       OpenAPI specification, can be a path, url or string content
+    -o, --output <value>      Output directory should end with service name workflows | events | notifications | core | journey | giving | smallGroup
+    -c, --config <value>      Path to the config file
+    -l, --login <value>       Login
+    -p, --password <value>    Password
+    -e, --environment <value> Environment dev | stage | stage2
+    -s, --service <value>     Service Service Workflows | Events | Notifications | Core | Journey | Giving | SmallGroup
     -h, --help                display help for command
+    -m, --filterMethod        Filter method include(default) | exclude')
+    -f, --filterArray         Filter array
 
   Examples
-    $ openapi --input ./spec.json --output ./generated
-    $ openapi --input ./spec.json --output ./generated --client xhr
+    $ saddlebackOpenApi --input ./spec.json --output ./generated
+    $ saddlebackOpenApi --config ./openapi.config.json
+    $ saddlebackOpenApi -o "./folderPath" -l "Login" -p "Password" -e "dev" -s "core"
+```
+
+## Config file
+*extends original OPTIONS*
+```
+    input                           required in the config or cmd arguments
+    output                          required in the config or cmd arguments
+
+    additionalModelFileExtension    optional
+    additionalServiceFileExtension  optional
+    removeLodashPrefixes            optional
 ```
+### Settings:
+### `input`
+- Default: `undefined`
+- Type: `string`
+
+OpenAPI specification, can be a path, url or string content (required in the config or cmd arguments)
+
+### `output`
+- Default: `undefined`
+- Type: `string`
+
+Output directory (required in the config or cmd arguments)
+
+### `login` (autofetch)
+- Default: `undefined`
+- Type: `string`
+
+Login to saddleback identity server
+
+### `password` (autofetch)
+- Default: `undefined`
+- Type: `string`
+
+Password to saddleback identity server
+
+### `environment` (autofetch)
+- Default: `undefined`
+- Type: `'dev' | 'stage' | 'stage2'`
+
+Which Environment should be used for swagger.json
+
+### `service` (autofetch)
+- Default: `undefined`
+- Type: `'workflows' | 'event' | 'notifications' | 'core'`
+
+Which service should be fetched
+
+### `filterMethod` (autofetch)
+- Default: `include`
+- Type: `'include' | 'exclude'`
+
+Which method of sort should be applied to the filter array
+
+### `filterArray` (autofetch)
+- Default: `undefined`
+- Type: `string[]`
+
+Which services should be *included* or *excluded* to/from generated list
+
+### `additionalModelFileExtension`
+- Default: `true`
+- Type: `boolean`
+
+Apply `*.models.*` extension to model files.
+
+For example (myModel.ts -> myModel.models.ts)
+
+### `additionalServiceFileExtension`
+- Default: `true`
+- Type: `boolean`
+
+Apply `*.service.*` extension to service files.
+
+For example (myService.ts -> myService.service.ts)
+
+### `removeLodashPrefixes`
+- Default: `true`
+- Type: `boolean`
+
+Remove special prefixes that are separated by `_` at the start of names.
 
-Documentation
-===
-- [Basic usage](docs/basic-usage.md)
-- [OpenAPI object](docs/openapi-object.md)
-- [Client instances](docs/client-instances.md) `--name`
-- [Argument vs. Object style](docs/arguments-vs-object-style.md) `--useOptions`
-- [Enums vs. Union types](docs/enum-vs-union-types.md) `--useUnionTypes`
-- [Runtime schemas](docs/runtime-schemas.md) `--exportSchemas`
-- [Enum with custom names and descriptions](docs/custom-enums.md)
-- [Nullable props (OpenAPI v2)](docs/nullable-props.md)
-- [Authorization](docs/authorization.md)
-- [External references](docs/external-references.md)
-- [Canceling requests](docs/canceling-requests.md)
-- [Custom request file](docs/custom-request-file.md)
-
-Support
-===
-- [Babel support](docs/babel-support.md)
-- [Axios support](docs/axios-support.md)
-- [Angular support](docs/angular-support.md)
-- [Node-Fetch support](docs/node-fetch-support.md)
-
-[npm-url]: https://npmjs.org/package/openapi-typescript-codegen
-[npm-image]: https://img.shields.io/npm/v/openapi-typescript-codegen.svg
-[license-url]: LICENSE
-[license-image]: http://img.shields.io/npm/l/openapi-typescript-codegen.svg
-[coverage-url]: https://codecov.io/gh/ferdikoomen/openapi-typescript-codegen
-[coverage-image]: https://img.shields.io/codecov/c/github/ferdikoomen/openapi-typescript-codegen.svg
-[quality-url]: https://lgtm.com/projects/g/ferdikoomen/openapi-typescript-codegen
-[quality-image]: https://img.shields.io/lgtm/grade/javascript/g/ferdikoomen/openapi-typescript-codegen.svg
-[climate-url]: https://codeclimate.com/github/ferdikoomen/openapi-typescript-codegen
-[climate-image]: https://img.shields.io/codeclimate/maintainability/ferdikoomen/openapi-typescript-codegen.svg
-[downloads-url]: http://npm-stat.com/charts.html?package=openapi-typescript-codegen
-[downloads-image]: http://img.shields.io/npm/dm/openapi-typescript-codegen.svg
-[build-url]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master
-[build-image]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master.svg?style=svg
+For example (Custom_Prefix_Name -> Name)
diff --git a/bin/saddleback.cli.js b/bin/saddleback.cli.js
@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const path = require('path');
+const { program } = require('commander');
+const pkg = require('../package.json');
+
+const params = program
+    .name('saddlebackOpenApi')
+    .usage('[options]')
+    .version(pkg.version)
+    .option('-i, --input <value>', 'OpenAPI specification, can be a path, url or string content (required)')
+    .option('-o, --output <value>', 'Output directory (required)')
+    .option('-c, --config <value>', 'Path to the config file')
+    .option('-l, --login <value>', 'Login')
+    .option('-p, --password <value>', 'Password')
+    .option('-e, --environment <value>', 'Environment dev | stage | stage2')
+    .option(
+        '-s, --service <value>',
+        'Service Workflows | Events | Notifications | Core | Journey | Giving | SmallGroup'
+    )
+    .option('-m, --filterMethod <value>', 'Filter method include(default) | exclude')
+    .option('-f, --filterArray <value>', 'Filter array')
+    .parse(process.argv)
+    .opts();
+
+const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
+const config = require(path.resolve(params.config || `openapi.config.json`));
+
+if (OpenAPI) {
+    OpenAPI.generateSaddlebackSpec({
+        httpClient: 'saddleback',
+        clientName: '',
+        useOptions: true,
+        useUnionTypes: false,
+        exportCore: false,
+        exportServices: true,
+        exportModels: true,
+        exportSchemas: false,
+        indent: '4',
+        postfix: '',
+        request: '',
+        write: true,
+        additionalModelFileExtension: true,
+        additionalServiceFileExtension: true,
+        removeLodashPrefixes: true,
+        ...config,
+        input: params.input || config.input,
+        output: params.output || config.output,
+        username: params.login || config.login,
+        password: params.password || config.password,
+        useEnvironment: params.environment || config.environment,
+        useService: params.service || config.service,
+        filterMethod: params.filterMethod || config.filterMethod || 'include',
+        filterArray: params.filterArray || config.filterArray || [],
+    })
+        .then(() => {
+            process.exit(0);
+        })
+        .catch(error => {
+            console.error(error);
+            process.exit(1);
+        });
+}
diff --git a/docs/basic-usage.md b/docs/basic-usage.md
@@ -1,4 +1,4 @@
-# Basic usage
+ # Basic usage
 
 ```
 $ openapi --help

diff --git a/docs/original-readme.md b/docs/original-readme.md
@@ -0,0 +1,95 @@
+# OpenAPI Typescript Codegen
+
+[![NPM][npm-image]][npm-url]
+[![License][license-image]][license-url]
+[![Coverage][coverage-image]][coverage-url]
+[![Quality][quality-image]][quality-url]
+[![Code Climate][climate-image]][climate-url]
+[![Downloads][downloads-image]][downloads-url]
+[![Build][build-image]][build-url]
+
+> Node.js library that generates Typescript clients based on the OpenAPI specification.
+
+## Why?
+- Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds
+- Quick, lightweight, robust and framework-agnostic 🚀
+- Supports generation of TypeScript clients
+- Supports generations of Fetch, [Node-Fetch](#node-fetch-support), [Axios](#axios-support), [Angular](#angular-support) and XHR http clients
+- Supports OpenAPI specification v2.0 and v3.0
+- Supports JSON and YAML files for input
+- Supports generation through CLI, Node.js and NPX
+- Supports tsc and @babel/plugin-transform-typescript
+- Supports aborting of requests (cancelable promise pattern)
+- Supports external references using [json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser/)
+
+## Install
+
+```
+npm install openapi-typescript-codegen --save-dev
+```
+
+## Usage
+
+```
+$ openapi --help
+
+  Usage: openapi [options]
+
+  Options:
+    -V, --version             output the version number
+    -i, --input <value>       OpenAPI specification, can be a path, url or string content (required)
+    -o, --output <value>      Output directory (required)
+    -c, --client <value>      HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
+    --name <value>            Custom client class name
+    --useOptions              Use options instead of arguments
+    --useUnionTypes           Use union types instead of enums
+    --exportCore <value>      Write core files to disk (default: true)
+    --exportServices <value>  Write services to disk (default: true)
+    --exportModels <value>    Write models to disk (default: true)
+    --exportSchemas <value>   Write schemas to disk (default: false)
+    --indent <value>          Indentation options [4, 2, tab] (default: "4")
+    --postfix <value>         Service name postfix (default: "Service")
+    --request <value>         Path to custom request file
+    -h, --help                display help for command
+
+  Examples
+    $ openapi --input ./spec.json --output ./generated
+    $ openapi --input ./spec.json --output ./generated --client xhr
+```
+
+Documentation
+===
+- [Basic usage](basic-usage.md)
+- [OpenAPI object](openapi-object.md)
+- [Client instances](client-instances.md) `--name`
+- [Argument vs. Object style](arguments-vs-object-style.md) `--useOptions`
+- [Enums vs. Union types](enum-vs-union-types.md) `--useUnionTypes`
+- [Runtime schemas](runtime-schemas.md) `--exportSchemas`
+- [Enum with custom names and descriptions](custom-enums.md)
+- [Nullable props (OpenAPI v2)](nullable-props.md)
+- [Authorization](authorization.md)
+- [External references](external-references.md)
+- [Canceling requests](canceling-requests.md)
+- [Custom request file](custom-request-file.md)
+
+Support
+===
+- [Babel support](babel-support.md)
+- [Axios support](axios-support.md)
+- [Angular support](angular-support.md)
+- [Node-Fetch support](node-fetch-support.md)
+
+[npm-url]: https://npmjs.org/package/openapi-typescript-codegen
+[npm-image]: https://img.shields.io/npm/v/openapi-typescript-codegen.svg
+[license-url]: ../LICENSE
+[license-image]: http://img.shields.io/npm/l/openapi-typescript-codegen.svg
+[coverage-url]: https://codecov.io/gh/ferdikoomen/openapi-typescript-codegen
+[coverage-image]: https://img.shields.io/codecov/c/github/ferdikoomen/openapi-typescript-codegen.svg
+[quality-url]: https://lgtm.com/projects/g/ferdikoomen/openapi-typescript-codegen
+[quality-image]: https://img.shields.io/lgtm/grade/javascript/g/ferdikoomen/openapi-typescript-codegen.svg
+[climate-url]: https://codeclimate.com/github/ferdikoomen/openapi-typescript-codegen
+[climate-image]: https://img.shields.io/codeclimate/maintainability/ferdikoomen/openapi-typescript-codegen.svg
+[downloads-url]: http://npm-stat.com/charts.html?package=openapi-typescript-codegen
+[downloads-image]: http://img.shields.io/npm/dm/openapi-typescript-codegen.svg
+[build-url]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master
+[build-image]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master.svg?style=svg