@api-client/core 0.20.10 → 0.21.0

package/src/models/legacy/request/ArcRequest.ts

@@ -1,405 +0,0 @@
-/* eslint-disable @typescript-eslint/no-empty-object-type */
-import { AuthorizationSettingsUnion } from '../authorization/Authorization.js'
-import { HostRule } from '../models/HostRule.js'
-import { Entity } from '../models/base.js'
-import { ErrorResponse, Response } from './ArcResponse.js'
-import { LegacyResponse, LegacyResponseMeta } from './Legacy.js'
-import { ApiType } from '../models/ApiTypes.js'
-import { BodyMeta, MultipartBody } from './RequestBody.js'
-import { RunnableAction } from '../actions/Actions.js'
-import { Variable } from '../models/Variable.js'
-import { RequestCertificate } from '../models/ClientCertificate.js'
-
-/**
- * This interface was used in a few components, this is left for compatibility
- * @deprecated Use RequestBody.MultipartBody instead
- */
-export interface MultipartTransformer extends MultipartBody {}
-
-/**
- * The definition of the ARC base HTTP request object
- * @deprecated
- */
-export interface HTTPRequest {
-  /**
-   * The request URL
-   */
-  url: string
-  /**
-   * HTTP method name
-   */
-  method: string
-  /**
-   * HTTP headers string
-   */
-  headers?: string
-  /**
-   * The request payload
-   */
-  payload?: string | File | Blob | ArrayBuffer | FormData
-}
-
-/**
- * An interface describing a request made by the HTTP transport.
- * Each transport used by ARC must return this structure in the response event.
- * This is not a replacement for the editor request that also has to be returned.
- *
- * Another difference is that this headers contains a final list of headers sent to the
- * server, including default headers, content-length, authorization, and so on.
- * @deprecated
- */
-export interface TransportRequest extends HTTPRequest {
-  /**
-   * The HTTP message sent to the server (full message).
-   * Some HTTP clients may not give this information.
-   */
-  httpMessage: string
-  /**
-   * The timestamp when the request was started (before the connection is made)
-   */
-  startTime: number
-  /**
-   * The timestamp of when the response ended.
-   */
-  endTime: number
-}
-
-/**
- * ARC request `config` object.
- * @deprecated
- */
-export interface RequestConfig {
-  /**
-   * Whether the processor should use this configuration.
-   */
-  enabled: boolean
-  /**
-   * The request timeout.
-   * Default no timeout.
-   */
-  timeout?: number
-  /**
-   * Whether or not the request should follow redirects.
-   */
-  followRedirects?: boolean
-  /**
-   * Does not set session (saved) cookies to this request
-   */
-  ignoreSessionCookies?: boolean
-  /**
-   * Hosts table configuration.
-   */
-  hosts?: HostRule[]
-  /**
-   * Whether the processor should validate certificates.
-   */
-  validateCertificates?: boolean
-  /**
-   * Whether the native (Node's) transport should be used.
-   */
-  nativeTransport?: boolean
-  /**
-   * Whether to put a "default" headers (accept and user agent)
-   */
-  defaultHeaders?: boolean
-  /**
-   * A list of variables to use with the request.
-   * Note, request variables override application and workspace variables.
-   */
-  variables?: Variable[]
-}
-
-/**
- * Authorization configuration for the request.
- * @deprecated
- */
-export interface RequestAuthorization {
-  /**
-   * Authorization configuration
-   */
-  config: AuthorizationSettingsUnion
-  /**
-   * The name of the authorization
-   */
-  type: string
-  /**
-   * Whether the authorization is enabled.
-   */
-  enabled: boolean
-  /**
-   * Whether the authorization is reported to be valid.
-   * The application should take action when the authorization is invalid but possibly allow the request.
-   */
-  valid: boolean
-}
-
-/**
- * URL editor meta data.
- * @deprecated
- */
-export interface UrlMeta {
-  /**
-   * The model generated for the URL parameters.
-   */
-  model?: ApiType[]
-  /**
-   * The query params delimiter. By default it is `&`.
-   */
-  delimiter?: string
-}
-
-/**
- * Headers editor meta data.
- * @deprecated
- */
-export interface HeadersMeta {
-  /**
-   * The model generated for the headers editor.
-   */
-  model?: ApiType[]
-  /**
-   * Whether the source editor is opened.
-   */
-  source?: boolean
-}
-
-/**
- * @deprecated
- */
-export interface AuthMeta {
-  /**
-   * The index of the selected authorization method.
-   */
-  selected?: number
-}
-
-/**
- * @deprecated
- */
-export declare interface ActionsMeta {
-  /**
-   * The index of the selected arc actions view.
-   */
-  selected?: number
-}
-
-/**
- * UI configuration for the request.
- * @deprecated
- */
-export declare interface RequestUiMeta {
-  /**
-   * Body editor metadata.
-   */
-  body?: BodyMeta
-  /**
-   * URL editor metadata.
-   */
-  url?: UrlMeta
-  /**
-   * Headers editor metadata.
-   */
-  headers?: HeadersMeta
-  /**
-   * Authorization editor meta.
-   */
-  authorization?: AuthMeta
-  /**
-   * ARC request actions editor UI config.
-   */
-  actions?: ActionsMeta
-
-  /**
-   * The currently selected editor in the request editor UI.
-   */
-  selectedEditor?: number
-  /**
-   * Optional configuration of the response view
-   */
-  response?: ResponseUiMeta
-}
-
-/**
- * @deprecated
- */
-export declare interface ResponseUiMeta {
-  /**
-   * The list of activated panels in the response view.
-   */
-  activePanels?: string[]
-  /**
-   * The name of the selected response panel.
-   */
-  selectedPanel?: string
-}
-
-/**
- * @deprecated
- */
-export declare interface RequestActions {
-  /**
-   * Actions to be executed before the request is sent to the transport library.
-   */
-  request?: RunnableAction[]
-  /**
-   * Actions to be executed after the response is fully received but before it is reported back to the UI.
-   */
-  response?: RunnableAction[]
-}
-
-/**
- * The definition of the ARC request that is shared in different contexts.
- * @deprecated This is a legacy ARC request definition.
- */
-export interface ArcBaseRequest extends HTTPRequest {
-  /**
-   * The kind of the object. In ARC by default a request object is an HTTP request object.
-   */
-  kind?: string
-  /**
-   * Request processing configuration.
-   */
-  config?: RequestConfig
-  /**
-   * The old authorization system that allowed only single request to be used.
-   * @deprecated
-   */
-  auth?: AuthorizationSettingsUnion
-  /**
-   * Request authorization configuration
-   */
-  authorization?: RequestAuthorization[]
-  /**
-   * The last response made with this request. This is always set with the history object.
-   * May not be set with others.
-   */
-  response?: Response | ErrorResponse
-  /**
-   * Set together with `response` property. Describes a request sent by the transport.
-   */
-  transportRequest?: TransportRequest
-  /**
-   * Old ARC's response declaration. This is kept for internal data model processing.
-   * @deprecated Do not use.
-   */
-  _response?: LegacyResponse
-  /**
-   * Old ARC's response meta declaration. This is kept for internal data model processing.
-   * @deprecated Do not use.
-   */
-  _responseMeta?: LegacyResponseMeta
-  /**
-   * @deprecated Do not use.
-   */
-  _isErrorResponse?: boolean
-  /**
-   * The UI configuration for the request.
-   * Each part of the UI has its own default state so this is optional and
-   * always updated when the UI change.
-   */
-  ui?: RequestUiMeta
-  /**
-   * Actions to be performed when the request is executed.
-   */
-  actions?: RequestActions
-
-  clientCertificate?: RequestCertificate
-}
-
-/**
- * A model of an ARC request that has been stored in the data store
- * @deprecated This is a legacy ARC request definition.
- */
-export interface ArcStoredRequest extends ArcBaseRequest {
-  /**
-   * The type of the request stored in the data store.
-   * Can be either `saved` or `history` which corresponds
-   * to `SavedRequest` and `HistoryRequest` definitions respectively.
-   */
-  type?: string
-  /**
-   * Timestamp when the request was last updated.
-   */
-  updated?: number
-  /**
-   * Timestamp when the request was created.
-   */
-  created?: number
-  /**
-   * An ID of Google Drive object where this request is stored.
-   */
-  driveId?: string
-  /**
-   * A timestamp of the midnight when the request object was updated
-   */
-  midnight?: number
-  /**
-   * ARCs internal transformation of a native FormData into a structure that
-   * can be stored in the data store. This is used internally by their model
-   * and when requesting ARC request object this is restored to the original
-   * format.
-   */
-  multipart?: MultipartBody[]
-  /**
-   * When a file is the request payload then in the data store it is transformed into a
-   * string and the payload is emptied. This is used internally by the data store
-   * to restore the original format
-   */
-  blob?: string
-}
-
-/**
- * The definition of the ARC request history data entity.
- * @deprecated This is a legacy ARC request definition.
- */
-export interface ARCHistoryRequest extends ArcStoredRequest, Entity {}
-
-/**
- * @deprecated This is a legacy ARC request definition.
- */
-export interface ARCSavedRequest extends ArcStoredRequest, Entity {
-  /**
-   * The name of the request
-   */
-  name: string
-  /**
-   * The description of the request
-   */
-  description?: string
-  /**
-   * A list of projects this request is assigned to.
-   */
-  projects?: string[]
-}
-
-/**
- * The definition of the ARC request in the request editor.
- * @deprecated
- */
-export interface ArcEditorRequest {
-  /**
-   * The auto generated ID of the request in the editor.
-   */
-  id: string
-  /**
-   * The ARC request object
-   */
-  request: ArcBaseRequest | ARCSavedRequest | ARCHistoryRequest
-}
-
-/**
- * @deprecated
- */
-export interface ARCRequestRestoreOptions {
-  /**
-   * When set the payload is ignored from the request and the model returns `undefined.
-   * This is used to optimize queries to the data store.
-   */
-  ignorePayload?: boolean
-  /**
-   * When performing a bulk read operation it preserves order
-   * or requested items by key by adding `undefined` to the indexes that
-   * failed to read
-   */
-  preserveOrder?: boolean
-}

