@advanced-rest-client/arc-models

v5.2.4

Published

3 years ago

Event based access to ARC datastores

Downloads

2,083

0High
0Medium
0Low

web-components datastore api

Deprecated

This has been moved to @advanced-rest-client/idb-store

Data models for Advanced REST Client application. This module contains the logic used by the application to store and restore data to the UI.

It also provides DOM events based access to the API. Each operation has corresponding event that can be used to access the data. A convenient way of using the events API is to by using the ArcModelEvents and ArcModelEventTypes interfaces. The first provides access to function which call creates and dispatches events on a given node. The later provides the definition of the event types for manual handling.

It is highly recommended to use this models with the support of typescript. The library and each component has types definition with documentation for convenient use. Types are declared in @advanced-rest-client/arc-types module.

Usage

The models are modularized so the ARC application can easily replace each interface depending on the interface. It also allows to extract part of the application logic to the outside the application and use the same models to add storage support.

Installation

npm install --save @advanced-rest-client/arc-models

Working with the events

Each model has a corresponding to (almost) each public method an event that can be used instead of directly accessing the model instance. It is more convenient than direct use of the library in each component as it's easier to manage API changes if the components are using an abstract layer instead of the direct API. This way it's a much simpler task to change the data store implementation that when the components would use the library directly.

Say, you want to list ARC requests data stored in the application. This is supported by the request-model. You can access the data by dispatching the list event:

import '@advanced-rest-client/arc-models/request-model.js';
import { ArcModelEvents } '@advanced-rest-client/arc-models';

const result = await ArcModelEvents.Request.list(document.body, 'saved', {
  limit: 25,
});
const { items } = result;

Pagination

All components uses the same interface to list the data. When calling list() function (or the corresponding event) an the model it always accept an object with the limit and nextPageToken property. Both are optional. The limit tells the model how many entities to return with the response. Then next page token is returned with each list result and contains hashed data about the current position in the pagination.

import '@advanced-rest-client/arc-models/request-model.js';
import { ArcModelEvents } '@advanced-rest-client/arc-models';

const result = await ArcModelEvents.Request.list(document.body, 'saved', {
  limit: 25,
});
const { items, nextPageToken } = result;

The items array contains a list of ARCSavedRequest entities. The second property returned by the query is the nextPageToken that now can be passed to the next list request to request the next page of the results.

const next = await ArcModelEvents.Request.list(document.body, 'saved', {
  limit: 25,
  nextPageToken,
});

Note that limit has to be defined for each call as the page cursor does not store this information.

In an html file

<html>
  <head>
    <script type="module">
      import '@advanced-rest-client/arc-models/auth-data-model.js';
      import '@advanced-rest-client/arc-models/host-rules-model.js';
      import '@advanced-rest-client/arc-models/project-model.js';
      import '@advanced-rest-client/arc-models/request-model.js';
      import '@advanced-rest-client/arc-models/rest-api-model.js';
      import '@advanced-rest-client/arc-models/url-indexer.js';
      import '@advanced-rest-client/arc-models/variables-model.js';
      import '@advanced-rest-client/arc-models/websocket-url-history-model.js';
    </script>
  </head>
  <body>
    <auth-data-model></auth-data-model>
    <host-rules-model></host-rules-model>
    <project-model></project-model>
    <request-model></request-model>
    <rest-api-model></rest-api-model>
    <url-indexer></url-indexer>
    <variables-model></variables-model>
    <websocket-url-history-model></websocket-url-history-model>
  </body>
</html>

In a LitElement template

import { LitElement, html } from 'lit-element';
import '@advanced-rest-client/arc-models/auth-data-model.js';
import '@advanced-rest-client/arc-models/host-rules-model.js';
import '@advanced-rest-client/arc-models/project-model.js';
import '@advanced-rest-client/arc-models/request-model.js';
import '@advanced-rest-client/arc-models/rest-api-model.js';
import '@advanced-rest-client/arc-models/url-indexer.js';
import '@advanced-rest-client/arc-models/variables-model.js';
import '@advanced-rest-client/arc-models/websocket-url-history-model.js';

class SampleElement extends LitElement {
  render() { `
    <auth-data-model></auth-data-model>
    <host-rules-model></host-rules-model>
    <project-model></project-model>
    <request-model></request-model>
    <rest-api-model></rest-api-model>
    <url-indexer></url-indexer>
    <variables-model></variables-model>
    <websocket-url-history-model></websocket-url-history-model>
    `;
  }
}
customElements.define('sample-element', SampleElement);

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@advanced-rest-client/arc-models/auth-data-model.js';
import '@advanced-rest-client/arc-models/host-rules-model.js';
import '@advanced-rest-client/arc-models/project-model.js';
import '@advanced-rest-client/arc-models/request-model.js';
import '@advanced-rest-client/arc-models/rest-api-model.js';
import '@advanced-rest-client/arc-models/url-indexer.js';
import '@advanced-rest-client/arc-models/variables-model.js';
import '@advanced-rest-client/arc-models/websocket-url-history-model.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`<auth-data-model></auth-data-model>
    <host-rules-model></host-rules-model>
    <project-model></project-model>
    <request-model></request-model>
    <rest-api-model></rest-api-model>
    <url-indexer></url-indexer>
    <variables-model></variables-model>
    <websocket-url-history-model></websocket-url-history-model>`;
  }
}
customElements.define('sample-element', SampleElement);

Export elements

ImportDataInspectorElement

An element to visually inspect ARC export object. It is used by ARC during the import flow.

<import-data-inspector .data="${data}" @cancel="${this.cancelled}" @import="${this.imported}"></import-data-inspector>

The data object is the ArcExportObject declare in the @advanced-rest-client/arc-types/DataExport declaration.

ExportOptionsElement

An element to present the user with the file export options handled by the application.

<export-options file="my-demo-file.arc" provider="drive" parentId="drive file id" withEncrypt></export-options>

The element dispatches event defined in GoogleDriveEventTypes.listAppFolders to request the application to list all application created folder in the Google Drive application.

ArcExportFormElement

An element that contains a UI to present ARC database export options. It communicates with the ArcDataExportElement via events.

<arc-export-form withEncrypt provider="drive" parentId="drive file id"></arc-export-form>

ArcDataExportElement

A component that handles ARC data export logic via events. It takes care for creating an export object for ARC data, encrypting the content (when requested) and to produce communicate with the export provides via event.

This element should be inserted into the DOM somewhere in the project.

<are-data-export appVersion="major.minor.patch" electronCookies></are-data-export>

ArcDataImportElement

The opposite of the ArcDataExportElement element. Provides the logic for the import flow and communicates with other components via the events system to finish the import flow.

<are-data-import></are-data-import>

Development

git clone https://github.com/@advanced-rest-client/arc-models
cd arc-models
npm install

Running the demo locally

npm start

Running the tests

npm test