@api-client/ui 0.2.0 → 0.2.3

package/src/amf/store/mixins/AmfStoreDomEventsMixin.ts

@@ -1,132 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { dedupeMixin } from '@open-wc/dedupe-mixin'
-import { EventTypes } from '../../../events/amf/EventTypes.js'
-
-export const eventHandler = Symbol('eventHandler')
-
-const eventsMap: Record<string, { target: string; args?: string[]; eventProperties?: boolean; passDetail?: boolean }> =
-  {
-    [EventTypes.Api.summary]: { target: 'apiSummary' },
-    [EventTypes.Api.protocols]: { target: 'apiProtocols' },
-    [EventTypes.Api.version]: { target: 'apiVersion' },
-    [EventTypes.Api.documentMeta]: { target: 'documentMeta' },
-    [EventTypes.Endpoint.get]: { target: 'getEndpoint', args: ['id'] },
-    [EventTypes.Endpoint.byPath]: { target: 'getEndpointByPath', args: ['id'] },
-    [EventTypes.Endpoint.list]: { target: 'listEndpointsWithOperations' },
-    [EventTypes.Operation.get]: { target: 'getOperation', args: ['id', 'parent'] },
-    [EventTypes.Operation.getParent]: { target: 'getOperationParent', args: ['id'] },
-    [EventTypes.Server.query]: { target: 'queryServers', passDetail: true },
-    [EventTypes.Documentation.list]: { target: 'listDocumentations' },
-    [EventTypes.Documentation.get]: { args: ['id'], target: 'getDocumentation' },
-    [EventTypes.Security.get]: { args: ['id'], target: 'getSecurityScheme' },
-    [EventTypes.Security.getRequirement]: { args: ['id'], target: 'getSecurityRequirement' },
-    [EventTypes.Security.list]: { target: 'listSecurity' },
-    [EventTypes.Request.get]: { args: ['id'], target: 'getRequest' },
-    [EventTypes.Response.get]: { args: ['id'], target: 'getResponse' },
-    [EventTypes.Payload.get]: { args: ['id'], target: 'getPayload' },
-    [EventTypes.Type.list]: { target: 'listTypes' },
-    [EventTypes.Type.get]: { args: ['id'], target: 'getType' },
-  }
-
-type Constructor<T = object> = new (...args: any[]) => T
-
-/**
- * This mixin adds events listeners for DOM events related to the AMF store.
- * It does not provide implementations for the functions called by each handler.
- * This to be mixed in with an instance of the `AmfStoreService`.
- *
- * The implementation by default listens on the `window` object.
- * Set `eventsTarget` property to listen to the events on a specific node.
- *
- * @mixin
- */
-export interface AmfStoreDomEventsMixinInterface {
-  [eventHandler](e: CustomEvent): void
-  /**
-   * Listens for the store DOM events.
-   */
-  listen(node?: EventTarget): void
-
-  /**
-   * Removes store's DOM events.
-   */
-  unlisten(node?: EventTarget): void
-}
-
-/**
- * This mixin adds events listeners for DOM events related to the AMF store.
- * It does not provide implementations for the functions called by each handler.
- * This to be mixed in with an instance of the `AmfStoreService`.
- *
- * The implementation by default listens on the `window` object.
- * Set `eventsTarget` property to listen to the events on a specific node.
- *
- * @TODO: Add event listeners after removing the events target listener.
- *
- * @mixin
- */
-export const AmfStoreDomEventsMixin = dedupeMixin(
-  <T extends Constructor<any>>(superClass: T): Constructor<AmfStoreDomEventsMixinInterface> & T => {
-    class AmfStoreDomEventsMixinClass extends superClass {
-      /**
-       * @param args Base class arguments
-       */
-      constructor(...args: any[]) {
-        super(...args)
-        this[eventHandler] = this[eventHandler].bind(this)
-      }
-
-      /**
-       * Listens for the store DOM events.
-       */
-      listen(node: EventTarget = window): void {
-        Object.keys(eventsMap).forEach((type) => node.addEventListener(type, this[eventHandler] as EventListener))
-      }
-
-      /**
-       * Removes store's DOM events.
-       */
-      unlisten(node: EventTarget = window): void {
-        Object.keys(eventsMap).forEach((type) => node.removeEventListener(type, this[eventHandler] as EventListener))
-      }
-
-      _attachListeners(node: EventTarget): void {
-        super._attachListeners(node)
-        this.listen(node)
-      }
-
-      _detachListeners(node: EventTarget): void {
-        super._detachListeners(node)
-        this.unlisten(node)
-      }
-
-      [eventHandler](e: CustomEvent): void {
-        if (e.defaultPrevented) {
-          return
-        }
-        e.preventDefault()
-        const info = eventsMap[e.type]
-        if (!info) {
-          // eslint-disable-next-line no-console
-          console.warn(`Incorrectly handled event ${e.type}`)
-          return
-        }
-        const { args, target, passDetail } = info
-        if (passDetail) {
-          const cp = { ...(e.detail || {}) }
-          e.detail.result = this[target](cp)
-        } else if (!Array.isArray(args) || !args.length) {
-          e.detail.result = this[target]()
-        } else {
-          const params: any[] = []
-          args.forEach((n) => {
-            const value = info.eventProperties ? (e as any)[n] : e.detail[n]
-            params.push(value)
-          })
-          e.detail.result = this[target](...params)
-        }
-      }
-    }
-    return AmfStoreDomEventsMixinClass as Constructor<AmfStoreDomEventsMixinInterface> & T
-  }
-)

