oneentry 1.0.64 → 1.0.65

package/README.md

@@ -55,7 +55,7 @@ const api = defineOneEntry('your-url');
 
 The second parameter of the function takes a configuration object with the keys "token", "langCode" and "multipleResponse".
 Set the token key if your project secure "Security API Token"
-
+If your project uses user authorization, pass the user access token to the "userToken" variable to use methods that require authorization.
 Set the "langCode" to set the default language. By specifying this parameter once, you don't have to pass the langCode to the methods ONEENTRY API. If you have not passed the default language, it will be set "en_US"
 Some methods use more than one request to the CMS so that the data you receive is complete and easy to work with. Pass the value "false" for this parameter to save traffic and decide for yourself what data you need. The default value "true"
 
@@ -74,8 +74,13 @@ You can also connect a tls certificate to protect your project. In this case, do
 
 
 ```js 
-const api = defineOneEntry('your-url', {token: 'my-token', langCode:'my-langCode'})
+const api = defineOneEntry('your-url', {
+    token: 'my-token', 
+    userToken: 'user.token',
+    langCode:'my-langCode',
+})
 ```
+
 Now you can use the following links to jump to specific entries:
 - [Admins](#admins)
 - [AttributesSets](#attributessets)
@@ -373,7 +378,7 @@ const data = {
     }
 }
 
-const value = await AuthProvider.getBlocks('en_US', 0, 30)
+const value = await AuthProvider.signUp('email', data)
 ```
 
 > This method will register a new user. Returns the registered user's object.
@@ -510,10 +515,23 @@ Example return:
 true
 ```
 
-### AuthProvider.auth(marker, login, password)
+### AuthProvider.auth(marker, data)
 
 ```js
-const value = await AuthProvider.auth('email', 'test@trer.com', '123456')
+const data = {
+    authData: [
+        {
+            marker: "login",
+            value: "user@gmail.com"
+        },
+        {
+            marker: "password",
+            value: "12345"
+        }
+    ]
+}
+
+const value = await AuthProvider.auth('email', data)
 ```
 
 > This method performs user authorization. Returns an object with a set of tokens.
@@ -698,9 +716,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
       "title": "My block"
-    }
   },
   "version": 10,
   "identifier": "catalog",

package/dist/auth-provider/authProviderApi.d.ts

@@ -1,6 +1,6 @@
 import OneEntry from "../base/oneEntry";
 import { IConfig } from "../base/utils";
-import { IAuthProvider, ISignUpData, ISignUpEntity, ICodeEntity, IAuthEntity, IAuthProvidersEntity } from "./authProvidersInterfaces";
+import { IAuthProvider, ISignUpData, ISignUpEntity, ICodeEntity, IAuthEntity, IAuthProvidersEntity, IAuthPostBody } from "./authProvidersInterfaces";
 /**
  * Controllers for working with auth services.
  */
@@ -44,11 +44,6 @@ export default class AuthProviderApi extends OneEntry implements IAuthProvider {
      * Getting a user activation code
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} userIdentifier - The text identifier of the user's object (user login)
-     *
-     * @example
-     * const data = {
-     *   "userIdentifier": "test@test.com"
-     * }
      */
     generateCode(marker: string, userIdentifier: string): Promise<ICodeEntity>;
     /**
@@ -61,11 +56,24 @@ export default class AuthProviderApi extends OneEntry implements IAuthProvider {
     /**
      * User authorization
      * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} login - User login
-     * @param {string} password - User password
+     * @param {IAuthPostBody} data - Array of objects contains auth information
+     *
+     * @example
+     * const data = {
+     *   authData: [
+     *     {
+     *       marker: "login",
+     *       value: "test"
+     *     },
+     *     {
+     *       marker: "password",
+     *       value: "12345"
+     *     }
+     *   ]
+     * }
      *
      */
-    auth(marker: string, login: string, password: string): Promise<IAuthEntity>;
+    auth(marker: string, data: IAuthPostBody): Promise<IAuthEntity>;
     /**
      * Refresh token
      * @param {string} marker - The text identifier of the authorization provider. Example - email
@@ -94,7 +102,7 @@ export default class AuthProviderApi extends OneEntry implements IAuthProvider {
      * @param {number} [offset] - Parameter for pagination. Default 0
      * @param {number} [limit] - Parameter for pagination. Default 30
      */
