@api-client/core 0.3.1 → 0.3.4

package/src/models/legacy/models/ApiTypes.ts

@@ -0,0 +1,202 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Entity } from './base.js';
+
+/**
+ * @deprecated
+ */
+export declare class ApiHttpUrl {
+  /**
+   * The value of the URL.
+   */
+  path?: string;
+  /**
+   * The host value of the URL
+   */
+  host?: string;
+  /**
+   * The protocol value of the URL
+   */
+  protocol?: string;
+  /**
+   * The query parameters.
+   */
+  query?: ApiType[];
+}
+
+/**
+ * @deprecated
+ */
+export interface EntityTiming {
+  /**
+   * Timestamp when the project was last updated.
+   */
+  updated?: number;
+  /**
+   * Timestamp when the project was created.
+   */
+  created?: number;
+  /**
+   * A timestamp of the midnight when the object was updated or created
+   * (depending on the object).
+   */
+  midnight?: number;
+}
+
+/**
+ * @deprecated
+ */
+export interface ApiServerVariable {
+  /**
+   * The variable name.
+   */
+  name: string;
+  /**
+   * The description of the variable
+   */
+  description?: string;
+  /**
+   * List of possible values.
+   */
+  enum: string[];
+  /**
+   * The default value of selected variable.
+   */
+  default: string;
+}
+
+/**
+ * A definition of an API server. This is used in the API project to define a base URI for each request.
+ * @deprecated
+ */
+export interface ApiServer {
+  /**
+   * The base URI value. The server can contain variables in form
+   * `https://{region}.api.domain.com`. By default each variable is a required string until
+   * `variables` property is set.
+   */
+  url: string;
+  /**
+   * A list of variables in the url value.
+   */
+  variables?: ApiServerVariable[];
+}
+
+/**
+ * The definition of a project folder structure.
+ * @deprecated
+ */
+export interface ARCProjectFolder extends EntityTiming {
+  /**
+   * The name of the project or a folder
+   */
+  name: string;
+  /**
+   * The description of the project or a folder
+   */
+  description?: string;
+  /**
+   * List of folders in this project / folder
+   */
+  folders?: ARCProjectFolder[];
+  /**
+   * The list of request ids associated with the API project.
+   * The requests are stored in the `api-request` data store.
+   */
+  requests?: string[];
+  /**
+   * List of tags added to the project.
+   */
+  tags?: string[];
+}
+
+/**
+ * The new definition of the ARC project that is an API project.
+ * @deprecated
+ */
+export interface ARCApiProject extends Entity, ARCProjectFolder {
+  /**
+   * True when the project is starred by the user.
+   */
+  starred?: boolean;
+  /**
+   * Definition of base servers to be used with the request editor.
+   */
+  servers?: ApiServer[];
+}
+
+/**
+ * @deprecated
+ */
+export interface ApiType {
+  /**
+   * Property name
+   */
+  name: string;
+  /**
+   * Property value
+   */
+  value: any;
+  /**
+   * Property type
+   */
+  type?: 'string' | 'integer' | 'float' | 'nil' | 'boolean' | 'date' | 'datetime' | 'time' | 'enum';
+  /**
+   * Whether the property is enabled. If not set it is assumed the property is enabled.
+   */
+  enabled?: boolean;
+  /**
+   * The default value for the property
+   */
+  default?: any;
+  /**
+   * Enum values for the property.
+   */
+  enum?: any|any[];
+  /**
+   * The description of the property
+   */
+  description?: string;
+  /**
+   * Whether the value id required to be provided. This is used with validation.
+   */
+  required?: boolean;
+}
+
+/**
+ * The definition of the API request HTTP properties.
+ * @deprecated
+ */
+export interface ApiHttpRequest {
+  /**
+   * HTTP method name
+   */
+  method: string;
+  /**
+   * The list of headers on the request
+   */
+  headers?: ApiType[];
+  /**
+   * Definition of the API request URL.
+   */
+  url: ApiHttpUrl;
+}
+
+/**
+ * An API request object is an entity that only exists inside an API project.
+ * The reference is created in an API folder.
+ * @deprecated
+ */
+export interface APIRequest extends EntityTiming, Entity {
+  /**
+   * The request definition for the request editor.
+   */
+  http: ApiHttpRequest;
+  /**
+   * The name of the request
+   */
+  name: string;
+  /**
+   * The description of the request
+   */
+  description?: string;
+}