package/src/amf/types.ts

@@ -1,359 +0,0 @@
-import type {
-  IApiDocumentation,
-  IApiEndPoint,
-  IApiParameter,
-  IApiSecurityRequirement,
-  IApiServer,
-} from '@api-client/core/amf/definitions/Api.js'
-import type { IApiDataExample, IShapeUnion } from '@api-client/core/amf/definitions/Shapes.js'
-
-export interface PopulationInfo {
-  annotationName: string
-  annotationValue: string
-  fieldValue: string
-}
-
-export interface OperationParameter {
-  /**
-   * Works with the `allowDisableParams` configuration. By default
-   * a parameter is always enabled regardless of this value.
-   * When the `allowDisableParams` is set it uses this value to ignore some parameters (even the required ones).
-   */
-  enabled?: boolean
-  /**
-   * The parameter definition transformed from the AMF graph model.
-   * This is set for path, query, and header parameters.
-   */
-  parameter: IApiParameter
-  /**
-   * The schema associated with the parameter. Determines the shape of the user input control.
-   */
-  schema?: IShapeUnion
-  /**
-   * Link to `parameter.id`.
-   */
-  paramId: string
-  /**
-   * Link to `schema.id`.
-   */
-  schemaId?: string
-  /**
-   * The value of the binding. Determines where the control should be rendered (parameters or headers).
-   */
-  binding: string
-  /**
-   * A property set to determine from where the object came from. Used internally in the code.
-   */
-  source: string
-}
-
-export interface SecuritySelectorListItem {
-  types: (string | undefined)[]
-  labels: (string | undefined)[]
-  security: IApiSecurityRequirement
-}
-
-export interface ParameterRenderOptions {
-  /**
-   * When set it overrides the parameter's / schema's required property
-   * and renders the input as required.
-   * This also forces the renderer to force example value when default is not present.
-   */
-  required?: boolean
-}
-
-export interface ShapeTemplateOptions extends ParameterRenderOptions {
-  nillable?: boolean
-  arrayItem?: boolean
-  index?: number
-  value?: unknown
-}
-
-export interface ComputeBaseUriOptions {
-  /**
-   * The API base URI to use. When not set it computes the base URI from the `server` and `protocols`.
-   */
-  baseUri?: string
-  /**
-   * When set it uses the server to determine the base URI.
-   * When the `baseUri` is set this value is ignored.
-   * When both are missing then the URL computations ignores the base URI part and reads the path only.
-   */
-  server?: IApiServer
-  /**
-   * The endpoint definition used to compute path of the URL.
-   * When not set it ignores the path part.
-   */
-  endpoint?: IApiEndPoint
-  /**
-   * The protocols to use with the computation of the URL.
-   * When the server has no protocol (http or https) defined on the base URI
-   * then these protocols will be used.
-   * If in both cases this is missing then the protocol is not included.
-   * Note, it adds the protocol only when the base URI is defined (from the server).
-   */
-  protocols?: string[]
-  /**
-   * The API version. When set it replaces the `{version}` URI template with the value.
-   */
-  version?: string
-  /**
-   * When set is forces setting an HTTP protocol (http:) when protocol information is missing in the API spec.
-   */
-  forceHttpProtocol?: boolean
-}
-
-// export interface OperationParameter {
-//   parameter: IApiParameter;
-//   schema?: ApiShapeUnion;
-//   paramId: string;
-//   schemaId?: string;
-//   binding: string;
-//   source: string;
-// }
-
-export declare interface SelectionInfo {
-  /**
-   * Type of the detected selection
-   */
-  type: string
-  /**
-   * The normalized value to be used by API editors
-   */
-  value: string
-}
-
-export declare interface UpdateServersOptions {
-  /**
-   * The selected node type where servers should be fetched
-   */
-  type?: string
-  /**
-   * The selected node ID where servers should be fetched
-   */
-  id?: string
-  /**
-   * Optional endpoint id the method id belongs to
-   */
-  endpointId?: 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 ServerType = 'server' | 'custom' | 'extra'
-export type SelectionType = '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 NavigationLayout = 'tree' | 'natural' | 'natural-sort' | 'off'
-
-export interface SelectableMenuItem {
-  /**
-   * 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 EditableMenuItem {
-  /**
-   * When set the name editor for the item is enabled.
-   */
-  nameEditor?: boolean
-}
-
-export interface ApiEndPointListItem {
-  /**
-   * 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 ApiEndPointWithOperationsListItem extends ApiEndPointListItem {
-  operations: ApiOperationListItem[]
-}
-
-export interface ApiOperationListItem {
-  id: string
-  method: string
-  name?: string
-}
-
-export interface ApiEndpointsTreeItem extends ApiEndPointWithOperationsListItem {
-  label: string | undefined
-  indent: number
-  hasShortPath?: boolean
-  hasChildren?: boolean
-}
-
-export interface ApiSecuritySchemeListItem {
-  id: string
-  types: string[]
-  type: string
-  name?: string
-  displayName?: string
-}
-
-export declare interface ApiNodeShapeListItem {
-  id: string
-  name?: string
-  displayName?: string
-}
-
-export declare interface EndpointItem extends ApiEndpointsTreeItem, SelectableMenuItem, EditableMenuItem {
-  operations: OperationItem[]
-}
-
-export declare interface OperationItem extends ApiOperationListItem, SelectableMenuItem, EditableMenuItem {}
-export declare interface NodeShapeItem extends ApiNodeShapeListItem, SelectableMenuItem, EditableMenuItem {}
-export declare interface SecurityItem extends ApiSecuritySchemeListItem, SelectableMenuItem {}
-export declare interface DocumentationItem extends IApiDocumentation, SelectableMenuItem, EditableMenuItem {}
-export declare type SchemaAddType = 'scalar' | 'object' | 'file' | 'array' | 'union'
-
-export declare interface TargetModel {
-  documentation?: DocumentationItem[]
-  types?: NodeShapeItem[]
-  securitySchemes?: SecurityItem[]
-  endpoints?: EndpointItem[]
-  _typeIds?: string[]
-  _basePaths?: string[]
-}
-
-export declare interface SchemaExample extends IApiDataExample {
-  /**
-   * The value to render as the example value.
-   */
-  renderValue?: string
-  label?: string
-}
-
-export declare interface ShapeRenderOptions {
-  /**
-   * All selected unions in the current view.
-   * When the processor encounter an union it checks this array
-   * to pick the selected union.
-   * When the selected union cannot be determined it picks the first union.
-   */
-  selectedUnions?: string[]
-  /**
-   * Whether to include optional fields into the schema.
-   * @default false
-   */
-  renderOptional?: boolean
-  /**
-   * When set it uses the data mocking library to generate the values
-   * when examples and default are not set.
-   */
-  renderMocked?: boolean
-  /**
-   * The library **always** uses default values in the schema.
-   * When a default value is not set by default it inserts an empty value for
-   * the given data type ('', false, null, random date). When this is set
-   * it includes examples in the generated value.
-   */
-  renderExamples?: boolean
-}
-
-export interface MonacoSchema {
-  uri: string
-  schema: MonacoProperty
-  fileMatch?: string[]
-}
-
-export interface MonacoProperty {
-  $id?: string
-  title: string
-  type: string
-  description?: string
-  readOnly?: boolean
-  writeOnly?: boolean
-}
-
-export interface MonacoScalarProperty extends MonacoProperty {
-  default?: string
-  pattern?: string
-  format?: string
-  exclusiveMaximum?: boolean
-  exclusiveMinimum?: boolean
-  maxLength?: number
-  minLength?: number
-  minimum?: number
-  maximum?: number
-  multipleOf?: number
-  enum?: string[]
-}
-
-export interface MonacoObjectProperty extends MonacoProperty {
-  properties: Record<string, MonacoProperty>
-  required: string[]
-  additionalProperties?: boolean
-  minProperties?: number
-  maxProperties?: number
-}
-
-export interface MonacoArrayProperty extends MonacoProperty {
-  additionalItems?: boolean
-  items: {
-    anyOf: MonacoProperty[]
-  }
-  uniqueItems?: boolean
-  minItems?: number
-  maxItems?: number
-  required: string[]
-}
-
-export interface ApiSchemaReadOptions {
-  /**
-   * Whether the value should be read only when the required property is set.
-   */
-  requiredOnly?: boolean
-  /**
-   * Whether to read the examples to generate the value.
-   */
-  fromExamples?: boolean
-}
-
-export interface DocumentMeta {
-  /**
-   * True when the loaded document represent an API (in an opposite to a fragment or a partial model).
-   */
-  isApi: boolean
-  /**
-   * Whether the loaded document represent an Async API.
-   */
-  isAsync: boolean
-  /**
-   * Whether the loaded document represent a RAML fragment / OAS reference.
-   */
-  isFragment: boolean
-  /**
-   * A special type of fragment that is a RAML library.
-   */
-  isLibrary: boolean
-  /**
-   * The list of types of the loaded document.
-   */
-  types: string[]
-  /**
-   * The domain id of the `encodes` property.
-   */
-  encodesId?: string
-}

package/src/define/amf/api-annotation-document.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiAnnotationDocument.element.js'
-import styles from '../../elements/amf/ApiAnnotationDocument.styles.js'
-
-@customElement('api-annotation-document')
-export class ApiAnnotationDocumentElement extends Element {
-  static override styles = [styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-annotation-document': Element
-  }
-}

package/src/define/amf/api-authorization-editor.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiAuthorizationEditor.element.js'
-import styles from '../../elements/amf/ApiAuthorizationEditor.styles.js'
-
-@customElement('api-authorization-editor')
-export class ApiAuthorizationEditorElement extends Element {
-  static override styles = [styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-authorization-editor': Element
-  }
-}

package/src/define/amf/api-channel-document.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiChannelDocument.element.js'
-import styles from '../../elements/amf/ApiResourceDocument.styles.js'
-
-@customElement('api-channel-document')
-export class ApiChannelDocumentElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-channel-document': Element
-  }
-}

