@opengeoweb/authentication 19.1.0 → 19.2.0

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+import apiTranslations from '../locales/api.json';
+import authTranslations from '../locales/authentication.json';
+export { default as Code } from './lib/components/pages/Code';
+export { default as Login } from './lib/components/pages/Login';
+export { default as Logout } from './lib/components/pages/Logout';
+export * from './lib/components/UserMenuRoles';
+export * from './lib/components/AuthenticationContext';
+export * from './lib/components/ApiContext';
+export * from './lib/components/apiHooks';
+export * from './lib/utils/utils';
+export { AUTH_NAMESPACE } from './lib/utils/i18n';
+export { authTranslations, apiTranslations };

package/dist/src/lib/components/ApiContext/index.d.ts

@@ -0,0 +1,2 @@
+export * from './utils';
+export type * from './types';

package/dist/src/lib/components/ApiContext/types.d.ts

@@ -0,0 +1,35 @@
+export interface GeoWebJWT {
+    access_token: string;
+    refresh_token?: string;
+    id_token: string;
+    expires_in: number;
+}
+export interface Credentials {
+    username: string;
+    roles?: Role[];
+    token: string;
+    refresh_token: string;
+    expires_at?: number;
+    has_connection_issue?: boolean;
+}
+export interface ApiUrls {
+    baseURL?: string;
+    appURL?: string;
+    authTokenURL?: string;
+    authClientId?: string;
+}
+export interface ApiModule {
+    auth?: Credentials;
+    onSetAuth?: (cred: Credentials) => void;
+    config?: ApiUrls;
+    name?: string;
+    onLogin?: (isLoggedIn: boolean) => void;
+}
+export interface CreateApiProps extends ApiModule {
+    timeout?: number;
+}
+export type CreateApiFn = (props: CreateApiProps) => unknown;
+export interface Role {
+    name: string;
+    title: string;
+}

package/dist/src/lib/components/ApiContext/utils.d.ts

@@ -0,0 +1,27 @@
+import type { AxiosInstance, AxiosResponse } from 'axios';
+import type { ConfigType } from '@opengeoweb/shared';
+import type { CreateApiProps, Credentials, Role } from './types';
+export declare const KEEP_ALIVE_POLLER_IN_SECONDS = 60;
+export declare const REFRESH_TOKEN_WHEN_PCT_EXPIRED = 75;
+export declare const MILLISECOND_TO_SECOND: number;
+export declare const GEOWEB_ROLE_PRESETS_ADMIN: Role;
+export declare const GEOWEB_ROLE_USER: Role;
+/**
+ * Creates a Credentials object based on the axios response from the token service.
+ *
+ * It will calculate the expires_at attribute based on the expires_in property found in the JWT.
+ *
+ * @param tokenResponse Response of the tokenservice as axios response object.
+ * @returns Credentials object.
+ */
+export declare const makeCredentialsFromTokenResponse: (tokenResponse: AxiosResponse, authConfig?: ConfigType) => Credentials;
+export declare const refreshAccessToken: ({ auth, config: { authTokenURL, authClientId, appURL }, timeout, }: CreateApiProps) => Promise<AxiosResponse>;
+export declare const refreshAccessTokenAndSetAuthContext: ({ auth, onSetAuth, config, timeout, configURLS, onLogin, }: CreateApiProps & {
+    configURLS?: ConfigType;
+}) => Promise<void>;
+export declare const createApiInstance: ({ auth, config: { baseURL }, timeout, }: CreateApiProps) => AxiosInstance;
+export declare const createNonAuthApiInstance: ({ config: { baseURL }, timeout, }: CreateApiProps) => AxiosInstance;
+export declare const fakeApiRequest: (signal?: AbortController) => Promise<void>;
+export declare const createFakeApiInstance: () => AxiosInstance;
+export declare const getCurrentTimeInSeconds: () => number;
+export declare const groupsToRoles: (groups: string[] | undefined, authConfig?: ConfigType) => Role[];

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

@@ -0,0 +1,19 @@
+import React from 'react';
+import type { AuthenticationConfig, AuthenticationContextProps, AuthenticationDefaultStateProps } from './types';
+import type { Credentials } from '../ApiContext/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>;
+type OnAuthChange = (isLoggedIn: boolean, auth: Credentials | null) => void;
+export declare const setAuthChangeListener: (listener: OnAuthChange) => void;
+export declare const useAuthenticationDefaultProps: () => AuthenticationDefaultStateProps;
+export interface AuthenticationProviderProps {
+    children: React.ReactNode;
+    value?: AuthenticationDefaultStateProps;
+    configURLS?: AuthenticationConfig;
+}
+export declare const AuthenticationProvider: React.FC<AuthenticationProviderProps>;
+export declare const useAuthenticationContext: () => AuthenticationContextProps;
+export {};

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

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { Credentials } from '../ApiContext/types';
+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/dist/src/lib/components/AuthenticationContext/index.d.ts

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

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

