@descope/react-sdk 0.0.52-alpha.16 → 0.0.52-alpha.17

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Descope
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -145,16 +145,31 @@ const App = () => {
 }
 ```
 
-## Contributing to this project
+## Run a local example
 
-In order to use this repo locally
+There is a simple app that uses Descope React SDK, with two routes
+
+- Home
+- Login
+
+In order to run this app locally, do the following steps:
 
 - Clone this repository
 - Navigate to repository directory
 - Run `npm i`
-- Edit `src/app/index.tsx` in the following way
-  - Set `projectId` prop - replace `<project-id>` with your project id
-  - Set `flowId` prop - Replace `<flow-id>` (for example - `sign-up-or-in`)
-  - Optional - set a different `baseUrl` (for example - `http://localhost:8000`)
+- Create a `.env` file with the following variables (or alternatively export them manually):
+
+```env
+// .env
+# Your project id
+DESCOPE_PROJECT_ID=<project-id>
+# Flow id to run, e.g. sign-up-or-in
+DESCOPE_FLOW_ID=<flow-id>
+# Optional - Descope base url, e.g. http://localhost:8000
+DESCOPE_BASE_URL=<base-url>
+```
+
 - Run `npm run start`
-- Go to `http://localhost:3000/` and start flow
+- Go to `http://localhost:3000/` and press the "Start Flow" button
+
+Note: if you change env file (for example, change DESCOPE_PROJECT_ID), you need to rerun `npm run start`

package/dist/index.js

