@e22m4u/js-openapi 0.0.5

package/src/oa-document-builder.d.ts

@@ -0,0 +1,312 @@
+import {Optional} from './types.js';
+import {Service, ServiceContainer} from '@e22m4u/js-service';
+import {OADocumentScope, OADocumentScopeOptions} from './oa-document-scope.js';
+
+import {
+  OADocumentObject,
+  OAOperationMethod,
+  OAOperationObject,
+} from './oa-specification.js';
+
+import {
+  OALinkObject,
+  OASchemaObject,
+  OAHeaderObject,
+  OAExampleObject,
+  OACallbackObject,
+  OAResponseObject,
+  OAPathItemObject,
+  OAReferenceObject,
+  OAParameterObject,
+  OARequestBodyObject,
+  OASecuritySchemeObject,
+} from './oa-specification.js';
+
+/**
+ * Component type.
+ */
+export declare const OAComponentType: {
+  SCHEMA: 'schema';
+  RESPONSE: 'response';
+  PARAMETER: 'parameter';
+  EXAMPLE: 'example';
+  REQUEST_BODY: 'requestBody';
+  HEADER: 'header';
+  SECURITY_SCHEME: 'securityScheme';
+  LINK: 'link';
+  CALLBACK: 'callback';
+  PATH_ITEM: 'pathItem';
+};
+
+export type OAComponentType =
+  (typeof OAComponentType)[keyof typeof OAComponentType];
+
+/**
+ * Component types.
+ */
+export declare const OA_COMPONENT_TYPES: OAComponentType[];
+
+/**
+ * Component type to components key map.
+ */
+export declare const OA_COMPONENT_TYPE_TO_COMPONENTS_KEY_MAP: {
+  [OAComponentType.SCHEMA]: 'schemas';
+  [OAComponentType.RESPONSE]: 'responses';
+  [OAComponentType.PARAMETER]: 'parameters';
+  [OAComponentType.EXAMPLE]: 'examples';
+  [OAComponentType.REQUEST_BODY]: 'requestBodies';
+  [OAComponentType.HEADER]: 'headers';
+  [OAComponentType.SECURITY_SCHEME]: 'securitySchemes';
+  [OAComponentType.LINK]: 'links';
+  [OAComponentType.CALLBACK]: 'callbacks';
+  [OAComponentType.PATH_ITEM]: 'pathItems';
+};
+
+/**
+ * Schema component definition.
+ */
+export type OASchemaComponentDefinition = {
+  name: string;
+  schema: OASchemaObject;
+};
+
+/**
+ * Response component definition.
+ */
+export type OAResponseComponentDefinition = {
+  name: string;
+  response: OAResponseObject | OAReferenceObject;
+};
+
+/**
+ * Parameter component definition.
+ */
+export type OAParameterComponentDefinition = {
+  name: string;
+  parameter: OAParameterObject | OAReferenceObject;
+};
+
+/**
+ * Example component definition.
+ */
+export type OAExampleComponentDefinition = {
+  name: string;
+  example: OAExampleObject | OAReferenceObject;
+};
+
+/**
+ * Request body component definition.
+ */
+export type OARequestBodyComponentDefinition = {
+  name: string;
+  requestBody: OARequestBodyObject | OAReferenceObject;
+};
+
+/**
+ * Header component definition.
+ */
+export type OAHeaderComponentDefinition = {
+  name: string;
+  header: OAHeaderObject | OAReferenceObject;
+};
+
+/**
+ * Security scheme component definition.
+ */
+export type OASecuritySchemeComponentDefinition = {
+  name: string;
+  securityScheme: OASecuritySchemeObject | OAReferenceObject;
+};
+
+/**
+ * Link component definition.
+ */
+export type OALinkComponentDefinition = {
+  name: string;
+  link: OALinkObject | OAReferenceObject;
+};
+
+/**
+ * Callback component definition.
+ */
+export type OACallbackComponentDefinition = {
+  name: string;
+  callback: OACallbackObject | OAReferenceObject;
+};
+
+/**
+ * Path item component definition.
+ */
+export type OAPathItemComponentDefinition = {
+  name: string;
+  pathItem: OAPathItemObject | OAReferenceObject;
+};
+
+/**
+ * Operation definition.
+ */
+export type OAOperationDefinition = {
+  path: string;
+  method: OAOperationMethod;
+  operation: OAOperationObject;
+};
+
+/**
+ * Document input.
+ */
+export type OADocumentInput = Optional<OADocumentObject, 'openapi' | 'info'>;
+
+/**
+ * Document builder.
+ */
+export declare class OADocumentBuilder extends Service {
+  /**
+   * Constructor.
+   *
+   * @param container
+   * @param document
+   */
+  constructor(container: ServiceContainer, document?: OADocumentInput);
+
+  /**
+   * Constructor.
+   *
+   * @param document
+   */
+  constructor(document?: OADocumentInput);
+
+  /**
+   * Constructor.
+   *
+   * @param containerOrDocument
+   * @param document
+   */
+  constructor(
+    containerOrDocument?: ServiceContainer | OADocumentInput,
+    document?: OADocumentInput,
+  );
+
+  /**
+   * Define component.
+   *
+   * @param type
+   * @param definition
+   */
+  defineComponent(type: OAComponentType, definition: object): this;
+
+  /**
+   * Has component.
+   *
+   * @param type
+   * @param name
+   */
+  hasComponent(type: OAComponentType, name: string): boolean;
+
+  /**
+   * Get component.
+   *
+   * @param type
+   * @param name
+   */
+  getComponent<T = any>(type: OAComponentType, name: string): T;
+
+  /**
+   * Define schema component.
+   *
+   * @param schemaDef
+   */
+  defineSchemaComponent(schemaDef: OASchemaComponentDefinition): this;
+
+  /**
+   * Define response component.
+   *
+   * @param responseDef
+   */
+  defineResponseComponent(responseDef: OAResponseComponentDefinition): this;
+
+  /**
+   * Define parameter component.
+   *
+   * @param parameterDef
+   */
+  defineParameterComponent(parameterDef: OAParameterComponentDefinition): this;
+
+  /**
+   * Define example component.
+   *
+   * @param exampleDef
+   */
+  defineExampleComponent(exampleDef: OAExampleComponentDefinition): this;
+
+  /**
+   * Define request body component.
+   *
+   * @param requestBodyDef
+   */
+  defineRequestBodyComponent(
+    requestBodyDef: OARequestBodyComponentDefinition,
+  ): this;
+
+  /**
+   * Define header component.
+   *
+   * @param headerDef
+   */
+  defineHeaderComponent(headerDef: OAHeaderComponentDefinition): this;
+
+  /**
+   * Define security scheme component.
+   *
+   * @param securitySchemeDef
+   */
+  defineSecuritySchemeComponent(
+    securitySchemeDef: OASecuritySchemeComponentDefinition,
+  ): this;
+
+  /**
+   * Define link component.
+   *
+   * @param linkDef
+   */
+  defineLinkComponent(linkDef: OALinkComponentDefinition): this;
+
+  /**
+   * Define callback component.
+   *
+   * @param callbackDef
+   */
+  defineCallbackComponent(callbackDef: OACallbackComponentDefinition): this;
+
+  /**
+   * Define path item component.
+   *
+   * @param pathItemDef
+   */
+  definePathItemComponent(pathItemDef: OAPathItemComponentDefinition): this;
+
+  /**
+   * Define operation.
+   *
+   * @param operationDef
+   */
+  defineOperation(operationDef: OAOperationDefinition): this;
+
+  /**
+   * Create scope.
+   *
+   * @param options
+   */
+  createScope(options?: OADocumentScopeOptions): OADocumentScope;
+
+  /**
+   * Build.
+   */
+  build(): OADocumentObject;
+
+  /**
+   * Build JSON.
+   *
+   * @param space
+   */
+  buildJson(space?: string | number): string;
+}