package/src/models/legacy/models/ArcLegacyProject.ts

@@ -0,0 +1,39 @@
+import { Entity } from './base.js';
+
+/**
+ * The legacy structure of a project.
+ * @deprecated
+ */
+export interface ArcLegacyProject {
+  /**
+   * Project order
+   */
+  order?: number;
+  /**
+   * List of requests associated with the project.
+   */
+  requests?: string[];
+  /**
+   * Timestamp when the project was last updated.
+   */
+  updated?: number;
+  /**
+   * Timestamp when the project was created.
+   */
+  created?: number;
+  /**
+   * The name of the project
+   */
+  name: string;
+  /**
+   * The description of the project
+   */
+  description?: string;
+  error?: boolean;
+}
+
+/**
+ * @deprecated
+ */
+export declare interface ARCProject extends ArcLegacyProject, Entity {
+}

package/src/models/legacy/models/AuthData.ts

@@ -0,0 +1,17 @@
+import { Entity } from './base.js';
+
+/**
+ * @deprecated
+ */
+export declare interface BasicAuthData {
+  username?: string;
+  password?: string;
+  domain?: string;
+}
+
+/**
+ * @deprecated
+ */
+export declare interface ARCAuthData extends BasicAuthData, Entity {
+
+}

package/src/models/legacy/models/ClientCertificate.ts

@@ -0,0 +1,95 @@
+import { Entity } from './base.js';
+
+/**
+ * Represents a single certificate object (cert/key)
+ * @deprecated
+ */
+export interface Certificate {
+  /**
+   * The certificate to use.
+   * The `p12` type certificate must be a Buffer.
+   * The model's `get()` method always returns original data type.
+   */
+  data: string | ArrayBuffer | Buffer | Uint8Array;
+  /**
+   * A passphrase to use to unlock the certificate.
+   */
+  passphrase?: string;
+  /**
+   * The original data type of the certificate. This is used by the data store
+   * to move between buffers and string values stored in the store.
+   * By any means, outside the internal procedure of the data store this
+   * filed is always `undefined` and the `data` contains the original data format.
+   */
+  type?: string;
+}
+
+/**
+ * Represents a complete certificate configuration required to make
+ * a HTTP request.
+ * @deprecated
+ */
+export interface RequestCertificate {
+  /**
+    * Certificate type. Either `p12` or `pem`.
+    */
+  type: string;
+  /**
+   * Certificate or list of certificates to use.
+   */
+  cert: Certificate | Certificate[];
+  /**
+   * Key for the `pem` type certificate.
+   */
+  key?: Certificate | Certificate[];
+}
+
+/**
+ * Client certificate index definition for listings.
+ * @deprecated 
+ */
+export interface CertificateIndex {
+  /**
+   * Certificate type. Either `p12` or `pem`.
+   */
+  type: string;
+  /**
+   * Custom name of the certificate.
+   */
+  name: string;
+  /**
+   * Timestamp when the certificate was inserted into the data store.
+   * Required when returning a result. Auto-generated when inserting, if missing.
+   */
+  created?: number;
+}
+
+/**
+ * A base client certificate object used in ARC to create / list objects.
+ * This is not a data entity but rather something used to outside of a context of a data store.
+ * @deprecated
+ */
+export interface ClientCertificate extends RequestCertificate, CertificateIndex {
+}
+
+/**
+ * Client certificate index datastore definition. For data entity use `ARCRequestCertificate` definition.
+ * @deprecated
+ */
+export interface ARCCertificateIndex extends CertificateIndex, Entity {
+  /**
+   * In previous version of the application data and index keys were different.
+   * This is to accommodate the difference.
+   * @deprecated In the current system both data and index uses the same ID. This is left for compatibility purposes only.
+   */
+  dataKey?: string;
+}
+
+/**
+ * The certificate object returned by the PouchDB store.
+ * This is the data definition of a certificate data. For index entity use `ARCCertificateIndex` definition.
+ * @deprecated
+ */
+export interface ARCRequestCertificate extends RequestCertificate, Entity {
+
+}

