@equinor/subsurface-app-management 4.2.0 → 4.3.1

package/dist/api/index.d.ts

@@ -22,6 +22,8 @@ export type { MyTutorialDto } from './models/MyTutorialDto';
 export type { StepDto } from './models/StepDto';
 export { TutorialPosition } from './models/TutorialPosition';
 export type { MyFeatureDto } from './models/MyFeatureDto';
+export type { Faq } from './models/Faq';
+export type { FaqCategory } from './models/FaqCategory';
 export { AmplifyApplicationService } from './services/AmplifyApplicationService';
 export { FeatureToggleService } from './services/FeatureToggleService';
 export { ImpersonateUserService } from './services/ImpersonateUserService';
@@ -29,3 +31,4 @@ export { ReleaseNotesService } from './services/ReleaseNotesService';
 export { ServiceNowService } from './services/ServiceNowService';
 export { SlackService } from './services/SlackService';
 export { TutorialService } from './services/TutorialService';
+export { FaqService } from './services/FaqService';

package/dist/api/models/Faq.d.ts

@@ -0,0 +1,9 @@
+export type Faq = {
+    id: number;
+    question: string;
+    answer: string;
+    orderBy?: number | null;
+    faqCategoryId: number;
+    updatedDate?: string | null;
+    createdDate?: string | null;
+};

package/dist/api/models/FaqCategory.d.ts

@@ -0,0 +1,10 @@
+import { Faq } from './..';
+export type FaqCategory = {
+    id: number;
+    categoryName: string;
+    orderBy?: number | null;
+    applicationId: string;
+    faqs: Array<Faq>;
+    updatedDate?: string | null;
+    createdDate?: string | null;
+};

package/dist/api/models/Step.d.ts

@@ -6,4 +6,5 @@ export type Step = {
     key?: string | null;
     position?: TutorialPosition;
     imgUrl?: string | null;
+    orderBy?: number | null;
 };

package/dist/api/models/StepDto.d.ts

@@ -5,4 +5,5 @@ export type StepDto = {
     imgUrl?: string | null;
     highlightElement?: boolean | null;
     custom?: boolean | null;
+    orderBy?: number | null;
 };

package/dist/api/services/FaqService.d.ts

@@ -0,0 +1,40 @@
+import type { Faq } from '../models/Faq';
+import type { FaqCategory } from '../models/FaqCategory';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class FaqService {
+    /**
+     * Get FAQ categories and related FAQs based on application id
+     * @param applicationId
+     * @returns FaqCategory OK
+     * @throws ApiError
+     */
+    static getCategoriesWithFaqsFromApplicationName(applicationName: string): CancelablePromise<Array<FaqCategory>>;
+    /**
+     * Get FAQ image
+     * @param path
+     * @returns string OK
+     * @throws ApiError
+     */
+    static getFaqImage(path: string): CancelablePromise<string>;
+    /**
+     * Get FAQ categories from application id
+     * @param applicationId
+     * @returns FaqCategory OK
+     * @throws ApiError
+     */
+    static getFaqCategoriesFromApplicationId(applicationId: string): CancelablePromise<Array<FaqCategory>>;
+    /**
+     * Get FAQs from category id
+     * @param categoryId
+     * @returns Faq OK
+     * @throws ApiError
+     */
+    static getFaqsFromCategoryId(categoryId: number): CancelablePromise<Array<Faq>>;
+    /**
+     * Get FAQ by id
+     * @param id
+     * @returns Faq OK
+     * @throws ApiError
+     */
+    static getFaqById(id: number): CancelablePromise<Faq>;
+}

package/dist/api/services/FaqService.js

