kodzero-front-sdk-alfa 0.0.5 → 0.0.7

package/README.md

@@ -18,14 +18,14 @@ const kodzero = new Kodzero({
   host: 'https://api.your-backend.com'
 });
 
-// Sign up a new user
-const signupResult = await kodzero.auth.signup({
+// New user registration
+const registerResult = await kodzero.auth.register({
   email: 'user@example.com',
   password: 'secure_password'
 });
 
-// Sign in
-const signinResult = await kodzero.auth.signin({
+// Login
+const loginResult = await kodzero.auth.login({
   email: 'user@example.com',
   password: 'secure_password'
 });
@@ -36,8 +36,8 @@ const verified = await kodzero.auth.verify();
 // Refresh the token
 const refreshed = await kodzero.auth.refresh();
 
-// Sign out
-await kodzero.auth.signout();
+// Logout
+await kodzero.auth.logout();
 
 // Manually set tokens (useful for persisting sessions)
 kodzero.auth.setTokens('access_token', 'refresh_token');

package/dist/auth/base.d.ts

@@ -7,10 +7,10 @@ declare class KodzeroAuthBase {
     tokensManager: TokensManagerClass;
     constructor(options: AuthOptions, api: typeof FluidFetch, tokensManager: TokensManagerClass);
     _handleApiError(response: Response): Promise<void>;
-    signin: (...args: any[]) => Promise<any> | void;
-    signup: (...args: any[]) => Promise<any> | void;
+    login: (...args: any[]) => Promise<any> | void;
+    register: (...args: any[]) => Promise<any> | void;
     refresh: (...args: any[]) => Promise<any> | void;
-    signout: (...args: any[]) => Promise<any> | void;
+    logout: (...args: any[]) => Promise<any> | void;
     verify: (...args: any[]) => Promise<any> | void;
 }
 export default KodzeroAuthBase;

package/dist/auth/base.js

@@ -13,10 +13,10 @@ class KodzeroAuthBase {
     _handleApiError(response) {
         return validateApiResponse(response);
     }
-    signin = (...args) => { };
-    signup = (...args) => { };
+    login = (...args) => { };
+    register = (...args) => { };
     refresh = (...args) => { };
-    signout = (...args) => { };
+    logout = (...args) => { };
     verify = (...args) => { };
 }
 export default KodzeroAuthBase;

package/dist/auth/email.d.ts

@@ -2,22 +2,52 @@ import FluidFetch from "fluid-fetch";
 import { AuthOptions } from "./index.js";
 import KodzeroAuthBase from "./base.js";
 import TokensManagerClass from "./tokens.js";
-interface KodzeroAuthEmailSignin {
+interface KodzeroAuthEmailLogin {
     email: string;
     password: string;
 }
+interface SuccessResponse<Result> {
+    ok: true;
+    result: Result;
+}
+interface Tokens {
+    access: string;
+    refresh: string;
+}
+interface AuthUser {
+    _id: string;
+    email: string;
+    name: string;
+    workspace: string;
+    createdAt: string;
+    updatedAt: string;
+    [key: string]: any;
+}
+type RegisterResponse = SuccessResponse<{
+    user: AuthUser;
+    tokens: Tokens;
+    session: number;
+}>;
+type LoginResponse = SuccessResponse<{
+    user: AuthUser;
+    tokens: Tokens;
+    session: number;
+}>;
+type VerifyResponse = SuccessResponse<{}>;
+type RefreshResponse = SuccessResponse<{
+    tokens: Tokens;
+}>;
 declare class KodzeroAuthEmail extends KodzeroAuthBase {
     tokensManager: TokensManagerClass;
     collection: "auth/password";
     constructor(options: AuthOptions, api: typeof FluidFetch, tokensManager: TokensManagerClass);
     _setTokens: (access: string, refresh?: string) => void;
-    signin: (input: KodzeroAuthEmailSignin) => Promise<{
-        access: string;
-        refresh: string;
+    login: (input: KodzeroAuthEmailLogin) => Promise<LoginResponse["result"]>;
+    register: (userData: Record<string, string>) => Promise<RegisterResponse["result"]>;
+    verify: () => Promise<VerifyResponse["result"]>;
+    refresh: () => Promise<RefreshResponse["result"] | {
+        tokens: null;
     }>;
-    signup: (userData: Record<string, string>) => Promise<Record<string, any>>;
-    verify: () => Promise<any>;
-    refresh: () => Promise<any>;
-    signout: () => Promise<any>;
+    logout: () => Promise<boolean>;
 }
 export default KodzeroAuthEmail;

package/dist/auth/email.js

@@ -13,19 +13,19 @@ class KodzeroAuthEmail extends KodzeroAuthBase {
         if (refresh)
             this.tokensManager.setRefresh(refresh);
     };
-    signin = async (input) => {
-        const url = buildURL(this.host, this.collection + '/signin');
+    login = async (input) => {
+        const url = buildURL(this.host, this.collection + '/login');
         const response = await this.api.post(url, input)
             .headers({ 'Content-Type': 'application/json' });
         await this._handleApiError(response);
         const json = await response.json();
-        if (json.ok && json.tokens && json.tokens.access && json.tokens.refresh) {
-            this._setTokens(json.tokens.access, json.tokens.refresh);
+        if (json.ok && json.result && json.result.tokens.access && json.result.tokens.refresh) {
+            this._setTokens(json.result.tokens.access, json.result.tokens.refresh);
         }
-        return json.tokens;
+        return json.result;
     };
-    signup = async (userData) => {
-        const url = buildURL(this.host, this.collection + '/signup');
+    register = async (userData) => {
+        const url = buildURL(this.host, this.collection + '/register');
         const response = await this.api.post(url, userData)
             .headers({ 'Content-Type': 'application/json' });
         await this._handleApiError(response);
@@ -33,7 +33,7 @@ class KodzeroAuthEmail extends KodzeroAuthBase {
         if (json.ok && json.result && json.result.tokens.access && json.result.tokens.refresh) {
             this._setTokens(json.result.tokens.access, json.result.tokens.refresh);
         }
-        return json.result.user;
+        return json.result;
     };
     verify = async () => {
         try {
@@ -53,13 +53,13 @@ class KodzeroAuthEmail extends KodzeroAuthBase {
             .headers({ 'Content-Type': 'application/json' });
         await this._handleApiError(response);
         const json = await response.json();
-        if (json.ok && json.tokens && json.tokens.access) {
-            this.tokensManager.setAccess(json.tokens.access);
+        if (json.ok && json.result?.tokens && json.result.tokens.access) {
+            this.tokensManager.setAccess(json.result.tokens.access);
         }
-        return json.ok ? true : false;
+        return json.ok ? { tokens: json.result.tokens } : { tokens: null };
     };
-    signout = async () => {
-        const url = buildURL(this.host, this.collection + '/signout');
+    logout = async () => {
+        const url = buildURL(this.host, this.collection + '/logout');
         const response = await this.api.post(url, {})
             .headers({ 'Content-Type': 'application/json' });
         await this._handleApiError(response);

package/dist/auth/index.js

@@ -7,9 +7,9 @@ class KodzeroAuth extends KodzeroAuthBase {
     constructor(options, api, tokensManager) {
         super(options, api, tokensManager);
         this.email = new KodzeroAuthEmail(options, api, tokensManager);
-        this.signin = this.email.signin;
-        this.signup = this.email.signup;
-        this.signout = this.email.signout;
+        this.login = this.email.login;
+        this.register = this.email.register;
+        this.logout = this.email.logout;
         this.verify = this.email.verify;
         this.refresh = this.email.refresh;
         this.setTokens = (access, refresh) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kodzero-front-sdk-alfa",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "main": "dist/index.js",
   "scripts": {
     "tsc": "tsc -b src/",

package/src/auth/base.ts

@@ -29,10 +29,10 @@ class KodzeroAuthBase {
      * Base auth methods.
      * These will be overridden by specific strategies (e.g. email, social, etc.)
      */
-    signin = (...args: any[]): Promise<any> | void => {}
-    signup = (...args: any[]): Promise<any> | void => {}
+    login = (...args: any[]): Promise<any> | void => {}
+    register = (...args: any[]): Promise<any> | void => {}
     refresh = (...args: any[]): Promise<any> | void => {}
-    signout = (...args: any[]): Promise<any> | void => {}
+    logout = (...args: any[]): Promise<any> | void => {}
     verify = (...args: any[]): Promise<any> | void => {}
 }
 

package/src/auth/email.ts

@@ -4,11 +4,47 @@ import buildURL from "../utils/buildURL.js"
 import KodzeroAuthBase from "./base.js"
 import TokensManagerClass from "./tokens.js"
 
-interface KodzeroAuthEmailSignin {
+interface KodzeroAuthEmailLogin {
     email: string
     password: string
 }
 
+interface SuccessResponse<Result> {
+    ok: true
+    result: Result
+}
+
+interface Tokens {
+    access: string
+    refresh: string
+}
+
+interface AuthUser {
+    _id: string
+    email: string
+    name: string
+    workspace: string
+    createdAt: string
+    updatedAt: string
+    [key: string]: any
+}
+
+type RegisterResponse = SuccessResponse<{
+    user: AuthUser
+    tokens: Tokens
+    session: number
+}>
+
+type LoginResponse = SuccessResponse<{
+    user: AuthUser
+    tokens: Tokens
+    session: number
+}>
+
+type VerifyResponse = SuccessResponse<{}>
+type RefreshResponse = SuccessResponse<{tokens: Tokens}>
+type LogoutResponse = SuccessResponse<boolean>
+
 class KodzeroAuthEmail extends KodzeroAuthBase {
     tokensManager: TokensManagerClass
     collection: "auth/password"
@@ -30,50 +66,50 @@ class KodzeroAuthEmail extends KodzeroAuthBase {
     }
 
     /**
-     * Sign in with email and password. On success, sets tokens in TokensManager automatically
+     * Login with email and password. On success, sets tokens in TokensManager automatically
      */
-    signin = async (input: KodzeroAuthEmailSignin): Promise<{access: string, refresh: string}> => {
-        const url = buildURL(this.host, this.collection + '/signin')
-       
+    login = async (input: KodzeroAuthEmailLogin): Promise<LoginResponse['result']> => {
+        const url = buildURL(this.host, this.collection + '/login')
+
         const response = await this.api.post(url, input)
             .headers({ 'Content-Type': 'application/json' });
 
         await this._handleApiError(response);        
-        const json = await response.json();
+        const json: LoginResponse = await response.json();
 
-        if (json.ok && json.tokens && json.tokens.access && json.tokens.refresh) {        
-            this._setTokens(json.tokens.access, json.tokens.refresh);
+        if (json.ok && json.result && json.result.tokens.access && json.result.tokens.refresh) {
+            this._setTokens(json.result.tokens.access, json.result.tokens.refresh);
         }
     
-        return json.tokens
+        return json.result
     }
 
     /**
-     *  Sign up with email and password. On success, sets tokens in TokensManager automatically
+     *  Register with email and password. On success, sets tokens in TokensManager automatically
      */
-    signup = async (userData: Record<string, string>): Promise<Record<string, any>> => {
-        const url = buildURL(this.host, this.collection + '/signup')
+    register = async (userData: Record<string, string>): Promise<RegisterResponse['result']> => {
+        const url = buildURL(this.host, this.collection + '/register')
         const response = await this.api.post(url, userData)
             .headers({ 'Content-Type': 'application/json' });
             
         await this._handleApiError(response);        
-        const json = await response.json();
+        const json: RegisterResponse = await response.json();
 
         if (json.ok && json.result && json.result.tokens.access && json.result.tokens.refresh) {
             this._setTokens(json.result.tokens.access, json.result.tokens.refresh);
         }
 
-        return json.result.user
+        return json.result
     }
 
     /**
      * Verify current access token
      */
-    verify = async (): Promise<any> => {
+    verify = async (): Promise<VerifyResponse['result']> => {
         try {
             const url = buildURL(this.host, this.collection + '/verify')
             const response = await this.api.get(url)
-            const json = await response.json();
+            const json: VerifyResponse = await response.json();
 
             return json.ok ? true : false
         } catch (error) {
@@ -86,32 +122,32 @@ class KodzeroAuthEmail extends KodzeroAuthBase {
      * Refresh access token using refresh token
      * If success, updates access token in TokensManager automatically
      */
-    refresh = async (): Promise<any> => {
+    refresh = async (): Promise<RefreshResponse['result'] | {tokens: null}> => {
         const url = buildURL(this.host, this.collection + '/refresh')
         const response = await this.api.post(url, { refresh: this.tokensManager.refresh })
             .headers({ 'Content-Type': 'application/json' });
 
         await this._handleApiError(response);        
-        const json = await response.json(); 
+        const json: RefreshResponse = await response.json(); 
         
-        if (json.ok && json.tokens && json.tokens.access) {
-            this.tokensManager.setAccess(json.tokens.access)
+        if (json.ok && json.result?.tokens && json.result.tokens.access) {
+            this.tokensManager.setAccess(json.result.tokens.access)
         }
 
-        return json.ok ? true : false
+        return json.ok ? { tokens: json.result.tokens } : { tokens: null }
     }
 
     /**
-     * Sign out the user
+     * Logout the user
      * If success, clears tokens in TokensManager automatically
      */
-    signout = async (): Promise<any> => {
-        const url = buildURL(this.host, this.collection + '/signout')
+    logout = async (): Promise<boolean> => {
+        const url = buildURL(this.host, this.collection + '/logout')
         const response = await this.api.post(url, {})
             .headers({ 'Content-Type': 'application/json' });
 
         await this._handleApiError(response);        
-        const json = await response.json(); 
+        const json: LogoutResponse = await response.json(); 
 
         if (json.ok) this.tokensManager.clear()
 

package/src/auth/index.ts

@@ -19,9 +19,9 @@ class KodzeroAuth extends KodzeroAuthBase {
         this.email = new KodzeroAuthEmail(options, api, tokensManager)
         
         // Default methods set to email strategy methods
-        this.signin = this.email.signin
-        this.signup = this.email.signup
-        this.signout = this.email.signout
+        this.login = this.email.login
+        this.register = this.email.register
+        this.logout = this.email.logout
         this.verify = this.email.verify
         this.refresh = this.email.refresh