@opengeoweb/api 9.22.0 → 9.24.0

package/index.esm.js

@@ -3,6 +3,29 @@ import axios from 'axios';
 import { useIsMounted, useDebounce } from '@opengeoweb/shared';
 import { jsx } from 'react/jsx-runtime';
 
+var en = {
+	"api-role-title-user": "User",
+	"api-role-title-preset-admin": "Preset-admin"
+};
+var fi = {
+	"api-role-title-user": "Käyttäjä",
+	"api-role-title-preset-admin": "Preset-pääkäyttäjä"
+};
+var no = {
+	"api-role-title-user": "Bruker",
+	"api-role-title-preset-admin": "Preset-admin"
+};
+var nl = {
+	"api-role-title-user": "Gebruiker",
+	"api-role-title-preset-admin": "Preset-beheerder"
+};
+var api = {
+	en: en,
+	fi: fi,
+	no: no,
+	nl: nl
+};
+
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 var fails$s = function (exec) {
@@ -5019,19 +5042,43 @@ if (DESCRIPTORS && !('size' in URLSearchParamsPrototype)) {
   });
 }
 
+/* *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright 2024 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2024 - Finnish Meteorological Institute (FMI)
+ * */
+const API_NAMESPACE = 'api';
+// Initialize and create provider if needed
+
 const DEFAULT_TIMEOUT = 15000;
 const KEEP_ALIVE_IN_SECONDS = 60; // Number of seconds in between intervals to check with the token request if connection is stil intact
 const KEEP_ALIVE_POLLER_IN_SECONDS = 10; // Number of milliseconds to check if connection is restored or to check if KEEP_ALIVE_IN_SECONDS has passed
 const REFRESH_TOKEN_WHEN_PCT_EXPIRED = 75; // Refresh token when 75% expired. Set to (10 / 3600) * 100 = 0.2777778%  to test with 10 second interval.
 const DEFAULT_TOKEN_EXPIRES_IN = 3600; // Number of seconds a token expires by default
 const MILLISECOND_TO_SECOND = 1 / 1000;
+const ns = API_NAMESPACE;
 const GEOWEB_ROLE_PRESETS_ADMIN = {
   name: 'ROLE_PRESET_ADMIN',
-  title: 'Preset-admin'
+  getTitle: t => t('api-role-title-preset-admin', {
+    ns
+  })
 };
 const GEOWEB_ROLE_USER = {
   name: 'ROLE_USER',
-  title: 'User'
+  getTitle: t => t('api-role-title-user', {
+    ns
+  })
 };
 /**
  * Creates a Credentials object based on the axios response from the token service.
@@ -5051,6 +5098,7 @@ const makeCredentialsFromTokenResponse = (tokenResponse, authConfig) => {
     expires_in
   } = token;
   if (!access_token || !id_token) {
+    // message is not user-facing
     throw new Error('Login failed');
   }
   const userInfoString = atob(
@@ -5261,4 +5309,4 @@ const groupsToRoles = (groups, authConfig) => {
   return roles;
 };
 
-export { ApiProvider, GEOWEB_ROLE_PRESETS_ADMIN, GEOWEB_ROLE_USER, KEEP_ALIVE_IN_SECONDS, KEEP_ALIVE_POLLER_IN_SECONDS, MILLISECOND_TO_SECOND, REFRESH_TOKEN_WHEN_PCT_EXPIRED, createApiInstance, createFakeApiInstance, createNonAuthApiInstance, fakeApiRequest, getApi, getCurrentTimeInSeconds, groupsToRoles, makeCredentialsFromTokenResponse, refreshAccessToken, refreshAccessTokenAndSetAuthContext, useApi, useApiContext };
+export { API_NAMESPACE, ApiProvider, GEOWEB_ROLE_PRESETS_ADMIN, GEOWEB_ROLE_USER, KEEP_ALIVE_IN_SECONDS, KEEP_ALIVE_POLLER_IN_SECONDS, MILLISECOND_TO_SECOND, REFRESH_TOKEN_WHEN_PCT_EXPIRED, api as apiTranslations, createApiInstance, createFakeApiInstance, createNonAuthApiInstance, fakeApiRequest, getApi, getCurrentTimeInSeconds, groupsToRoles, makeCredentialsFromTokenResponse, refreshAccessToken, refreshAccessTokenAndSetAuthContext, useApi, useApiContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/api",
-  "version": "9.22.0",
+  "version": "9.24.0",
   "description": "GeoWeb API library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -9,7 +9,8 @@
   },
   "dependencies": {
     "axios": "1.5.0",
-    "@opengeoweb/shared": "*"
+    "@opengeoweb/shared": "*",
+    "i18next": "^23.11.5"
   },
   "peerDependencies": {
     "react": "18"

package/src/i18n.d.ts

@@ -0,0 +1 @@
+export declare const API_NAMESPACE = "api";

package/src/index.d.ts

@@ -1,2 +1,5 @@
+import apiTranslations from '../locales/api.json';
 export * from './lib/components/apihooks';
 export * from './lib/components/ApiContext';
+export { API_NAMESPACE } from './i18n';
+export { apiTranslations };

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

@@ -1,3 +1,4 @@
+import { TFunction } from 'i18next';
 export interface GeoWebJWT {
     access_token: string;
     refresh_token?: string;
@@ -31,5 +32,5 @@ export interface CreateApiProps extends ApiModule {
 export type CreateApiFn = (props: CreateApiProps) => void;
 export interface Role {
     name: string;
-    title: string;
+    getTitle: (t: TFunction) => string;
 }

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

@@ -5,14 +5,8 @@ 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: {
-    name: string;
-    title: string;
-};
-export declare const GEOWEB_ROLE_USER: {
-    name: string;
-    title: string;
-};
+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.
  *