package/src/models/legacy/models/Cookies.ts

@@ -0,0 +1,52 @@
+/**
+ * A model of a cookie object used by the API Client.
+ * @deprecated
+ */
+export interface ARCCookie {
+  /**
+   * Cookie name
+   */
+  name: string;
+  /**
+   * Cookie value
+   */
+  value?: string;
+  /**
+   * A string representing the domain the cookie belongs to
+   * (e.g. "www.google.com", "example.com")
+   */
+  domain: string;
+  /**
+   * Cookie path
+   */
+  path: string;
+  /**
+   * A boolean, `true` if the cookie is a `host-only` cookie
+   * (i.e. the request's host must exactly match the domain of the cookie),
+   * or `false` otherwise.
+   */
+  hostOnly?: boolean;
+  /**
+   * A boolean, `true` if the cookie is marked as HttpOnly
+   * (i.e. the cookie is inaccessible to client-side scripts),
+   * or `false` otherwise.
+   */
+  httpOnly?: boolean;
+  /**
+   * A boolean, `true` if the cookie is marked as secure
+   * (i.e. its scope is limited to secure channels, typically HTTPS),
+   * or `false` otherwise.
+   */
+  secure?: boolean;
+  /**
+   * Whether or not a cookie is a session cookie this means the cookie is
+   * deleted when the session ends.
+   *
+   * Session cookies are not used in the data export.
+   */
+  session?: boolean;
+  /**
+   * A timestamp when the cookie expires
+   */
+  expires?: number;
+}

package/src/models/legacy/models/HostRule.ts

@@ -0,0 +1,35 @@
+import { Entity } from './base.js';
+
+/**
+ * ARC host rule definition.
+ * @deprecated
+ */
+export declare interface HostRule {
+  /**
+   * The from rule (may contain asterisks)
+   */
+  from: string;
+  /**
+   * replacement value
+   */
+  to: string;
+  /**
+   * if false the rule is ignored
+   */
+  enabled?: boolean;
+  /**
+   * optional rule description
+   */
+  comment?: string;
+}
+
+/**
+ * @deprecated
+ */
+export declare interface ARCHostRule extends HostRule, Entity {
+  /**
+   * The timestamp when the rule was updated the last time.
+   * This value is created by the model. Not accepted when creating the entity.
+   */
+  updated?: number;
+}

package/src/models/legacy/models/RestApi.ts

@@ -0,0 +1,49 @@
+import { Entity } from './base';
+
+/**
+ * @deprecated
+ */
+export interface ARCRestApiIndex extends Entity {
+  /**
+   * API title
+   */
+  title: string;
+  /**
+   * API media type
+   */
+  type: string;
+  /**
+   * API order on the list
+   */
+  order: number;
+  /**
+   * List of version names stored with this API.
+   */
+  versions: string[];
+  /**
+   * The latest added version name.
+   */
+  latest: string;
+}
+
+/**
+ * @deprecated
+ */
+export interface ARCRestApi extends Entity {
+  /**
+   * The ID of the index item that this entry refers to.
+   */
+  indexId: string;
+  /**
+   * Version name of the API
+   */
+  version: string;
+  /**
+   * API data model. It is the output of the AMF parser run on the API.
+   */
+  data: string;
+  /**
+   * The AMF parser version used to parse this document.
+   */
+  amfVersion?: string;
+}

