@api-client/core 0.6.13 → 0.6.16

package/build/src/amf/shape/ShapeXmlSchemaGenerator.d.ts

@@ -0,0 +1,84 @@
+import { ShapeBase } from './ShapeBase.js';
+import { IAnyShape, IArrayShape, IDataExample, IDataNodeUnion, INodeShape, IPropertyShape, IScalarShape, IShapeUnion, IUnionShape } from "../definitions/Shapes.js";
+interface IProcessNodeOptions {
+    forceName?: string;
+    indent?: number;
+    noWrap?: boolean;
+}
+interface ICollectExamplesOptions {
+    nodeName?: string;
+    indent?: number;
+    isWrapped?: boolean;
+    tagFill?: string;
+}
+/**
+ * Normalizes given name to a value that can be accepted by `createElement`
+ * function on a document object.
+ * @param name A name to process
+ * @returns The normalized name
+ */
+export declare const normalizeXmlTagName: (name: string) => string;
+export declare function shapeToXmlTagName(shape: IAnyShape): string;
+export declare class ShapeXmlSchemaGenerator extends ShapeBase {
+    /**
+     * Generates a XML example from the structured value.
+     *
+     * @param schema The Shape definition
+     */
+    generate(schema: IShapeUnion): string;
+    /**
+     * Processes the Shape definition and returns a JavaScript object or array.
+     */
+    processNode(schema: IShapeUnion, options?: IProcessNodeOptions): string;
+    /**
+     * Serializes generated JS value according to the mime type.
+     */
+    serialize(value: any): string | undefined;
+    /**
+     * Picks the union member to render.
+     */
+    protected _readCurrentUnion(anyOf: IShapeUnion[]): IShapeUnion;
+    protected _collectProperties(schema: INodeShape): IPropertyShape[];
+    protected _nodeShapeObject(schema: INodeShape, options?: IProcessNodeOptions): string;
+    protected _scalarShapeObject(schema: IScalarShape, options?: IProcessNodeOptions): any;
+    protected _nilShapeObject(schema: IScalarShape, options?: IProcessNodeOptions): any | undefined;
+    /**
+     * @returns The value for the property or undefined when cannot generate the value.
+     */
+    protected _propertyShapeObject(schema: IPropertyShape, options?: IProcessNodeOptions): string | undefined;
+    protected _collectExamples(schema: IShapeUnion, opts?: ICollectExamplesOptions): string | undefined;
+    protected _createTabs(indent?: number, offset?: number): string;
+    protected _nodePropertyObject(schema: IPropertyShape<INodeShape>, options?: IProcessNodeOptions): string;
+    protected _nodePropertyArray(schema: IPropertyShape<IArrayShape>, options?: IProcessNodeOptions): string;
+    protected _arrayShapeObject(schema: IArrayShape, options?: IProcessNodeOptions): string;
+    /**
+     * Creates an example from an array shape when the items is the scalar shape.
+     * Note, it assumes the previous step tested whether the `items` is scalar.
+     *
+     * @param schema The array schema
+     * @param options Processing options.
+     */
+    protected _scalarItems(schema: IArrayShape<IScalarShape>, options?: IProcessNodeOptions): string;
+    /**
+     * Renders a NodeShape as an array item.
+     *
+     * @param schema The array shape with item that is NodeShape.
+     * @param options Rendering options.
+     */
+    protected _nodeItems(schema: IArrayShape<INodeShape>, options?: IProcessNodeOptions): string;
+    /**
+     * @param example The example to turn into a JS object
+     */
+    protected _exampleToObject(example?: IDataExample): any;
+    protected _unionShapeObject(schema: IUnionShape, options?: IProcessNodeOptions): any;
+    /**
+     * @param schema The schema with unions
+     * @param defaultValue The definition of a default value.
+     */
+    protected _unionDefaultValue(schema: IShapeUnion, defaultValue: IDataNodeUnion, options?: IProcessNodeOptions): any | undefined;
+    protected _fileShapeObject(): any;
+    protected _schemaShapeObject(): any;
+    protected _tupleShapeObject(): any;
+    protected _anyShapeObject(schema: IAnyShape): string;
+}
+export {};