@odata2ts/odata2ts 0.23.1 → 0.25.0

package/lib/OptionModel.d.ts

@@ -1,223 +1,228 @@
-import { TypeConverterConfig } from "@odata2ts/converter-runtime";
-import { NameSettings, OverridableNamingOptions } from "./NamingModel";
-/**
- * Generation mode, by default "all".
- */
-export declare enum Modes {
-    models = 0,
-    qobjects = 1,
-    service = 2,
-    all = 3
-}
-/**
- * What kind of stuff to emit: Either raw TS or TS that has been compiled to JS / DTS.
- */
-export declare enum EmitModes {
-    ts = "ts",
-    js = "js",
-    dts = "dts",
-    js_dts = "js_dts"
-}
-/**
- * Config options for CLI.
- */
-export interface CliOptions {
-    /**
-     * The source file to use. Must be an EDMX compliant XML file.
-     *
-     * If not specified, at least one service must be configured in config file.
-     */
-    source?: string;
-    /**
-     * Specifies the output directory for the generated stuff.
-     *
-     *  If not specified, at least one service must be configured in config file.
-     */
-    output?: string;
-    /**
-     * Only generates the specified services.
-     * Relies on an existing config file where these service names are maintained.
-     */
-    services?: Array<string>;
-    /**
-     * Specifies what to generate:
-     * - {@code Modes.models} will only generate TS interfaces
-     * - {@code Modes.qobjects} will generate functional units used in QueryBuilder and for functions and actions
-     * - {@code Modes.service} will generate one main OData service client and one per each entity
-     * - {@code Modes.all} the same as {@code Modes.service}
-     *
-     * QObjects will also generate models, and generating the service client will also generate models and QObjects.
-     * Defaults to {@code Modes.all}
-     */
-    mode?: Modes;
-    /**
-     * Specifies the type of the output files: TypeScript, JS, DTS only, JS with DTS.
-     * Defaults to {@code EmitModes.js_dts}
-     */
-    emitMode?: EmitModes;
-    /**
-     * Uses prettier with your local configuration to pretty print TypeScript files.
-     * Only applies if mode is set to {@code EmitModes.ts}.
-     */
-    prettier?: boolean;
-    /**
-     * When compiling TypeScript to JS, "tsconfig.json" is used by default to add compilerOptions.
-     * This option allows to specify an alternative file.
-     *
-     * Only takes effect, when mode is set to anything else than {@code EmitModes.ts}.
-     */
-    tsconfig?: string;
-    /**
-     * Verbose debugging information.
-     */
-    debug?: boolean;
-    /**
-     * Overrides the service name found in the source file.
-     *
-     * The service name is the basis for all file names and the name of the main OData client service
-     * that serves as entry point for the user.
-     */
-    serviceName?: string;
-    /**
-     * odata2ts will automatically decide if a key prop is managed on the server side.
-     * If managed, the property will not be editable (create, update, patch).
-     * The following rule applies:
-     * If a property is the only key prop of an entity, then the prop is deemed to be managed;
-     * in ony other case the prop is unmanaged.
-     */
-    disableAutoManagedKey?: boolean;
-    /**
-     * By default, odata2ts doesn't change param, operation, property or model names.
-     * The generated models and their properties are named exactly as advertised by the server.
-     *
-     * By allowing odata2ts to change these names, certain predefined formatting strategies are used:
-     * Model / class names are formatted with PascalCase; property, param, and operation names with camelCase.
-     *
-     * The naming configuration allows to control this and other naming related settings.
-     * Note: Even if renaming is disabled, model prefixing / suffing still applies.
-     */
-    allowRenaming?: boolean;
-}
-/**
- * Available options for the actual generation run.
- * Every property is required, except the overriding service name.
- */
-export interface RunOptions extends Required<Omit<ServiceGenerationOptions, "serviceName">> {
-    serviceName?: string;
-    naming: NameSettings;
-}
-/**
- * Available options for configuration files, i.e. odata2ts.config.ts.
- */
-export interface ConfigFileOptions extends Omit<CliOptions, "source" | "output" | "services"> {
-    services?: {
-        [serviceName: string]: ServiceGenerationOptions;
-    };
-    /**
-     * Specify which converters to use by their package name, e.g. "@odata2ts/converter-v2-to-v4".
-     * Each converter knows which data type to map.
-     *
-     * To only use specific converters, the object syntax must be used, where supported converters
-     * must be listed by their ids.
-     */
-    converters?: Array<string | TypeConverterConfig>;
-    /**
-     * For each model an editable version is generated which represents the model definition for
-     * create, update and patch actions.
-     *
-     * You can skip the generation altogether, not generating editable model variants,
-     * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.
-     */
-    skipEditableModels?: boolean;
-    /**
-     * ID models are generated from entity id parameters.
-     * The generation for one entity entails one model interface representing the id parameters and
-     * one QId function which allows to format the parameters for URL usage and to parse parameters
-     * from a URL string.
-     *
-     * You can skip the generation altogether, not generating models and QId objects, if the
-     * generation mode is {@code Mode.model} or {@code Mode.qobject}.
-     */
-    skipIdModels?: boolean;
-    /**
-     * Operations are functions and actions of the OData service.
-     * The generation for one operation entails one parameter model interface
-     * and one QFunction / QAction class.
-     *
-     * You can skip the generation altogether, neither generating model nor query object,
-     * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.
-     */
-    skipOperations?: boolean;
-    /**
-     * The naming options regarding the generated artefacts.
-     */
-    naming?: OverridableNamingOptions;
-    /**
-     * Some OData V2 services generate an extra wrapping for entity collection attributes:
-     * <code>trips: {results: [...]}</code>. So instead of directly returning an array of entities
-     * an object with the property "results" is wrapped around the entity collection.
-     *
-     * If you're using the odata client then there's a build-in workaround in place which transforms
-     * the results to remove this extra mapping. However, if you're only interested in the types, then
-     * the generated models will not match that extra wrapping.
-     *
-     * Setting this configuration option to <code>true</code> (default: false) will add this extra
-     * wrapping to the generated models. But this option is only valid if the generation mode is set
-     * to <code>models</code>; it is ignored otherwise.
-     */
-    v2ModelsWithExtraResultsWrapping?: boolean;
-}
-/**
- * Custom generation options which are dependent on a specific odata service.
- */
-export interface ServiceGenerationOptions extends Required<Pick<CliOptions, "source" | "output">>, Omit<ConfigFileOptions, "services"> {
-    /**
-     * Configure generation process for EntityTypes and ComplexTypes including their keys and properties.
-     */
-    entitiesByName?: Array<EntityGenerationOptions>;
-    /**
-     * Configure generation process for individual properties based on their name.
-     */
-    propertiesByName?: Array<PropertyGenerationOptions>;
-}
-/**
- * Configuration options for EntityTypes and ComplexTypes.
- * This config applies if the name matches the name of an EntityType or ComplexType as it is specified
- * in the metadata (e.g. in EDMX <EntityType name="Test" ...)
- */
-export interface EntityGenerationOptions {
-    /**
-     * Name of the EntityType or ComplexType, e.g. "Person".
-     * Must match exactly or can be a regular expression.
-     */
-    name: string | RegExp;
-    /**
-     * Use a different name.
-     * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).
-     */
-    mappedName?: string;
-    /**
-     * Overwrite the key specification by naming the props by their EDMX name.
-     */
-    keys?: Array<string>;
-}
-/**
- * All configuration options for properties of models.
- */
-export interface PropertyGenerationOptions {
-    /**
-     * Name of the property to match.
-     * Must match exactly or can be a regular expression.
-     */
-    name: string | RegExp;
-    /**
-     * Use a different name.
-     * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).
-     */
-    mappedName?: string;
-    /**
-     * Managed attributes - i.e. managed by the server - cannot be created or updated.
-     * Hence, they are left out of the editable model versions.
-     */
-    managed?: boolean;
-}
+import { TypeConverterConfig } from "@odata2ts/converter-runtime";
+import { NameSettings, OverridableNamingOptions } from "./NamingModel";
+/**
+ * Generation mode, by default "all".
+ */
+export declare enum Modes {
+    models = 0,
+    qobjects = 1,
+    service = 2,
+    all = 3
+}
+/**
+ * What kind of stuff to emit: Either raw TS or TS that has been compiled to JS / DTS.
+ */
+export declare enum EmitModes {
+    ts = "ts",
+    js = "js",
+    dts = "dts",
+    js_dts = "js_dts"
+}
+/**
+ * Config options for CLI.
+ */
+export interface CliOptions {
+    /**
+     * The source file to use. Must be an EDMX compliant XML file.
+     *
+     * If not specified, at least one service must be configured in config file.
+     */
+    source?: string;
+    /**
+     * Specifies the output directory for the generated stuff.
+     *
+     *  If not specified, at least one service must be configured in config file.
+     */
+    output?: string;
+    /**
+     * Only generates the specified services.
+     * Relies on an existing config file where these service names are maintained.
+     */
+    services?: Array<string>;
+    /**
+     * Specifies what to generate:
+     * - {@code Modes.models} will only generate TS interfaces
+     * - {@code Modes.qobjects} will generate functional units used in QueryBuilder and for functions and actions
+     * - {@code Modes.service} will generate one main OData service client and one per each entity
+     * - {@code Modes.all} the same as {@code Modes.service}
+     *
+     * QObjects will also generate models, and generating the service client will also generate models and QObjects.
+     * Defaults to {@code Modes.all}
+     */
+    mode?: Modes;
+    /**
+     * Specifies the type of the output files: TypeScript, JS, DTS only, JS with DTS.
+     * Defaults to {@code EmitModes.js_dts}
+     */
+    emitMode?: EmitModes;
+    /**
+     * Uses prettier with your local configuration to pretty print TypeScript files.
+     * Only applies if mode is set to {@code EmitModes.ts}.
+     */
+    prettier?: boolean;
+    /**
+     * When compiling TypeScript to JS, "tsconfig.json" is used by default to add compilerOptions.
+     * This option allows to specify an alternative file.
+     *
+     * Only takes effect, when mode is set to anything else than {@code EmitModes.ts}.
+     */
+    tsconfig?: string;
+    /**
+     * Verbose debugging information.
+     */
+    debug?: boolean;
+    /**
+     * Overrides the service name found in the source file.
+     *
+     * The service name is the basis for all file names and the name of the main OData client service
+     * that serves as entry point for the user.
+     */
+    serviceName?: string;
+    /**
+     * odata2ts will automatically decide if a key prop is managed on the server side.
+     * If managed, the property will not be editable (create, update, patch).
+     * The following rule applies:
+     * If a property is the only key prop of an entity, then the prop is deemed to be managed;
+     * in ony other case the prop is unmanaged.
+     */
+    disableAutoManagedKey?: boolean;
+    /**
+     * By default, odata2ts doesn't change param, operation, property or model names.
+     * The generated models and their properties are named exactly as advertised by the server.
+     *
+     * By allowing odata2ts to change these names, certain predefined formatting strategies are used:
+     * Model / class names are formatted with PascalCase; property, param, and operation names with camelCase.
+     *
+     * The naming configuration allows to control this and other naming related settings.
+     * Note: Even if renaming is disabled, model prefixing / suffing still applies.
+     */
+    allowRenaming?: boolean;
+}
+/**
+ * Available options for the actual generation run.
+ * Every property is required, except the overriding service name.
+ */
+export interface RunOptions extends Required<Omit<ServiceGenerationOptions, "serviceName">> {
+    serviceName?: string;
+    naming: NameSettings;
+}
+/**
+ * Available options for configuration files, i.e. odata2ts.config.ts.
+ */
+export interface ConfigFileOptions extends Omit<CliOptions, "source" | "output" | "services"> {
+    services?: {
+        [serviceName: string]: ServiceGenerationOptions;
+    };
+    /**
+     * Specify which converters to use by their package name, e.g. "@odata2ts/converter-v2-to-v4".
+     * Each converter knows which data type to map.
+     *
+     * To only use specific converters, the object syntax must be used, where supported converters
+     * must be listed by their ids.
+     */
+    converters?: Array<string | TypeConverterConfig>;
+    /**
+     * For each model an editable version is generated which represents the model definition for
+     * create, update and patch actions.
+     *
+     * You can skip the generation altogether, not generating editable model variants,
+     * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.
+     */
+    skipEditableModels?: boolean;
+    /**
+     * ID models are generated from entity id parameters.
+     * The generation for one entity entails one model interface representing the id parameters and
+     * one QId function which allows to format the parameters for URL usage and to parse parameters
+     * from a URL string.
+     *
+     * You can skip the generation altogether, not generating models and QId objects, if the
+     * generation mode is {@code Mode.model} or {@code Mode.qobject}.
+     */
+    skipIdModels?: boolean;
+    /**
+     * Operations are functions and actions of the OData service.
+     * The generation for one operation entails one parameter model interface
+     * and one QFunction / QAction class.
+     *
+     * You can skip the generation altogether, neither generating model nor query object,
+     * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.
+     */
+    skipOperations?: boolean;
+    /**
+     * Model properties have explaining comments by default.
+     * With this option you can turn that off.
+     */
+    skipComments?: boolean;
+    /**
+     * The naming options regarding the generated artefacts.
+     */
+    naming?: OverridableNamingOptions;
+    /**
+     * Some OData V2 services generate an extra wrapping for entity collection attributes:
+     * <code>trips: {results: [...]}</code>. So instead of directly returning an array of entities
+     * an object with the property "results" is wrapped around the entity collection.
+     *
+     * If you're using the odata client then there's a build-in workaround in place which transforms
+     * the results to remove this extra mapping. However, if you're only interested in the types, then
+     * the generated models will not match that extra wrapping.
+     *
+     * Setting this configuration option to <code>true</code> (default: false) will add this extra
+     * wrapping to the generated models. But this option is only valid if the generation mode is set
+     * to <code>models</code>; it is ignored otherwise.
+     */
+    v2ModelsWithExtraResultsWrapping?: boolean;
+}
+/**
+ * Custom generation options which are dependent on a specific odata service.
+ */
+export interface ServiceGenerationOptions extends Required<Pick<CliOptions, "source" | "output">>, Omit<ConfigFileOptions, "services"> {
+    /**
+     * Configure generation process for EntityTypes and ComplexTypes including their keys and properties.
+     */
+    entitiesByName?: Array<EntityGenerationOptions>;
+    /**
+     * Configure generation process for individual properties based on their name.
+     */
+    propertiesByName?: Array<PropertyGenerationOptions>;
+}
+/**
+ * Configuration options for EntityTypes and ComplexTypes.
+ * This config applies if the name matches the name of an EntityType or ComplexType as it is specified
+ * in the metadata (e.g. in EDMX <EntityType name="Test" ...)
+ */
+export interface EntityGenerationOptions {
+    /**
+     * Name of the EntityType or ComplexType, e.g. "Person".
+     * Must match exactly or can be a regular expression.
+     */
+    name: string | RegExp;
+    /**
+     * Use a different name.
+     * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).
+     */
+    mappedName?: string;
+    /**
+     * Overwrite the key specification by naming the props by their EDMX name.
+     */
+    keys?: Array<string>;
+}
+/**
+ * All configuration options for properties of models.
+ */
+export interface PropertyGenerationOptions {
+    /**
+     * Name of the property to match.
+     * Must match exactly or can be a regular expression.
+     */
+    name: string | RegExp;
+    /**
+     * Use a different name.
+     * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).
+     */
+    mappedName?: string;
+    /**
+     * Managed attributes - i.e. managed by the server - cannot be created or updated.
+     * Hence, they are left out of the editable model versions.
+     */
+    managed?: boolean;
+}

