@opengeoweb/authentication 9.6.0

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@opengeoweb/authentication",
+  "version": "9.6.0",
+  "description": "GeoWeb authentication library for the opengeoweb project",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
+  },
+  "dependencies": {
+    "axios": "1.5.0",
+    "@opengeoweb/api": "*",
+    "react-router-dom": "^6.21.0",
+    "@opengeoweb/shared": "*",
+    "@opengeoweb/theme": "*"
+  },
+  "peerDependencies": {
+    "react": "18"
+  },
+  "module": "./index.esm.js",
+  "type": "module",
+  "main": "./index.esm.js"
+}

package/src/index.d.ts

@@ -0,0 +1,7 @@
+export { default as Code } from './lib/pages/Code';
+export { default as Login } from './lib/pages/Login';
+export { default as Logout } from './lib/pages/Logout';
+export * from './lib/AuthenticationContext';
+export * from './lib/PrivateRoute';
+export * from './lib/utils/session';
+export * from './lib/utils/utils';

package/src/lib/AuthenticationContext/AuthenticationContext.d.ts

@@ -0,0 +1,16 @@
+import React from 'react';
+import { AuthenticationConfig, AuthenticationContextProps, AuthenticationDefaultStateProps } from './types';
+export declare const getRandomString: () => string;
+export declare const getCodeChallenge: (codeVerifier: string) => Promise<string>;
+export declare const replaceTemplateKeys: (url: string, clientId: string, appUrl: string, oauthState?: string, codeChallenge?: string) => string;
+export declare const getAuthConfig: (_configUrls: AuthenticationConfig) => AuthenticationConfig;
+export declare const AuthenticationContext: React.Context<AuthenticationContextProps>;
+export declare const useAuthenticationDefaultProps: () => AuthenticationDefaultStateProps;
+interface AuthenticationProviderProps {
+    children: React.ReactNode;
+    value?: AuthenticationDefaultStateProps;
+    configURLS?: AuthenticationConfig;
+}
+export declare const AuthenticationProvider: React.FC<AuthenticationProviderProps>;
+export declare const useAuthenticationContext: () => AuthenticationContextProps;
+export {};

package/src/lib/AuthenticationContext/AuthenticationContext.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/AuthenticationContext/AuthenticationRenderTestComponent.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { Credentials } from '@opengeoweb/api';
+interface AuthenticationRenderTestComponentProps {
+    auth: Credentials | null;
+    newAuth: Credentials;
+    onSetAuth: (auth: Credentials) => void;
+}
+export declare const resetNumRenders: () => void;
+declare const AuthenticationRenderTestComponent: React.FC<AuthenticationRenderTestComponentProps>;
+export default AuthenticationRenderTestComponent;

package/src/lib/AuthenticationContext/AuthenticationRenderTestComponent.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/AuthenticationContext/index.d.ts

@@ -0,0 +1,2 @@
+export { useAuthenticationContext, AuthenticationProvider, useAuthenticationDefaultProps, AuthenticationContext, getAuthConfig, getRandomString, getCodeChallenge, } from './AuthenticationContext';
+export * from './types';

package/src/lib/AuthenticationContext/types.d.ts

@@ -0,0 +1,42 @@
+import { Credentials } from '@opengeoweb/api';
+export interface AuthenticationConfig {
+    GW_AUTH_LOGIN_URL: string;
+    GW_AUTH_LOGOUT_URL: string;
+    GW_AUTH_TOKEN_URL: string;
+    GW_APP_URL: string;
+    GW_AUTH_CLIENT_ID: string;
+    GW_INFRA_BASE_URL?: string;
+}
+export interface SessionStorageProvider {
+    setOauthState: (value: string) => void;
+    getOauthState: () => string;
+    removeOauthState: () => void;
+    setOauthCodeVerifier: (value: string) => void;
+    getOauthCodeVerifier: () => string;
+    removeOauthCodeVerifier: () => void;
+    setOauthCodeChallenge: (value: string) => void;
+    getOauthCodeChallenge: () => string;
+    removeOauthCodeChallenge: () => void;
+    setHasAuthenticated: (value: string) => void;
+    getHasAuthenticated: () => string;
+    removeHasAuthenticated: () => void;
+    getCallbackUrl: () => string;
+    setCallbackUrl: (value: string) => void;
+}
+export declare enum SessionStorageKey {
+    OAUTH_STATE = "oauth_state",
+    OAUTH_CODE_VERIFIER = "code_verifier",
+    OAUTH_CODE_CHALLENGE = "code_challenge",
+    HAS_AUTHENTICATED = "has_authenticated",
+    CALLBACK_URL = "callback_url"
+}
+export interface AuthenticationDefaultStateProps {
+    isLoggedIn: boolean;
+    onLogin: (isLoggedIn: boolean) => void;
+    auth: Credentials | null;
+    onSetAuth: (auth: Credentials) => void;
+    sessionStorageProvider: SessionStorageProvider;
+}
+export interface AuthenticationContextProps extends AuthenticationDefaultStateProps {
+    authConfig: AuthenticationConfig;
+}

package/src/lib/PrivateRoute/RequireAuth.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface RequireAuthProps {
+    children: React.ReactElement;
+}
+export declare const RequireAuth: React.FC<RequireAuthProps>;
+export {};

package/src/lib/PrivateRoute/RequireAuth.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/PrivateRoute/index.d.ts

@@ -0,0 +1 @@
+export * from './RequireAuth';

package/src/lib/pages/Code.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+export declare const axiosInstance: import("axios").AxiosInstance;
+export declare const HandleOAuth2Code: React.FC;
+export default HandleOAuth2Code;

package/src/lib/pages/Code.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/pages/Login.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const OAuth2Login: React.FC;
+export default OAuth2Login;

package/src/lib/pages/Login.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/pages/Logout.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const OAuth2Logout: React.FC;
+export default OAuth2Logout;

package/src/lib/pages/Logout.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/utils/mockdata.d.ts

@@ -0,0 +1,18 @@
+export declare const mockloginSuccess: {
+    statusCode: number;
+    body: {
+        access_token: string;
+        refresh_token: string;
+        id_token: string;
+    };
+};
+export declare const mockloginSuccessGitlab: {
+    statusCode: number;
+    access_token: string;
+    refresh_token: string;
+    id_token: string;
+};
+export declare const mockloginFailed: {
+    statusCode: number;
+    body: {};
+};

package/src/lib/utils/session.d.ts

@@ -0,0 +1,2 @@
+import { SessionStorageProvider } from '../AuthenticationContext/types';
+export declare const getSessionStorageProvider: () => SessionStorageProvider;

package/src/lib/utils/session.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/utils/utils.d.ts

@@ -0,0 +1 @@
+export declare const getCurrentUrlLocation: (url: string, appUrl: string) => string;

package/src/lib/utils/utils.spec.d.ts

@@ -0,0 +1 @@
+export {};