@api-client/core 0.7.12 → 0.8.0

package/build/src/amf/definitions/Api.d.ts

@@ -1,7 +1,7 @@
-import { IDomainProperty } from "./Base.js";
-import { IDataExample, IDataNode, IDataNodeUnion, IShapeUnion } from "./Shapes.js";
+import { IApiDomainProperty } from "./Base.js";
+import { IApiDataExample, IApiDataNode, IApiDataNodeUnion, IShapeUnion } from "./Shapes.js";
 export declare type IScalarDataTypes = 'string' | 'base64Binary' | 'boolean' | 'date' | 'dateTime' | 'double' | 'float' | 'integer' | 'long' | 'number' | 'time';
-export interface ApiSummary extends IDomainProperty {
+export interface IApiSummary extends IApiDomainProperty {
     name?: string;
     description?: string;
     schemes: string[];
@@ -9,46 +9,46 @@ export interface ApiSummary extends IDomainProperty {
     contentType: string[];
     version?: string;
     termsOfService?: string;
-    provider?: ApiOrganization;
-    license?: ApiLicense;
-    documentations: ApiDocumentation[];
-    tags: ApiTag[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    provider?: IApiOrganization;
+    license?: IApiLicense;
+    documentations: IApiDocumentation[];
+    tags: IApiTag[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiBase extends ApiSummary {
-    endPoints: ApiEndPoint[];
-    servers: ApiServer[];
-    security: ApiSecurityRequirement[];
+export interface IApiBase extends IApiSummary {
+    endPoints: IApiEndPoint[];
+    servers: IApiServer[];
+    security: IApiSecurityRequirement[];
 }
-export interface ApiWeb extends ApiBase {
+export interface IApiWeb extends IApiBase {
 }
-export interface ApiAsync extends ApiBase {
+export interface IApiAsync extends IApiBase {
 }
-export interface ApiOrganization extends IDomainProperty {
+export interface IApiOrganization extends IApiDomainProperty {
     url?: string;
     name?: string;
     email?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiLicense extends IDomainProperty {
+export interface IApiLicense extends IApiDomainProperty {
     url?: string;
     name?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiEndPoint extends IDomainProperty {
+export interface IApiEndPoint extends IApiDomainProperty {
     description?: string;
     name?: string;
     summary?: string;
     path: string;
-    operations: ApiOperation[];
-    parameters: ApiParameter[];
-    payloads: ApiPayload[];
-    servers: ApiServer[];
-    security: ApiSecurityRequirement[];
-    sourceMaps?: ApiDocumentSourceMaps;
-    extends: ApiParametrizedDeclaration[];
-}
-export interface ApiOperation extends IDomainProperty {
+    operations: IApiOperation[];
+    parameters: IApiParameter[];
+    payloads: IApiPayload[];
+    servers: IApiServer[];
+    security: IApiSecurityRequirement[];
+    sourceMaps?: IApiDocumentSourceMaps;
+    extends: IApiParametrizedDeclaration[];
+}
+export interface IApiOperation extends IApiDomainProperty {
     method: string;
     name?: string;
     description?: string;
@@ -58,30 +58,30 @@ export interface ApiOperation extends IDomainProperty {
     accepts?: string[];
     contentType?: string[];
     operationId?: string;
-    documentation?: ApiDocumentation;
-    request?: ApiRequest;
-    responses: ApiResponse[];
-    security: ApiSecurityRequirement[];
-    callbacks: ApiCallback[];
-    servers: ApiServer[];
-    tags: ApiTag[];
-    sourceMaps?: ApiDocumentSourceMaps;
-    extends: ApiParametrizedTrait[];
-}
-export interface ApiTag extends IDomainProperty {
+    documentation?: IApiDocumentation;
+    request?: IApiRequest;
+    responses: IApiResponse[];
+    security: IApiSecurityRequirement[];
+    callbacks: IApiCallback[];
+    servers: IApiServer[];
+    tags: IApiTag[];
+    sourceMaps?: IApiDocumentSourceMaps;
+    extends: IApiParametrizedTrait[];
+}
+export interface IApiTag extends IApiDomainProperty {
     name: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiServer extends IDomainProperty {
+export interface IApiServer extends IApiDomainProperty {
     url: string;
     description?: string;
-    variables: ApiParameter[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    variables: IApiParameter[];
+    sourceMaps?: IApiDocumentSourceMaps;
     protocol?: string;
     protocolVersion?: string;
-    security?: ApiSecurityRequirement[];
+    security?: IApiSecurityRequirement[];
 }
-export interface ApiParameter extends IDomainProperty {
+export interface IApiParameter extends IApiDomainProperty {
     name?: string;
     paramName?: string;
     description?: string;
@@ -93,199 +93,199 @@ export interface ApiParameter extends IDomainProperty {
     allowReserved?: boolean;
     binding?: string;
     schema?: IShapeUnion;
-    payloads: ApiPayload[];
-    examples: IDataExample[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    payloads: IApiPayload[];
+    examples: IApiDataExample[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiPayload extends IDomainProperty {
+export interface IApiPayload extends IApiDomainProperty {
     name?: string;
     mediaType?: string;
     schema?: IShapeUnion;
-    examples: IDataExample[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    examples: IApiDataExample[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiResponse extends IDomainProperty {
+export interface IApiResponse extends IApiDomainProperty {
     name?: string;
     description?: string;
     statusCode?: string;
-    headers: ApiParameter[];
-    payloads: ApiPayload[];
-    examples: IDataExample[];
-    links: ApiTemplatedLink[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    headers: IApiParameter[];
+    payloads: IApiPayload[];
+    examples: IApiDataExample[];
+    links: IApiTemplatedLink[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiTemplatedLink extends IDomainProperty {
+export interface IApiTemplatedLink extends IApiDomainProperty {
     name?: string;
     description?: string;
     template?: string;
     operationId?: string;
     requestBody?: string;
-    mapping: ApiIriTemplateMapping[];
-    server?: ApiServer;
-    sourceMaps?: ApiDocumentSourceMaps;
+    mapping: IApiIriTemplateMapping[];
+    server?: IApiServer;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiIriTemplateMapping extends IDomainProperty {
+export interface IApiIriTemplateMapping extends IApiDomainProperty {
     templateVariable?: string;
     linkExpression?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityRequirement extends IDomainProperty {
+export interface IApiSecurityRequirement extends IApiDomainProperty {
     name?: string;
-    schemes: ApiParametrizedSecurityScheme[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    schemes: IApiParametrizedSecurityScheme[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiParametrizedSecurityScheme extends IDomainProperty {
+export interface IApiParametrizedSecurityScheme extends IApiDomainProperty {
     name?: string;
-    settings?: ApiSecuritySettingsUnion;
-    scheme?: ApiSecurityScheme;
-    sourceMaps?: ApiDocumentSourceMaps;
+    settings?: IApiSecuritySettingsUnion;
+    scheme?: IApiSecurityScheme;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityScheme extends IDomainProperty {
+export interface IApiSecurityScheme extends IApiDomainProperty {
     name?: string;
     type?: string;
     displayName?: string;
     description?: string;
-    settings?: ApiSecuritySettingsUnion;
-    headers: ApiParameter[];
-    queryParameters: ApiParameter[];
-    responses: ApiResponse[];
+    settings?: IApiSecuritySettingsUnion;
+    headers: IApiParameter[];
+    queryParameters: IApiParameter[];
+    responses: IApiResponse[];
     queryString?: IShapeUnion;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecuritySettings extends IDomainProperty {
-    additionalProperties?: IDataNodeUnion;
-    sourceMaps?: ApiDocumentSourceMaps;
+export interface IApiSecuritySettings extends IApiDomainProperty {
+    additionalProperties?: IApiDataNodeUnion;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityOAuth1Settings extends ApiSecuritySettings {
+export interface IApiSecurityOAuth1Settings extends IApiSecuritySettings {
     requestTokenUri?: string;
     authorizationUri?: string;
     tokenCredentialsUri?: string;
     signatures: string[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityOAuth2Settings extends ApiSecuritySettings {
+export interface IApiSecurityOAuth2Settings extends IApiSecuritySettings {
     authorizationGrants: string[];
-    flows: ApiSecurityOAuth2Flow[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    flows: IApiSecurityOAuth2Flow[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityApiKeySettings extends ApiSecuritySettings {
+export interface IApiSecurityApiKeySettings extends IApiSecuritySettings {
     name?: string;
     in?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityHttpSettings extends ApiSecuritySettings {
+export interface IApiSecurityHttpSettings extends IApiSecuritySettings {
     scheme?: string;
     bearerFormat?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityOpenIdConnectSettings extends ApiSecuritySettings {
+export interface IApiSecurityOpenIdConnectSettings extends IApiSecuritySettings {
     url?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export declare type ApiSecuritySettingsUnion = ApiSecuritySettings | ApiSecurityOAuth1Settings | ApiSecurityOAuth2Settings | ApiSecurityApiKeySettings | ApiSecurityHttpSettings | ApiSecurityOpenIdConnectSettings;
-export interface ApiSecurityOAuth2Flow extends IDomainProperty {
+export declare type IApiSecuritySettingsUnion = IApiSecuritySettings | IApiSecurityOAuth1Settings | IApiSecurityOAuth2Settings | IApiSecurityApiKeySettings | IApiSecurityHttpSettings | IApiSecurityOpenIdConnectSettings;
+export interface IApiSecurityOAuth2Flow extends IApiDomainProperty {
     authorizationUri?: string;
     accessTokenUri?: string;
     flow?: string;
     refreshUri?: string;
-    scopes: ApiSecurityScope[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    scopes: IApiSecurityScope[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiSecurityScope extends IDomainProperty {
+export interface IApiSecurityScope extends IApiDomainProperty {
     name?: string;
     description?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiRequest extends IDomainProperty {
+export interface IApiRequest extends IApiDomainProperty {
     description?: string;
     required?: boolean;
-    queryParameters: ApiParameter[];
-    headers: ApiParameter[];
-    payloads: ApiPayload[];
+    queryParameters: IApiParameter[];
+    headers: IApiParameter[];
+    payloads: IApiPayload[];
     queryString?: IShapeUnion;
-    uriParameters: ApiParameter[];
-    cookieParameters: ApiParameter[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    uriParameters: IApiParameter[];
+    cookieParameters: IApiParameter[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiCallback extends IDomainProperty {
+export interface IApiCallback extends IApiDomainProperty {
     name?: string;
     expression?: string;
-    endpoint?: ApiEndPoint;
-    sourceMaps?: ApiDocumentSourceMaps;
+    endpoint?: IApiEndPoint;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
 /**
  * The definition of the domain extension
  */
-export interface ApiCustomDomainExtension extends IDomainProperty {
+export interface IApiCustomDomainExtension extends IApiDomainProperty {
     name?: string;
     displayName?: string;
     description?: string;
     domain: string[];
     schema?: IShapeUnion;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
 /**
  * Applies to an object domain extension
  */
-export interface ApiDomainExtension extends IDomainProperty {
+export interface IApiDomainExtension extends IApiDomainProperty {
     name?: string;
-    definedBy?: ApiCustomDomainExtension;
-    extension?: IDataNodeUnion;
-    sourceMaps?: ApiDocumentSourceMaps;
+    definedBy?: IApiCustomDomainExtension;
+    extension?: IApiDataNodeUnion;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiDocumentation extends IDomainProperty {
+export interface IApiDocumentation extends IApiDomainProperty {
     url?: string;
     description?: string;
     title?: string;
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiEncoding {
+export interface IApiEncoding {
     propertyName?: string;
     contentType?: string;
     style?: string;
     explode?: boolean;
     allowReserved?: boolean;
-    headers: ApiParameter[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    headers: IApiParameter[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiDocumentSourceMaps {
+export interface IApiDocumentSourceMaps {
     id?: string;
     types?: string[];
-    synthesizedField?: ApiSynthesizedField[];
-    lexical?: ApiSynthesizedField[];
-    trackedElement?: ApiSynthesizedField;
-    autoGeneratedName?: ApiSynthesizedField[];
-    parsedJsonSchema?: ApiSynthesizedField;
-    declaredElement?: ApiSynthesizedField;
-}
-export interface ApiSynthesizedField {
+    synthesizedField?: IApiSynthesizedField[];
+    lexical?: IApiSynthesizedField[];
+    trackedElement?: IApiSynthesizedField;
+    autoGeneratedName?: IApiSynthesizedField[];
+    parsedJsonSchema?: IApiSynthesizedField;
+    declaredElement?: IApiSynthesizedField;
+}
+export interface IApiSynthesizedField {
     id: string;
     element?: string;
     value: string;
 }
-export interface ApiParametrizedDeclaration extends IDomainProperty {
+export interface IApiParametrizedDeclaration extends IApiDomainProperty {
     name?: string;
-    target?: ApiAbstractDeclaration;
-    variables: ApiVariableValue[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    target?: IApiAbstractDeclaration;
+    variables: IApiVariableValue[];
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiVariableValue extends IDomainProperty {
+export interface IApiVariableValue extends IApiDomainProperty {
     name: string;
-    value?: IDataNode;
-    sourceMaps?: ApiDocumentSourceMaps;
+    value?: IApiDataNode;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiAbstractDeclaration extends IDomainProperty {
+export interface IApiAbstractDeclaration extends IApiDomainProperty {
     name: string;
     description?: string;
-    dataNode?: IDataNode;
+    dataNode?: IApiDataNode;
     variables: string[];
-    sourceMaps?: ApiDocumentSourceMaps;
+    sourceMaps?: IApiDocumentSourceMaps;
 }
-export interface ApiParametrizedTrait extends ApiParametrizedDeclaration {
+export interface IApiParametrizedTrait extends IApiParametrizedDeclaration {
 }
-export interface ApiParametrizedResourceType extends ApiParametrizedDeclaration {
+export interface IApiParametrizedResourceType extends IApiParametrizedDeclaration {
 }
-export interface ShapeProcessingOptions {
+export interface IShapeProcessingOptions {
     /**
      * This is set when serializing a shape / parameter.
      * It is used to determine which example of the schema to include.
@@ -304,8 +304,8 @@ export interface ShapeProcessingOptions {
  * - `custom`: custom base URI value (entered by the user)
  * - `extra`: an application controlled server value selected by the user.
  */
-export declare type ServerType = 'server' | 'custom' | 'extra';
-export declare type SelectionType = 'summary' | 'resource' | 'operation' | 'schema' | 'security' | 'documentation';
+export declare type IServerType = 'server' | 'custom' | 'extra';
+export declare type ISelectionType = 'summary' | 'resource' | 'operation' | 'schema' | 'security' | 'documentation';
 /**
  * API navigation layout options.
  *
@@ -314,8 +314,8 @@ export declare type SelectionType = 'summary' | 'resource' | 'operation' | 'sche
  * - natural-sort - as `natural` but endpoints are sorted by name.
  * - off (or none) - just like in the API spec.
  */
-export declare type NavigationLayout = 'tree' | 'natural' | 'natural-sort' | 'off';
-export interface SelectableMenuItem {
+export declare type INavigationLayout = 'tree' | 'natural' | 'natural-sort' | 'off';
+export interface ISelectableMenuItem {
     /**
      * Whether the item is a selected menu item.
      */
@@ -326,13 +326,13 @@ export interface SelectableMenuItem {
      */
     secondarySelected?: boolean;
 }
-export interface EditableMenuItem {
+export interface IEditableMenuItem {
     /**
      * When set the name editor for the item is enabled.
      */
     nameEditor?: boolean;
 }
-export interface ApiEndPointListItem {
+export interface IApiEndPointListItem {
     /**
      * The domain id of the endpoint.
      * It may be undefined when the endpoint is created "abstract" endpoint vor the visualization.
@@ -341,41 +341,41 @@ export interface ApiEndPointListItem {
     path: string;
     name?: string;
 }
-export interface ApiEndPointWithOperationsListItem extends ApiEndPointListItem {
-    operations: ApiOperationListItem[];
+export interface IApiEndPointWithOperationsListItem extends IApiEndPointListItem {
+    operations: IApiOperationListItem[];
 }
-export interface ApiOperationListItem {
+export interface IApiOperationListItem {
     id: string;
     method: string;
     name?: string;
 }
-export interface ApiEndpointsTreeItem extends ApiEndPointWithOperationsListItem {
+export interface IApiEndpointsTreeItem extends IApiEndPointWithOperationsListItem {
     label: string;
     indent: number;
     hasShortPath?: boolean;
     hasChildren?: boolean;
 }
-export interface ApiSecuritySchemeListItem {
+export interface IApiSecuritySchemeListItem {
     id: string;
     type: string;
     name?: string;
     displayName?: string;
     types: string[];
 }
-export declare interface ApiNodeShapeListItem {
+export declare interface IApiNodeShapeListItem {
     id: string;
     name?: string;
     displayName?: string;
 }
-export interface EndpointItem extends ApiEndpointsTreeItem, SelectableMenuItem, EditableMenuItem {
-    operations: OperationItem[];
+export interface IEndpointItem extends IApiEndpointsTreeItem, ISelectableMenuItem, IEditableMenuItem {
+    operations: IOperationItem[];
 }
-export interface OperationItem extends ApiOperationListItem, SelectableMenuItem, EditableMenuItem {
+export interface IOperationItem extends IApiOperationListItem, ISelectableMenuItem, IEditableMenuItem {
 }
-export interface NodeShapeItem extends ApiNodeShapeListItem, SelectableMenuItem, EditableMenuItem {
+export interface INodeShapeItem extends IApiNodeShapeListItem, ISelectableMenuItem, IEditableMenuItem {
 }
-export interface SecurityItem extends ApiSecuritySchemeListItem, SelectableMenuItem {
+export interface ISecurityItem extends IApiSecuritySchemeListItem, ISelectableMenuItem {
 }
-export interface DocumentationItem extends ApiDocumentation, SelectableMenuItem, EditableMenuItem {
+export interface IDocumentationItem extends IApiDocumentation, ISelectableMenuItem, IEditableMenuItem {
 }
-export declare type SchemaAddType = 'scalar' | 'object' | 'file' | 'array' | 'union';
+export declare type ISchemaAddType = 'scalar' | 'object' | 'file' | 'array' | 'union';

package/build/src/amf/definitions/Base.d.ts

@@ -1,11 +1,11 @@
-import { IDataNodeUnion } from "./Shapes.js";
-export interface IDomainProperty {
+import { IApiDataNodeUnion } from "./Shapes.js";
+export interface IApiDomainProperty {
     id: string;
     types: string[];
-    customDomainProperties: ICustomDomainProperty[];
+    customDomainProperties: IApiCustomDomainProperty[];
 }
-export interface ICustomDomainProperty {
+export interface IApiCustomDomainProperty {
     id: string;
     name: string;
-    extension: IDataNodeUnion;
+    extension: IApiDataNodeUnion;
 }