package/src/define/amf/api-documentation-document.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiDocumentationDocument.element.js'
-import styles from '../../elements/amf/ApiDocumentationDocument.styles.js'
-
-@customElement('api-documentation-document')
-export class ApiDocumentationDocumentElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-documentation-document': Element
-  }
-}

package/src/define/amf/api-documentation.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiDocumentation.element.js'
-import styles from '../../elements/amf/ApiDocumentation.styles.js'
-
-@customElement('api-documentation')
-export class ApiDocumentationElement extends Element {
-  static override styles = [styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-documentation': Element
-  }
-}

package/src/define/amf/api-navigation.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiNavigation.element.js'
-import styles from '../../elements/amf/ApiNavigation.styles.js'
-
-@customElement('api-navigation')
-export class ApiNavigationElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-navigation': Element
-  }
-}

package/src/define/amf/api-operation-document.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiOperationDocument.element.js'
-import styles from '../../elements/amf/ApiOperationDocument.styles.js'
-
-@customElement('api-operation-document')
-export class ApiOperationDocumentElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-operation-document': Element
-  }
-}

package/src/define/amf/api-parameter-document.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiParameterDocument.element.js'
-import styles from '../../elements/amf/ApiParameterDocument.styles.js'
-
-@customElement('api-parameter-document')
-export class ApiParameterDocumentElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-parameter-document': Element
-  }
-}

