@odata2ts/odata2ts 0.23.1 → 0.25.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.25.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/odata2ts@0.24.0...@odata2ts/odata2ts@0.25.0) (2023-07-10)
+
+### Bug Fixes
+
+* **odata2ts:** use qualified name for bound operations ([#182](https://github.com/odata2ts/odata2ts/issues/182)) ([120c9b8](https://github.com/odata2ts/odata2ts/commit/120c9b807ac209a8eb82b389bc7c21d7df7fe876))
+
+### Features
+
+* **odata2ts:** support for multiple namespaces by merging ([#175](https://github.com/odata2ts/odata2ts/issues/175)) ([db8fd61](https://github.com/odata2ts/odata2ts/commit/db8fd6165c57ceb9e04488789a62f2a5467ecc68))
+* **odata2ts:** support schema alias ([#181](https://github.com/odata2ts/odata2ts/issues/181)) ([e0c04a8](https://github.com/odata2ts/odata2ts/commit/e0c04a83e32d99187652966bb9cc32f36ead3df2))
+* **odata2ts:** support TypeDefinition elements ([#183](https://github.com/odata2ts/odata2ts/issues/183)) ([d77d2cb](https://github.com/odata2ts/odata2ts/commit/d77d2cbf17383dab50d35bb7374e08a83d264db2))
+
+# [0.24.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/odata2ts@0.23.1...@odata2ts/odata2ts@0.24.0) (2023-06-14)
+
+### Features
+
+* **odata2ts:** generate comments for model properties ([#173](https://github.com/odata2ts/odata2ts/issues/173)) ([b218297](https://github.com/odata2ts/odata2ts/commit/b2182974637499060d7d0c8d358da17ca03608e0))
+
 ## [0.23.1](https://github.com/odata2ts/odata2ts/compare/@odata2ts/odata2ts@0.23.0...@odata2ts/odata2ts@0.23.1) (2023-06-10)
 
 **Note:** Version bump only for package @odata2ts/odata2ts
@@ -22,7 +40,9 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 ### BREAKING CHANGES
 
 * **odata2ts:** Changed defaults for properties representing related services: no prefix anymore, just the name of the property as function (previously, prefix `navTo`).
+
 Removed `get` method of EntitySetServices: use property directly instead.
+
 Removed the following naming options regarding generated services: `serviceResolverFunction`, `publicProps`
 
 # [0.21.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/odata2ts@0.20.3...@odata2ts/odata2ts@0.21.0) (2023-04-20)
@@ -36,7 +56,9 @@ Removed the following naming options regarding generated services: `serviceResol
 ### Bug Fixes
 
 * **odata2ts:** add empty array as type for empty params ([#154](https://github.com/odata2ts/odata2ts/issues/154)) ([fbdd000](https://github.com/odata2ts/odata2ts/commit/fbdd0005d46d7d402d8039bec3ea4aecdb593b88))
+
 * prevent idModel and qIdFunction from baseclass to be overwritten in digester which breaks multiple inheritance ([#150](https://github.com/odata2ts/odata2ts/issues/150)) ([e17038e](https://github.com/odata2ts/odata2ts/commit/e17038ee0e924101f9dd6ed97e10da5847cb8857))
+
 * Reorder models and qobjects by inheritance (base types first) ([#151](https://github.com/odata2ts/odata2ts/issues/151)) ([7d456fe](https://github.com/odata2ts/odata2ts/commit/7d456fe3fd28b246721a170cd878d04c3dbc2d80))
 
 ## [0.20.2](https://github.com/odata2ts/odata2ts/compare/@odata2ts/odata2ts@0.20.1...@odata2ts/odata2ts@0.20.2) (2023-04-13)

package/lib/FactoryFunctionModel.d.ts

@@ -1,13 +1,13 @@
-import { ODataVersions } from "@odata2ts/odata-core";
-import { SourceFile } from "ts-morph";
-import { DataModel } from "./data-model/DataModel";
-import { Schema } from "./data-model/edmx/ODataEdmxModelBase";
-import { NamingHelper } from "./data-model/NamingHelper";
-import { RunOptions } from "./OptionModel";
-export type DigestionOptions = Pick<RunOptions, "converters" | "disableAutoManagedKey" | "propertiesByName" | "entitiesByName" | "v2ModelsWithExtraResultsWrapping" | "skipEditableModels">;
-/**
- * Takes an EdmxSchema plus the run options and creates a DataModel.
- */
-export type DigesterFunction<S extends Schema<any, any>> = (schema: S, options: DigestionOptions, namingHelper: NamingHelper) => Promise<DataModel>;
-export type GeneratorFunctionOptions = Pick<RunOptions, "skipEditableModels" | "skipIdModels" | "skipOperations" | "v2ModelsWithExtraResultsWrapping">;
-export type EntityBasedGeneratorFunction = (dataModel: DataModel, sourceFile: SourceFile, version: ODataVersions, options: GeneratorFunctionOptions, namingHelper: NamingHelper) => void;
+import { ODataVersions } from "@odata2ts/odata-core";
+import { SourceFile } from "ts-morph";
+import { DataModel } from "./data-model/DataModel";
+import { Schema } from "./data-model/edmx/ODataEdmxModelBase";
+import { NamingHelper } from "./data-model/NamingHelper";
+import { RunOptions } from "./OptionModel";
+export type DigestionOptions = Pick<RunOptions, "converters" | "disableAutoManagedKey" | "propertiesByName" | "entitiesByName" | "v2ModelsWithExtraResultsWrapping" | "skipEditableModels" | "skipComments">;
+/**
+ * Takes an EdmxSchema plus the run options and creates a DataModel.
+ */
+export type DigesterFunction<S extends Schema<any, any>> = (schema: Array<S>, options: DigestionOptions, namingHelper: NamingHelper) => Promise<DataModel>;
+export type GeneratorFunctionOptions = Pick<RunOptions, "skipEditableModels" | "skipIdModels" | "skipOperations" | "skipComments" | "v2ModelsWithExtraResultsWrapping">;
+export type EntityBasedGeneratorFunction = (dataModel: DataModel, sourceFile: SourceFile, version: ODataVersions, options: GeneratorFunctionOptions, namingHelper: NamingHelper) => void;

package/lib/FactoryFunctionModel.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=FactoryFunctionModel.js.map

package/lib/FactoryFunctionModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"FactoryFunctionModel.js","sourceRoot":"","sources":["../src/FactoryFunctionModel.ts"],"names":[],"mappings":"","sourcesContent":["import { ODataVersions } from \"@odata2ts/odata-core\";\r\nimport { SourceFile } from \"ts-morph\";\r\n\r\nimport { DataModel } from \"./data-model/DataModel\";\r\nimport { Schema } from \"./data-model/edmx/ODataEdmxModelBase\";\r\nimport { NamingHelper } from \"./data-model/NamingHelper\";\r\nimport { RunOptions } from \"./OptionModel\";\r\n\r\nexport type DigestionOptions = Pick<\r\n  RunOptions,\r\n  | \"converters\"\r\n  | \"disableAutoManagedKey\"\r\n  | \"propertiesByName\"\r\n  | \"entitiesByName\"\r\n  | \"v2ModelsWithExtraResultsWrapping\"\r\n  | \"skipEditableModels\"\r\n>;\r\n\r\n/**\r\n * Takes an EdmxSchema plus the run options and creates a DataModel.\r\n */\r\nexport type DigesterFunction<S extends Schema<any, any>> = (\r\n  schema: S,\r\n  options: DigestionOptions,\r\n  namingHelper: NamingHelper\r\n) => Promise<DataModel>;\r\n\r\nexport type GeneratorFunctionOptions = Pick<\r\n  RunOptions,\r\n  \"skipEditableModels\" | \"skipIdModels\" | \"skipOperations\" | \"v2ModelsWithExtraResultsWrapping\"\r\n>;\r\n\r\nexport type EntityBasedGeneratorFunction = (\r\n  dataModel: DataModel,\r\n  sourceFile: SourceFile,\r\n  version: ODataVersions,\r\n  options: GeneratorFunctionOptions,\r\n  namingHelper: NamingHelper\r\n) => void;\r\n"]}
+{"version":3,"file":"FactoryFunctionModel.js","sourceRoot":"","sources":["../src/FactoryFunctionModel.ts"],"names":[],"mappings":"","sourcesContent":["import { ODataVersions } from \"@odata2ts/odata-core\";\r\nimport { SourceFile } from \"ts-morph\";\r\n\r\nimport { DataModel } from \"./data-model/DataModel\";\r\nimport { Schema } from \"./data-model/edmx/ODataEdmxModelBase\";\r\nimport { NamingHelper } from \"./data-model/NamingHelper\";\r\nimport { RunOptions } from \"./OptionModel\";\r\n\r\nexport type DigestionOptions = Pick<\r\n  RunOptions,\r\n  | \"converters\"\r\n  | \"disableAutoManagedKey\"\r\n  | \"propertiesByName\"\r\n  | \"entitiesByName\"\r\n  | \"v2ModelsWithExtraResultsWrapping\"\r\n  | \"skipEditableModels\"\r\n  | \"skipComments\"\r\n>;\r\n\r\n/**\r\n * Takes an EdmxSchema plus the run options and creates a DataModel.\r\n */\r\nexport type DigesterFunction<S extends Schema<any, any>> = (\r\n  schema: Array<S>,\r\n  options: DigestionOptions,\r\n  namingHelper: NamingHelper\r\n) => Promise<DataModel>;\r\n\r\nexport type GeneratorFunctionOptions = Pick<\r\n  RunOptions,\r\n  \"skipEditableModels\" | \"skipIdModels\" | \"skipOperations\" | \"skipComments\" | \"v2ModelsWithExtraResultsWrapping\"\r\n>;\r\n\r\nexport type EntityBasedGeneratorFunction = (\r\n  dataModel: DataModel,\r\n  sourceFile: SourceFile,\r\n  version: ODataVersions,\r\n  options: GeneratorFunctionOptions,\r\n  namingHelper: NamingHelper\r\n) => void;\r\n"]}

package/lib/NamingModel.d.ts

@@ -1,182 +1,182 @@
-/**
- * The available naming strategies.
- */
-import { PartialDeep } from "type-fest";
-export declare enum NamingStrategies {
-    NONE = "",
-    PASCAL_CASE = "pascalCase",
-    CAMEL_CASE = "camelCase",
-    CONSTANT_CASE = "constantCase",
-    SNAKE_CASE = "snakeCase"
-}
-/**
- * Based on an existing configuration (for example default settings) the user only specifies what needs
- * to be changed. Hence, all options are completely optional.
- */
-export interface OverridableNamingOptions extends PartialDeep<NameSettings> {
-}
-/**
- * The required and optional name settings for the generator.
- */
-export interface NameSettings {
-    /**
-     * Because multiple artefacts are generated out of the same entity, some name settings are required in order
-     * to differentiate those artefacts. Out-of-the-box odata2ts provides you with sensible default settings,
-     * so that you only need to override those settings you want to change.
-     *
-     * However, sometimes it makes more sense to start from scratch, so that the defaults don't interfere with
-     * your own configuration. In this scenario this switch should be enabled to only have default values for
-     * the required name settings.
-     */
-    minimalDefaults?: boolean;
-    /**
-     * Generation options for models, i.e. interfaces representing entity or complex types.
-     */
-    models: ModelNamingOptions;
-    /**
-     * Generation options for Query Objects.
-     *
-     * By default, prefix = "Q"
-     */
-    queryObjects: QueryObjectNamingOptions;
-    services: ServiceNamingOptions;
-}
-export interface ModelNamingOptions extends NamingStrategyOption, StandardNamingOptions {
-    /**
-     * All generated models are bundled into one file.
-     * This option specifies the formatting of the file name.
-     */
-    fileName: FileNamingStrategyOption & RequiredNamingOptions;
-    /**
-     * Choose a specific strategy to format property names of models: pascal-case, camel-case, etc.
-     * By default, camel-case.
-     */
-    propNamingStrategy?: NamingStrategies;
-    /**
-     * For each model an editable version is generated which represents the model definition for
-     * create, update and patch actions.
-     *
-     * You can override the naming options here.
-     * By default, prefix = "Editable"
-     */
-    editableModels: EntityDerivedNamingOptions;
-    /**
-     * ID models are generated from entity id parameters.
-     *
-     * You can configure the naming options here.
-     * By default, suffix = "Id"
-     */
-    idModels: EntityDerivedNamingOptions;
-    /**
-     * Operation parameter models are generated from function or action signatures.
-     *
-     * You can configure the naming options here.
-     * By default, suffix = "Params"
-     */
-    operationParamModels: EntityDerivedNamingOptions;
-}
-export interface EntityDerivedNamingOptions extends RequiredNamingOptions {
-    applyModelNaming?: boolean;
-}
-export interface QueryObjectNamingOptions extends NamingStrategyOption, RequiredNamingOptions {
-    /**
-     * All generated models are bundled into one file.
-     * This option specifies the formatting of the file name.
-     */
-    fileName: FileNamingStrategyOption & RequiredNamingOptions;
-    /**
-     * Choose a specific strategy to format property names of query objects: pascal-case, camel-case, etc.
-     * By default, camel-case.
-     */
-    propNamingStrategy?: NamingStrategies;
-    idFunctions: RequiredNamingOptions;
-    operations?: OperationNamingOptions;
-}
-export interface OperationNamingOptions extends StandardNamingOptions {
-    /**
-     * Naming options for actions only.
-     * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.
-     */
-    action?: StandardNamingOptions;
-    /**
-     * Naming options for functions only.
-     * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.
-     */
-    function?: StandardNamingOptions;
-}
-export interface NamingStrategyOption {
-    /**
-     * Choose a specific strategy to format names: pascal-case, camel-case, etc.
-     * Defaults to pascal-case.
-     */
-    namingStrategy?: NamingStrategies;
-}
-export interface FileNamingStrategyOption {
-    /**
-     * Choose a specific strategy to format names: pascal-case, camel-case, etc.
-     * Defaults to pascal-case.
-     */
-    namingStrategy?: NamingStrategies;
-}
-export interface StandardNamingOptions {
-    /**
-     * Prefix all names, e.g. "I" => "ITest"
-     */
-    prefix?: string;
-    /**
-     * Suffix all names, e.g. "model" => "TestModel"
-     */
-    suffix?: string;
-}
-export interface RequiredNamingOptions extends Required<StandardNamingOptions> {
-}
-/**
- * Naming options for generated service classes.
- * These options affect the main service as well as all services generated for each entity, complex and collection type.
- *
- * There exists one specialty about services: The file names are not configurable.
- * File names are determined by the name of their corresponding classes, so that service file name
- * and service class name always correspond.
- *
- * By default, suffix = Service and namingStrategy = PascalCase
- */
-export interface ServiceNamingOptions extends NamingStrategyOption, RequiredNamingOptions {
-    /**
-     * Controls the naming options for the main odata service.
-     * By default, the base service naming options are applied.
-     * But since this is the main entry point for users, it can be configured individually here.
-     *
-     * By default, applyServiceNaming = true
-     */
-    main?: NamingStrategyOption & StandardNamingOptions & {
-        applyServiceNaming?: boolean;
-    };
-    /**
-     * Name of the service responsible for entity collections.
-     *
-     * By default, suffix = Collection and applyServiceNaming = true
-     */
-    collection: RequiredNamingOptions & {
-        applyServiceNaming?: boolean;
-    };
-    /**
-     * Naming for getter method of another service.
-     *
-     * By default, namingStrategy = camelCase
-     */
-    relatedServiceGetter: NamingStrategyOption & RequiredNamingOptions;
-    /**
-     * Operations are functions and actions of the OData service and are represented as methods
-     * of the generated service class. This setting controls the naming of the corresponding
-     * function.
-     *
-     * By default, namingStrategy = camelCase
-     */
-    operations?: NamingStrategyOption & OperationNamingOptions;
-    /**
-     * Naming options for private properties of service classes.
-     *
-     * By default, prefix = _
-     */
-    privateProps: NamingStrategyOption & RequiredNamingOptions;
-}
+/**
+ * The available naming strategies.
+ */
+import { PartialDeep } from "type-fest";
+export declare enum NamingStrategies {
+    NONE = "",
+    PASCAL_CASE = "pascalCase",
+    CAMEL_CASE = "camelCase",
+    CONSTANT_CASE = "constantCase",
+    SNAKE_CASE = "snakeCase"
+}
+/**
+ * Based on an existing configuration (for example default settings) the user only specifies what needs
+ * to be changed. Hence, all options are completely optional.
+ */
+export interface OverridableNamingOptions extends PartialDeep<NameSettings> {
+}
+/**
+ * The required and optional name settings for the generator.
+ */
+export interface NameSettings {
+    /**
+     * Because multiple artefacts are generated out of the same entity, some name settings are required in order
+     * to differentiate those artefacts. Out-of-the-box odata2ts provides you with sensible default settings,
+     * so that you only need to override those settings you want to change.
+     *
+     * However, sometimes it makes more sense to start from scratch, so that the defaults don't interfere with
+     * your own configuration. In this scenario this switch should be enabled to only have default values for
+     * the required name settings.
+     */
+    minimalDefaults?: boolean;
+    /**
+     * Generation options for models, i.e. interfaces representing entity or complex types.
+     */
+    models: ModelNamingOptions;
+    /**
+     * Generation options for Query Objects.
+     *
+     * By default, prefix = "Q"
+     */
+    queryObjects: QueryObjectNamingOptions;
+    services: ServiceNamingOptions;
+}
+export interface ModelNamingOptions extends NamingStrategyOption, StandardNamingOptions {
+    /**
+     * All generated models are bundled into one file.
+     * This option specifies the formatting of the file name.
+     */
+    fileName: FileNamingStrategyOption & RequiredNamingOptions;
+    /**
+     * Choose a specific strategy to format property names of models: pascal-case, camel-case, etc.
+     * By default, camel-case.
+     */
+    propNamingStrategy?: NamingStrategies;
+    /**
+     * For each model an editable version is generated which represents the model definition for
+     * create, update and patch actions.
+     *
+     * You can override the naming options here.
+     * By default, prefix = "Editable"
+     */
+    editableModels: EntityDerivedNamingOptions;
+    /**
+     * ID models are generated from entity id parameters.
+     *
+     * You can configure the naming options here.
+     * By default, suffix = "Id"
+     */
+    idModels: EntityDerivedNamingOptions;
+    /**
+     * Operation parameter models are generated from function or action signatures.
+     *
+     * You can configure the naming options here.
+     * By default, suffix = "Params"
+     */
+    operationParamModels: EntityDerivedNamingOptions;
+}
+export interface EntityDerivedNamingOptions extends RequiredNamingOptions {
+    applyModelNaming?: boolean;
+}
+export interface QueryObjectNamingOptions extends NamingStrategyOption, RequiredNamingOptions {
+    /**
+     * All generated models are bundled into one file.
+     * This option specifies the formatting of the file name.
+     */
+    fileName: FileNamingStrategyOption & RequiredNamingOptions;
+    /**
+     * Choose a specific strategy to format property names of query objects: pascal-case, camel-case, etc.
+     * By default, camel-case.
+     */
+    propNamingStrategy?: NamingStrategies;
+    idFunctions: RequiredNamingOptions;
+    operations?: OperationNamingOptions;
+}
+export interface OperationNamingOptions extends StandardNamingOptions {
+    /**
+     * Naming options for actions only.
+     * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.
+     */
+    action?: StandardNamingOptions;
+    /**
+     * Naming options for functions only.
+     * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.
+     */
+    function?: StandardNamingOptions;
+}
+export interface NamingStrategyOption {
+    /**
+     * Choose a specific strategy to format names: pascal-case, camel-case, etc.
+     * Defaults to pascal-case.
+     */
+    namingStrategy?: NamingStrategies;
+}
+export interface FileNamingStrategyOption {
+    /**
+     * Choose a specific strategy to format names: pascal-case, camel-case, etc.
+     * Defaults to pascal-case.
+     */
+    namingStrategy?: NamingStrategies;
+}
+export interface StandardNamingOptions {
+    /**
+     * Prefix all names, e.g. "I" => "ITest"
+     */
+    prefix?: string;
+    /**
+     * Suffix all names, e.g. "model" => "TestModel"
+     */
+    suffix?: string;
+}
+export interface RequiredNamingOptions extends Required<StandardNamingOptions> {
+}
+/**
+ * Naming options for generated service classes.
+ * These options affect the main service as well as all services generated for each entity, complex and collection type.
+ *
+ * There exists one specialty about services: The file names are not configurable.
+ * File names are determined by the name of their corresponding classes, so that service file name
+ * and service class name always correspond.
+ *
+ * By default, suffix = Service and namingStrategy = PascalCase
+ */
+export interface ServiceNamingOptions extends NamingStrategyOption, RequiredNamingOptions {
+    /**
+     * Controls the naming options for the main odata service.
+     * By default, the base service naming options are applied.
+     * But since this is the main entry point for users, it can be configured individually here.
+     *
+     * By default, applyServiceNaming = true
+     */
+    main?: NamingStrategyOption & StandardNamingOptions & {
+        applyServiceNaming?: boolean;
+    };
+    /**
+     * Name of the service responsible for entity collections.
+     *
+     * By default, suffix = Collection and applyServiceNaming = true
+     */
+    collection: RequiredNamingOptions & {
+        applyServiceNaming?: boolean;
+    };
+    /**
+     * Naming for getter method of another service.
+     *
+     * By default, namingStrategy = camelCase
+     */
+    relatedServiceGetter: NamingStrategyOption & RequiredNamingOptions;
+    /**
+     * Operations are functions and actions of the OData service and are represented as methods
+     * of the generated service class. This setting controls the naming of the corresponding
+     * function.
+     *
+     * By default, namingStrategy = camelCase
+     */
+    operations?: NamingStrategyOption & OperationNamingOptions;
+    /**
+     * Naming options for private properties of service classes.
+     *
+     * By default, prefix = _
+     */
+    privateProps: NamingStrategyOption & RequiredNamingOptions;
+}

package/lib/NamingModel.js

@@ -1,12 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NamingStrategies = void 0;
-var NamingStrategies;
-(function (NamingStrategies) {
-    NamingStrategies["NONE"] = "";
-    NamingStrategies["PASCAL_CASE"] = "pascalCase";
-    NamingStrategies["CAMEL_CASE"] = "camelCase";
-    NamingStrategies["CONSTANT_CASE"] = "constantCase";
-    NamingStrategies["SNAKE_CASE"] = "snakeCase";
-})(NamingStrategies = exports.NamingStrategies || (exports.NamingStrategies = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NamingStrategies = void 0;
+var NamingStrategies;
+(function (NamingStrategies) {
+    NamingStrategies["NONE"] = "";
+    NamingStrategies["PASCAL_CASE"] = "pascalCase";
+    NamingStrategies["CAMEL_CASE"] = "camelCase";
+    NamingStrategies["CONSTANT_CASE"] = "constantCase";
+    NamingStrategies["SNAKE_CASE"] = "snakeCase";
+})(NamingStrategies || (exports.NamingStrategies = NamingStrategies = {}));
 //# sourceMappingURL=NamingModel.js.map

package/lib/NamingModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"NamingModel.js","sourceRoot":"","sources":["../src/NamingModel.ts"],"names":[],"mappings":";;;AAKA,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,6BAAS,CAAA;IACT,8CAA0B,CAAA;IAC1B,4CAAwB,CAAA;IACxB,kDAA8B,CAAA;IAC9B,4CAAwB,CAAA;AAC1B,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B","sourcesContent":["/**\r\n * The available naming strategies.\r\n */\r\nimport { PartialDeep } from \"type-fest\";\r\n\r\nexport enum NamingStrategies {\r\n  NONE = \"\",\r\n  PASCAL_CASE = \"pascalCase\",\r\n  CAMEL_CASE = \"camelCase\",\r\n  CONSTANT_CASE = \"constantCase\",\r\n  SNAKE_CASE = \"snakeCase\",\r\n}\r\n\r\n/**\r\n * Based on an existing configuration (for example default settings) the user only specifies what needs\r\n * to be changed. Hence, all options are completely optional.\r\n */\r\nexport interface OverridableNamingOptions extends PartialDeep<NameSettings> {}\r\n\r\n/**\r\n * The required and optional name settings for the generator.\r\n */\r\nexport interface NameSettings {\r\n  /**\r\n   * Because multiple artefacts are generated out of the same entity, some name settings are required in order\r\n   * to differentiate those artefacts. Out-of-the-box odata2ts provides you with sensible default settings,\r\n   * so that you only need to override those settings you want to change.\r\n   *\r\n   * However, sometimes it makes more sense to start from scratch, so that the defaults don't interfere with\r\n   * your own configuration. In this scenario this switch should be enabled to only have default values for\r\n   * the required name settings.\r\n   */\r\n  minimalDefaults?: boolean;\r\n\r\n  /**\r\n   * Generation options for models, i.e. interfaces representing entity or complex types.\r\n   */\r\n  models: ModelNamingOptions;\r\n\r\n  /**\r\n   * Generation options for Query Objects.\r\n   *\r\n   * By default, prefix = \"Q\"\r\n   */\r\n  queryObjects: QueryObjectNamingOptions;\r\n\r\n  services: ServiceNamingOptions;\r\n}\r\n\r\nexport interface ModelNamingOptions extends NamingStrategyOption, StandardNamingOptions {\r\n  /**\r\n   * All generated models are bundled into one file.\r\n   * This option specifies the formatting of the file name.\r\n   */\r\n  fileName: FileNamingStrategyOption & RequiredNamingOptions;\r\n\r\n  /**\r\n   * Choose a specific strategy to format property names of models: pascal-case, camel-case, etc.\r\n   * By default, camel-case.\r\n   */\r\n  propNamingStrategy?: NamingStrategies;\r\n\r\n  /**\r\n   * For each model an editable version is generated which represents the model definition for\r\n   * create, update and patch actions.\r\n   *\r\n   * You can override the naming options here.\r\n   * By default, prefix = \"Editable\"\r\n   */\r\n  editableModels: EntityDerivedNamingOptions;\r\n\r\n  /**\r\n   * ID models are generated from entity id parameters.\r\n   *\r\n   * You can configure the naming options here.\r\n   * By default, suffix = \"Id\"\r\n   */\r\n  idModels: EntityDerivedNamingOptions;\r\n\r\n  /**\r\n   * Operation parameter models are generated from function or action signatures.\r\n   *\r\n   * You can configure the naming options here.\r\n   * By default, suffix = \"Params\"\r\n   */\r\n  operationParamModels: EntityDerivedNamingOptions;\r\n}\r\n\r\nexport interface EntityDerivedNamingOptions extends RequiredNamingOptions {\r\n  applyModelNaming?: boolean;\r\n}\r\n\r\nexport interface QueryObjectNamingOptions extends NamingStrategyOption, RequiredNamingOptions {\r\n  /**\r\n   * All generated models are bundled into one file.\r\n   * This option specifies the formatting of the file name.\r\n   */\r\n  fileName: FileNamingStrategyOption & RequiredNamingOptions;\r\n\r\n  /**\r\n   * Choose a specific strategy to format property names of query objects: pascal-case, camel-case, etc.\r\n   * By default, camel-case.\r\n   */\r\n  propNamingStrategy?: NamingStrategies;\r\n\r\n  idFunctions: RequiredNamingOptions;\r\n\r\n  operations?: OperationNamingOptions;\r\n}\r\n\r\nexport interface OperationNamingOptions extends StandardNamingOptions {\r\n  /**\r\n   * Naming options for actions only.\r\n   * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.\r\n   */\r\n  action?: StandardNamingOptions;\r\n  /**\r\n   * Naming options for functions only.\r\n   * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.\r\n   */\r\n  function?: StandardNamingOptions;\r\n}\r\n\r\nexport interface NamingStrategyOption {\r\n  /**\r\n   * Choose a specific strategy to format names: pascal-case, camel-case, etc.\r\n   * Defaults to pascal-case.\r\n   */\r\n  namingStrategy?: NamingStrategies;\r\n}\r\n\r\nexport interface FileNamingStrategyOption {\r\n  /**\r\n   * Choose a specific strategy to format names: pascal-case, camel-case, etc.\r\n   * Defaults to pascal-case.\r\n   */\r\n  namingStrategy?: NamingStrategies;\r\n}\r\n\r\nexport interface StandardNamingOptions {\r\n  /**\r\n   * Prefix all names, e.g. \"I\" => \"ITest\"\r\n   */\r\n  prefix?: string;\r\n  /**\r\n   * Suffix all names, e.g. \"model\" => \"TestModel\"\r\n   */\r\n  suffix?: string;\r\n}\r\n\r\nexport interface RequiredNamingOptions extends Required<StandardNamingOptions> {}\r\n\r\n/**\r\n * Naming options for generated service classes.\r\n * These options affect the main service as well as all services generated for each entity, complex and collection type.\r\n *\r\n * There exists one specialty about services: The file names are not configurable.\r\n * File names are determined by the name of their corresponding classes, so that service file name\r\n * and service class name always correspond.\r\n *\r\n * By default, suffix = Service and namingStrategy = PascalCase\r\n */\r\nexport interface ServiceNamingOptions extends NamingStrategyOption, RequiredNamingOptions {\r\n  /**\r\n   * Controls the naming options for the main odata service.\r\n   * By default, the base service naming options are applied.\r\n   * But since this is the main entry point for users, it can be configured individually here.\r\n   *\r\n   * By default, applyServiceNaming = true\r\n   */\r\n  main?: NamingStrategyOption & StandardNamingOptions & { applyServiceNaming?: boolean };\r\n\r\n  /**\r\n   * Name of the service responsible for entity collections.\r\n   *\r\n   * By default, suffix = Collection and applyServiceNaming = true\r\n   */\r\n  collection: RequiredNamingOptions & { applyServiceNaming?: boolean };\r\n\r\n  /**\r\n   * Naming for getter method of another service.\r\n   *\r\n   * By default, namingStrategy = camelCase\r\n   */\r\n  relatedServiceGetter: NamingStrategyOption & RequiredNamingOptions;\r\n\r\n  /**\r\n   * Operations are functions and actions of the OData service and are represented as methods\r\n   * of the generated service class. This setting controls the naming of the corresponding\r\n   * function.\r\n   *\r\n   * By default, namingStrategy = camelCase\r\n   */\r\n  operations?: NamingStrategyOption & OperationNamingOptions;\r\n\r\n  /**\r\n   * Naming options for private properties of service classes.\r\n   *\r\n   * By default, prefix = _\r\n   */\r\n  privateProps: NamingStrategyOption & RequiredNamingOptions;\r\n}\r\n"]}
+{"version":3,"file":"NamingModel.js","sourceRoot":"","sources":["../src/NamingModel.ts"],"names":[],"mappings":";;;AAKA,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,6BAAS,CAAA;IACT,8CAA0B,CAAA;IAC1B,4CAAwB,CAAA;IACxB,kDAA8B,CAAA;IAC9B,4CAAwB,CAAA;AAC1B,CAAC,EANW,gBAAgB,gCAAhB,gBAAgB,QAM3B","sourcesContent":["/**\r\n * The available naming strategies.\r\n */\r\nimport { PartialDeep } from \"type-fest\";\r\n\r\nexport enum NamingStrategies {\r\n  NONE = \"\",\r\n  PASCAL_CASE = \"pascalCase\",\r\n  CAMEL_CASE = \"camelCase\",\r\n  CONSTANT_CASE = \"constantCase\",\r\n  SNAKE_CASE = \"snakeCase\",\r\n}\r\n\r\n/**\r\n * Based on an existing configuration (for example default settings) the user only specifies what needs\r\n * to be changed. Hence, all options are completely optional.\r\n */\r\nexport interface OverridableNamingOptions extends PartialDeep<NameSettings> {}\r\n\r\n/**\r\n * The required and optional name settings for the generator.\r\n */\r\nexport interface NameSettings {\r\n  /**\r\n   * Because multiple artefacts are generated out of the same entity, some name settings are required in order\r\n   * to differentiate those artefacts. Out-of-the-box odata2ts provides you with sensible default settings,\r\n   * so that you only need to override those settings you want to change.\r\n   *\r\n   * However, sometimes it makes more sense to start from scratch, so that the defaults don't interfere with\r\n   * your own configuration. In this scenario this switch should be enabled to only have default values for\r\n   * the required name settings.\r\n   */\r\n  minimalDefaults?: boolean;\r\n\r\n  /**\r\n   * Generation options for models, i.e. interfaces representing entity or complex types.\r\n   */\r\n  models: ModelNamingOptions;\r\n\r\n  /**\r\n   * Generation options for Query Objects.\r\n   *\r\n   * By default, prefix = \"Q\"\r\n   */\r\n  queryObjects: QueryObjectNamingOptions;\r\n\r\n  services: ServiceNamingOptions;\r\n}\r\n\r\nexport interface ModelNamingOptions extends NamingStrategyOption, StandardNamingOptions {\r\n  /**\r\n   * All generated models are bundled into one file.\r\n   * This option specifies the formatting of the file name.\r\n   */\r\n  fileName: FileNamingStrategyOption & RequiredNamingOptions;\r\n\r\n  /**\r\n   * Choose a specific strategy to format property names of models: pascal-case, camel-case, etc.\r\n   * By default, camel-case.\r\n   */\r\n  propNamingStrategy?: NamingStrategies;\r\n\r\n  /**\r\n   * For each model an editable version is generated which represents the model definition for\r\n   * create, update and patch actions.\r\n   *\r\n   * You can override the naming options here.\r\n   * By default, prefix = \"Editable\"\r\n   */\r\n  editableModels: EntityDerivedNamingOptions;\r\n\r\n  /**\r\n   * ID models are generated from entity id parameters.\r\n   *\r\n   * You can configure the naming options here.\r\n   * By default, suffix = \"Id\"\r\n   */\r\n  idModels: EntityDerivedNamingOptions;\r\n\r\n  /**\r\n   * Operation parameter models are generated from function or action signatures.\r\n   *\r\n   * You can configure the naming options here.\r\n   * By default, suffix = \"Params\"\r\n   */\r\n  operationParamModels: EntityDerivedNamingOptions;\r\n}\r\n\r\nexport interface EntityDerivedNamingOptions extends RequiredNamingOptions {\r\n  applyModelNaming?: boolean;\r\n}\r\n\r\nexport interface QueryObjectNamingOptions extends NamingStrategyOption, RequiredNamingOptions {\r\n  /**\r\n   * All generated models are bundled into one file.\r\n   * This option specifies the formatting of the file name.\r\n   */\r\n  fileName: FileNamingStrategyOption & RequiredNamingOptions;\r\n\r\n  /**\r\n   * Choose a specific strategy to format property names of query objects: pascal-case, camel-case, etc.\r\n   * By default, camel-case.\r\n   */\r\n  propNamingStrategy?: NamingStrategies;\r\n\r\n  idFunctions: RequiredNamingOptions;\r\n\r\n  operations?: OperationNamingOptions;\r\n}\r\n\r\nexport interface OperationNamingOptions extends StandardNamingOptions {\r\n  /**\r\n   * Naming options for actions only.\r\n   * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.\r\n   */\r\n  action?: StandardNamingOptions;\r\n  /**\r\n   * Naming options for functions only.\r\n   * When this configuration is provided, the parent configuration regarding suffix and prefix is ignored.\r\n   */\r\n  function?: StandardNamingOptions;\r\n}\r\n\r\nexport interface NamingStrategyOption {\r\n  /**\r\n   * Choose a specific strategy to format names: pascal-case, camel-case, etc.\r\n   * Defaults to pascal-case.\r\n   */\r\n  namingStrategy?: NamingStrategies;\r\n}\r\n\r\nexport interface FileNamingStrategyOption {\r\n  /**\r\n   * Choose a specific strategy to format names: pascal-case, camel-case, etc.\r\n   * Defaults to pascal-case.\r\n   */\r\n  namingStrategy?: NamingStrategies;\r\n}\r\n\r\nexport interface StandardNamingOptions {\r\n  /**\r\n   * Prefix all names, e.g. \"I\" => \"ITest\"\r\n   */\r\n  prefix?: string;\r\n  /**\r\n   * Suffix all names, e.g. \"model\" => \"TestModel\"\r\n   */\r\n  suffix?: string;\r\n}\r\n\r\nexport interface RequiredNamingOptions extends Required<StandardNamingOptions> {}\r\n\r\n/**\r\n * Naming options for generated service classes.\r\n * These options affect the main service as well as all services generated for each entity, complex and collection type.\r\n *\r\n * There exists one specialty about services: The file names are not configurable.\r\n * File names are determined by the name of their corresponding classes, so that service file name\r\n * and service class name always correspond.\r\n *\r\n * By default, suffix = Service and namingStrategy = PascalCase\r\n */\r\nexport interface ServiceNamingOptions extends NamingStrategyOption, RequiredNamingOptions {\r\n  /**\r\n   * Controls the naming options for the main odata service.\r\n   * By default, the base service naming options are applied.\r\n   * But since this is the main entry point for users, it can be configured individually here.\r\n   *\r\n   * By default, applyServiceNaming = true\r\n   */\r\n  main?: NamingStrategyOption & StandardNamingOptions & { applyServiceNaming?: boolean };\r\n\r\n  /**\r\n   * Name of the service responsible for entity collections.\r\n   *\r\n   * By default, suffix = Collection and applyServiceNaming = true\r\n   */\r\n  collection: RequiredNamingOptions & { applyServiceNaming?: boolean };\r\n\r\n  /**\r\n   * Naming for getter method of another service.\r\n   *\r\n   * By default, namingStrategy = camelCase\r\n   */\r\n  relatedServiceGetter: NamingStrategyOption & RequiredNamingOptions;\r\n\r\n  /**\r\n   * Operations are functions and actions of the OData service and are represented as methods\r\n   * of the generated service class. This setting controls the naming of the corresponding\r\n   * function.\r\n   *\r\n   * By default, namingStrategy = camelCase\r\n   */\r\n  operations?: NamingStrategyOption & OperationNamingOptions;\r\n\r\n  /**\r\n   * Naming options for private properties of service classes.\r\n   *\r\n   * By default, prefix = _\r\n   */\r\n  privateProps: NamingStrategyOption & RequiredNamingOptions;\r\n}\r\n"]}