@api-client/core 0.9.25 → 0.10.1

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

@@ -0,0 +1,381 @@
+import { IApiDomainProperty } from "./Base.js";
+import { IApiDataExample, IApiDataNode, IApiDataNodeUnion, IShapeUnion } from "./Shapes.js";
+export type IScalarDataTypes = 'string' | 'base64Binary' | 'boolean' | 'date' | 'dateTime' | 'double' | 'float' | 'integer' | 'long' | 'number' | 'time';
+export interface IApiSummary extends IApiDomainProperty {
+    name?: string;
+    description?: string;
+    schemes: string[];
+    accepts: string[];
+    contentType: string[];
+    version?: string;
+    termsOfService?: string;
+    provider?: IApiOrganization;
+    license?: IApiLicense;
+    documentations: IApiDocumentation[];
+    tags: IApiTag[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiBase extends IApiSummary {
+    endPoints: IApiEndPoint[];
+    servers: IApiServer[];
+    security: IApiSecurityRequirement[];
+}
+export interface IApiWeb extends IApiBase {
+}
+export interface IApiAsync extends IApiBase {
+}
+export interface IApiOrganization extends IApiDomainProperty {
+    url?: string;
+    name?: string;
+    email?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiLicense extends IApiDomainProperty {
+    url?: string;
+    name?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiEndPoint extends IApiDomainProperty {
+    description?: string;
+    name?: string;
+    summary?: string;
+    path: string;
+    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;
+    summary?: string;
+    deprecated: boolean;
+    schemes?: string[];
+    accepts?: string[];
+    contentType?: string[];
+    operationId?: string;
+    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?: IApiDocumentSourceMaps;
+}
+export interface IApiServer extends IApiDomainProperty {
+    url: string;
+    description?: string;
+    variables: IApiParameter[];
+    sourceMaps?: IApiDocumentSourceMaps;
+    protocol?: string;
+    protocolVersion?: string;
+    security?: IApiSecurityRequirement[];
+}
+export interface IApiParameter extends IApiDomainProperty {
+    name?: string;
+    paramName?: string;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+    binding?: string;
+    schema?: IShapeUnion;
+    payloads: IApiPayload[];
+    examples: IApiDataExample[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiPayload extends IApiDomainProperty {
+    name?: string;
+    mediaType?: string;
+    schema?: IShapeUnion;
+    examples: IApiDataExample[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiResponse extends IApiDomainProperty {
+    name?: string;
+    description?: string;
+    statusCode?: string;
+    headers: IApiParameter[];
+    payloads: IApiPayload[];
+    examples: IApiDataExample[];
+    links: IApiTemplatedLink[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiTemplatedLink extends IApiDomainProperty {
+    name?: string;
+    description?: string;
+    template?: string;
+    operationId?: string;
+    requestBody?: string;
+    mapping: IApiIriTemplateMapping[];
+    server?: IApiServer;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiIriTemplateMapping extends IApiDomainProperty {
+    templateVariable?: string;
+    linkExpression?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityRequirement extends IApiDomainProperty {
+    name?: string;
+    schemes: IApiParametrizedSecurityScheme[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiParametrizedSecurityScheme extends IApiDomainProperty {
+    name?: string;
+    settings?: IApiSecuritySettingsUnion;
+    scheme?: IApiSecurityScheme;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityScheme extends IApiDomainProperty {
+    name?: string;
+    type?: string;
+    displayName?: string;
+    description?: string;
+    settings?: IApiSecuritySettingsUnion;
+    headers: IApiParameter[];
+    queryParameters: IApiParameter[];
+    responses: IApiResponse[];
+    queryString?: IShapeUnion;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecuritySettings extends IApiDomainProperty {
+    additionalProperties?: IApiDataNodeUnion;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityOAuth1Settings extends IApiSecuritySettings {
+    requestTokenUri?: string;
+    authorizationUri?: string;
+    tokenCredentialsUri?: string;
+    signatures: string[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityOAuth2Settings extends IApiSecuritySettings {
+    authorizationGrants: string[];
+    flows: IApiSecurityOAuth2Flow[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityApiKeySettings extends IApiSecuritySettings {
+    name?: string;
+    in?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityHttpSettings extends IApiSecuritySettings {
+    scheme?: string;
+    bearerFormat?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityOpenIdConnectSettings extends IApiSecuritySettings {
+    url?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export type IApiSecuritySettingsUnion = IApiSecuritySettings | IApiSecurityOAuth1Settings | IApiSecurityOAuth2Settings | IApiSecurityApiKeySettings | IApiSecurityHttpSettings | IApiSecurityOpenIdConnectSettings;
+export interface IApiSecurityOAuth2Flow extends IApiDomainProperty {
+    authorizationUri?: string;
+    accessTokenUri?: string;
+    flow?: string;
+    refreshUri?: string;
+    scopes: IApiSecurityScope[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiSecurityScope extends IApiDomainProperty {
+    name?: string;
+    description?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiRequest extends IApiDomainProperty {
+    description?: string;
+    required?: boolean;
+    queryParameters: IApiParameter[];
+    headers: IApiParameter[];
+    payloads: IApiPayload[];
+    queryString?: IShapeUnion;
+    uriParameters: IApiParameter[];
+    cookieParameters: IApiParameter[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiCallback extends IApiDomainProperty {
+    name?: string;
+    expression?: string;
+    endpoint?: IApiEndPoint;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+/**
+ * The definition of the domain extension
+ */
+export interface IApiCustomDomainExtension extends IApiDomainProperty {
+    name?: string;
+    displayName?: string;
+    description?: string;
+    domain: string[];
+    schema?: IShapeUnion;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+/**
+ * Applies to an object domain extension
+ */
+export interface IApiDomainExtension extends IApiDomainProperty {
+    name?: string;
+    definedBy?: IApiCustomDomainExtension;
+    extension?: IApiDataNodeUnion;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiDocumentation extends IApiDomainProperty {
+    url?: string;
+    description?: string;
+    title?: string;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiEncoding {
+    propertyName?: string;
+    contentType?: string;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+    headers: IApiParameter[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiDocumentSourceMaps {
+    id?: string;
+    types?: string[];
+    synthesizedField?: IApiSynthesizedField[];
+    lexical?: IApiSynthesizedField[];
+    trackedElement?: IApiSynthesizedField;
+    autoGeneratedName?: IApiSynthesizedField[];
+    parsedJsonSchema?: IApiSynthesizedField;
+    declaredElement?: IApiSynthesizedField;
+}
+export interface IApiSynthesizedField {
+    id: string;
+    element?: string;
+    value: string;
+}
+export interface IApiParametrizedDeclaration extends IApiDomainProperty {
+    name?: string;
+    target?: IApiAbstractDeclaration;
+    variables: IApiVariableValue[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiVariableValue extends IApiDomainProperty {
+    name: string;
+    value?: IApiDataNode;
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiAbstractDeclaration extends IApiDomainProperty {
+    name: string;
+    description?: string;
+    dataNode?: IApiDataNode;
+    variables: string[];
+    sourceMaps?: IApiDocumentSourceMaps;
+}
+export interface IApiParametrizedTrait extends IApiParametrizedDeclaration {
+}
+export interface IApiParametrizedResourceType extends IApiParametrizedDeclaration {
+}
+export interface IShapeProcessingOptions {
+    /**
+     * This is set when serializing a shape / parameter.
+     * It is used to determine which example of the schema to include.
+     *
+     * When an example has the `tracked-element` in the source maps then this
+     * is used to determine the only examples included to the schema.
+     *
+     * Note, the value of the tracked-element can be a list of IDs separated by coma.
+     */
+    trackedId?: string;
+}
+/**
+ * The selected type
+ *
+ * - `server`: server from the AMF model
+ * - `custom`: custom base URI value (entered by the user)
+ * - `extra`: an application controlled server value selected by the user.
+ */
+export type IServerType = 'server' | 'custom' | 'extra';
+export type ISelectionType = 'summary' | 'resource' | 'operation' | 'schema' | 'security' | 'documentation';
+/**
+ * API navigation layout options.
+ *
+ * - tree - creates a tree structure from the endpoints list
+ * - natural - behavior consistent with the previous version of the navigation. Creates a tree structure based on the previous endpoints.
+ * - natural-sort - as `natural` but endpoints are sorted by name.
+ * - off (or none) - just like in the API spec.
+ */
+export type INavigationLayout = 'tree' | 'natural' | 'natural-sort' | 'off';
+export interface ISelectableMenuItem {
+    /**
+     * Whether the item is a selected menu item.
+     */
+    selected?: boolean;
+    /**
+     * Whether the item has secondary selection.
+     * This happens when a "passive" selection has been applied to the item.
+     */
+    secondarySelected?: boolean;
+}
+export interface IEditableMenuItem {
+    /**
+     * When set the name editor for the item is enabled.
+     */
+    nameEditor?: boolean;
+}
+export interface IApiEndPointListItem {
+    /**
+     * The domain id of the endpoint.
+     * It may be undefined when the endpoint is created "abstract" endpoint vor the visualization.
+     */
+    id?: string;
+    path: string;
+    name?: string;
+}
+export interface IApiEndPointWithOperationsListItem extends IApiEndPointListItem {
+    operations: IApiOperationListItem[];
+}
+export interface IApiOperationListItem {
+    id: string;
+    method: string;
+    name?: string;
+}
+export interface IApiEndpointsTreeItem extends IApiEndPointWithOperationsListItem {
+    label: string;
+    indent: number;
+    hasShortPath?: boolean;
+    hasChildren?: boolean;
+}
+export interface IApiSecuritySchemeListItem {
+    id: string;
+    type: string;
+    name?: string;
+    displayName?: string;
+    types: string[];
+}
+export declare interface IApiNodeShapeListItem {
+    id: string;
+    name?: string;
+    displayName?: string;
+}
+export interface IEndpointItem extends IApiEndpointsTreeItem, ISelectableMenuItem, IEditableMenuItem {
+    operations: IOperationItem[];
+}
+export interface IOperationItem extends IApiOperationListItem, ISelectableMenuItem, IEditableMenuItem {
+}
+export interface INodeShapeItem extends IApiNodeShapeListItem, ISelectableMenuItem, IEditableMenuItem {
+}
+export interface ISecurityItem extends IApiSecuritySchemeListItem, ISelectableMenuItem {
+}
+export interface IDocumentationItem extends IApiDocumentation, ISelectableMenuItem, IEditableMenuItem {
+}
+export type ISchemaAddType = 'scalar' | 'object' | 'file' | 'array' | 'union';

package/build/esm/src/amf/definitions/Api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Api.js","sourceRoot":"","sources":["../../../../../src/amf/definitions/Api.ts"],"names":[],"mappings":""}

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

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

package/build/esm/src/amf/definitions/Base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.js","sourceRoot":"","sources":["../../../../../src/amf/definitions/Base.ts"],"names":[],"mappings":""}

package/build/esm/src/amf/definitions/Namespace.d.ts

@@ -0,0 +1,311 @@
+/**
+ * AMF namespace.
+ */
+export declare const AmfNamespace: {
+    aml: {
+        key: string;
+        vocabularies: {
+            key: string;
+            document: {
+                key: string;
+                Module: string;
+                Document: string;
+                SecuritySchemeFragment: string;
+                UserDocumentation: string;
+                DataType: string;
+                NamedExamples: string;
+                DomainElement: string;
+                ParametrizedDeclaration: string;
+                ExternalDomainElement: string;
+                customDomainProperties: string;
+                encodes: string;
+                declares: string;
+                references: string;
+                examples: string;
+                linkTarget: string;
+                linkLabel: string;
+                referenceId: string;
+                structuredValue: string;
+                raw: string;
+                extends: string;
+                value: string;
+                name: string;
+                strict: string;
+                deprecated: string;
+                location: string;
+                variable: string;
+                target: string;
+                dataNode: string;
+                root: string;
+                usage: string;
+                version: string;
+            };
+            core: {
+                key: string;
+                CreativeWork: string;
+                version: string;
+                urlTemplate: string;
+                displayName: string;
+                title: string;
+                name: string;
+                description: string;
+                documentation: string;
+                summary: string;
+                provider: string;
+                email: string;
+                url: string;
+                termsOfService: string;
+                license: string;
+                mediaType: string;
+                extensionName: string;
+                deprecated: string;
+            };
+            security: {
+                key: string;
+                ParametrizedSecurityScheme: string;
+                SecuritySchemeFragment: string;
+                SecurityScheme: string;
+                OAuth1Settings: string;
+                OAuth2Settings: string;
+                OAuth2Flow: string;
+                Scope: string;
+                Settings: string;
+                HttpSettings: string;
+                ApiKeySettings: string;
+                OpenIdConnectSettings: string;
+                security: string;
+                scheme: string;
+                schemes: string;
+                settings: string;
+                name: string;
+                type: string;
+                scope: string;
+                accessTokenUri: string;
+                authorizationUri: string;
+                authorizationGrant: string;
+                flows: string;
+                flow: string;
+                signature: string;
+                tokenCredentialsUri: string;
+                requestTokenUri: string;
+                refreshUri: string;
+                securityRequirement: string;
+                openIdConnectUrl: string;
+                bearerFormat: string;
+                in: string;
+            };
+            apiContract: {
+                key: string;
+                Payload: string;
+                Request: string;
+                Response: string;
+                EndPoint: string;
+                Parameter: string;
+                Operation: string;
+                WebAPI: string;
+                API: string;
+                AsyncAPI: string;
+                UserDocumentationFragment: string;
+                Example: string;
+                Server: string;
+                ParametrizedResourceType: string;
+                ParametrizedTrait: string;
+                Callback: string;
+                TemplatedLink: string;
+                IriTemplateMapping: string;
+                Tag: string;
+                Message: string;
+                header: string;
+                parameter: string;
+                paramName: string;
+                uriParameter: string;
+                cookieParameter: string;
+                variable: string;
+                payload: string;
+                server: string;
+                path: string;
+                url: string;
+                scheme: string;
+                endpoint: string;
+                queryString: string;
+                accepts: string;
+                guiSummary: string;
+                binding: string;
+                response: string;
+                returns: string;
+                expects: string;
+                examples: string;
+                supportedOperation: string;
+                statusCode: string;
+                method: string;
+                required: string;
+                callback: string;
+                expression: string;
+                link: string;
+                linkExpression: string;
+                templateVariable: string;
+                mapping: string;
+                operationId: string;
+                protocol: string;
+                protocolVersion: string;
+                headerSchema: string;
+                contentType: string;
+                allowEmptyValue: string;
+                style: string;
+                explode: string;
+                allowReserved: string;
+                tag: string;
+            };
+            shapes: {
+                key: string;
+                Shape: string;
+                ScalarShape: string;
+                ArrayShape: string;
+                UnionShape: string;
+                NilShape: string;
+                FileShape: string;
+                AnyShape: string;
+                SchemaShape: string;
+                MatrixShape: string;
+                TupleShape: string;
+                RecursiveShape: string;
+                DataTypeFragment: string;
+                XMLSerializer: string;
+                number: string;
+                integer: string;
+                long: string;
+                double: string;
+                boolean: string;
+                float: string;
+                nil: string;
+                password: string;
+                int32: string;
+                int64: string;
+                uint32: string;
+                uint64: string;
+                sint32: string;
+                sint64: string;
+                fixed32: string;
+                fixed64: string;
+                sfixed32: string;
+                sfixed64: string;
+                dateTimeOnly: string;
+                range: string;
+                items: string;
+                anyOf: string;
+                fileType: string;
+                schema: string;
+                xmlSerialization: string;
+                xmlName: string;
+                xmlAttribute: string;
+                xmlWrapped: string;
+                xmlNamespace: string;
+                xmlPrefix: string;
+                readOnly: string;
+                writeOnly: string;
+                deprecated: string;
+                fixPoint: string;
+                discriminator: string;
+                discriminatorValue: string;
+                format: string;
+                multipleOf: string;
+                uniqueItems: string;
+            };
+            data: {
+                key: string;
+                Scalar: string;
+                Object: string;
+                Array: string;
+                Node: string;
+                value: string;
+                type: string;
+                description: string;
+                required: string;
+                displayName: string;
+                minLength: string;
+                maxLength: string;
+                default: string;
+                multipleOf: string;
+                minimum: string;
+                maximum: string;
+                enum: string;
+                pattern: string;
+                items: string;
+                format: string;
+                example: string;
+                examples: string;
+            };
+            docSourceMaps: {
+                key: string;
+                SourceMap: string;
+                sources: string;
+                element: string;
+                value: string;
+                declaredElement: string;
+                trackedElement: string;
+                parsedJsonSchema: string;
+                autoGeneratedName: string;
+                lexical: string;
+                synthesizedField: string;
+            };
+        };
+    };
+    w3: {
+        key: string;
+        shacl: {
+            key: string;
+            Shape: string;
+            NodeShape: string;
+            SchemaShape: string;
+            PropertyShape: string;
+            in: string;
+            defaultValue: string;
+            defaultValueStr: string;
+            pattern: string;
+            minInclusive: string;
+            maxInclusive: string;
+            multipleOf: string;
+            minLength: string;
+            maxLength: string;
+            fileType: string;
+            and: string;
+            property: string;
+            name: string;
+            raw: string;
+            datatype: string;
+            minCount: string;
+            maxCount: string;
+            xone: string;
+            not: string;
+            or: string;
+            closed: string;
+            path: string;
+        };
+        xmlSchema: {
+            key: string;
+            boolean: string;
+            string: string;
+            number: string;
+            integer: string;
+            long: string;
+            double: string;
+            float: string;
+            nil: string;
+            dateTime: string;
+            time: string;
+            date: string;
+            base64Binary: string;
+            byte: string;
+        };
+        rdfSyntax: {
+            key: string;
+            Seq: string;
+            member: string;
+        };
+        rdfSchema: {
+            key: string;
+            Seq: string;
+            member: string;
+        };
+    };
+};