package/src/models/legacy/request/ArcResponse.ts

@@ -1,177 +0,0 @@
-import { MultipartBody } from './RequestBody.js'
-
-/**
- * Schema definition for ARC request timings. This is mostly consistent with HAR timings.
- * @deprecated
- */
-export interface RequestTime {
-  connect: number
-  receive: number
-  send: number
-  wait: number
-  blocked: number
-  dns: number
-  ssl?: number
-}
-
-/**
- * ARC transforms response body from ArrayBuffer or Buffer
- * to this structure to store it in the data store.
- * @deprecated
- */
-export interface TransformedPayload {
-  /**
-   * The type of the original data typ
-   */
-  type: string
-  /**
-   * Array of integers to be restored to its original form defined in the `type`.
-   */
-  data: number[]
-}
-
-/**
- * @deprecated
- */
-export interface HTTPResponse {
-  /**
-   * The response status code
-   */
-  status: number
-  /**
-   * The reason part of the status message
-   */
-  statusText?: string
-  /**
-   * The response headers
-   */
-  headers?: string
-  /**
-   * The response message
-   */
-  payload?: string | ArrayBuffer | TransformedPayload
-}
-
-/**
- * An information about a redirect
- * @deprecated
- */
-export interface ResponseRedirect {
-  /**
-   * Redirection response
-   */
-  response: HTTPResponse
-  /**
-   * Redirection timings, if available.
-   */
-  timings?: RequestTime
-  /**
-   * The timestamp when the request was started (before the connection is made)
-   */
-  startTime: number
-  /**
-   * The timestamp of when the response ended.
-   */
-  endTime: number
-  /**
-   * The URL the request was redirected to
-   */
-  url: string
-}
-
-/**
- * @deprecated
- */
-export interface RequestsSize {
-  /**
-   * The size of the request in bytes
-   */
-  request: number
-  /**
-   * The size of the response in bytes
-   */
-  response: number
-}
-
-/**
- * @deprecated
- */
-export interface BaseResponse extends HTTPResponse {
-  /**
-   * The ID of the request object used to trigger the response.
-   */
-  id?: string
-}
-
-/**
- * ARC response object.
- * @deprecated
- */
-export interface Response extends BaseResponse {
-  /**
-   * The request timings.
-   * Some HTTP clients may not give this information.
-   */
-  timings?: RequestTime
-  /**
-   * The total loading time (from sending the request to receive last byte)
-   */
-  loadingTime: number
-  /**
-   * The list of redirects, if any.
-   */
-  redirects?: ResponseRedirect[]
-  /**
-   * Request and response size. Some HTTP clients may not give this information.
-   */
-  size?: RequestsSize
-
-  /**
-   * ARCs internal transformation of a native FormData into a structure that
-   * can be stored in the data store. This is used internally by their model
-   * and when requesting ARC request object this is restored to the original
-   * format.
-   */
-  multipart?: MultipartBody[]
-
-  /**
-   * When a file is the request payload then in the data store it is transformed into a
-   * string and the payload is emptied. This is used internally by the data store
-   * to restore the original format
-   */
-  blob?: string
-
-  /**
-   * The authentication request from the server.
-   */
-  auth?: ResponseAuth
-}
-
-/**
- * @deprecated
- */
-export interface ErrorResponse extends BaseResponse {
-  /**
-   * An error associated with the response
-   */
-  error: Error
-}
-
-/**
- * @deprecated
- */
-export interface ResponseAuth {
-  /**
-   * The requested by the authorization server authentication method
-   */
-  method: string
-  /**
-   * The current state if the authorization process. This is used by NTLM authorization helper.
-   */
-  state?: number
-  /**
-   * The headers association with the response.
-   */
-  headers?: string
-  challengeHeader?: string
-}