package/lib/OptionModel.js

@@ -1,24 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmitModes = exports.Modes = void 0;
-/**
- * Generation mode, by default "all".
- */
-var Modes;
-(function (Modes) {
-    Modes[Modes["models"] = 0] = "models";
-    Modes[Modes["qobjects"] = 1] = "qobjects";
-    Modes[Modes["service"] = 2] = "service";
-    Modes[Modes["all"] = 3] = "all";
-})(Modes = exports.Modes || (exports.Modes = {}));
-/**
- * What kind of stuff to emit: Either raw TS or TS that has been compiled to JS / DTS.
- */
-var EmitModes;
-(function (EmitModes) {
-    EmitModes["ts"] = "ts";
-    EmitModes["js"] = "js";
-    EmitModes["dts"] = "dts";
-    EmitModes["js_dts"] = "js_dts";
-})(EmitModes = exports.EmitModes || (exports.EmitModes = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmitModes = exports.Modes = void 0;
+/**
+ * Generation mode, by default "all".
+ */
+var Modes;
+(function (Modes) {
+    Modes[Modes["models"] = 0] = "models";
+    Modes[Modes["qobjects"] = 1] = "qobjects";
+    Modes[Modes["service"] = 2] = "service";
+    Modes[Modes["all"] = 3] = "all";
+})(Modes || (exports.Modes = Modes = {}));
+/**
+ * What kind of stuff to emit: Either raw TS or TS that has been compiled to JS / DTS.
+ */
+var EmitModes;
+(function (EmitModes) {
+    EmitModes["ts"] = "ts";
+    EmitModes["js"] = "js";
+    EmitModes["dts"] = "dts";
+    EmitModes["js_dts"] = "js_dts";
+})(EmitModes || (exports.EmitModes = EmitModes = {}));
 //# sourceMappingURL=OptionModel.js.map

package/lib/OptionModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"OptionModel.js","sourceRoot":"","sources":["../src/OptionModel.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,IAAY,KAKX;AALD,WAAY,KAAK;IACf,qCAAM,CAAA;IACN,yCAAQ,CAAA;IACR,uCAAO,CAAA;IACP,+BAAG,CAAA;AACL,CAAC,EALW,KAAK,GAAL,aAAK,KAAL,aAAK,QAKhB;AAED;;GAEG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,sBAAS,CAAA;IACT,sBAAS,CAAA;IACT,wBAAW,CAAA;IACX,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB","sourcesContent":["import { TypeConverterConfig } from \"@odata2ts/converter-runtime\";\r\n\r\nimport { NameSettings, OverridableNamingOptions } from \"./NamingModel\";\r\n\r\n/**\r\n * Generation mode, by default \"all\".\r\n */\r\nexport enum Modes {\r\n  models,\r\n  qobjects,\r\n  service,\r\n  all,\r\n}\r\n\r\n/**\r\n * What kind of stuff to emit: Either raw TS or TS that has been compiled to JS / DTS.\r\n */\r\nexport enum EmitModes {\r\n  ts = \"ts\",\r\n  js = \"js\",\r\n  dts = \"dts\",\r\n  js_dts = \"js_dts\",\r\n}\r\n\r\n/**\r\n * Config options for CLI.\r\n */\r\nexport interface CliOptions {\r\n  /**\r\n   * The source file to use. Must be an EDMX compliant XML file.\r\n   *\r\n   * If not specified, at least one service must be configured in config file.\r\n   */\r\n  source?: string;\r\n  /**\r\n   * Specifies the output directory for the generated stuff.\r\n   *\r\n   *  If not specified, at least one service must be configured in config file.\r\n   */\r\n  output?: string;\r\n  /**\r\n   * Only generates the specified services.\r\n   * Relies on an existing config file where these service names are maintained.\r\n   */\r\n  services?: Array<string>;\r\n  /**\r\n   * Specifies what to generate:\r\n   * - {@code Modes.models} will only generate TS interfaces\r\n   * - {@code Modes.qobjects} will generate functional units used in QueryBuilder and for functions and actions\r\n   * - {@code Modes.service} will generate one main OData service client and one per each entity\r\n   * - {@code Modes.all} the same as {@code Modes.service}\r\n   *\r\n   * QObjects will also generate models, and generating the service client will also generate models and QObjects.\r\n   * Defaults to {@code Modes.all}\r\n   */\r\n  mode?: Modes;\r\n  /**\r\n   * Specifies the type of the output files: TypeScript, JS, DTS only, JS with DTS.\r\n   * Defaults to {@code EmitModes.js_dts}\r\n   */\r\n  emitMode?: EmitModes;\r\n  /**\r\n   * Uses prettier with your local configuration to pretty print TypeScript files.\r\n   * Only applies if mode is set to {@code EmitModes.ts}.\r\n   */\r\n  prettier?: boolean;\r\n  /**\r\n   * When compiling TypeScript to JS, \"tsconfig.json\" is used by default to add compilerOptions.\r\n   * This option allows to specify an alternative file.\r\n   *\r\n   * Only takes effect, when mode is set to anything else than {@code EmitModes.ts}.\r\n   */\r\n  tsconfig?: string;\r\n  /**\r\n   * Verbose debugging information.\r\n   */\r\n  debug?: boolean;\r\n  /**\r\n   * Overrides the service name found in the source file.\r\n   *\r\n   * The service name is the basis for all file names and the name of the main OData client service\r\n   * that serves as entry point for the user.\r\n   */\r\n  serviceName?: string;\r\n  /**\r\n   * odata2ts will automatically decide if a key prop is managed on the server side.\r\n   * If managed, the property will not be editable (create, update, patch).\r\n   * The following rule applies:\r\n   * If a property is the only key prop of an entity, then the prop is deemed to be managed;\r\n   * in ony other case the prop is unmanaged.\r\n   */\r\n  disableAutoManagedKey?: boolean;\r\n  /**\r\n   * By default, odata2ts doesn't change param, operation, property or model names.\r\n   * The generated models and their properties are named exactly as advertised by the server.\r\n   *\r\n   * By allowing odata2ts to change these names, certain predefined formatting strategies are used:\r\n   * Model / class names are formatted with PascalCase; property, param, and operation names with camelCase.\r\n   *\r\n   * The naming configuration allows to control this and other naming related settings.\r\n   * Note: Even if renaming is disabled, model prefixing / suffing still applies.\r\n   */\r\n  allowRenaming?: boolean;\r\n}\r\n\r\n/**\r\n * Available options for the actual generation run.\r\n * Every property is required, except the overriding service name.\r\n */\r\nexport interface RunOptions extends Required<Omit<ServiceGenerationOptions, \"serviceName\">> {\r\n  serviceName?: string;\r\n  naming: NameSettings;\r\n}\r\n\r\n/**\r\n * Available options for configuration files, i.e. odata2ts.config.ts.\r\n */\r\nexport interface ConfigFileOptions extends Omit<CliOptions, \"source\" | \"output\" | \"services\"> {\r\n  services?: { [serviceName: string]: ServiceGenerationOptions };\r\n\r\n  /**\r\n   * Specify which converters to use by their package name, e.g. \"@odata2ts/converter-v2-to-v4\".\r\n   * Each converter knows which data type to map.\r\n   *\r\n   * To only use specific converters, the object syntax must be used, where supported converters\r\n   * must be listed by their ids.\r\n   */\r\n  converters?: Array<string | TypeConverterConfig>;\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 skip the generation altogether, not generating editable model variants,\r\n   * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.\r\n   */\r\n  skipEditableModels?: boolean;\r\n\r\n  /**\r\n   * ID models are generated from entity id parameters.\r\n   * The generation for one entity entails one model interface representing the id parameters and\r\n   * one QId function which allows to format the parameters for URL usage and to parse parameters\r\n   * from a URL string.\r\n   *\r\n   * You can skip the generation altogether, not generating models and QId objects, if the\r\n   * generation mode is {@code Mode.model} or {@code Mode.qobject}.\r\n   */\r\n  skipIdModels?: boolean;\r\n  /**\r\n   * Operations are functions and actions of the OData service.\r\n   * The generation for one operation entails one parameter model interface\r\n   * and one QFunction / QAction class.\r\n   *\r\n   * You can skip the generation altogether, neither generating model nor query object,\r\n   * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.\r\n   */\r\n  skipOperations?: boolean;\r\n\r\n  /**\r\n   * The naming options regarding the generated artefacts.\r\n   */\r\n  naming?: OverridableNamingOptions;\r\n\r\n  /**\r\n   * Some OData V2 services generate an extra wrapping for entity collection attributes:\r\n   * <code>trips: {results: [...]}</code>. So instead of directly returning an array of entities\r\n   * an object with the property \"results\" is wrapped around the entity collection.\r\n   *\r\n   * If you're using the odata client then there's a build-in workaround in place which transforms\r\n   * the results to remove this extra mapping. However, if you're only interested in the types, then\r\n   * the generated models will not match that extra wrapping.\r\n   *\r\n   * Setting this configuration option to <code>true</code> (default: false) will add this extra\r\n   * wrapping to the generated models. But this option is only valid if the generation mode is set\r\n   * to <code>models</code>; it is ignored otherwise.\r\n   */\r\n  v2ModelsWithExtraResultsWrapping?: boolean;\r\n}\r\n\r\n/**\r\n * Custom generation options which are dependent on a specific odata service.\r\n */\r\nexport interface ServiceGenerationOptions\r\n  extends Required<Pick<CliOptions, \"source\" | \"output\">>,\r\n    Omit<ConfigFileOptions, \"services\"> {\r\n  /**\r\n   * Configure generation process for EntityTypes and ComplexTypes including their keys and properties.\r\n   */\r\n  entitiesByName?: Array<EntityGenerationOptions>;\r\n  /**\r\n   * Configure generation process for individual properties based on their name.\r\n   */\r\n  propertiesByName?: Array<PropertyGenerationOptions>;\r\n}\r\n\r\n/**\r\n * Configuration options for EntityTypes and ComplexTypes.\r\n * This config applies if the name matches the name of an EntityType or ComplexType as it is specified\r\n * in the metadata (e.g. in EDMX <EntityType name=\"Test\" ...)\r\n */\r\nexport interface EntityGenerationOptions {\r\n  /**\r\n   * Name of the EntityType or ComplexType, e.g. \"Person\".\r\n   * Must match exactly or can be a regular expression.\r\n   */\r\n  name: string | RegExp;\r\n  /**\r\n   * Use a different name.\r\n   * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).\r\n   */\r\n  mappedName?: string;\r\n  /**\r\n   * Overwrite the key specification by naming the props by their EDMX name.\r\n   */\r\n  keys?: Array<string>;\r\n  /**\r\n   * Configuration of individual properties.\r\n   */\r\n  // properties?: Array<PropertyGenerationOptions>;\r\n\r\n  // converter: string | Array<string>\r\n\r\n  /**\r\n   * Whether the generated service should allow for querying this model.\r\n   * True by default.\r\n   */\r\n  // queryable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for creating new models (POST).\r\n   * True by default.\r\n   */\r\n  // creatable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for updates (PUT).\r\n   * True by default.\r\n   */\r\n  // updatable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for partial updates (PATCH).\r\n   * True by default.\r\n   */\r\n  // patchable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for deletion.\r\n   * True by default.\r\n   */\r\n  // deletable?: boolean;\r\n}\r\n\r\n/**\r\n * All configuration options for properties of models.\r\n */\r\nexport interface PropertyGenerationOptions {\r\n  /**\r\n   * Name of the property to match.\r\n   * Must match exactly or can be a regular expression.\r\n   */\r\n  name: string | RegExp;\r\n  /**\r\n   * Use a different name.\r\n   * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).\r\n   */\r\n  mappedName?: string;\r\n  /**\r\n   * Managed attributes - i.e. managed by the server - cannot be created or updated.\r\n   * Hence, they are left out of the editable model versions.\r\n   */\r\n  managed?: boolean;\r\n\r\n  /**\r\n   * TODO\r\n   *\r\n   * Each converter must specify its package name, e.g. \"@odata2ts/converter-v2-to-v4\",\r\n   * as well it's i\r\n   * and their ids, e.g. \"timeToDurationConverter\".\r\n   *\r\n   * To only use specific converters, the object syntax must be used, where supported converters\r\n   * must be listed by their ids.\r\n   */\r\n  // converters?: Array<Required<TypeConverterConfig>>;\r\n}\r\n"]}
+{"version":3,"file":"OptionModel.js","sourceRoot":"","sources":["../src/OptionModel.ts"],"names":[],"mappings":";;;AAIA;;GAEG;AACH,IAAY,KAKX;AALD,WAAY,KAAK;IACf,qCAAM,CAAA;IACN,yCAAQ,CAAA;IACR,uCAAO,CAAA;IACP,+BAAG,CAAA;AACL,CAAC,EALW,KAAK,qBAAL,KAAK,QAKhB;AAED;;GAEG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,sBAAS,CAAA;IACT,sBAAS,CAAA;IACT,wBAAW,CAAA;IACX,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB","sourcesContent":["import { TypeConverterConfig } from \"@odata2ts/converter-runtime\";\r\n\r\nimport { NameSettings, OverridableNamingOptions } from \"./NamingModel\";\r\n\r\n/**\r\n * Generation mode, by default \"all\".\r\n */\r\nexport enum Modes {\r\n  models,\r\n  qobjects,\r\n  service,\r\n  all,\r\n}\r\n\r\n/**\r\n * What kind of stuff to emit: Either raw TS or TS that has been compiled to JS / DTS.\r\n */\r\nexport enum EmitModes {\r\n  ts = \"ts\",\r\n  js = \"js\",\r\n  dts = \"dts\",\r\n  js_dts = \"js_dts\",\r\n}\r\n\r\n/**\r\n * Config options for CLI.\r\n */\r\nexport interface CliOptions {\r\n  /**\r\n   * The source file to use. Must be an EDMX compliant XML file.\r\n   *\r\n   * If not specified, at least one service must be configured in config file.\r\n   */\r\n  source?: string;\r\n  /**\r\n   * Specifies the output directory for the generated stuff.\r\n   *\r\n   *  If not specified, at least one service must be configured in config file.\r\n   */\r\n  output?: string;\r\n  /**\r\n   * Only generates the specified services.\r\n   * Relies on an existing config file where these service names are maintained.\r\n   */\r\n  services?: Array<string>;\r\n  /**\r\n   * Specifies what to generate:\r\n   * - {@code Modes.models} will only generate TS interfaces\r\n   * - {@code Modes.qobjects} will generate functional units used in QueryBuilder and for functions and actions\r\n   * - {@code Modes.service} will generate one main OData service client and one per each entity\r\n   * - {@code Modes.all} the same as {@code Modes.service}\r\n   *\r\n   * QObjects will also generate models, and generating the service client will also generate models and QObjects.\r\n   * Defaults to {@code Modes.all}\r\n   */\r\n  mode?: Modes;\r\n  /**\r\n   * Specifies the type of the output files: TypeScript, JS, DTS only, JS with DTS.\r\n   * Defaults to {@code EmitModes.js_dts}\r\n   */\r\n  emitMode?: EmitModes;\r\n  /**\r\n   * Uses prettier with your local configuration to pretty print TypeScript files.\r\n   * Only applies if mode is set to {@code EmitModes.ts}.\r\n   */\r\n  prettier?: boolean;\r\n  /**\r\n   * When compiling TypeScript to JS, \"tsconfig.json\" is used by default to add compilerOptions.\r\n   * This option allows to specify an alternative file.\r\n   *\r\n   * Only takes effect, when mode is set to anything else than {@code EmitModes.ts}.\r\n   */\r\n  tsconfig?: string;\r\n  /**\r\n   * Verbose debugging information.\r\n   */\r\n  debug?: boolean;\r\n  /**\r\n   * Overrides the service name found in the source file.\r\n   *\r\n   * The service name is the basis for all file names and the name of the main OData client service\r\n   * that serves as entry point for the user.\r\n   */\r\n  serviceName?: string;\r\n  /**\r\n   * odata2ts will automatically decide if a key prop is managed on the server side.\r\n   * If managed, the property will not be editable (create, update, patch).\r\n   * The following rule applies:\r\n   * If a property is the only key prop of an entity, then the prop is deemed to be managed;\r\n   * in ony other case the prop is unmanaged.\r\n   */\r\n  disableAutoManagedKey?: boolean;\r\n  /**\r\n   * By default, odata2ts doesn't change param, operation, property or model names.\r\n   * The generated models and their properties are named exactly as advertised by the server.\r\n   *\r\n   * By allowing odata2ts to change these names, certain predefined formatting strategies are used:\r\n   * Model / class names are formatted with PascalCase; property, param, and operation names with camelCase.\r\n   *\r\n   * The naming configuration allows to control this and other naming related settings.\r\n   * Note: Even if renaming is disabled, model prefixing / suffing still applies.\r\n   */\r\n  allowRenaming?: boolean;\r\n}\r\n\r\n/**\r\n * Available options for the actual generation run.\r\n * Every property is required, except the overriding service name.\r\n */\r\nexport interface RunOptions extends Required<Omit<ServiceGenerationOptions, \"serviceName\">> {\r\n  serviceName?: string;\r\n  naming: NameSettings;\r\n}\r\n\r\n/**\r\n * Available options for configuration files, i.e. odata2ts.config.ts.\r\n */\r\nexport interface ConfigFileOptions extends Omit<CliOptions, \"source\" | \"output\" | \"services\"> {\r\n  services?: { [serviceName: string]: ServiceGenerationOptions };\r\n\r\n  /**\r\n   * Specify which converters to use by their package name, e.g. \"@odata2ts/converter-v2-to-v4\".\r\n   * Each converter knows which data type to map.\r\n   *\r\n   * To only use specific converters, the object syntax must be used, where supported converters\r\n   * must be listed by their ids.\r\n   */\r\n  converters?: Array<string | TypeConverterConfig>;\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 skip the generation altogether, not generating editable model variants,\r\n   * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.\r\n   */\r\n  skipEditableModels?: boolean;\r\n\r\n  /**\r\n   * ID models are generated from entity id parameters.\r\n   * The generation for one entity entails one model interface representing the id parameters and\r\n   * one QId function which allows to format the parameters for URL usage and to parse parameters\r\n   * from a URL string.\r\n   *\r\n   * You can skip the generation altogether, not generating models and QId objects, if the\r\n   * generation mode is {@code Mode.model} or {@code Mode.qobject}.\r\n   */\r\n  skipIdModels?: boolean;\r\n  /**\r\n   * Operations are functions and actions of the OData service.\r\n   * The generation for one operation entails one parameter model interface\r\n   * and one QFunction / QAction class.\r\n   *\r\n   * You can skip the generation altogether, neither generating model nor query object,\r\n   * if the generation mode is {@code Mode.model} or {@code Mode.qobject}.\r\n   */\r\n  skipOperations?: boolean;\r\n  /**\r\n   * Model properties have explaining comments by default.\r\n   * With this option you can turn that off.\r\n   */\r\n  skipComments?: boolean;\r\n\r\n  /**\r\n   * The naming options regarding the generated artefacts.\r\n   */\r\n  naming?: OverridableNamingOptions;\r\n\r\n  /**\r\n   * Some OData V2 services generate an extra wrapping for entity collection attributes:\r\n   * <code>trips: {results: [...]}</code>. So instead of directly returning an array of entities\r\n   * an object with the property \"results\" is wrapped around the entity collection.\r\n   *\r\n   * If you're using the odata client then there's a build-in workaround in place which transforms\r\n   * the results to remove this extra mapping. However, if you're only interested in the types, then\r\n   * the generated models will not match that extra wrapping.\r\n   *\r\n   * Setting this configuration option to <code>true</code> (default: false) will add this extra\r\n   * wrapping to the generated models. But this option is only valid if the generation mode is set\r\n   * to <code>models</code>; it is ignored otherwise.\r\n   */\r\n  v2ModelsWithExtraResultsWrapping?: boolean;\r\n}\r\n\r\n/**\r\n * Custom generation options which are dependent on a specific odata service.\r\n */\r\nexport interface ServiceGenerationOptions\r\n  extends Required<Pick<CliOptions, \"source\" | \"output\">>,\r\n    Omit<ConfigFileOptions, \"services\"> {\r\n  /**\r\n   * Configure generation process for EntityTypes and ComplexTypes including their keys and properties.\r\n   */\r\n  entitiesByName?: Array<EntityGenerationOptions>;\r\n  /**\r\n   * Configure generation process for individual properties based on their name.\r\n   */\r\n  propertiesByName?: Array<PropertyGenerationOptions>;\r\n}\r\n\r\n/**\r\n * Configuration options for EntityTypes and ComplexTypes.\r\n * This config applies if the name matches the name of an EntityType or ComplexType as it is specified\r\n * in the metadata (e.g. in EDMX <EntityType name=\"Test\" ...)\r\n */\r\nexport interface EntityGenerationOptions {\r\n  /**\r\n   * Name of the EntityType or ComplexType, e.g. \"Person\".\r\n   * Must match exactly or can be a regular expression.\r\n   */\r\n  name: string | RegExp;\r\n  /**\r\n   * Use a different name.\r\n   * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).\r\n   */\r\n  mappedName?: string;\r\n  /**\r\n   * Overwrite the key specification by naming the props by their EDMX name.\r\n   */\r\n  keys?: Array<string>;\r\n  /**\r\n   * Configuration of individual properties.\r\n   */\r\n  // properties?: Array<PropertyGenerationOptions>;\r\n\r\n  // converter: string | Array<string>\r\n\r\n  /**\r\n   * Whether the generated service should allow for querying this model.\r\n   * True by default.\r\n   */\r\n  // queryable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for creating new models (POST).\r\n   * True by default.\r\n   */\r\n  // creatable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for updates (PUT).\r\n   * True by default.\r\n   */\r\n  // updatable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for partial updates (PATCH).\r\n   * True by default.\r\n   */\r\n  // patchable?: boolean;\r\n  /**\r\n   * Whether the generated service should allow for deletion.\r\n   * True by default.\r\n   */\r\n  // deletable?: boolean;\r\n}\r\n\r\n/**\r\n * All configuration options for properties of models.\r\n */\r\nexport interface PropertyGenerationOptions {\r\n  /**\r\n   * Name of the property to match.\r\n   * Must match exactly or can be a regular expression.\r\n   */\r\n  name: string | RegExp;\r\n  /**\r\n   * Use a different name.\r\n   * If name is a regular expression, mappedName allows to specify captured groups (via $1, $2, ...).\r\n   */\r\n  mappedName?: string;\r\n  /**\r\n   * Managed attributes - i.e. managed by the server - cannot be created or updated.\r\n   * Hence, they are left out of the editable model versions.\r\n   */\r\n  managed?: boolean;\r\n\r\n  /**\r\n   * TODO\r\n   *\r\n   * Each converter must specify its package name, e.g. \"@odata2ts/converter-v2-to-v4\",\r\n   * as well it's i\r\n   * and their ids, e.g. \"timeToDurationConverter\".\r\n   *\r\n   * To only use specific converters, the object syntax must be used, where supported converters\r\n   * must be listed by their ids.\r\n   */\r\n  // converters?: Array<Required<TypeConverterConfig>>;\r\n}\r\n"]}

package/lib/app.d.ts

@@ -1,8 +1,8 @@
-import { ODataEdmxModelBase } from "./data-model/edmx/ODataEdmxModelBase";
-import { RunOptions } from "./OptionModel";
-/**
- *
- * @param metadataJson metadata of a given OData service already parsed as JSON
- * @param options further options
- */
-export declare function runApp(metadataJson: ODataEdmxModelBase<any>, options: RunOptions): Promise<void>;
+import { ODataEdmxModelBase } from "./data-model/edmx/ODataEdmxModelBase";
+import { RunOptions } from "./OptionModel";
+/**
+ *
+ * @param metadataJson metadata of a given OData service already parsed as JSON
+ * @param options further options
+ */
+export declare function runApp(metadataJson: ODataEdmxModelBase<any>, options: RunOptions): Promise<void>;