@kattebak/openapi-generator-ts 1.0.0

package/templates/typescript-fetch/README.mustache

@@ -0,0 +1,127 @@
+# {{npmName}}@{{npmVersion}}
+
+A TypeScript SDK client for the {{host}} API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install {{npmName}} --save
+```
+
+Next, try it out.
+
+{{#apiInfo}}{{#apis}}{{#if @first}}{{#operations}}{{#operation}}{{#if @first}}
+```ts
+{{>api_example}}
+```
+{{/if}}{{/operation}}{{/operations}}{{/if}}{{/apis}}{{/apiInfo}}
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *{{basePath}}*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}/{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{summary}}
+{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
+
+### Models
+
+{{#models}}{{#model}}- [{{{classname}}}]({{modelDocPath}}/{{{classname}}}.md){{/model}}
+{{/models}}
+
+### Authorization
+
+{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
+{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
+{{#authMethods}}
+<a id="{{name}}{{#isOAuth}}-{{flow}}{{/isOAuth}}"></a>
+#### {{name}}{{#isOAuth}} {{flow}}{{/isOAuth}}
+
+{{#isApiKey}}
+
+- **Type**: API key
+- **API key parameter name**: `{{keyParamName}}`
+- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
+{{/isApiKey}}
+{{#isBasicBasic}}
+
+- **Type**: HTTP basic authentication
+{{/isBasicBasic}}
+{{#isBasicBearer}}
+
+- **Type**: HTTP Bearer Token authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
+{{/isBasicBearer}}
+{{#isHttpSignature}}
+
+- **Type**: HTTP signature authentication
+{{/isHttpSignature}}
+{{#isOAuth}}
+
+- **Type**: OAuth
+- **Flow**: {{flow}}
+- **Authorization URL**: {{authorizationUrl}}
+- **Scopes**: {{^scopes}}N/A{{/scopes}}
+{{#scopes}}  - `{{scope}}`: {{description}}
+{{/scopes}}
+{{/isOAuth}}
+{{/authMethods}}
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `{{appVersion}}`
+- Package version: `{{npmVersion}}`
+{{^hideGenerationTimestamp}}
+- Build date: `{{generatedDate}}`
+{{/hideGenerationTimestamp}}
+- Generator version: `{{generatorVersion}}`
+- Build package: `{{generatorClass}}`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+{{#if infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/if}}
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[{{licenseInfo}}]({{{licenseUrl}}})

package/templates/typescript-fetch/allSagas.mustache

@@ -0,0 +1,19 @@
+import {all, fork} from "redux-saga/effects";
+
+import {
+{{#apiInfo}}
+{{#apis}}
+    {{#camelcase}}{{classFilename}}{{/camelcase}}AllSagas,
+{{/apis}}
+{{/apiInfo}}
+} from "./index{{importFileExtension}}";
+
+export function *allApiSagas() {
+    yield all([
+{{#apiInfo}}
+{{#apis}}
+        fork({{#camelcase}}{{classFilename}}{{/camelcase}}AllSagas),
+{{/apis}}
+{{/apiInfo}}
+    ]);
+}

package/templates/typescript-fetch/api_doc.mustache

@@ -0,0 +1,63 @@
+# {{classname}}{{#if description}}
+
+{{description}}{{/if}}
+
+All URIs are relative to *{{basePath}}*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+{{#operations}}{{#operation}}| [**{{operationId}}**]({{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{commonPath}}{{path}} | {{summary}} |
+{{/operation}}{{/operations}}
+
+{{#operations}}
+{{#operation}}
+
+## {{operationId}}
+
+> {{#if returnType}}{{returnType}} {{/if}}{{operationId}}({{#allParams}}{{{paramName}}}{{#unless @last}}, {{/unless}}{{/allParams}})
+
+{{summary}}{{#if notes}}
+
+{{notes}}{{/if}}
+
+### Example
+
+```ts
+{{>api_example}}
+```
+
+### Parameters
+
+{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#if @last}}
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|{{/if}}{{/allParams}}
+{{#allParams}}| **{{paramName}}** | {{#isEnum}}{{#allowableValues}}{{#values}}`{{{.}}}`{{#unless @last}}, {{/unless}}{{/values}}{{/allowableValues}}{{/isEnum}}{{^isEnum}}{{#isModel}}[{{baseType}}]({{baseType}}.md){{/isModel}}{{^isModel}}`{{{dataType}}}`{{/isModel}}{{/isEnum}} | {{description}} |{{^required}} [Optional]{{/required}}{{^isContainer}}{{#if defaultValue}} [Defaults to `{{defaultValue}}`]{{/if}}{{/isContainer}}{{#allowableValues}} [Enum: {{#values}}{{{.}}}{{#unless @last}}, {{/unless}}{{/values}}]{{/allowableValues}} |
+{{/allParams}}
+
+### Return type
+
+{{#if returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/if}}{{#unless returnType}}`void` (Empty response body){{/unless}}
+
+### Authorization
+
+{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}{{#isOAuth}} {{flow}}{{/isOAuth}}](../README.md#{{{name}}}{{#isOAuth}}-{{flow}}{{/isOAuth}}){{#unless @last}}, {{/unless}}{{/authMethods}}
+
+### HTTP request headers
+
+- **Content-Type**: {{#consumes}}`{{{mediaType}}}`{{#unless @last}}, {{/unless}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
+- **Accept**: {{#produces}}`{{{mediaType}}}`{{#unless @last}}, {{/unless}}{{/produces}}{{^produces}}Not defined{{/produces}}
+
+{{#if responses}}
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+{{#responses}}
+| **{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{#unless headers}} - {{/if}} |
+{{/responses}}
+{{/if}}
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+{{/operation}}
+{{/operations}}

package/templates/typescript-fetch/api_example.mustache

@@ -0,0 +1,44 @@
+import {
+  Configuration,
+  {{classname}},
+} from '{{npmName}}';
+import type { {{operationIdCamelCase}}Request } from '{{npmName}}';
+
+async function example() {
+  console.log("🚀 Testing {{npmName}} SDK...");
+  {{#hasAuthMethods}}
+  const config = new Configuration({ {{#authMethods}}{{#isBasicBasic}}
+    // To configure HTTP basic authorization: {{{name}}}
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",{{/isBasicBasic}}{{#isBasicBearer}}
+    // Configure HTTP bearer authorization: {{{name}}}
+    accessToken: "YOUR BEARER TOKEN",{{/isBasicBearer}}{{#isOAuth}}
+    // To configure OAuth2 access token for authorization: {{{name}}} {{{flow}}}
+    accessToken: "YOUR ACCESS TOKEN",{{/isOAuth}}{{#isApiKey}}
+    // To configure API key authorization: {{{name}}}
+    apiKey: "YOUR API KEY",{{/isApiKey}}{{#isHttpSignature}}
+    // To configure HTTP signature authorization: {{{name}}}
+    headers: { "YOUR HEADER NAME": "YOUR SIGNATURE" },{{/isHttpSignature}}{{/authMethods}}
+  });
+  {{/hasAuthMethods}}
+  const api = new {{classname}}({{#hasAuthMethods}}config{{/hasAuthMethods}});
+
+  {{#hasParams}}
+  const body = {
+    {{#allParams}}
+    // {{{dataType}}}{{#if description}} | {{{description}}}{{/if}}{{^required}} (optional){{/required}}
+    {{paramName}}: {{{example}}}{{#unless example}}...{{/unless}},
+    {{/allParams}}
+  } satisfies {{operationIdCamelCase}}Request;
+
+  {{/hasParams}}
+  try {
+    const data = await api.{{{operationId}}}({{#hasParams}}body{{/hasParams}});
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);

package/templates/typescript-fetch/apis.index.mustache

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