@@ -0,0 +1 @@
+import{OpenAPI_SAM_Prod as a}from"../core/OpenAPI.js";import{request as t}from"../core/request.js";class e{static getCategoriesWithFaqsFromApplicationName(e){return t(a,{method:"GET",url:"/api/v1/Faq/faqcategorieswithfaqs/{applicationName}",path:{applicationName:e}})}static getFaqImage(e){return t(a,{method:"GET",url:"/api/v1/Faq/getfaqimage/{path}",path:{path:e},errors:{404:"Not Found"}})}static getFaqCategoriesFromApplicationId(e){return t(a,{method:"GET",url:"/api/v1/Faq/faqcategories/{applicationId}",path:{applicationId:e}})}static getFaqsFromCategoryId(e){return t(a,{method:"GET",url:"/api/v1/Faq/faqs/{categoryId}",path:{categoryId:e}})}static getFaqById(e){return t(a,{method:"GET",url:"/api/v1/Faq/faq/{id}",path:{id:e}})}}export{e as FaqService};

package/dist/hooks/useTutorialsQuery.js

@@ -1 +1 @@
-import{useQuery as t}from"@tanstack/react-query";import"../api/core/OpenAPI.js";import"../api/models/ApplicationCategory.js";import"../api/models/ServiceNowUrgency.js";import"../api/models/TutorialPosition.js";import{TutorialService as r}from"../api/services/TutorialService.js";import{GET_TUTORIALS_FOR_APP as i}from"../constants/queryKeys.js";import{EnvironmentType as o}from"../types/Environment.js";import"../types/ReleaseNotes.js";import{getEnvironmentName as e,getAppName as a}from"../utils/environment.js";function p(){return t({queryKey:[i],queryFn:async()=>{if(e(import.meta.env.VITE_ENVIRONMENT_NAME)===o.PRODUCTION){return(await r.getMyTutorialsForApplication(a(import.meta.env.VITE_NAME),!1)).map((t=>({...t,id:t.tutorialDraftId?t.tutorialDraftId:t.id})))}return r.getDraftTutorialsForApplication(a(import.meta.env.VITE_NAME))}})}export{p as useTutorialsQuery};
+import{useQuery as r}from"@tanstack/react-query";import"../api/core/OpenAPI.js";import"../api/models/ApplicationCategory.js";import"../api/models/ServiceNowUrgency.js";import"../api/models/TutorialPosition.js";import{TutorialService as t}from"../api/services/TutorialService.js";import{GET_TUTORIALS_FOR_APP as o}from"../constants/queryKeys.js";import{EnvironmentType as e}from"../types/Environment.js";import"../types/ReleaseNotes.js";import{getEnvironmentName as i,getAppName as s}from"../utils/environment.js";function p(){return r({queryKey:[o],queryFn:async()=>{if(i(import.meta.env.VITE_ENVIRONMENT_NAME)===e.PRODUCTION){return(await t.getMyTutorialsForApplication(s(import.meta.env.VITE_NAME),!1)).map((r=>({...r,id:r.tutorialDraftId?r.tutorialDraftId:r.id,steps:r.steps.sort(((r,t)=>(r.orderBy??0)-(t.orderBy??0)))})))}return t.getDraftTutorialsForApplication(s(import.meta.env.VITE_NAME))}})}export{p as useTutorialsQuery};

package/dist/index.js

