Skip to content

Add support for the group element #1348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for the group element #1348

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 51 additions & 4 deletions src/wsdl/elements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,7 @@ export class RestrictionElement extends Element {
'all',
'choice',
'enumeration',
'group',
'sequence',
'attribute',
]);
Expand All @@ -416,7 +417,7 @@ export class RestrictionElement extends Element {
$attributes[child.$name] = child.description(definitions);
continue;
}
if (!isFirstChild && (child instanceof SequenceElement || child instanceof ChoiceElement)) {
if (!isFirstChild && (child instanceof SequenceElement || child instanceof ChoiceElement || child instanceof GroupElement)) {
isFirstChild = true;
desc = child.description(definitions, xmlns);
}
Expand Down Expand Up @@ -459,14 +460,15 @@ export class ExtensionElement extends Element {
public readonly allowedChildren = buildAllowedChildren([
'all',
'choice',
'group',
'sequence',
]);
public $base: string;

public description(definitions: DefinitionsElement, xmlns?: IXmlNs) {
let desc = {};
for (const child of this.children) {
if (child instanceof SequenceElement || child instanceof ChoiceElement) {
if (child instanceof SequenceElement || child instanceof GroupElement || child instanceof ChoiceElement) {
desc = child.description(definitions, xmlns);
}
}
Expand Down Expand Up @@ -499,6 +501,7 @@ export class ChoiceElement extends Element {
'any',
'choice',
'element',
'group',
'sequence',
]);
public description(definitions: DefinitionsElement, xmlns: IXmlNs) {
Expand All @@ -513,6 +516,42 @@ export class ChoiceElement extends Element {
}
}

export class GroupElement extends Element {
public readonly allowedChildren = buildAllowedChildren([
'annotation',
'all',
'choice',
'sequence',
]);

public $ref?: string;

// XSD allows min(/max)Occurs, but node-soap currently only pluralizes on element level
Copy link
Contributor

@smokhov smokhov Sep 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also explain this comment in relationship to:

node-soap/src/wsdl/elements.ts

Line 207 in 012457e

public $minOccurs?: string;

I am curious.

// public $minOccurs?: string;
// public $maxOccurs?: string;

public description(definitions?: DefinitionsElement, xmlns?: IXmlNs) {
if (this.$ref) {
const q = splitQName(this.$ref);
const ns = findNs(q.prefix, xmlns, this.xmlns, this.schemaXmlns, this.definitionsXmlns, definitions.xmlns);
const schema = ns && definitions.schemas[ns];
const defn = schema && (schema as any).groups && schema.groups[q.name];
if (defn) {
return defn.description(definitions, schema.xmlns);
}
debug(`Unable to resolve group ref: ${this.$ref}`);
return {};
}

for (const child of this.children) {
if (child instanceof SequenceElement || child instanceof ChoiceElement || child instanceof AllElement) {
return child.description(definitions, xmlns);
}
}
return {};
}
}

export class EnumerationElement extends Element {
// no children
public description(): string {
Expand All @@ -526,6 +565,7 @@ export class ComplexTypeElement extends Element {
'annotation',
'choice',
'complexContent',
'group',
'sequence',
'simpleContent',
'attribute',
Expand All @@ -543,6 +583,7 @@ export class ComplexTypeElement extends Element {

if (!isFirstChild && (child instanceof ChoiceElement ||
child instanceof SequenceElement ||
child instanceof GroupElement ||
child instanceof AllElement ||
child instanceof SimpleContentElement ||
child instanceof ComplexContentElement)) {
Expand Down Expand Up @@ -594,6 +635,7 @@ export class SequenceElement extends Element {
'any',
'choice',
'element',
'group',
'sequence',
]);
public description(definitions: DefinitionsElement, xmlns: IXmlNs) {
Expand Down Expand Up @@ -626,7 +668,7 @@ export class AttributeElement extends Element {

export class AllElement extends Element {
public readonly allowedChildren = buildAllowedChildren([
'choice',
'choice', // TODO: W3C doesn't allow this as a child to AllElement
'element',
]);
public description(definitions: DefinitionsElement, xmlns: IXmlNs) {
Expand Down Expand Up @@ -849,11 +891,13 @@ export class SchemaElement extends Element {
public readonly allowedChildren = buildAllowedChildren([
'complexType',
'element',
'group',
'import',
'include',
'simpleType',
]);
public complexTypes: { [name: string]: ComplexTypeElement } = {};
public groups: { [name: string]: GroupElement } = {};
public types: { [name: string]: SimpleTypeElement } = {};
public elements: { [name: string]: ElementElement } = {};
public includes: IInclude[] = [];
Expand All @@ -863,6 +907,7 @@ export class SchemaElement extends Element {
assert(source instanceof SchemaElement);

_.merge(this.complexTypes, source.complexTypes);
_.merge(this.groups, source.groups);
_.merge(this.types, source.types);
_.merge(this.elements, source.elements);
_.merge(this.xmlns, source.xmlns);
Expand Down Expand Up @@ -891,6 +936,8 @@ export class SchemaElement extends Element {
this.complexTypes[child.$name] = child;
} else if (child instanceof ElementElement) {
this.elements[child.$name] = child;
} else if (child instanceof GroupElement && child.$name) {
this.groups[child.$name] = child;
} else if (child instanceof SimpleTypeElement) {
this.types[child.$name] = child;
}
Expand Down Expand Up @@ -1242,7 +1289,6 @@ export class ImportElement extends Element {
const ElementTypeMap: {
[k: string]: typeof Element;
} = {
// group: [GroupElement, 'element group'],
all: AllElement,
any: AnyElement,
binding: BindingElement,
Expand All @@ -1256,6 +1302,7 @@ const ElementTypeMap: {
enumeration: EnumerationElement,
extension: ExtensionElement,
fault: Element,
group: GroupElement,
import: ImportElement,
include: IncludeElement,
input: InputElement,
Expand Down