@@ -0,0 +1,25 @@
+import type { SessionStorageProvider } from '@opengeoweb/shared';
+import type { Credentials, Role } from '../ApiContext/types';
+export interface AuthenticationConfig {
+    GW_AUTH_LOGIN_URL: string;
+    GW_AUTH_LOGOUT_URL: string;
+    GW_AUTH_TOKEN_URL: string;
+    GW_AUTH_ROLE_CLAIM_NAME?: string;
+    GW_AUTH_ROLE_CLAIM_VALUE_PRESETS_ADMIN?: string;
+    GW_APP_URL: string;
+    GW_BE_VERSION_BASE_URL?: string;
+    GW_AUTH_CLIENT_ID: string;
+}
+export interface AuthenticationDefaultStateProps {
+    isLoggedIn: boolean;
+    onLogin: (isLoggedIn: boolean) => void;
+    auth: Credentials | null;
+    onSetAuth: (auth: Credentials) => void;
+    sessionStorageProvider: SessionStorageProvider;
+    currentRole?: Role;
+    setCurrentRole?: (newRole: Role) => void;
+}
+export interface AuthenticationContextProps extends AuthenticationDefaultStateProps {
+    authConfig: AuthenticationConfig;
+}
+export type AuthChangeListener = (isLoggedIn: boolean, auth: Credentials | null) => void;

package/dist/src/lib/components/Providers/Providers.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface AuthTranslationWrapperProps {
+    children?: React.ReactNode;
+}
+export declare const AuthI18nProvider: React.FC<AuthTranslationWrapperProps>;
+export declare const DemoWrapper: React.FC<AuthTranslationWrapperProps>;
+export {};

package/dist/src/lib/components/Providers/index.d.ts

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

package/dist/src/lib/components/UserMenuRoles/UserMenuRoles.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import type { Role } from '../ApiContext/types';
+export declare const UserMenuRoles: React.FC<{
+    currentRole?: Role;
+    onChangeRole?: (role: Role) => void;
+    roles?: Role[];
+}>;

package/dist/src/lib/components/UserMenuRoles/index.d.ts

@@ -0,0 +1 @@
+export { UserMenuRoles } from './UserMenuRoles';

package/dist/src/lib/components/apiHooks/index.d.ts

@@ -0,0 +1 @@
+export { useApi } from './useApi';

package/dist/src/lib/components/apiHooks/useApi.d.ts

@@ -0,0 +1,36 @@
+import type { ConfigType } from '@opengeoweb/shared';
+export type ApiParams = string | ConfigType | Record<string, string | undefined> | null;
+interface BaseApiHookProps {
+    fetchApiData?: (params: ApiParams) => Promise<void>;
+    clearResults?: () => void;
+}
+type PendingApiHookProps = BaseApiHookProps & {
+    isLoading: true;
+    result: null;
+    error: null;
+};
+type DoneApiHookProps<R> = BaseApiHookProps & {
+    isLoading: false;
+    result: R;
+    error: null;
+};
+type ErrorApiHookProps = BaseApiHookProps & {
+    isLoading: false;
+    result: null;
+    error: Error;
+};
+export type ApiHookProps<TData> = ErrorApiHookProps | PendingApiHookProps | DoneApiHookProps<TData>;
+interface Callbacks<TData> {
+    onSuccess?: (data: TData) => void;
+    onError?: (e: Error) => void;
+}
+export declare const useApi: <TResponse extends {
+    data: unknown;
+} | {
+    data: unknown;
+}[], TResult = TResponse extends {
+    data: infer TData;
+}[] ? TData[] : TResponse extends {
+    data: infer TData_1;
+} ? TData_1 : never>(apiCall?: (params?: any, id?: string) => Promise<TResponse>, params?: any, callbacks?: Callbacks<TResult>) => ApiHookProps<TResult>;
+export {};

package/dist/src/lib/components/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/dist/src/lib/components/pages/Login.d.ts

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

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

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

package/dist/src/lib/components/pages/index.d.ts

@@ -0,0 +1,3 @@
+export { default as Code } from './Code';
+export { default as Login } from './Login';
+export { default as Logout } from './Logout';

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

@@ -0,0 +1,6 @@
+import i18n from 'i18next';
+import type { UseTranslationResponse } from 'react-i18next';
+export declare const AUTH_NAMESPACE = "auth";
+export declare const initAuthTestI18n: () => void;
+export declare const useAuthenticationTranslation: () => UseTranslationResponse<typeof AUTH_NAMESPACE, typeof i18n>;
+export declare const translateInTestsAndStories: (key: string, params?: Record<string, string | number> | undefined) => string;

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/authentication",
-  "version": "19.1.0",
+  "version": "19.2.0",
   "description": "GeoWeb authentication library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -26,7 +26,7 @@
     "i18next": "^25.0.1",
     "react-i18next": "^15.1.1",
     "@mui/material": "^9.0.1",
-    "react-router": "^7.15.0"
+    "react-router": "^7.15.1"
   },
   "peerDependencies": {
     "react": "19",
@@ -38,6 +38,7 @@
   },
   "files": [
     "dist",
+    "!dist/package.json",
     "README.md",
     "package.json"
   ]