package/src/define/amf/api-parametrized-security-scheme.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiParametrizedSecurityScheme.element.js'
-import styles from '../../elements/amf/ApiParametrizedSecurityScheme.styles.js'
-
-@customElement('api-parametrized-security-scheme')
-export class ApiParametrizedSecuritySchemeElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-parametrized-security-scheme': Element
-  }
-}

package/src/define/amf/api-payload-document.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiPayloadDocument.element.js'
-import styles from '../../elements/amf/ApiPayloadDocument.styles.js'
-
-@customElement('api-payload-document')
-export class ApiPayloadDocumentElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-payload-document': Element
-  }
-}

package/src/define/amf/api-request-document.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiRequestDocument.element.js'
-import styles from '../../elements/amf/ApiRequestDocument.styles.js'
-
-@customElement('api-request-document')
-export class ApiRequestDocumentElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-request-document': Element
-  }
-}

package/src/define/amf/api-request-editor.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiRequestEditor.element.js'
-import styles from '../../elements/amf/ApiRequestEditor.styles.js'
-
-@customElement('api-request-editor')
-export class ApiRequestEditorElement extends Element {
-  static override styles = [...styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-request-editor': ApiRequestEditorElement
-  }
-}

package/src/define/amf/api-request.ts

@@ -1,14 +0,0 @@
-import { customElement } from 'lit/decorators.js'
-import Element from '../../elements/amf/ApiRequest.element.js'
-import styles from '../../elements/amf/ApiRequest.styles.js'
-
-@customElement('api-request')
-export class ApiRequestElement extends Element {
-  static override styles = [styles]
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'api-request': Element
-  }
-}