@api-client/core 0.6.13 → 0.6.16

package/build/src/amf/ApiExampleGenerator.js

@@ -0,0 +1,109 @@
+import { AmfNamespace as ns } from "./definitions/Namespace.js";
+import { JsonDataNodeGenerator } from './data-node/JsonDataNodeGenerator.js';
+import { XmlDataNodeGenerator } from './data-node/XmlDataNodeGenerator.js';
+import { UrlEncodedDataNodeGenerator } from './data-node/UrlEncodedDataNodeGenerator.js';
+import { formatXmlValue } from './Utils.js';
+/**
+ * A class that processes AMF's Example object to read the example value
+ * or to generate the example for the given media type.
+ */
+export class ApiExampleGenerator {
+    /**
+     * Reads or generates an example.
+     * When the `mime` is set then it tries to "guess" whether the mime type corresponds to the value.
+     * If it doesn't then it generates the example from the structured value, when possible.
+     * @param example The structured value of the example
+     * @param mime The optional mime type of the example. When not set it won't generate example from the structured value.
+     * @param shape The optional shape containing this example to use with the XML examples which needs wrapping into an element.
+     * @returns The read or generated example.
+     */
+    read(example, mime, shape) {
+        const { value, structuredValue } = example;
+        if (!value && !structuredValue) {
+            return undefined;
+        }
+        if (structuredValue && !value && mime) {
+            return this.fromStructuredValue(mime, structuredValue, shape);
+        }
+        if (!mime) {
+            return value;
+        }
+        if (this.mimeMatches(mime, value)) {
+            return value;
+        }
+        if (structuredValue) {
+            return this.fromStructuredValue(mime, structuredValue, shape);
+        }
+        return undefined;
+    }
+    /**
+     * Employs some basic heuristics to determine whether the given mime type patches the content.
+     * @param mime The mime type for the value.
+     * @param value The value.
+     * @returns True when the value matches the mime type.
+     */
+    mimeMatches(mime, value) {
+        const trimmed = String(value).trim();
+        if (mime.includes('json')) {
+            // JSON string has to start with either of these characters
+            return trimmed[0] === '{' || trimmed[0] === '[';
+        }
+        if (mime.includes('xml')) {
+            return trimmed.startsWith('<');
+        }
+        if (mime.includes('x-www-form-urlencoded')) {
+            return trimmed.includes('=') || trimmed.includes('&');
+        }
+        return true;
+    }
+    /**
+     * Generates the example for the given structured value and the media type.
+     * @param mime The mime type for the value.
+     * @param structuredValue The structuredValue of the example.
+     * @param shape The optional shape containing this example to use with the XML examples which needs wrapping into an element.
+     * @returns The generated example or null if couldn't process the data.
+     */
+    fromStructuredValue(mime, structuredValue, shape) {
+        if (mime.includes('json')) {
+            const generator = new JsonDataNodeGenerator();
+            return generator.generate(structuredValue);
+        }
+        let shapeName;
+        if (shape && shape.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
+            shapeName = shape.name;
+        }
+        else if (shape && shape.types.includes(ns.aml.vocabularies.shapes.ArrayShape)) {
+            const typed = shape;
+            if (typed.items && typed.items.types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
+                shapeName = typed.items.name || shape.name;
+            }
+        }
+        if (mime.includes('xml')) {
+            const generator = new XmlDataNodeGenerator();
+            let value = generator.generate(structuredValue, shapeName);
+            if (shape && !shapeName) {
+                value = this.wrapXmlValue(value, shape);
+            }
+            return value;
+        }
+        if (mime.includes('x-www-form-urlencoded')) {
+            const generator = new UrlEncodedDataNodeGenerator();
+            return generator.generate(structuredValue, shapeName);
+        }
+        return undefined;
+    }
+    /**
+     * Wraps the generated XML example into an element according to the `shape` properties.
+     */
+    wrapXmlValue(value, shape) {
+        if (!value || !shape) {
+            return value;
+        }
+        const { name } = shape;
+        const parts = [`<${name}>`];
+        parts.push(formatXmlValue('  ', value.trim()));
+        parts.push(`</${name}>`);
+        return parts.join('\n');
+    }
+}
+//# sourceMappingURL=ApiExampleGenerator.js.map