-    getAuthProviders(langCode: string, offset: number, limit: number): Promise<Array<IAuthProvidersEntity>>;
+    getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<Array<IAuthProvidersEntity>>;
     /**
      * Get one auth provider object by marker
      * @param {string} marker - The text identifier of the authorization provider. Example - email

package/dist/auth-provider/authProviderApi.js

@@ -43,18 +43,14 @@ class AuthProviderApi extends oneEntry_1.default {
      * }
      */
     async signUp(marker, data, langCode = this._defaultLangCode) {
-        const result = await this._fetchPost(`/marker/${marker}/users/sign-up`, this._normalizePostBody(data, langCode));
+        const body = this._normalizePostBody(data, langCode);
+        const result = await this._fetchPost(`/marker/${marker}/users/sign-up`, body);
         return this._normalizeData(result);
     }
     /**
      * Getting a user activation code
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} userIdentifier - The text identifier of the user's object (user login)
-     *
-     * @example
-     * const data = {
-     *   "userIdentifier": "test@test.com"
-     * }
      */
     async generateCode(marker, userIdentifier) {
         const data = {
@@ -80,22 +76,26 @@ class AuthProviderApi extends oneEntry_1.default {
     /**
      * User authorization
      * @param {string} marker - The text identifier of the authorization provider. Example - email
-     * @param {string} login - User login
-     * @param {string} password - User password
+     * @param {IAuthPostBody} data - Array of objects contains auth information
+     *
+     * @example
+     * const data = {
+     *   authData: [
+     *     {
+     *       marker: "login",
+     *       value: "test"
+     *     },
+     *     {
+     *       marker: "password",
+     *       value: "12345"
+     *     }
+     *   ]
+     * }
      *
      */
-    async auth(marker, login, password) {
-        const data = [
-            {
-                "marker": "login",
-                "value": login
-            },
-            {
-                "marker": "password",
-                "value": password
-            }
-        ];
-        const result = await this._fetchPost(`/marker/${marker}/users/activate`, data);
+    async auth(marker, data) {
+        const result = await this._fetchPost(`/marker/${marker}/users/auth`, data);
+        this._userToken = result.accessToken;
         return result;
     }
     /**
@@ -119,6 +119,9 @@ class AuthProviderApi extends oneEntry_1.default {
             "refreshToken": token
         };
         const result = await this._fetchPost(`/marker/${marker}/users/logout`, data);
+        if (result) {
+            this._userToken = null;
+        }
         return result;
     }
     /**
@@ -145,7 +148,7 @@ class AuthProviderApi extends oneEntry_1.default {
      * @param {number} [offset] - Parameter for pagination. Default 0
      * @param {number} [limit] - Parameter for pagination. Default 30
      */
-    async getAuthProviders(langCode, offset, limit) {
+    async getAuthProviders(langCode = this._defaultLangCode, offset = 0, limit = 30) {
         const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
         return this._normalizeData(result);
     }
@@ -154,7 +157,7 @@ class AuthProviderApi extends oneEntry_1.default {
      * @param {string} marker - The text identifier of the authorization provider. Example - email
      * @param {string} [langCode] - Optional parameter language code. Default "en_US"
      */
-    async getMarker(marker, langCode) {
+    async getMarker(marker, langCode = this._defaultLangCode) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._normalizeData(result);
     }

package/dist/auth-provider/authProvidersInterfaces.d.ts

@@ -16,11 +16,11 @@ interface IAuthProvider {
     signUp(marker: string, data: ISignUpData, langCode?: string): Promise<ISignUpEntity>;
     generateCode(marker: string, userIdentifier: string): Promise<ICodeEntity>;
     activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean>;
-    auth(marker: string, login: string, password: string): Promise<IAuthEntity>;
+    auth(marker: string, data: IAuthPostBody): Promise<IAuthEntity>;
     refresh(marker: string, token: string): Promise<IAuthEntity>;
     logout(marker: string, token: string): Promise<boolean>;
     changePassword(marker: string, userIdentifier: string, code: string, newPassword: string, repeatPassword?: string): Promise<boolean>;
-    getAuthProviders(langCode: string, offset: number, limit: number): Promise<Array<IAuthProvidersEntity>>;
+    getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<Array<IAuthProvidersEntity>>;
     getMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity>;
 }
 interface IAuthFormData {
@@ -78,4 +78,10 @@ interface IAuthProvidersEntity {
     type: string;
     formIdentifier: string | null;
 }
-export { IAuthProvider, IAuthFormData, ISignUpData, ISignUpEntity, ICodeEntity, IAuthEntity, IAuthProvidersEntity };
+interface IAuthPostBody {
+    authData: Array<{
+        marker: string;
+        value: string | number;
+    }>;
+}
+export { IAuthProvider, IAuthFormData, ISignUpData, ISignUpEntity, ICodeEntity, IAuthEntity, IAuthProvidersEntity, IAuthPostBody };

package/dist/base/oneEntry.d.ts

@@ -4,6 +4,7 @@ import { IUploadingQuery } from "../file-uploding/fileUploadingInterfaces";
 export default abstract class OneEntry {
     protected _url: string;
     protected _token: string | undefined;
+    protected _userToken: string | undefined;
     protected _defaultLangCode: string;
     protected _multipleResponse: boolean;
     protected _NO_FETCH: boolean;

package/dist/base/oneEntry.js

@@ -5,6 +5,7 @@ class OneEntry {
         var _a;
         this._url = url;
         this._token = config.token;
+        this._userToken = config.userToken;
         this._defaultLangCode = config.langCode ? config.langCode : 'en_US';
         this._multipleResponse = (_a = config.multipleRequests) !== null && _a !== void 0 ? _a : true;
         this._NO_FETCH = !!(typeof process === 'object' && process.versions);
@@ -24,6 +25,7 @@ class OneEntry {
             headers: {
                 'Content-Type': 'application/json',
                 'x-app-token': this._token,
+                'Authorization': this._userToken
             }
         };
         if (!this._NO_FETCH) {
@@ -56,7 +58,8 @@ class OneEntry {
             method: 'POST',
             headers: {
                 'x-app-token': this._token,
-                'Content-Type': 'application/json'
+                'Content-Type': 'application/json',
+                'Authorization': this._userToken ? 'Bearer ' + this._userToken : null
             }
         };
         if (data instanceof FormData || data instanceof Blob) {
@@ -65,7 +68,7 @@ class OneEntry {
         if (!this._NO_FETCH) {
             const response = await fetch(this._getFullPath(path), {
                 ...options,
-                body: data
+                body: JSON.stringify(data)
             });
             if (!response.ok) {
                 const error = await response.json();
@@ -87,7 +90,7 @@ class OneEntry {
                 req.on('error', (error) => {
                     reject(error);
                 });
-                req.write(data);
+                req.write(JSON.stringify(data));
                 req.end();
             });
         }
@@ -98,6 +101,7 @@ class OneEntry {
             headers: {
                 'x-app-token': this._token,
                 'Content-Type': 'application/json',
+                'Authorization': this._userToken ? 'Bearer ' + this._userToken : null
             },
         };
         if (data instanceof FormData || data instanceof Blob) {
@@ -106,7 +110,7 @@ class OneEntry {
         if (!this._NO_FETCH) {
             const response = await fetch(this._getFullPath(path), {
                 ...options,
-                body: data,
+                body: JSON.stringify(data),
             });
             if (!response.ok) {
                 const error = await response.json();
@@ -128,7 +132,7 @@ class OneEntry {
                 req.on('error', (error) => {
                     reject(error);
                 });
-                req.write(data);
+                req.write(JSON.stringify(data));
                 req.end();
             });
         }
@@ -139,6 +143,7 @@ class OneEntry {
             headers: {
                 'Content-Type': 'application/json',
                 'x-app-token': this._token,
+                'Authorization': this._userToken ? 'Bearer ' + this._userToken : null
             },
             body: data
         };

package/dist/base/utils.d.ts

@@ -23,9 +23,11 @@ declare enum Types {
  * @param {string} [token] - If your project is protected by a token, specify this token in this parameter.
  * @param {string} [langCode] - specify the default language to avoid specifying it in every request.
  * @param {boolean} [multipleRequests] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {boolean} [userToken] - If your project uses user authorization, pass the user access token to the "userToken" variable to use methods that require authorization.
  */
 interface IConfig {
     token?: string;
+    userToken?: string;
     langCode?: string;
     multipleRequests?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.64",
+  "version": "1.0.65",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
     "test": "jest"
   },
   "bin": {
-    "lavss": "./configure.js"
+    "oneentry": "./configure.js"
   },
   "author": "ONEENTRY PORTAL CO.",
   "license": "ISC",