Skip to content
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.

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

refactor: port components model #548

Merged
merged 2 commits into from
May 16, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
57 changes: 30 additions & 27 deletions src/models/components.ts
Original file line number Diff line number Diff line change
@@ -1,33 +1,36 @@
import type { BaseModel } from './base';
import type { Collection } from './collection';
import type { ServersInterface } from './servers';
import type { ChannelsInterface } from './channels';
import type { OperationsInterface } from './operations';
import type { OperationTraitsInterface } from './operation-traits';
import type { MessagesInterface } from './messages';
import type { MessageTraitsInterface } from './message-traits';
import type { SchemasInterface } from './schemas';
import type { ChannelParametersInterface } from './channel-parameters';
import type { ServerVariablesInterface } from './server-variables';
import type { ServerInterface } from './server';
import type { ChannelInterface } from './channel';
import type { OperationInterface } from './operation';
import type { OperationTraitInterface } from './operation-trait';
import type { MessageInterface } from './message';
import type { MessageTraitInterface } from './message-trait';
import type { SchemaInterface } from './schema';
import type { ChannelParameterInterface } from './channel-parameter';
import type { ServerVariableInterface } from './server-variable';
import type { CorrelationIdInterface } from './correlation-id';
import type { ExternalDocumentationInterface } from './external-docs';
import type { TagInterface } from './tag';
import type { BindingsInterface } from './bindings';
import type { SecuritySchemesInterface } from './security-schemes';
import type { SecuritySchemeInterface } from './security-scheme';
import type { ExtensionsMixinInterface } from './mixins';