package/build/src/amf/ApiExampleGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiExampleGenerator.js","sourceRoot":"","sources":["../../../src/amf/ApiExampleGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAG5C;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAqB,EAAE,IAAa,EAAE,KAAmB;QAC5D,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAC3C,IAAI,CAAC,KAAK,IAAI,CAAC,eAAe,EAAE;YAC9B,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,eAAe,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;YACrC,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,KAAK,CAAC;SACd;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE;YACjC,OAAO,KAAK,CAAC;SACd;QACD,IAAI,eAAe,EAAE;YACnB,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;SAC/D;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,IAAY,EAAE,KAAc;QACtC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACzB,2DAA2D;YAC3D,OAAO,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC;SACjD;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACxB,OAAO,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;SAChC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;YAC1C,OAAO,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;SACvD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,IAAY,EAAE,eAA0B,EAAE,KAAmB;QAC/E,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACzB,MAAM,SAAS,GAAG,IAAI,qBAAqB,EAAE,CAAC;YAC9C,OAAO,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;SAC5C;QACD,IAAI,SAAS,CAAC;QACd,IAAI,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;YACzE,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC;SACxB;aAAM,IAAI,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;YAC/E,MAAM,KAAK,GAAG,KAAoB,CAAC;YACnC,IAAI,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;gBACrF,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;aAC5C;SACF;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACxB,MAAM,SAAS,GAAG,IAAI,oBAAoB,EAAE,CAAC;YAC7C,IAAI,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;YAC3D,IAAI,KAAK,IAAI,CAAC,SAAS,EAAE;gBACvB,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;aACzC;YACD,OAAO,KAAK,CAAC;SACd;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,EAAE;YAC1C,MAAM,SAAS,GAAG,IAAI,2BAA2B,EAAE,CAAC;YACpD,OAAO,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;SACvD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,KAAc,EAAE,KAAmB;QAC9C,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE;YACpB,OAAO,KAAK,CAAC;SACd;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QACvB,MAAM,KAAK,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC;QACzB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF"}

package/build/src/amf/ApiMonacoSchemaGenerator.d.ts

@@ -0,0 +1,67 @@
+import { IArrayShape, INodeShape, IPropertyShape, IScalarShape, IShapeUnion } from "./definitions/Shapes.js";
+export interface IMonacoSchema {
+    uri: string;
+    schema: IMonacoProperty;
+    fileMatch?: string[];
+}
+export interface IMonacoProperty {
+    $id?: string;
+    title: string;
+    type: string;
+    description?: string;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+}
+export interface IMonacoScalarProperty extends IMonacoProperty {
+    default?: string;
+    pattern?: string;
+    format?: string;
+    exclusiveMaximum?: boolean;
+    exclusiveMinimum?: boolean;
+    maxLength?: number;
+    minLength?: number;
+    minimum?: number;
+    maximum?: number;
+    multipleOf?: number;
+    enum?: string[];
+}
+export interface IMonacoObjectProperty extends IMonacoProperty {
+    properties: Record<string, IMonacoProperty>;
+    required: string[];
+    additionalProperties?: boolean;
+    minProperties?: number;
+    maxProperties?: number;
+}
+export interface IMonacoArrayProperty extends IMonacoProperty {
+    additionalItems?: boolean;
+    items: {
+        anyOf: IMonacoProperty[];
+    };
+    uniqueItems?: boolean;
+    minItems?: number;
+    maxItems?: number;
+    required: string[];
+}
+/**
+ * A class to generate JSON schema from an ApiShapeUnion declaration to use with the Monaco editor schemas.
+ */
+export declare class ApiMonacoSchemaGenerator {
+    schemas: IMonacoSchema[];
+    /**
+     * @param parentUri The URI for the fileMatch property.
+     */
+    generate(schema: IShapeUnion, parentUri: string): IMonacoSchema[];
+    /**
+     * @param parentUri The URI for the fileMatch property.
+     */
+    fromNodeShape(schema: INodeShape, parentUri?: string): IMonacoSchema[];
+    appendSchemaProperty(content: IMonacoObjectProperty, property: IPropertyShape): void;
+    rangeToPropertySchema(range: IShapeUnion): IMonacoScalarProperty | IMonacoObjectProperty | IMonacoArrayProperty | undefined;
+    scalarRangeToPropertySchema(schema: IScalarShape): IMonacoScalarProperty;
+    /**
+     * Translates AMF data type to JSON schema data type.
+     */
+    schemaTypeToJsonDataType(schemaType?: string): string;
+    nodeShapeRangeToPropertySchema(schema: INodeShape): IMonacoObjectProperty;
+    arrayShapeRangeToPropertySchema(schema: IArrayShape): IMonacoArrayProperty;
+}

