diff --git a/.eslintignore b/.eslintignore deleted file mode 100644 index db4c6d9..0000000 --- a/.eslintignore +++ /dev/null @@ -1,2 +0,0 @@ -dist -node_modules \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js index 6414207..bf987ee 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -16,4 +16,5 @@ module.exports = { }, }, plugins: ["prettier", "jest"], + ignorePatterns: ["dist/*", "node_modules/*"], }; diff --git a/LICENSE.md b/LICENSE.md index d3a024c..6df1a67 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (C) 2020, Neuroio, dev@serptech.ru +Copyright (C) 2024, SERP, d@serptech.ru Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index 9b6c872..fdad9b1 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,39 @@ -# Neuroio API JS library - - -[](https://app.netlify.com/sites/neuroio-js/deploys) +# Serp API JS library ## Installation ### NPM ```bash -npm i --save @neuroio/api +npm i --save @serp/api ``` ### Yarn ```bash -yarn add @neuroio/api +yarn add @serp/api ``` ## Usage ```js // ES2015 module import: -import { createNeuroioRestApi, createNeuroioWsApi } from "@neuroio/api"; +import { createSerpRestApi, createSerpWsApi } from "@serp/api"; // CommonJS module require: -const { createNeuroioRestApi, createNeuroioWsApi } = require("@neuroio/api"); +const { createSerpRestApi, createSerpWsApi } = require("@serp/api"); // REST -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: "YOUR_NEUROIO_TOKEN", + token: "YOUR_SERP_TOKEN", }); // WebSocket -const NeuroioWsApi = createNeuroioWsApi({ +const SerpWsApi = createSerpWsApi({ version: 1, - token: "YOUR_NEUROIO_TOKEN", + token: "YOUR_SERP_TOKEN", }); -NeuroioWsApi.connect(); +SerpWsApi.connect(); ``` diff --git a/docs/README.md b/docs/README.md index eb88261..487c7bf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,37 +1,37 @@ -# Neuroio API JS library +# Serp API JS library ## Installation ### NPM ```bash -npm i --save @neuroio/api +npm i --save @serp/api ``` ### Yarn ```bash -yarn add @neuroio/api +yarn add @serp/api ``` ## Usage ```js // ES2015 module import: -import { createNeuroioRestApi, createNeuroioWsApi } from "@neuroio/api"; +import { createSerpRestApi, createSerpWsApi } from "@serp/api"; // CommonJS module require: -const { createNeuroioRestApi, createNeuroioWsApi } = require("@neuroio/api"); +const { createSerpRestApi, createSerpWsApi } = require("@serp/api"); -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: "YOUR_NEUROIO_TOKEN", + token: "YOUR_SERP_TOKEN", }); -const NeuroioWsApi = createNeuroioWsApi({ +const SerpWsApi = createSerpWsApi({ version: 1, - token: "YOUR_NEUROIO_TOKEN", + token: "YOUR_SERP_TOKEN", }); -NeuroioWsApi.connect(); +SerpWsApi.connect(); ``` diff --git a/docs/authorization.md b/docs/authorization.md index 62129ef..3c2cff0 100644 --- a/docs/authorization.md +++ b/docs/authorization.md @@ -1,23 +1,23 @@ # Authorization API reference -## Neuroio API references +## Serp API references -[Neuroio API](https://kb.serptech.ru/#/authorization) +[Serp API](https://kb.serptech.ru/#/authorization) ## Login ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); const username = "Jane Doe"; const password = "04.09.2001"; -const userWithToken = NeuroioRestApi.auth.login(username, password); +const userWithToken = SerpRestApi.auth.login(username, password); notification.then((userWithToken) => { console.log({ userWithToken }); @@ -29,16 +29,16 @@ notification.then((userWithToken) => { !> Note that you got token Id with login response. ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); const tokenId = 12; -const logout = NeuroioRestApi.auth.logout(tokenId); +const logout = SerpRestApi.auth.logout(tokenId); logout.then(() => { console.log("Logout successful!"); @@ -47,17 +47,17 @@ logout.then(() => { ## Get current user -[Neuroio API](https://kb.serptech.ru/#/authorization?id=user-name-and-group) +[Serp API](https://kb.serptech.ru/#/authorization?id=user-name-and-group) ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); -const user = NeuroioRestApi.auth.whoami(); +const user = SerpRestApi.auth.whoami(); user.then((user) => { console.log({ user }); @@ -66,17 +66,17 @@ user.then((user) => { ## Change current user password -[Neuroio API](https://kb.serptech.ru/#/authorization?id=password-change) +[Serp API](https://kb.serptech.ru/#/authorization?id=password-change) ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); -const result = NeuroioRestApi.auth.changePassword({ +const result = SerpRestApi.auth.changePassword({ old_password: "your_old_pass", password: "your_new_pass", password2: "your_new_pass", diff --git a/docs/entries.md b/docs/entries.md index 6284c44..59788f2 100644 --- a/docs/entries.md +++ b/docs/entries.md @@ -3,14 +3,14 @@ ## Get list of entries ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); -const haEntries = NeuroioRestApi.entries.getEntries({ result: "ha" }); +const haEntries = SerpRestApi.entries.getEntries({ result: "ha" }); haEntries.then((haEntries) => { console.log({ haEntries }); @@ -20,16 +20,16 @@ haEntries.then((haEntries) => { ## Get list of entries of a person ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); const pid = "123"; -const personEntries = NeuroioRestApi.entries.getEntries({ pid }); +const personEntries = SerpRestApi.entries.getEntries({ pid }); personEntries.then((personEntries) => { console.log({ personEntries }); @@ -39,16 +39,16 @@ personEntries.then((personEntries) => { ## Get entries stats by PID ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); const pid = "123"; -const entriesStats = NeuroioRestApi.entries.getEntriesStatsByPersonId(pid); +const entriesStats = SerpRestApi.entries.getEntriesStatsByPersonId(pid); entriesStats.then((entriesStats) => { console.log({ entriesStats }); @@ -58,16 +58,16 @@ entriesStats.then((entriesStats) => { ## Delete entry ```js -import { createNeuroioRestApi } from "@neuroio/api"; +import { createSerpRestApi } from "@serp/api"; -const NeuroioRestApi = createNeuroioRestApi({ +const SerpRestApi = createSerpRestApi({ version: 1, - token: NEUROIO_TOKEN, + token: SERP_TOKEN, }); const entryId = 1; -const entry = NeuroioRestApi.entries.deleteEntry(entryId); +const entry = SerpRestApi.entries.deleteEntry(entryId); entry.then(() => { console.log("Entry was deleted!"); diff --git a/docs/guide.md b/docs/guide.md index 17e84cd..eeeed6b 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -1,8 +1,8 @@ # Usage guide -## Neuroio API references +## Serp API references -Most of features have Neuroio API reference, link to witch you can find in description of each specific feature method. +Most of features have Serp API reference, link to witch you can find in description of each specific feature method. ## Data formats @@ -15,4 +15,4 @@ This lib handles two types of file data: ### Dates -Neuroio API works with [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) dates format +Serp API works with [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) dates format diff --git a/docs/index.html b/docs/index.html index f65bfb8..bab3b61 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,10 +3,10 @@