@@ -1 +1 @@
-import e from"@descope/web-js-sdk";import o,{useState as t,useMemo as r,useEffect as s,useRef as n,useImperativeHandle as c,useCallback as i}from"react";import"@descope/web-component";const u=o.createContext(void 0),d=({projectId:n,baseUrl:c,children:i})=>{const[d,a]=t({}),[l,p]=t(""),f=r((()=>{if(n)return e({projectId:n,baseUrl:c,hooks:{beforeRequest:e=>{const o=e;return o.headers={...o.headers,"x-descope-sdk-name":"react","x-descope-sdk-version":"0.0.52-alpha.16"},o}}})}),[n,c]);s((()=>{if(!f)return;const e=f.onSessionTokenChange(p),o=f.onUserChange(a);return()=>{e?.(),o?.()}}),[f]);const m=r((()=>({sdk:f,projectId:n,baseUrl:c,user:d,sessionToken:l,setUser:a,setSessionToken:p})),[l,d,n,c]);return o.createElement(u.Provider,{value:m},i)};d.defaultProps={baseUrl:"",children:void 0};const a=o.forwardRef((({flowId:e,onSuccess:t,onError:r,tenant:d},a)=>{const l=n();c(a,(()=>l.current));const{projectId:p,baseUrl:f,setUser:m,setSessionToken:h}=o.useContext(u),w=i((e=>{m(e.detail?.user);const o=e.detail?.sessionJwt;h(o),t&&t(e)}),[m,h,t]);return s((()=>{const e=l.current;return e?.addEventListener("success",w),r&&e?.addEventListener("error",r),()=>{r&&e?.removeEventListener("error",r),e?.removeEventListener("success",w)}}),[l,r,w]),o.createElement("descope-wc",{"project-id":p,"flow-id":e,"base-url":f,ref:l,tenant:d})}));a.defaultProps={onError:void 0,onSuccess:void 0};const l=e=>o.createElement(a,{...e,flowId:"sign-in"}),p=e=>o.createElement(a,{...e,flowId:"sign-up"}),f=e=>o.createElement(a,{...e,flowId:"sign-up-or-in"}),m=e=>(...o)=>{if(!e)throw Error("You can only use this function after sdk initialization. Make sure to supply 'projectId' to <AuthProvider /> component");return e(...o)},h=()=>{const e=o.useContext(u);if(!e)throw Error("You can only use 'useAuth' in the context of <AuthProvider />");const{user:t,sessionToken:s,sdk:n}=e,c=i(m(n?.logoutAll),[n]),d=i(m(n?.logout),[n]),a=i(m(n?.me),[n]),l=i(m(n?.getJwtPermissions),[n]),p=i(m(n?.getJwtRoles),[n]);return r((()=>({authenticated:!!s,user:t,sessionToken:s,logoutAll:c,logout:d,me:a,getJwtPermissions:l,getJwtRoles:p})),[t,s,n])};export{d as AuthProvider,a as Descope,l as SignInFlow,p as SignUpFlow,f as SignUpOrInFlow,h as useAuth};
+import e from"@descope/web-js-sdk";import o,{useState as t,useMemo as r,useEffect as s,useRef as n,useImperativeHandle as c,useCallback as i}from"react";import"@descope/web-component";const u=o.createContext(void 0),d=({projectId:n,baseUrl:c,children:i})=>{const[d,a]=t({}),[l,p]=t(""),f=r((()=>{if(n)return e({projectId:n,baseUrl:c,hooks:{beforeRequest:e=>{const o=e;return o.headers={...o.headers,"x-descope-sdk-name":"react","x-descope-sdk-version":"0.0.52-alpha.17"},o}}})}),[n,c]);s((()=>{if(!f)return;const e=f.onSessionTokenChange(p),o=f.onUserChange(a);return()=>{e?.(),o?.()}}),[f]);const m=r((()=>({sdk:f,projectId:n,baseUrl:c,user:d,sessionToken:l,setUser:a,setSessionToken:p})),[l,d,n,c]);return o.createElement(u.Provider,{value:m},i)};d.defaultProps={baseUrl:"",children:void 0};const a=o.forwardRef((({flowId:e,onSuccess:t,onError:r,tenant:d},a)=>{const l=n();c(a,(()=>l.current));const{projectId:p,baseUrl:f,setUser:m,setSessionToken:h}=o.useContext(u),w=i((e=>{m(e.detail?.user);const o=e.detail?.sessionJwt;h(o),t&&t(e)}),[m,h,t]);return s((()=>{const e=l.current;return e?.addEventListener("success",w),r&&e?.addEventListener("error",r),()=>{r&&e?.removeEventListener("error",r),e?.removeEventListener("success",w)}}),[l,r,w]),o.createElement("descope-wc",{"project-id":p,"flow-id":e,"base-url":f,ref:l,tenant:d})}));a.defaultProps={onError:void 0,onSuccess:void 0};const l=e=>o.createElement(a,{...e,flowId:"sign-in"}),p=e=>o.createElement(a,{...e,flowId:"sign-up"}),f=e=>o.createElement(a,{...e,flowId:"sign-up-or-in"}),m=e=>(...o)=>{if(!e)throw Error("You can only use this function after sdk initialization. Make sure to supply 'projectId' to <AuthProvider /> component");return e(...o)},h=()=>{const e=o.useContext(u);if(!e)throw Error("You can only use 'useAuth' in the context of <AuthProvider />");const{user:t,sessionToken:s,sdk:n}=e,c=i(m(n?.logoutAll),[n]),d=i(m(n?.logout),[n]),a=i(m(n?.me),[n]),l=i(m(n?.getJwtPermissions),[n]),p=i(m(n?.getJwtRoles),[n]);return r((()=>({authenticated:!!s,user:t,sessionToken:s,logoutAll:c,logout:d,me:a,getJwtPermissions:l,getJwtRoles:p})),[t,s,n])};export{d as AuthProvider,a as Descope,l as SignInFlow,p as SignUpFlow,f as SignUpOrInFlow,h as useAuth};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@descope/react-sdk",
-	"version": "0.0.52-alpha.16",
+	"version": "0.0.52-alpha.17",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"description": "Descope React SDK",
@@ -40,10 +40,10 @@
 		"eslint-import-resolver-typescript": "2.7.1",
 		"eslint-plugin-import": "2.26.0",
 		"eslint-plugin-jest": "26.9.0",
-		"eslint-plugin-jest-dom": "4.0.2",
+		"eslint-plugin-jest-dom": "4.0.3",
 		"eslint-plugin-jest-formatting": "3.1.0",
 		"eslint-plugin-jsx-a11y": "6.6.1",
-		"eslint-plugin-n": "15.3.0",
+		"eslint-plugin-n": "15.5.1",
 		"eslint-plugin-no-only-tests": "2.6.0",
 		"eslint-plugin-prefer-arrow": "1.2.3",
 		"eslint-plugin-prettier": "4.2.1",
@@ -62,6 +62,7 @@
 		"rollup-plugin-browsersync": "^1.3.3",
 		"rollup-plugin-define": "^1.0.1",
 		"rollup-plugin-delete": "^2.0.0",
+		"rollup-plugin-dotenv": "^0.4.1",
 		"rollup-plugin-dts": "^4.2.2",
 		"rollup-plugin-livereload": "^2.0.5",
 		"rollup-plugin-serve": "^1.1.0",