package/src/models/legacy/request/HistoryData.ts

@@ -1,47 +0,0 @@
-import { Entity } from '../models/base.js'
-import { MultipartTransformer } from './ArcRequest.js'
-import { RequestTime, TransformedPayload } from './ArcResponse.js'
-
-export interface HistoryData extends Entity {
-  timings: RequestTime
-  totalTime: number
-  created: number
-  request: HistoryDataRequest
-  response: HistoryDataResponse
-  stats: HistoryDataStats
-}
-export interface HistoryDataRequest {
-  headers?: string
-  payload?: string | ArrayBuffer | Blob | File | FormData
-  url: string
-  method: string
-  /**
-   * ARCs internal transformation of a native FormData into a structure that
-   * can be stored in the data store. This is used internally by their model
-   * and when requesting ARC request object this is restored to the original
-   * format.
-   */
-  multipart?: MultipartTransformer[]
-  /**
-   * When a file is the request payload then in the data store it is transformed into a
-   * string and the payload is emptied. This is used internally by the data store
-   * to restore the original format
-   */
-  blob?: string
-}
-export interface HistoryDataResponse {
-  statusCode: number
-  statusText?: string
-  headers?: string
-  payload: string | TransformedPayload
-}
-
-export interface HistoryDataStat {
-  headersSize: number
-  payloadSize: number
-}
-
-export interface HistoryDataStats {
-  request: HistoryDataStat
-  response: HistoryDataStat
-}