@@ -1 +1 @@
-export{Feature}from"./components/Feature/Feature.js";export{FeatureRoute}from"./components/FeatureRoute/FeatureRoute.js";export{FeatureToggleProvider,useFeatureToggleContext}from"./providers/FeatureToggleProvider.js";export{useFeatureToggling}from"./hooks/useFeatureToggling.js";export{useReleaseNotesQuery}from"./hooks/useReleaseNotesQuery.js";export{useTutorialsQuery}from"./hooks/useTutorialsQuery.js";export{useTutorialStepImage}from"./hooks/useTutorialStepImage.js";export{useSignalRMessages}from"./hooks/useSignalRMessages.js";export{TutorialProvider,useTutorials}from"./providers/TutorialProvider/TutorialProvider.js";export{ApplicationInsightsProvider}from"./providers/ApplicationInsightsProvider/ApplicationInsightsProvider.js";export{samTrackEvent,samTrackMetric}from"./providers/ApplicationInsightsProvider/ApplicationInsightsProvider.utils.js";export{EnvironmentType}from"./types/Environment.js";export{RELEASENOTE_TYPES_INFORMATION,ReleaseNoteType}from"./types/ReleaseNotes.js";import*as e from"./utils/environment.js";export{e as environment};export{ApiError}from"./api/core/ApiError.js";export{CancelError,CancelablePromise}from"./api/core/CancelablePromise.js";export{OpenAPI_APP,getJSEmbarkToken,getPortalToken,getSAMToken}from"./api/core/OpenAPI.js";export{request}from"./api/core/request.js";export{ApplicationCategory}from"./api/models/ApplicationCategory.js";export{ServiceNowUrgency}from"./api/models/ServiceNowUrgency.js";export{TutorialPosition}from"./api/models/TutorialPosition.js";export{AmplifyApplicationService}from"./api/services/AmplifyApplicationService.js";export{FeatureToggleService}from"./api/services/FeatureToggleService.js";export{ImpersonateUserService}from"./api/services/ImpersonateUserService.js";export{ReleaseNotesService}from"./api/services/ReleaseNotesService.js";export{ServiceNowService}from"./api/services/ServiceNowService.js";export{SlackService}from"./api/services/SlackService.js";export{TutorialService}from"./api/services/TutorialService.js";export{GET_FEATURE_TOGGLES_FOR_APP,GET_RELEASE_NOTES,GET_TUTORIALS_FOR_APP,GET_TUTORIALS_SAS_TOKEN,GET_TUTORIAL_STEP_IMAGE,SAM_QUERIES}from"./constants/queryKeys.js";
+export{Feature}from"./components/Feature/Feature.js";export{FeatureRoute}from"./components/FeatureRoute/FeatureRoute.js";export{FeatureToggleProvider,useFeatureToggleContext}from"./providers/FeatureToggleProvider.js";export{useFeatureToggling}from"./hooks/useFeatureToggling.js";export{useReleaseNotesQuery}from"./hooks/useReleaseNotesQuery.js";export{useTutorialsQuery}from"./hooks/useTutorialsQuery.js";export{useTutorialStepImage}from"./hooks/useTutorialStepImage.js";export{useSignalRMessages}from"./hooks/useSignalRMessages.js";export{TutorialProvider,useTutorials}from"./providers/TutorialProvider/TutorialProvider.js";export{ApplicationInsightsProvider}from"./providers/ApplicationInsightsProvider/ApplicationInsightsProvider.js";export{samTrackEvent,samTrackMetric}from"./providers/ApplicationInsightsProvider/ApplicationInsightsProvider.utils.js";export{EnvironmentType}from"./types/Environment.js";export{RELEASENOTE_TYPES_INFORMATION,ReleaseNoteType}from"./types/ReleaseNotes.js";import*as e from"./utils/environment.js";export{e as environment};export{ApiError}from"./api/core/ApiError.js";export{CancelError,CancelablePromise}from"./api/core/CancelablePromise.js";export{OpenAPI_APP,getJSEmbarkToken,getPortalToken,getSAMToken}from"./api/core/OpenAPI.js";export{request}from"./api/core/request.js";export{ApplicationCategory}from"./api/models/ApplicationCategory.js";export{ServiceNowUrgency}from"./api/models/ServiceNowUrgency.js";export{TutorialPosition}from"./api/models/TutorialPosition.js";export{AmplifyApplicationService}from"./api/services/AmplifyApplicationService.js";export{FeatureToggleService}from"./api/services/FeatureToggleService.js";export{ImpersonateUserService}from"./api/services/ImpersonateUserService.js";export{ReleaseNotesService}from"./api/services/ReleaseNotesService.js";export{ServiceNowService}from"./api/services/ServiceNowService.js";export{SlackService}from"./api/services/SlackService.js";export{TutorialService}from"./api/services/TutorialService.js";export{FaqService}from"./api/services/FaqService.js";export{GET_FEATURE_TOGGLES_FOR_APP,GET_RELEASE_NOTES,GET_TUTORIALS_FOR_APP,GET_TUTORIALS_SAS_TOKEN,GET_TUTORIAL_STEP_IMAGE,SAM_QUERIES}from"./constants/queryKeys.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/subsurface-app-management",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "description": "React Typescript components/hooks to communicate with equinor/sam",
   "types": "dist/index.d.ts",
   "type": "module",