export interface Components extends BaseModel, ExtensionsMixinInterface {
servers(): ServersInterface;
channels(): ChannelsInterface;
operations(): OperationsInterface;
messages(): MessagesInterface;
schemas(): SchemasInterface;
channelParameters(): ChannelParametersInterface;
serverVariables(): ServerVariablesInterface;
operationTraits(): OperationTraitsInterface;
messageTraits(): MessageTraitsInterface;
correlationIds(): Collection<CorrelationIdInterface>;
securitySchemes(): SecuritySchemesInterface;
serverBindings(): Collection<BindingsInterface>;
channelBindings(): Collection<BindingsInterface>;
operationBindings(): Collection<BindingsInterface>;
messageBindings(): Collection<BindingsInterface>;
export interface ComponentsInterface extends BaseModel, ExtensionsMixinInterface {
servers(): Record<string, ServerInterface>;
channels(): Record<string, ChannelInterface>;
operations(): Record<string, OperationInterface>;
messages(): Record<string, MessageInterface>;
schemas(): Record<string, SchemaInterface>;
channelParameters(): Record<string, ChannelParameterInterface>;
serverVariables(): Record<string, ServerVariableInterface>;
operationTraits(): Record<string, OperationTraitInterface>;
messageTraits(): Record<string, MessageTraitInterface>;
correlationIds(): Record<string, CorrelationIdInterface>;
externalDocs(): Record<string, ExternalDocumentationInterface>;
tags(): Record<string, TagInterface>;
Copy link
Member Author

Choose a reason for hiding this comment

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

More info asyncapi/spec#792

Copy link
Member

Choose a reason for hiding this comment

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

Why are you adding components that have yet to be accepted into the spec? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

Why not? Operations in 3.0.0 will land in components anyway.

Copy link
Member

Choose a reason for hiding this comment

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

Cause if the changes are rejected, they should not already be part of the parser 🙂 You still follow RFC.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, removed :P

securitySchemes(): Record<string, SecuritySchemeInterface>;
serverBindings(): Record<string, BindingsInterface>;
channelBindings(): Record<string, BindingsInterface>;
operationBindings(): Record<string, BindingsInterface>;
messageBindings(): Record<string, BindingsInterface>;
}
2 changes: 1 addition & 1 deletion src/models/v2/asyncapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export class AsyncAPIDocument extends Mixin(BaseModel, ExtensionsMixin) implemen

servers(): ServersInterface {
return new Servers(
Object.entries(this._json.servers).map(([serverName, server]) =>
Object.entries(this._json.servers || {}).map(([serverName, server]) =>
this.createModel(Server, server, { id: serverName, pointer: `/servers/${serverName}` })
)
);
Expand Down
123 changes: 123 additions & 0 deletions src/models/v2/components.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
import { BaseModel } from "../base";
import { Channel } from "./channel";
import { ChannelParameter } from "./channel-parameter";
import { CorrelationId } from "./correlation-id";
import { Message } from "./message";
import { MessageTrait } from "./message-trait";
import { Operation } from "./operation";
import { OperationTrait } from "./operation-trait";
import { Schema } from "./schema";
import { SecurityScheme } from "./security-scheme";
import { Server } from "./server";
import { ServerVariable } from "./server-variable";

import { Mixin } from '../utils';
import { Bindings, Binding } from "./mixins/bindings";
import { ExtensionsMixin } from './mixins/extensions';
import { ExternalDocumentation } from './mixins/external-docs';
import { Tag } from './mixins/tags';

import type { BindingsInterface } from "../bindings";
import type { ComponentsInterface } from "../components";
import type { ChannelInterface } from "../channel";
import type { ChannelParameterInterface } from "../channel-parameter";
import type { CorrelationIdInterface } from "../correlation-id";
import type { ExternalDocumentationInterface } from "../external-docs";
import type { TagInterface } from "../tag";
import type { MessageInterface } from "../message";
import type { MessageTraitInterface } from "../message-trait";
import type { OperationInterface } from "../operation";
import type { OperationTraitInterface } from "../operation-trait";
import type { SchemaInterface } from "../schema";
import type { SecuritySchemeInterface } from "../security-scheme";
import type { ServerInterface } from "../server";
import type { ServerVariableInterface } from "../server-variable";
import type { Constructor } from "../utils";

export class Components extends Mixin(BaseModel, ExtensionsMixin) implements ComponentsInterface {
servers(): Record<string, ServerInterface> {
return this.createMap('servers', Server);
}

channels(): Record<string, ChannelInterface> {
return this.createMap('channels', Channel);
}

operations(): Record<string, OperationInterface> {
return this.createMap('channels', Operation);
}

messages(): Record<string, MessageInterface> {
return this.createMap('messages', Message);
}

schemas(): Record<string, SchemaInterface> {
return this.createMap('schemas', Schema);
}

channelParameters(): Record<string, ChannelParameterInterface> {
return this.createMap('parameters', ChannelParameter);
}

serverVariables(): Record<string, ServerVariableInterface> {
return this.createMap('serverVariables', ServerVariable);
}

operationTraits(): Record<string, OperationTraitInterface> {
return this.createMap('operationTraits', OperationTrait);
}

messageTraits(): Record<string, MessageTraitInterface> {
return this.createMap('messageTraits', MessageTrait);
}

correlationIds(): Record<string, CorrelationIdInterface> {
return this.createMap('correlationIds', CorrelationId);
}

externalDocs(): Record<string, ExternalDocumentationInterface> {
return this.createMap('externalDocs', ExternalDocumentation);
}

tags(): Record<string, TagInterface> {
return this.createMap('tags', Tag);
}

securitySchemes(): Record<string, SecuritySchemeInterface> {
return this.createMap('securitySchemes', SecurityScheme);
}

serverBindings(): Record<string, BindingsInterface> {
return this.createBindings('serverBindings');
}

channelBindings(): Record<string, BindingsInterface> {
return this.createBindings('channelBindings');
}

operationBindings(): Record<string, BindingsInterface> {
return this.createBindings('operationBindings');
}

messageBindings(): Record<string, BindingsInterface> {
return this.createBindings('messageBindings');
}

protected createMap<M extends BaseModel>(itemsName: string, model: Constructor<M>): Record<string, M> {
return Object.entries(this._json[itemsName] || {}).reduce((items, [itemName, item]) => {
items[itemName] = this.createModel(model, item, { id: itemName, pointer: `/components/${itemsName}/${itemName}` })
return items;
}, {} as Record<string, M>);
}

protected createBindings(itemsName: string): Record<string, BindingsInterface> {
return Object.entries(this._json[itemsName] || {}).reduce((bindings, [name, item]) => {
bindings[name] = new Bindings(
Object.entries(item as any || {}).map(([protocol, binding]) =>
this.createModel(Binding, binding, { id: protocol, pointer: `components/${itemsName}/${name}/${protocol}` })
)
);
return bindings;
}, {} as Record<string, BindingsInterface>);
}
}
3 changes: 1 addition & 2 deletions src/models/v2/mixins/bindings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,8 @@ export class Bindings extends Collection<BindingInterface> implements BindingsIn

export abstract class BindingsMixin extends BaseModel implements BindingsMixinInterface {
bindings(): BindingsInterface {
const bindings: Record<string, any> = this._json.bindings || {};
return new Bindings(
Object.entries(bindings).map(([protocol, binding]) =>
Object.entries(this._json.bindings || {}).map(([protocol, binding]) =>
this.createModel(Binding, binding, { id: protocol, pointer: `${this._meta.pointer}/bindings/${protocol}` })
)
);
Expand Down
3 changes: 1 addition & 2 deletions src/models/v2/mixins/tags.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,8 @@ export class Tags extends Collection<TagInterface> implements TagsInterface {

export abstract class TagsMixin extends BaseModel implements TagsMixinInterface {
tags(): TagsInterface {
const tags = this._json.tags || [];
return new Tags(
tags.map((tag: any, idx: number) =>
(this._json.tags || []).map((tag: any, idx: number) =>
this.createModel(Tag, tag, { pointer: `${this._meta.pointer}/tags/${idx}` })
)
);
Expand Down
14 changes: 14 additions & 0 deletions src/models/v2/schemas.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { Collection } from '../collection';

import type { SchemasInterface } from '../schemas';
import type { SchemaInterface } from '../schema';

export class Schemas extends Collection<SchemaInterface> implements SchemasInterface {
override get(id: string): SchemaInterface | undefined {
return this.collections.find(schema => schema.uid() === id);
}

override has(id: string): boolean {
return this.collections.some(schema => schema.uid() === id);
}
}
Loading