package/src/models/legacy/models/UrlHistory.ts

@@ -0,0 +1,37 @@
+import { Entity } from './base.js';
+
+/**
+ * @deprecated
+ */
+export interface UrlHistory {
+ /**
+   * A number of times the URL was used
+   */
+  cnt: number;
+  /**
+   * Last use timestamp.
+   */
+  time: number;
+  /**
+   * The request URL stored in the history.
+   */
+  url: string;
+  /**
+   * A timestamp of the midnight that corresponds to the `time` property.
+   */
+  midnight: number;
+}
+
+/**
+ * @deprecated
+ */
+export declare interface ARCUrlHistory extends UrlHistory, Entity {
+  
+}
+
+/**
+ * @deprecated
+ */
+export declare interface ARCWebsocketUrlHistory extends UrlHistory, Entity {
+  
+}

package/src/models/legacy/models/Variable.ts

@@ -0,0 +1,43 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
+import { ApiType } from './ApiTypes.js';
+import { Entity } from './base.js';
+
+/**
+ * @deprecated
+ */
+export declare interface Environment {
+  name: string;
+  created?: number;
+}
+
+/**
+ * @deprecated
+ */
+export declare interface Variable extends ApiType {
+}
+
+/**
+ * @deprecated
+ */
+export declare interface ARCEnvironment extends Environment, Entity {
+  
+}
+
+/**
+ * @deprecated
+ */
+export declare interface ARCVariable extends Variable, Entity {
+  /**
+   * The name of the environment the variable is added to.
+   */
+  environment: string;
+  /**
+   * @deprecated Use `name` instead.
+   */
+  variable?: string;
+}
+
+/**
+ * @deprecated
+ */
+export declare type SystemVariables = Readonly<{[key: string]: string}>;

package/src/models/legacy/models/base.d.ts

@@ -0,0 +1,95 @@
+/**
+ * @deprecated
+ */
+export declare interface Entity {
+  /**
+   * Pouch DB datastore `_id`
+   */
+  _id?: string;
+  /**
+   * Pouch DB datastore `_rev` as a revision of the object
+   */
+  _rev?: string;
+  /**
+   * Special flag used by PouchDB to delete an object.
+   */
+  _deleted?: boolean;
+}
+
+/**
+ * @deprecated
+ */
+export declare interface DeletedEntity {
+  /**
+   * Pouch DB datastore `_id`
+   */
+  id: string;
+  /**
+   * Pouch DB datastore revision of the deleted object
+   */
+  rev: string;
+}
+
+/**
+ * An entity change record base definition
+ * @deprecated
+ */
+export declare interface ARCEntityChangeRecord<T> {
+  /**
+   * The ID of the changed entity
+   */
+  id: string;
+  /**
+   * The revision of the updated entity.
+   * It is not set when old revision is unavailable (new entity is created).
+   */
+  oldRev?: string;
+  /**
+   * New revision id of updated entity
+   */
+  rev: string;
+  /**
+   * The updated entity.
+   */
+  item?: T;
+}
+
+/**
+ * Event detail object for data store query result object.
+ * @deprecated
+ */
+export declare interface ARCModelListResultDetail<T> {
+  result: Promise<ARCModelListResult<T>>;
+}
+
+/**
+ * Base query options for the data store.
+ * @deprecated
+ */
+export declare interface ARCModelListOptions {
+  /**
+   * The number of results per the page.
+   */
+  limit?: number;
+  /**
+   * A string that should be used with pagination.
+   */
+  nextPageToken?: string;
+}
+
+/**
+ * Data store query result object.
+ * @deprecated
+ */
+export declare interface ARCModelListResult<T> {
+  /**
+   * Next page token to be used with pagination.
+   * It is not set when the query has not returned any results.
+   */
+  nextPageToken?: string;
+  /**
+   * The list of items in the response.
+   * May be empty array when there was no more results.
+   */
+  items: T[];
+}