package/build/src/amf/ApiMonacoSchemaGenerator.js

@@ -0,0 +1,243 @@
+import { AmfNamespace as ns } from "./definitions/Namespace.js";
+import { collectNodeProperties } from './Utils.js';
+function cleanName(name) {
+    if (!name) {
+        return '';
+    }
+    return name.replace('?', '');
+}
+/**
+ * A class to generate JSON schema from an ApiShapeUnion declaration to use with the Monaco editor schemas.
+ */
+export class ApiMonacoSchemaGenerator {
+    schemas = [];
+    /**
+     * @param parentUri The URI for the fileMatch property.
+     */
+    generate(schema, parentUri) {
+        this.schemas = [];
+        if (!schema) {
+            return [];
+        }
+        const { types } = schema;
+        if (types.includes(ns.w3.shacl.NodeShape)) {
+            return this.fromNodeShape(schema, parentUri);
+        }
+        return [];
+    }
+    /**
+     * @param parentUri The URI for the fileMatch property.
+     */
+    fromNodeShape(schema, parentUri) {
+        const { id, name } = schema;
+        const properties = collectNodeProperties(schema);
+        const content = {
+            title: cleanName(name),
+            type: "object",
+            properties: {},
+            required: [],
+        };
+        const result = {
+            uri: id,
+            schema: content,
+        };
+        if (parentUri) {
+            result.fileMatch = [parentUri];
+        }
+        this.schemas.push(result);
+        if (!Array.isArray(properties) || !properties.length) {
+            return this.schemas;
+        }
+        properties.forEach(property => this.appendSchemaProperty(content, property));
+        return this.schemas;
+    }
+    appendSchemaProperty(content, property) {
+        const { name, range, minCount } = property;
+        if (!range) {
+            return;
+        }
+        const value = this.rangeToPropertySchema(range);
+        if (value && name) {
+            content.properties[name] = value;
+            if (minCount === 1) {
+                content.required.push(name);
+            }
+        }
+    }
+    rangeToPropertySchema(range) {
+        const { types } = range;
+        if (types.includes(ns.aml.vocabularies.shapes.ScalarShape)) {
+            return this.scalarRangeToPropertySchema(range);
+        }
+        if (types.includes(ns.w3.shacl.NodeShape)) {
+            return this.nodeShapeRangeToPropertySchema(range);
+        }
+        if (types.includes(ns.aml.vocabularies.shapes.ArrayShape)) {
+            return this.arrayShapeRangeToPropertySchema(range);
+        }
+        return undefined;
+    }
+    scalarRangeToPropertySchema(schema) {
+        const { values, description, name, displayName, defaultValueStr, exclusiveMaximum, exclusiveMinimum, minimum, maximum, minLength, maxLength, id, multipleOf, pattern, readOnly, writeOnly } = schema;
+        const type = this.schemaTypeToJsonDataType(schema.dataType);
+        const result = {
+            '$id': id,
+            type,
+            title: cleanName(displayName || name),
+        };
+        if (description) {
+            result.description = description;
+        }
+        if (defaultValueStr) {
+            result.default = defaultValueStr;
+        }
+        if (typeof exclusiveMaximum === 'boolean') {
+            result.exclusiveMaximum = exclusiveMaximum;
+        }
+        if (typeof exclusiveMinimum === 'boolean') {
+            result.exclusiveMinimum = exclusiveMinimum;
+        }
+        if (typeof maxLength === 'number') {
+            result.maxLength = maxLength;
+        }
+        if (typeof minLength === 'number') {
+            result.minLength = minLength;
+        }
+        if (typeof minimum === 'number') {
+            result.minimum = minimum;
+        }
+        if (typeof maximum === 'number') {
+            result.maximum = maximum;
+        }
+        if (typeof multipleOf === 'number') {
+            result.multipleOf = multipleOf;
+        }
+        if (typeof pattern === 'string') {
+            result.pattern = pattern;
+        }
+        if (typeof readOnly === 'boolean') {
+            result.readOnly = readOnly;
+        }
+        if (typeof writeOnly === 'boolean') {
+            result.writeOnly = writeOnly;
+        }
+        switch (schema.dataType) {
+            case ns.aml.vocabularies.shapes.dateTimeOnly:
+                result.format = 'date-time';
+                break;
+            case ns.w3.xmlSchema.date:
+                result.format = 'date';
+                break;
+            case ns.w3.xmlSchema.time:
+                result.format = 'time';
+                break;
+            default:
+        }
+        if (Array.isArray(values) && values.length) {
+            // enum properties
+            result.enum = [];
+            values.forEach((value) => {
+                const { types } = value;
+                if (types.includes(ns.aml.vocabularies.data.Scalar)) {
+                    const typed = value;
+                    if (typed.value) {
+                        result.enum.push(typed.value);
+                    }
+                }
+            });
+        }
+        return result;
+    }
+    /**
+     * Translates AMF data type to JSON schema data type.
+     */
+    schemaTypeToJsonDataType(schemaType) {
+        switch (schemaType) {
+            case ns.aml.vocabularies.shapes.number:
+            case ns.aml.vocabularies.shapes.integer:
+            case ns.aml.vocabularies.shapes.float:
+            case ns.aml.vocabularies.shapes.long:
+            case ns.aml.vocabularies.shapes.double:
+            case ns.w3.xmlSchema.number:
+            case ns.w3.xmlSchema.integer:
+            case ns.w3.xmlSchema.float:
+            case ns.w3.xmlSchema.long:
+            case ns.w3.xmlSchema.double: return 'number';
+            case ns.w3.xmlSchema.boolean:
+            case ns.aml.vocabularies.shapes.boolean: return 'boolean';
+            case ns.aml.vocabularies.shapes.nil:
+            case ns.w3.xmlSchema.nil: return 'null';
+            default: return 'string';
+        }
+    }
+    nodeShapeRangeToPropertySchema(schema) {
+        const { description, name, displayName, id, readOnly, writeOnly, closed, minProperties, maxProperties } = schema;
+        const properties = collectNodeProperties(schema);
+        const result = {
+            '$id': id,
+            type: 'object',
+            title: cleanName(displayName || name),
+            properties: {},
+            required: [],
+        };
+        if (description) {
+            result.description = description;
+        }
+        if (typeof readOnly === 'boolean') {
+            result.readOnly = readOnly;
+        }
+        if (typeof writeOnly === 'boolean') {
+            result.writeOnly = writeOnly;
+        }
+        if (typeof closed === 'boolean') {
+            result.additionalProperties = !closed;
+        }
+        if (typeof minProperties === 'number') {
+            result.minProperties = minProperties;
+        }
+        if (typeof maxProperties === 'number') {
+            result.maxProperties = maxProperties;
+        }
+        properties.forEach(property => this.appendSchemaProperty(result, property));
+        return result;
+    }
+    arrayShapeRangeToPropertySchema(schema) {
+        const { description, name, displayName, id, readOnly, writeOnly, items, minItems, maxItems, uniqueItems } = schema;
+        const result = {
+            '$id': id,
+            type: 'array',
+            title: cleanName(displayName || name),
+            items: {
+                anyOf: [],
+            },
+            required: [],
+            additionalItems: false,
+        };
+        if (description) {
+            result.description = description;
+        }
+        if (typeof readOnly === 'boolean') {
+            result.readOnly = readOnly;
+        }
+        if (typeof writeOnly === 'boolean') {
+            result.writeOnly = writeOnly;
+        }
+        if (typeof uniqueItems === 'boolean') {
+            result.uniqueItems = uniqueItems;
+        }
+        if (items) {
+            const value = this.rangeToPropertySchema(items);
+            if (value) {
+                result.items.anyOf.push(value);
+            }
+        }
+        if (typeof minItems === 'number') {
+            result.minItems = minItems;
+        }
+        if (typeof maxItems === 'number') {
+            result.maxItems = maxItems;
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=ApiMonacoSchemaGenerator.js.map

package/build/src/amf/ApiMonacoSchemaGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiMonacoSchemaGenerator.js","sourceRoot":"","sources":["../../../src/amf/ApiMonacoSchemaGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAkDnD,SAAS,SAAS,CAAC,IAAa;IAC9B,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,EAAE,CAAC;KACX;IACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,wBAAwB;IACnC,OAAO,GAAoB,EAAE,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,MAAmB,EAAE,SAAiB;QAC7C,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,EAAE,CAAC;SACX;QACD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACzB,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAoB,EAAE,SAAS,CAAC,CAAC;SAC5D;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,MAAkB,EAAE,SAAkB;QAClD,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;QAC5B,MAAM,UAAU,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QACjD,MAAM,OAAO,GAA0B;YACrC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC;YACtB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,QAAQ,EAAE,EAAE;SACb,CAAC;QACF,MAAM,MAAM,GAAkB;YAC5B,GAAG,EAAE,EAAE;YACP,MAAM,EAAE,OAAO;SAChB,CAAC;QACF,IAAI,SAAS,EAAE;YACb,MAAM,CAAC,SAAS,GAAG,CAAC,SAAS,CAAC,CAAC;SAChC;QACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpD,OAAO,IAAI,CAAC,OAAO,CAAC;SACrB;QACD,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,oBAAoB,CAAC,OAA8B,EAAE,QAAwB;QAC3E,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,QAAQ,CAAC;QAC3C,IAAI,CAAC,KAAK,EAAE;YACV,OAAO;SACR;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAChD,IAAI,KAAK,IAAI,IAAI,EAAE;YACjB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACjC,IAAI,QAAQ,KAAK,CAAC,EAAE;gBAClB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC7B;SACF;IACH,CAAC;IAED,qBAAqB,CAAC,KAAkB;QACtC,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;QACxB,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE;YAC1D,OAAO,IAAI,CAAC,2BAA2B,CAAC,KAAqB,CAAC,CAAC;SAChE;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,8BAA8B,CAAC,KAAmB,CAAC,CAAC;SACjE;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;YACzD,OAAO,IAAI,CAAC,+BAA+B,CAAC,KAAoB,CAAC,CAAC;SACnE;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,2BAA2B,CAAC,MAAoB;QAC9C,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QACrM,MAAM,IAAI,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5D,MAAM,MAAM,GAA0B;YACpC,KAAK,EAAE,EAAE;YACT,IAAI;YACJ,KAAK,EAAE,SAAS,CAAC,WAAW,IAAI,IAAI,CAAC;SACtC,CAAC;QACF,IAAI,WAAW,EAAE;YACf,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;SAClC;QACD,IAAI,eAAe,EAAE;YACnB,MAAM,CAAC,OAAO,GAAG,eAAe,CAAC;SAClC;QACD,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE;YACzC,MAAM,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;SAC5C;QACD,IAAI,OAAO,gBAAgB,KAAK,SAAS,EAAE;YACzC,MAAM,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;SAC5C;QACD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;SAC9B;QACD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACjC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;SAC9B;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;SAC1B;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;SAC1B;QACD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;SAChC;QACD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;SAC1B;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE;YAClC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;SAC9B;QACD,QAAQ,MAAM,CAAC,QAAQ,EAAE;YACvB,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY;gBAAE,MAAM,CAAC,MAAM,GAAG,WAAW,CAAC;gBAAC,MAAM;YACjF,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI;gBAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;gBAAC,MAAM;YACzD,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI;gBAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;gBAAC,MAAM;YACzD,QAAQ;SACT;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE;YAC1C,kBAAkB;YAClB,MAAM,CAAC,IAAI,GAAG,EAAE,CAAC;YACjB,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACvB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;gBACxB,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBACnD,MAAM,KAAK,GAAG,KAAoB,CAAC;oBACnC,IAAI,KAAK,CAAC,KAAK,EAAE;wBACf,MAAM,CAAC,IAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;qBAChC;iBACF;YACH,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,wBAAwB,CAAC,UAAmB;QAC1C,QAAQ,UAAU,EAAE;YAClB,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;YACvC,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC;YACxC,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC;YACtC,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC;YACrC,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC;YACvC,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC;YAC5B,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC;YAC3B,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,QAAQ,CAAC;YAC7C,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;YAC1D,KAAK,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC;YACpC,KAAK,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,MAAM,CAAC;YACxC,OAAO,CAAC,CAAC,OAAO,QAAQ,CAAC;SAC1B;IACH,CAAC;IAED,8BAA8B,CAAC,MAAkB;QAC/C,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjH,MAAM,UAAU,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAEjD,MAAM,MAAM,GAA0B;YACpC,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,SAAS,CAAC,WAAW,IAAI,IAAI,CAAC;YACrC,UAAU,EAAE,EAAE;YACd,QAAQ,EAAE,EAAE;SACb,CAAC;QACF,IAAI,WAAW,EAAE;YACf,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;SAClC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE;YAClC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;SAC9B;QACD,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YAC/B,MAAM,CAAC,oBAAoB,GAAG,CAAC,MAAM,CAAC;SACvC;QACD,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACrC,MAAM,CAAC,aAAa,GAAG,aAAa,CAAC;SACtC;QACD,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;YACrC,MAAM,CAAC,aAAa,GAAG,aAAa,CAAC;SACtC;QACD,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,+BAA+B,CAAC,MAAmB;QACjD,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QACnH,MAAM,MAAM,GAAyB;YACnC,KAAK,EAAE,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,SAAS,CAAC,WAAW,IAAI,IAAI,CAAC;YACrC,KAAK,EAAE;gBACL,KAAK,EAAE,EAAE;aACV;YACD,QAAQ,EAAE,EAAE;YACZ,eAAe,EAAE,KAAK;SACvB,CAAC;QACF,IAAI,WAAW,EAAE;YACf,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;SAClC;QACD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;YACjC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE;YAClC,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;SAC9B;QACD,IAAI,OAAO,WAAW,KAAK,SAAS,EAAE;YACpC,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;SAClC;QACD,IAAI,KAAK,EAAE;YACT,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAChD,IAAI,KAAK,EAAE;gBACT,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAChC;SACF;QACD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YAChC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YAChC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/build/src/amf/ApiSchemaGenerator.d.ts

@@ -0,0 +1,55 @@
+import { IDataExample, IShapeUnion } from "./definitions/Shapes.js";
+import { ShapeBase, ShapeRenderOptions } from "./shape/ShapeBase.js";
+export interface ISchemaExample extends IDataExample {
+    /**
+     * The value to render as the example value.
+     */
+    renderValue?: string | number | boolean | null | undefined;
+    label?: string;
+}
+/**
+ * A class that processes AMF's Shape to auto-generate a schema from examples/type for a given media type.
+ * This should be used when examples for the Shape are not available but the application still needs to
+ * render an example or a schema from the Shape.
+ * If examples can be found directly in the shape, use the `ApiExampleGenerator` instead.
+ */
+export declare class ApiSchemaGenerator {
+    mime: string;
+    opts: Readonly<ShapeRenderOptions>;
+    generator?: ShapeBase;
+    /**
+     *
+     * @param mime The example mime type to format the generated example.
+     * @param opts Optional configuration.
+     */
+    constructor(mime: string, opts?: ShapeRenderOptions);
+    /**
+     * @param shape The Shape definition
+     * @param mime The mime type for the value.
+     * @returns Customized Example with the `renderValue` that is the generated Example value.
+     */
+    static asExample(shape: IShapeUnion, mime: string, opts?: ShapeRenderOptions): ISchemaExample | undefined;
+    /**
+     * @param shape The Shape definition
+     * @param mime The mime type for the value.
+     * @returns The generated schema
+     */
+    static asSchema(shape: IShapeUnion, mime: string, opts?: ShapeRenderOptions): string | number | boolean | null | undefined;
+    /**
+     * Generates the schema from the AMF shape.
+     *
+     * @param shape The Shape definition
+     */
+    generate(shape: IShapeUnion): string | number | boolean | null | undefined;
+    /**
+     * @link {#generate()}
+     * @param shape The Shape definition
+     */
+    toValue(shape: IShapeUnion): string | number | boolean | null | undefined;
+    /**
+     * Generates an API Example object with the value to render.
+     * @param shape The Shape definition
+     * @returns Customized Example with the `renderValue` that is the generated Example value.
+     */
+    toExample(shape: IShapeUnion): ISchemaExample | undefined;
+}

package/build/src/amf/ApiSchemaGenerator.js

@@ -0,0 +1,94 @@
+import { AmfNamespace as ns } from "./definitions/Namespace.js";
+import { ShapeJsonSchemaGenerator } from './shape/ShapeJsonSchemaGenerator.js';
+import { ShapeXmlSchemaGenerator } from './shape/ShapeXmlSchemaGenerator.js';
+/**
+ * A class that processes AMF's Shape to auto-generate a schema from examples/type for a given media type.
+ * This should be used when examples for the Shape are not available but the application still needs to
+ * render an example or a schema from the Shape.
+ * If examples can be found directly in the shape, use the `ApiExampleGenerator` instead.
+ */
+export class ApiSchemaGenerator {
+    mime;
+    opts;
+    generator;
+    /**
+     *
+     * @param mime The example mime type to format the generated example.
+     * @param opts Optional configuration.
+     */
+    constructor(mime, opts = {}) {
+        this.mime = mime;
+        this.opts = Object.freeze({ ...opts });
+        if (mime.includes('json')) {
+            this.generator = new ShapeJsonSchemaGenerator(opts);
+        }
+        else if (mime.includes('xml')) {
+            this.generator = new ShapeXmlSchemaGenerator(opts);
+        }
+    }
+    /**
+     * @param shape The Shape definition
+     * @param mime The mime type for the value.
+     * @returns Customized Example with the `renderValue` that is the generated Example value.
+     */
+    static asExample(shape, mime, opts) {
+        const generator = new ApiSchemaGenerator(mime, opts);
+        return generator.toExample(shape);
+    }
+    /**
+     * @param shape The Shape definition
+     * @param mime The mime type for the value.
+     * @returns The generated schema
+     */
+    static asSchema(shape, mime, opts) {
+        const generator = new ApiSchemaGenerator(mime, opts);
+        return generator.toValue(shape);
+    }
+    /**
+     * Generates the schema from the AMF shape.
+     *
+     * @param shape The Shape definition
+     */
+    generate(shape) {
+        const { generator } = this;
+        if (!generator) {
+            return undefined;
+        }
+        return generator.generate(shape);
+    }
+    /**
+     * @link {#generate()}
+     * @param shape The Shape definition
+     */
+    toValue(shape) {
+        return this.generate(shape);
+    }
+    /**
+     * Generates an API Example object with the value to render.
+     * @param shape The Shape definition
+     * @returns Customized Example with the `renderValue` that is the generated Example value.
+     */
+    toExample(shape) {
+        const renderValue = this.generate(shape);
+        if (renderValue === null || renderValue === undefined) {
+            return undefined;
+        }
+        const result = {
+            id: `${shape.id}/generated`,
+            strict: true,
+            types: [ns.aml.vocabularies.apiContract.Example],
+            mediaType: this.mime,
+            renderValue,
+            customDomainProperties: [],
+        };
+        const typed = shape;
+        if (Array.isArray(typed.examples) && typed.examples.length) {
+            const [example] = typed.examples;
+            if (example.value) {
+                result.value = example.value;
+            }
+        }
+        return result;
+    }
+}
+//# sourceMappingURL=ApiSchemaGenerator.js.map

package/build/src/amf/ApiSchemaGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiSchemaGenerator.js","sourceRoot":"","sources":["../../../src/amf/ApiSchemaGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAGhE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAU7E;;;;;GAKG;AACH,MAAM,OAAO,kBAAkB;IAUV;IATnB,IAAI,CAA+B;IAEnC,SAAS,CAAa;IAEtB;;;;OAIG;IACH,YAAmB,IAAY,EAAE,OAA2B,EAAE;QAA3C,SAAI,GAAJ,IAAI,CAAQ;QAC7B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACzB,IAAI,CAAC,SAAS,GAAG,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC;SACrD;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,uBAAuB,CAAC,IAAI,CAAC,CAAC;SACpD;IACH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,KAAkB,EAAE,IAAY,EAAE,IAAyB;QAC1E,MAAM,SAAS,GAAG,IAAI,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrD,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAkB,EAAE,IAAY,EAAE,IAAyB;QACzE,MAAM,SAAS,GAAG,IAAI,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrD,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,KAAkB;QACzB,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,KAAkB;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,KAAkB;QAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,WAAW,KAAK,IAAI,IAAI,WAAW,KAAK,SAAS,EAAE;YACrD,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,MAAM,GAAmB;YAC7B,EAAE,EAAE,GAAG,KAAK,CAAC,EAAE,YAAY;YAC3B,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC;YAChD,SAAS,EAAE,IAAI,CAAC,IAAI;YACpB,WAAW;YACX,sBAAsB,EAAE,EAAE;SAC3B,CAAC;QACF,MAAM,KAAK,GAAG,KAAkB,CAAC;QACjC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE;YAC1D,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;YACjC,IAAI,OAAO,CAAC,KAAK,EAAE;gBACjB,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;aAC9B;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}