package/src/models/legacy/request/RequestBody.ts

@@ -1,87 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { ApiType } from '../models/ApiTypes.js'
-
-/**
- * @deprecated
- */
-export interface MultipartBody {
-  /**
-   * When true a this entry represent a file part
-   */
-  isFile: boolean
-  /**
-   * The name of the filed
-   */
-  name: string
-  /**
-   * Converted value
-   */
-  value: string
-  /**
-   * A content type entered by the user to the text part of the text part input.
-   * This can only be set when `isFile` is false.
-   */
-  type?: string
-  /**
-   * The original file name used with the part
-   */
-  fileName?: string
-  /**
-   * Whether the parameter is enabled. Default to true.
-   */
-  enabled?: boolean
-  /**
-   * When `isFile` is true then this is the size of the selected file.
-   */
-  size?: number
-}
-
-/**
- * @deprecated
- */
-export interface RawBody {
-  /**
-   * The last used body value.
-   */
-  value: string
-  /**
-   * True when the generator was used to build the value
-   */
-  isGenerator?: boolean
-  /**
-   * The schema for the generator. Work in progress.
-   */
-  generatorSchema?: any
-}
-
-/**
- * The body editor may produce multiple view models
- * for the UI. Each editor can store it's data in here
- * to restore it after opening a request,
- * @deprecated
- */
-export interface BodyMetaModel {
-  /**
-   * The id of the editor. Each editor in ARC has own id.
-   */
-  type: string
-  /**
-   * Generated view model.
-   */
-  viewModel: (ApiType | MultipartBody | RawBody)[]
-}
-
-/**
- * Body editor meta data.
- * @deprecated
- */
-export interface BodyMeta {
-  /**
-   * The model generated for the body editor.
-   */
-  model?: BodyMetaModel[]
-  /**
-   * The selected editor
-   */
-  selected?: string
-}