kuzzle-sdk
Advanced tools
Comparing version 7.12.0 to 7.13.0
@@ -1,1 +0,1 @@ | ||
/*! Kuzzle Javascript SDK version 7.12.0 */ | ||
/*! Kuzzle Javascript SDK version 7.13.0 */ |
{ | ||
"name": "kuzzle-sdk", | ||
"version": "7.12.0", | ||
"version": "7.13.0", | ||
"description": "Official Javascript SDK for Kuzzle", | ||
@@ -44,2 +44,4 @@ "author": "The Kuzzle Team <support@kuzzle.io>", | ||
"devDependencies": { | ||
"@babel/core": "^7.21.4", | ||
"@babel/preset-env": "^7.21.4", | ||
"@commitlint/cli": "^17.6.7", | ||
@@ -51,11 +53,6 @@ "@commitlint/config-conventional": "^17.6.7", | ||
"@semantic-release/release-notes-generator": "^11.0.4", | ||
"@babel/core": "^7.21.4", | ||
"@babel/preset-env": "^7.21.4", | ||
"@types/node": "^18.15.11", | ||
"babel-loader": "^8.3.0", | ||
"buffer": "^6.0.3", | ||
"codecov": "^3.8.3", | ||
"cucumber": "^6.0.5", | ||
"semantic-release-config-kuzzle": "^1.0.0", | ||
"semantic-release-slack-bot": "^4.0.2", | ||
"cz-conventional-changelog": "^3.3.0", | ||
@@ -72,2 +69,4 @@ "eslint-plugin-kuzzle": "^0.0.6", | ||
"rewire": "^6.0.0", | ||
"semantic-release-config-kuzzle": "^1.0.0", | ||
"semantic-release-slack-bot": "^4.0.2", | ||
"should": "13.2.3", | ||
@@ -74,0 +73,0 @@ "should-sinon": "0.0.6", |
@@ -8,5 +8,2 @@ <p align="center"> | ||
</a> | ||
<a href="https://codecov.io/gh/kuzzleio/sdk-javascript"> | ||
<img src="https://codecov.io/gh/kuzzleio/sdk-javascript/branch/master/graph/badge.svg" /> | ||
</a> | ||
<a href="https://david-dm.org/kuzzleio/sdk-javascript"> | ||
@@ -28,4 +25,4 @@ <img src="https://david-dm.org/kuzzleio/sdk-javascript.svg" /> | ||
Currently, the SDK provides 2 protocols: __Http and WebSocket.__ | ||
WebSocket protocol implement the whole Kuzzle API, while the HTTP protocol does not implement realtime features (rooms and subscriptions). | ||
Currently, the SDK provides 2 protocols: **Http and WebSocket.** | ||
WebSocket protocol implement the whole Kuzzle API, while the HTTP protocol does not implement realtime features (rooms and subscriptions). | ||
@@ -47,8 +44,7 @@ #### Promises based | ||
* :octocat: __[Github](https://github.com/kuzzleio/kuzzle)__ | ||
* :earth_africa: __[Website](https://kuzzle.io)__ | ||
* :books: __[Documentation](https://docs.kuzzle.io)__ | ||
* :email: __[Discord](http://join.discord.kuzzle.io)__ | ||
- :octocat: **[Github](https://github.com/kuzzleio/kuzzle)** | ||
- :earth_africa: **[Website](https://kuzzle.io)** | ||
- :books: **[Documentation](https://docs.kuzzle.io)** | ||
- :email: **[Discord](http://join.discord.kuzzle.io)** | ||
## Get trained by the creators of Kuzzle :zap: | ||
@@ -65,3 +61,3 @@ | ||
| Kuzzle Version | SDK Version | | ||
|----------------|-------------| | ||
| -------------- | ----------- | | ||
| 1.x.x | 5.x.x | | ||
@@ -73,7 +69,7 @@ | 1.x.x | 6.x.x | | ||
- [Node.js](https://docs.kuzzle.io/sdk/js/7/getting-started/node-js/) | ||
- [Browser](https://docs.kuzzle.io/sdk/js/7/getting-started/raw-web/) | ||
- [Webpack](https://docs.kuzzle.io/sdk/js/7/getting-started/webpack/) | ||
- [React/Redux](https://docs.kuzzle.io/sdk/js/7/getting-started/react/with-redux/) | ||
- [Vue.js](https://docs.kuzzle.io/sdk/js/7/getting-started/vuejs/standalone/) | ||
- [Node.js](https://docs.kuzzle.io/sdk/js/7/getting-started/node-js/) | ||
- [Browser](https://docs.kuzzle.io/sdk/js/7/getting-started/raw-web/) | ||
- [Webpack](https://docs.kuzzle.io/sdk/js/7/getting-started/webpack/) | ||
- [React/Redux](https://docs.kuzzle.io/sdk/js/7/getting-started/react/with-redux/) | ||
- [Vue.js](https://docs.kuzzle.io/sdk/js/7/getting-started/vuejs/standalone/) | ||
@@ -84,3 +80,3 @@ ### Installation | ||
#### Node.js | ||
#### Node.js | ||
@@ -93,7 +89,9 @@ ``` | ||
To run the SDK in the browser, you have to build it yourself by cloning this repository and running | ||
To run the SDK in the browser, you have to build it yourself by cloning this repository and running | ||
```bash | ||
$ npm install | ||
$ npm run build | ||
```` | ||
``` | ||
A `dist` directory will be created, containing a browser version of this SDK. | ||
@@ -108,3 +106,6 @@ | ||
```html | ||
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/kuzzle-sdk@latest/dist/kuzzle.min.js"></script> | ||
<script | ||
type="text/javascript" | ||
src="https://cdn.jsdelivr.net/npm/kuzzle-sdk@latest/dist/kuzzle.min.js" | ||
></script> | ||
``` | ||
@@ -115,8 +116,6 @@ | ||
```html | ||
<script> | ||
const kuzzle = new KuzzleSDK.Kuzzle( | ||
new KuzzleSDK.WebSocket('localhost') | ||
); | ||
// ... | ||
</script> | ||
<script> | ||
const kuzzle = new KuzzleSDK.Kuzzle(new KuzzleSDK.WebSocket("localhost")); | ||
// ... | ||
</script> | ||
``` | ||
@@ -136,5 +135,5 @@ | ||
// with the classic require... | ||
const { Kuzzle } = require('kuzzle-sdk') | ||
const { Kuzzle } = require("kuzzle-sdk"); | ||
// ... or with the new import directive. | ||
import { Kuzzle } from 'kuzzle-sdk' | ||
import { Kuzzle } from "kuzzle-sdk"; | ||
``` | ||
@@ -144,10 +143,8 @@ | ||
The SDK supports different protocols. When instantiating, | ||
you must choose the protocol to use and fill in the different options needed to connect to Kuzzle. | ||
The SDK supports different protocols. When instantiating, | ||
you must choose the protocol to use and fill in the different options needed to connect to Kuzzle. | ||
```js | ||
const { Kuzzle, WebSocket } = require('kuzzle-sdk'); | ||
const kuzzle = new Kuzzle( | ||
new WebSocket('localhost', { port: 7512 }) | ||
); | ||
const { Kuzzle, WebSocket } = require("kuzzle-sdk"); | ||
const kuzzle = new Kuzzle(new WebSocket("localhost", { port: 7512 })); | ||
@@ -154,0 +151,0 @@ try { |
@@ -0,4 +1,4 @@ | ||
import { SpecificationsSearchResult } from "../core/searchResult/Specifications"; | ||
import { ArgsDefault, CollectionMappings, JSONObject } from "../types"; | ||
import { BaseController } from "./Base"; | ||
import { SpecificationsSearchResult } from "../core/searchResult/Specifications"; | ||
import { CollectionMappings, JSONObject, ArgsDefault } from "../types"; | ||
export declare class CollectionController extends BaseController { | ||
@@ -173,2 +173,6 @@ constructor(kuzzle: any); | ||
/** | ||
* If true, reindex the collection | ||
*/ | ||
reindexCollection?: boolean; | ||
/** | ||
* Elasticsearch index settings | ||
@@ -175,0 +179,0 @@ */ |
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.CollectionController = void 0; | ||
const Specifications_1 = require("../core/searchResult/Specifications"); | ||
const Base_1 = require("./Base"); | ||
const Specifications_1 = require("../core/searchResult/Specifications"); | ||
class CollectionController extends Base_1.BaseController { | ||
@@ -7,0 +7,0 @@ constructor(kuzzle) { |
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
35
12504
559111
148