@opengeoweb/authentication 9.25.0 → 9.25.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/authentication",
-  "version": "9.25.0",
+  "version": "9.25.2",
   "description": "GeoWeb authentication library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -9,13 +9,12 @@
   },
   "dependencies": {
     "axios": "1.5.0",
-    "@opengeoweb/api": "*",
     "react-router-dom": "^6.23.1",
     "@opengeoweb/shared": "*",
     "@opengeoweb/theme": "*",
     "i18next": "^23.11.5",
     "react-i18next": "^14.1.2",
-    "@opengeoweb/snackbar": "9.25.0",
+    "@opengeoweb/snackbar": "9.25.2",
     "react-redux": "^8.1.3",
     "@reduxjs/toolkit": "^1.9.7",
     "@mui/material": "^5.16.0"

package/src/index.d.ts

@@ -1,11 +1,14 @@
 import authTranslations from '../locales/authentication.json';
+import apiTranslations from '../locales/api.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/PrivateRoute';
+export * from './lib/components/ApiContext';
+export * from './lib/components/apiHooks';
 export * from './lib/utils/session';
 export * from './lib/utils/utils';
 export { AUTH_NAMESPACE } from './lib/utils/i18n';
-export { authTranslations };
+export { authTranslations, apiTranslations };

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

@@ -0,0 +1,16 @@
+import * as React from 'react';
+import { ApiModule, CreateApiFn } from './types';
+interface ApiContextState<ApiType> {
+    api: ApiType;
+}
+declare const ApiContext: React.Context<{
+    api: never;
+}>;
+interface ApiProviderProps extends ApiModule {
+    children: React.ReactNode;
+    createApi: CreateApiFn;
+}
+export declare function getApi<Type>(name: string): Type;
+export declare const ApiProvider: React.FC<ApiProviderProps>;
+export declare function useApiContext<ApiType>(): ApiContextState<ApiType>;
+export default ApiContext;

package/src/lib/components/ApiContext/ApiContext.spec.d.ts

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

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

@@ -0,0 +1,3 @@
+export * from './ApiContext';
+export * from './utils';
+export * from './types';

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

@@ -0,0 +1,36 @@
+import { TFunction } from 'i18next';
+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;
+    keep_session_alive_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;
+}
+export interface CreateApiProps extends ApiModule {
+    timeout?: number;
+}
+export type CreateApiFn = (props: CreateApiProps) => void;
+export interface Role {
+    name: string;
+    getTitle: (t: TFunction) => string;
+}

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

@@ -0,0 +1,26 @@
+import { AxiosInstance, AxiosResponse } from 'axios';
+import { ConfigType } from '@opengeoweb/shared';
+import { CreateApiProps, Credentials, Role } from './types';
+export declare const KEEP_ALIVE_IN_SECONDS = 60;
+export declare const KEEP_ALIVE_POLLER_IN_SECONDS = 10;
+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, }: CreateApiProps) => Promise<void>;
+export declare const createApiInstance: ({ auth, onSetAuth, config: { baseURL, authTokenURL, authClientId, appURL }, 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/src/lib/components/ApiContext/utils.spec.d.ts

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

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

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { Credentials } from '@opengeoweb/api';
+import { Credentials } from '../ApiContext/types';
 interface AuthenticationRenderTestComponentProps {
     auth: Credentials | null;
     newAuth: Credentials;

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

@@ -1,5 +1,5 @@
-import { Credentials } from '@opengeoweb/api';
 import { SessionStorageProvider } from '../../utils/session';
+import { Credentials } from '../ApiContext/types';
 export interface AuthenticationConfig {
     GW_AUTH_LOGIN_URL: string;
     GW_AUTH_LOGOUT_URL: string;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { Role } from '@opengeoweb/api';
+import { Role } from '../ApiContext/types';
 export declare const UserMenuRoles: React.FC<{
     roles?: Role[];
     currentRole?: string;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { Role } from '@opengeoweb/api';
+import { Role } from '../ApiContext/types';
 export declare const UserMenuRolesConnect: React.FC<{
     temporaryOnChangeRoleForDemo?: (role: Role) => void;
     roles?: Role[];

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

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

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

@@ -0,0 +1,36 @@
+import { 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?: ApiParams, id?: string) => Promise<TResponse>) | undefined, params?: ApiParams, callbacks?: Callbacks<TResult> | undefined) => ApiHookProps<TResult>;
+export {};

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

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