All files / js EngineClient.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/*
 * Grakn - A Distributed Semantic Database
 * Copyright (C) 2016  Grakn Labs Limited
 *
 * Grakn is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Grakn is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Grakn. If not, see <http://www.gnu.org/licenses/gpl.txt>.
 */
import User from './User';
 
/*
 * REST API client for Grakn Engine.
 */
export default {
    /**
     * Make an AJAX request with @requestData parameters.
     * Required attributes of @requestData are:
     *  - url
     * Optional attributes with defaults:
     *  - cache
     * @param requestData
     */
  request(requestData) {
    return new Promise((resolve, reject) => {
 
      const req = new XMLHttpRequest();
      req.open(requestData.requestType || 'GET', requestData.url);
      this.setHeaders(req, requestData);
 
      req.onload = function setOnLoad() {
        if (req.status === 200) {
          resolve(req.response);
        } else {
          reject(Error(req.response));
        }
      };
 
        // Handle network errors
      req.onerror = function setOnError() {
        reject(Error('Network Error'));
      };
 
    // Make the request
      req.send(requestData.data);
    });
  },
 
  setHeaders(xhr, requestData) {
    const token = localStorage.getItem('id_token');
    if (token != null) {
      xhr.setRequestHeader('Authorization', `Bearer ${token}`);
    }
    xhr.setRequestHeader('Content-Type', requestData.contentType || 'application/json; charset=utf-8');
    xhr.setRequestHeader('Accept', requestData.accepts || 'application/hal+json');
  },
 
  sendInvite(credentials, callbackFn) {
    $.ajax({
      type: 'POST',
      contentType: 'application/json; charset=utf-8',
      dataType: 'json',
      cache: false,
      data: JSON.stringify({
        name: credentials.name,
        surname: credentials.surname,
        email: credentials.email,
      }),
      url: 'https://grakn-community-inviter.herokuapp.com/invite',
    }).always((r) => {
      callbackFn(r);
    });
  },
 
  fetchKeyspaces() {
    return this.request({
      url: '/keyspaces',
    });
  },
 
  newSession(creds) {
    return this.request({
      url: '/auth/session/',
      data: JSON.stringify({
        username: creds.username,
        password: creds.password,
      }),
      requestType: 'POST',
    });
  },
            /**
             * Pre materialise
             */
  preMaterialiseAll() {
    this.request({
      url: `/graph/precomputeInferences?keyspace=${User.getCurrentKeySpace()}`,
      contentType: 'application/text',
    });
  },
 
            /**
             * Send graql shell command to engine. Returns a string representing shell output.
             */
  graqlShell(query) {
    return this.request({
      url: `/graph/graql?keyspace=${User.getCurrentKeySpace()}&query=${encodeURIComponent(query)}&infer=${User.getReasonerStatus()}&materialise=${User.getMaterialiseStatus()}`,
      contentType: 'application/text',
      accepts: 'application/text',
    });
  },
            /**
             * Send graql query to Engine, returns an array of HAL objects.
             */
  graqlHAL(query) {
      // In match queries we are also attaching a limit for the embedded objects of the resulting nodes, this is not the query limit.
    return this.request({
      url: `/graph/graql?keyspace=${User.getCurrentKeySpace()}&query=${encodeURIComponent(query)}&infer=${User.getReasonerStatus()}&materialise=${User.getMaterialiseStatus()}&limitEmbedded=${User.getQueryLimit()}`,
    });
  },
            /**
             * Send graql query to Engine, returns an array of HAL objects.
             */
  graqlAnalytics(query) {
    return this.request({
      url: `/graph/graql?keyspace=${User.getCurrentKeySpace()}&query=${encodeURIComponent(query)}&infer=false&materialise=false`,
      accepts: 'application/text',
    });
  },
 
  explainQuery(query) {
    return this.request({
      url: `/dashboard/explain?keyspace=${User.getCurrentKeySpace()}&query=${encodeURIComponent(query)}`,
    });
  },            /**
             * Get current engine configuration.
             */
  getConfig() {
    return this.request({
      url: '/configuration',
    });
  },
            /**
             * Get meta ontology type instances.
             */
  getMetaTypes() {
    return this.request({
      url: `/graph/ontology?keyspace=${User.getCurrentKeySpace()}`,
    });
  },
 
  getConceptTypes(id) {
    return this.request({
      url: `/dashboard/types/${id}?keyspace=${User.getCurrentKeySpace()}&limitEmbedded=${User.getQueryLimit()}`,
    });
  },
 
  /**
    * Get list of queued tasks from Engine
    */
  getAllTasks() {
    return this.request({
      url: '/tasks',
    });
  },
 
  stopTask(uuid) {
    return this.request({
      url: `/tasks/${uuid}/stop`,
      requestType: 'PUT',
    });
  },
};