@equinor/subsurface-app-management 5.2.3 → 5.4.0

package/dist/api/index.d.ts

@@ -10,6 +10,7 @@ export type { AccessRoles } from './models/AccessRoles';
 export type { FeatureAPIType } from './models/FeatureAPIType';
 export type { FeatureToggleDto } from './models/FeatureToggleDto';
 export type { GraphUser } from './models/GraphUser';
+export type { GraphAppRole } from './models/GraphAppRole';
 export type { ImpersonateUserDto } from './models/ImpersonateUserDto';
 export type { ImpersonateUserUpdateDto } from './models/ImpersonateUserUpdateDto';
 export type { ReleaseNote } from './models/ReleaseNote';
@@ -25,10 +26,30 @@ export type { MyFeatureDto } from './models/MyFeatureDto';
 export type { Faq } from './models/Faq';
 export type { FaqDto } from './models/FaqDto';
 export type { FaqCategoriesWithFaqDto } from './models/FaqCategoriesWithFaqDto';
+export type { AnswerId } from './models/AnswerId';
+export type { AnswerVm } from './models/AnswerVm';
+export type { AnswerQuestionCommandDto } from './models/AnswerQuestionCommandDto';
+export type { ObjectServiceResponse } from './models/ObjectServiceResponse';
+export type { OptionId } from './models/OptionId';
+export type { QuestionId } from './models/QuestionId';
+export type { QuestionVm } from './models/QuestionVm';
+export { QuestionType } from './models/QuestionType';
+export type { QuestionOptionDto } from './models/QuestionOptionDto';
+export type { StartSurveyDto } from './models/StartSurveyDto';
+export type { SurveyId } from './models/SurveyId';
+export { SurveyType } from './models/SurveyType';
+export type { SurveyResponseId } from './models/SurveyResponseId';
+export { SurveyResponseStatus } from './models/SurveyResponseStatus';
+export type { UserSurveyVm } from './models/UserSurveyVm';
 export type { ImpactMetric } from './models/ImpactMetric';
 export type { ImpactMetricDto } from './models/ImpactMetricDto';
 export type { ImpactUrl } from './models/ImpactUrl';
 export type { ImpactUrlDto } from './models/ImpactUrlDto';
+export type { WorkItem } from './models/WorkItem';
+export type { WorkItemAttachment } from './models/WorkItemAttachment';
+export { WorkItemType } from './models/WorkItemType';
+export { BugSeverity } from './models/BugSeverity';
+export { SamWorkItemState } from './models/SamWorkItemState';
 export { AmplifyApplicationService } from './services/AmplifyApplicationService';
 export { FeatureToggleService } from './services/FeatureToggleService';
 export { ImpersonateUserService } from './services/ImpersonateUserService';
@@ -38,3 +59,5 @@ export { SlackService } from './services/SlackService';
 export { TutorialService } from './services/TutorialService';
 export { FaqService } from './services/FaqService';
 export { AppAnalyticsService } from './services/AppAnalyticsService';
+export { SurveysPublicService } from './services/SurveysPublicService';
+export { WorkItemsService } from './services/WorkItemsService';

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

@@ -0,0 +1,3 @@
+export type AnswerId = {
+    value: string;
+};

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

@@ -0,0 +1,26 @@
+import type { AnswerId } from './AnswerId';
+import type { OptionId } from './OptionId';
+import type { QuestionId } from './QuestionId';
+/**
+ * Represents an answer to a survey question.
+ * Used for public survey responses.
+ */
+export type AnswerQuestionCommandDto = {
+    id: QuestionId;
+    answerId?: AnswerId;
+    /**
+     * The text answer provided for text questions.
+     * Only populated if the question type is Text.
+     */
+    textAnswer?: string | null;
+    /**
+     * The numeric answer provided for numeric questions.
+     * Only populated if the question type is LinearScale.
+     */
+    numericAnswer?: number | null;
+    /**
+     * The list of selected option IDs for multiple choice questions.
+     * Only populated if the question type is MultipleChoice.
+     */
+    selectedOptionIds?: Array<OptionId>;
+};

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

@@ -0,0 +1,8 @@
+import type { AnswerId } from './AnswerId';
+import type { OptionId } from './OptionId';
+export type AnswerVm = {
+    answerId: AnswerId;
+    textAnswer?: string | null;
+    numericAnswer?: number | null;
+    selectedOptions?: Array<OptionId> | null;
+};

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

@@ -0,0 +1,5 @@
+export declare enum BugSeverity {
+    UNABLE_TO_WORK = "UnableToWork",
+    DOES_NOT_AFFECT_ME = "DoesNotAffectMe",
+    IMPEDES_MY_PROGRESS = "ImpedesMyProgress"
+}

package/dist/api/models/BugSeverity.js

@@ -0,0 +1 @@
+var e;!function(e){e.UNABLE_TO_WORK="UnableToWork",e.DOES_NOT_AFFECT_ME="DoesNotAffectMe",e.IMPEDES_MY_PROGRESS="ImpedesMyProgress"}(e||(e={}));export{e as BugSeverity};

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

@@ -0,0 +1,3 @@
+export type OptionId = {
+    value: string;
+};

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

@@ -0,0 +1,3 @@
+export type QuestionId = {
+    value: string;
+};

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

@@ -0,0 +1,16 @@
+import type { OptionId } from './OptionId';
+/**
+ * Represents a option with all its properties.
+ * Used for administering surveys.
+ */
+export type QuestionOptionDto = {
+    id: OptionId;
+    /**
+     * The text of the option displayed to respondents.
+     */
+    optionText: string;
+    /**
+     * Display order of the option within the question.
+     */
+    order: number;
+};

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

@@ -0,0 +1,5 @@
+export declare enum QuestionType {
+    TEXT = "Text",
+    LINEAR_SCALE = "LinearScale",
+    CHOICE = "Choice"
+}

package/dist/api/models/QuestionType.js

@@ -0,0 +1 @@
+var e;!function(e){e.TEXT="Text",e.LINEAR_SCALE="LinearScale",e.CHOICE="Choice"}(e||(e={}));export{e as QuestionType};

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

@@ -0,0 +1,27 @@
+import type { AnswerVm } from './AnswerVm';
+import type { QuestionId } from './QuestionId';
+import type { QuestionOptionDto } from './QuestionOptionDto';
+import type { QuestionType } from './QuestionType';
+export type QuestionVm = {
+    questionId: QuestionId;
+    type: QuestionType;
+    order: number;
+    /**
+     * The text answer provided for text questions.
+     * Only populated if the question type is Text.
+     */
+    text: string;
+    /**
+     * The list of selected option IDs for choice questions.
+     * Only populated if the question type is MultipleChoice.
+     */
+    options?: Array<QuestionOptionDto> | null;
+    maxSelections?: number | null;
+    linearScaleConfig?: {
+        min: number;
+        max: number;
+        minLabel: string;
+        maxLabel: string;
+    };
+    answer?: AnswerVm;
+};

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

@@ -0,0 +1,6 @@
+export declare enum SamWorkItemState {
+    NEW = "New",
+    IN_PROGRESS = "InProgress",
+    CLOSED = "Closed",
+    REJECTED = "Rejected"
+}

package/dist/api/models/SamWorkItemState.js

@@ -0,0 +1 @@
+var e;!function(e){e.NEW="New",e.IN_PROGRESS="InProgress",e.CLOSED="Closed",e.REJECTED="Rejected"}(e||(e={}));export{e as SamWorkItemState};

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

@@ -0,0 +1,8 @@
+import type { SurveyId } from './SurveyId';
+export type StartSurveyDto = {
+    surveyId: SurveyId;
+    /**
+     * When true, the user opts out of participating in the survey.
+     */
+    optOut: boolean;
+};

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

@@ -0,0 +1,3 @@
+export type SurveyId = {
+    value: string;
+};

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

@@ -0,0 +1,3 @@
+export type SurveyResponseId = {
+    value: string;
+};

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

@@ -0,0 +1,6 @@
+export declare enum SurveyResponseStatus {
+    NOT_STARTED = "NotStarted",
+    IN_PROGRESS = "InProgress",
+    COMPLETED = "Completed",
+    OPTED_OUT = "OptedOut"
+}

package/dist/api/models/SurveyResponseStatus.js

@@ -0,0 +1 @@
+var t;!function(t){t.NOT_STARTED="NotStarted",t.IN_PROGRESS="InProgress",t.COMPLETED="Completed",t.OPTED_OUT="OptedOut"}(t||(t={}));export{t as SurveyResponseStatus};

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

@@ -0,0 +1,7 @@
+/**
+ * Defines the types of surveys available in the system.
+ */
+export declare enum SurveyType {
+    DEFAULT = "Default",
+    UMUX = "Umux"
+}

package/dist/api/models/SurveyType.js

@@ -0,0 +1 @@
+var U;!function(U){U.DEFAULT="Default",U.UMUX="Umux"}(U||(U={}));export{U as SurveyType};

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

@@ -0,0 +1,18 @@
+import type { QuestionVm } from './QuestionVm';
+import type { SurveyId } from './SurveyId';
+import type { SurveyResponseId } from './SurveyResponseId';
+import type { SurveyResponseStatus } from './SurveyResponseStatus';
+import { SurveyType } from './SurveyType';
+export type UserSurveyVm = {
+    surveyId: SurveyId;
+    surveyResponseId?: SurveyResponseId;
+    status: SurveyResponseStatus;
+    surveyType: SurveyType;
+    applicationId: string;
+    title: string;
+    description: string;
+    startAt: string;
+    endAt: string;
+    showConfettiOnComplete: boolean;
+    questions: Array<QuestionVm>;
+};

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

@@ -0,0 +1,24 @@
+import type { BugSeverity } from './BugSeverity';
+import type { SamWorkItemState } from './SamWorkItemState';
+import type { WorkItemAttachment } from './WorkItemAttachment';
+import type { WorkItemType } from './WorkItemType';
+export type WorkItem = {
+    updatedBy?: string | null;
+    updatedByName?: string | null;
+    updatedDate?: string | null;
+    createdBy: string;
+    createdByName: string;
+    createdDate: string;
+    title: string;
+    description: string;
+    applicationName: string;
+    browser?: string | null;
+    field?: string | null;
+    handler?: string | null;
+    severity?: BugSeverity;
+    workItemType: WorkItemType;
+    id: string;
+    state: SamWorkItemState;
+    userStoryUrl?: string | null;
+    attachments: Array<WorkItemAttachment>;
+};

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

@@ -0,0 +1,12 @@
+export type WorkItemAttachment = {
+    updatedBy?: string | null;
+    updatedByName?: string | null;
+    updatedDate?: string | null;
+    createdBy: string;
+    createdByName: string;
+    createdDate: string;
+    id: string;
+    fkWorkItemId: string;
+    fileName: string;
+    filePath: string;
+};

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

@@ -0,0 +1,4 @@
+export declare enum WorkItemType {
+    SUGGESTION = "Suggestion",
+    BUG = "Bug"
+}

package/dist/api/models/WorkItemType.js

@@ -0,0 +1 @@
+var g;!function(g){g.SUGGESTION="Suggestion",g.BUG="Bug"}(g||(g={}));export{g as WorkItemType};

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

@@ -0,0 +1,40 @@
+import type { AnswerId } from '../models/AnswerId';
+import type { AnswerQuestionCommandDto } from '../models/AnswerQuestionCommandDto';
+import type { StartSurveyDto } from '../models/StartSurveyDto';
+import type { SurveyResponseId } from '../models/SurveyResponseId';
+import type { UserSurveyVm } from '../models/UserSurveyVm';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class SurveysPublicService {
+    /**
+     * Begins a new survey response for the authenticated user for the specified survey.
+     * @param surveyId
+     * @param requestBody
+     * @returns SurveyResponseId OK
+     * @throws ApiError
+     */
+    static createSurveyResponse(surveyId: string, requestBody?: StartSurveyDto): CancelablePromise<SurveyResponseId>;
+    /**
+     * Returns the active survey for the application that the user has not yet answered for that application.
+     * Only returns an Sam.Api.Enums.Surveys.SurveyState.Active survey for the application that the authenticated user has not completed or opted out of.
+     * @param applicationName The name of the application.
+     * @returns UserSurveyVm The active survey for the application to prompt the user with. Null if no active survey is available.
+     * @throws ApiError
+     */
+    static getActiveSurveyForApplication(applicationName: string): CancelablePromise<UserSurveyVm | null>;
+    /**
+     * Updates or creates the authenticated user's answer to the question.
+     * ## Business Rules:
+     * One answer per user per question.
+     *
+     * ## Restrictions:
+     * - The OptionIds listed must exist for that question
+     * - The number of OptionIds listed cannot exceed Sam.Api.Models.Dto.SurveyPublic.Response.QuestionPublicDto.MaxSelections for the question.
+     * - Survey must be Sam.Api.Enums.Surveys.SurveyState.Active
+     * - User cannot have Sam.Api.Enums.Surveys.SurveyResponseStatus.Completed the survey or Sam.Api.Enums.Surveys.SurveyResponseStatus.OptedOut.
+     * @param surveyResponseId
+     * @param requestBody
+     * @returns AnswerId The updated answer.
+     * @throws ApiError
+     */
+    static upsertSurveyResponse(surveyResponseId: string, requestBody?: AnswerQuestionCommandDto): CancelablePromise<AnswerId>;
+}

package/dist/api/services/SurveysPublicService.js

@@ -0,0 +1 @@
+import{OpenAPI_SAM as e}from"../core/OpenAPI.js";import{request as s}from"../core/request.js";class t{static createSurveyResponse(t,r){return s(e,{method:"POST",url:"/api/v1/surveys/{surveyId}/survey/me",path:{surveyId:t},body:r,mediaType:"application/json",errors:{404:"Not Found",409:"Conflict",422:"Unprocessable Content"}})}static getActiveSurveyForApplication(t){return s(e,{method:"GET",url:"/api/v1/surveys/applications/{applicationName}/me",path:{applicationName:t}})}static upsertSurveyResponse(t,r){return s(e,{method:"PUT",url:"/api/v1/surveys/{surveyResponseId}/responses/me",path:{surveyResponseId:t},body:r,mediaType:"application/json",errors:{404:"Survey or question with the specified ID was not found or survey is not active.",409:"Cannot update answer due to status being completed or opted out.",422:"The provided answer data is invalid."}})}}export{t as SurveysPublicService};

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

@@ -0,0 +1,30 @@
+import type { BugSeverity } from '../models/BugSeverity';
+import type { WorkItem } from '../models/WorkItem';
+import type { WorkItemType } from '../models/WorkItemType';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class WorkItemsService {
+    /**
+     * Creates a workItem in SAM, and creates a userstory or bug in Azure devops.
+     * Slack comment is always forwarding the slack message first, and then saves in db and creates userstory.
+     * Information can be found in the SAM Azure Devops wiki, in the Upscaling wiki.
+     * @param slackComment Creates a slack comment in the feedback channel. If empty, no message will be sent.
+     * @param attachmentComment Creates a comment to one of the attachments. If empty, no message will be sent.
+     * @param formData
+     * @returns WorkItem OK
+     * @throws ApiError
+     */
+    static createWorkItemWithAttachment(slackComment?: string, attachmentComment?: string, formData?: {
+        /**
+         * Files to attach to the user stories.
+         */
+        fileList?: Array<Blob>;
+        Title?: string;
+        Description?: string;
+        ApplicationName?: string;
+        Browser?: string;
+        Field?: string;
+        IssueUrl?: string;
+        Severity?: BugSeverity;
+        WorkItemType?: WorkItemType;
+    }): CancelablePromise<WorkItem>;
+}

package/dist/api/services/WorkItemsService.js

@@ -0,0 +1 @@
+import{OpenAPI_SAM as t}from"../core/OpenAPI.js";import{request as e}from"../core/request.js";class m{static createWorkItemWithAttachment(m,r,a){return e(t,{method:"POST",url:"/api/v1/WorkItems/workitem-with-attachment",query:{slackComment:m,attachmentComment:r},formData:a,mediaType:"multipart/form-data"})}}export{m as WorkItemsService};

package/dist/components/Feature/Feature.js

@@ -1 +1 @@
-import{jsx as o,Fragment as r}from"react/jsx-runtime";import"../../providers/FeatureToggleProvider.js";import{useFeatureToggling as e}from"../../hooks/useFeatureToggling.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import"../../api/models/TutorialPosition.js";import"../../types/Environment.js";import"../../types/ReleaseNotes.js";import"react";import"@microsoft/signalr";const t=({children:t,fallback:i,...s})=>{const{showContent:p}=e({...s});return p?o(r,{children:t}):void 0===i?null:o(r,{children:i})};export{t as Feature};
+import{jsx as o,Fragment as e}from"react/jsx-runtime";import"../../providers/FeatureToggleProvider.js";import{useFeatureToggling as r}from"../../hooks/useFeatureToggling.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import"../../api/models/TutorialPosition.js";import"../../api/models/QuestionType.js";import"../../api/models/SurveyType.js";import"../../api/models/SurveyResponseStatus.js";import"../../api/models/WorkItemType.js";import"../../api/models/BugSeverity.js";import"../../api/models/SamWorkItemState.js";import"../../types/Environment.js";import"../../types/ReleaseNotes.js";import"react";import"@microsoft/signalr";const t=({children:t,fallback:i,...s})=>{const{showContent:p}=r({...s});return p?o(e,{children:t}):void 0===i?null:o(e,{children:i})};export{t as Feature};

package/dist/constants/queryKeys.d.ts

@@ -3,4 +3,5 @@ export declare const GET_TUTORIALS_FOR_APP = "getTutorialsForApp";
 export declare const GET_TUTORIALS_SAS_TOKEN = "getTutorialsSasToken";
 export declare const GET_RELEASE_NOTES = "getReleaseNotes";
 export declare const GET_TUTORIAL_STEP_IMAGE = "getTutorialStepImage";
+export declare const GET_SURVEY_FOR_APP = "getSurveyForApp";
 export declare const SAM_QUERIES: string[];

package/dist/constants/queryKeys.js

@@ -1 +1 @@
-const e="getFeatureToggleFromAppName",t="getTutorialsForApp",o="getTutorialsSasToken",a="getReleaseNotes",g="getTutorialStepImage",r=[e,t,o,a];export{e as GET_FEATURE_TOGGLES_FOR_APP,a as GET_RELEASE_NOTES,t as GET_TUTORIALS_FOR_APP,o as GET_TUTORIALS_SAS_TOKEN,g as GET_TUTORIAL_STEP_IMAGE,r as SAM_QUERIES};
+const e="getFeatureToggleFromAppName",t="getTutorialsForApp",o="getTutorialsSasToken",g="getReleaseNotes",r="getTutorialStepImage",a="getSurveyForApp",p=[e,t,o,g,a];export{e as GET_FEATURE_TOGGLES_FOR_APP,g as GET_RELEASE_NOTES,a as GET_SURVEY_FOR_APP,t as GET_TUTORIALS_FOR_APP,o as GET_TUTORIALS_SAS_TOKEN,r as GET_TUTORIAL_STEP_IMAGE,p as SAM_QUERIES};

package/dist/hooks/index.d.ts

@@ -4,3 +4,6 @@ export { useReleaseNotesQuery } from './useReleaseNotesQuery';
 export { useTutorialsQuery } from './useTutorialsQuery';
 export { useTutorialStepImage } from './useTutorialStepImage';
 export { useSignalRMessages } from './useSignalRMessages';
+export { useActiveSurvey } from './useActiveSurvey';
+export { useRespondActiveSurvey } from './useRespondActiveSurvey';
+export { useAnswerQuestionActiveSurvey } from './useAnswerQuestionActiveSurvey';

package/dist/hooks/useActiveSurvey.d.ts

@@ -0,0 +1,27 @@
+export declare function useActiveSurvey(): import("@tanstack/react-query").UseQueryResult<{
+    questions: {
+        options: import("../api").QuestionOptionDto[] | undefined;
+        questionId: import("../api").QuestionId;
+        type: import("../api").QuestionType;
+        order: number;
+        text: string;
+        maxSelections?: number | null;
+        linearScaleConfig?: {
+            min: number;
+            max: number;
+            minLabel: string;
+            maxLabel: string;
+        };
+        answer?: import("../api").AnswerVm;
+    }[];
+    surveyId: import("../api").SurveyId;
+    surveyResponseId?: import("../api").SurveyResponseId;
+    status: import("../api").SurveyResponseStatus;
+    surveyType: import("../api").SurveyType;
+    applicationId: string;
+    title: string;
+    description: string;
+    startAt: string;
+    endAt: string;
+    showConfettiOnComplete: boolean;
+} | null, Error>;

package/dist/hooks/useActiveSurvey.js

@@ -0,0 +1 @@
+import{useQuery as e}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"../api/models/QuestionType.js";import"../api/models/SurveyType.js";import"../api/models/SurveyResponseStatus.js";import"../api/models/WorkItemType.js";import"../api/models/BugSeverity.js";import"../api/models/SamWorkItemState.js";import"../types/Environment.js";import"../types/ReleaseNotes.js";import{SurveysPublicService as o}from"../api/services/SurveysPublicService.js";import{GET_SURVEY_FOR_APP as r}from"../constants/queryKeys.js";import{getAppName as t}from"../utils/environment.js";function i(){return e({queryKey:[r],queryFn:()=>o.getActiveSurveyForApplication(t(import.meta.env.VITE_NAME)),select:e=>null===e?null:{...e,questions:e.questions.toSorted(((e,o)=>e.order-o.order)).map((e=>({...e,options:e.options?.toSorted(((e,o)=>e.order-o.order))})))}})}export{i as useActiveSurvey};

package/dist/hooks/useAnswerQuestionActiveSurvey.d.ts

@@ -0,0 +1,5 @@
+import { AnswerQuestionCommandDto } from '../api';
+export declare function useAnswerQuestionActiveSurvey(): import("@tanstack/react-query").UseMutationResult<import("../api").AnswerId, Error, {
+    surveyResponseId: string;
+    body: AnswerQuestionCommandDto;
+}, unknown>;

package/dist/hooks/useAnswerQuestionActiveSurvey.js

@@ -0,0 +1 @@
+import{useMutation as e}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"../api/models/QuestionType.js";import"../api/models/SurveyType.js";import"../api/models/SurveyResponseStatus.js";import"../api/models/WorkItemType.js";import"../api/models/BugSeverity.js";import"../api/models/SamWorkItemState.js";import"../types/Environment.js";import"../types/ReleaseNotes.js";import{SurveysPublicService as o}from"../api/services/SurveysPublicService.js";function s(){return e({mutationFn:({surveyResponseId:e,body:s})=>o.upsertSurveyResponse(e,s)})}export{s as useAnswerQuestionActiveSurvey};

package/dist/hooks/useRespondActiveSurvey.d.ts

@@ -0,0 +1,2 @@
+import { StartSurveyDto } from '../api';
+export declare function useRespondActiveSurvey(): import("@tanstack/react-query").UseMutationResult<import("../api").SurveyResponseId, Error, StartSurveyDto, unknown>;

package/dist/hooks/useRespondActiveSurvey.js

@@ -0,0 +1 @@
+import{useQueryClient as e,useMutation 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"../api/models/QuestionType.js";import"../api/models/SurveyType.js";import{SurveyResponseStatus as o}from"../api/models/SurveyResponseStatus.js";import"../api/models/WorkItemType.js";import"../api/models/BugSeverity.js";import"../api/models/SamWorkItemState.js";import"../types/Environment.js";import"../types/ReleaseNotes.js";import{SurveysPublicService as s}from"../api/services/SurveysPublicService.js";import{GET_SURVEY_FOR_APP as r}from"../constants/queryKeys.js";function i(){const i=e();return t({mutationFn:async e=>{const t=await s.createSurveyResponse(e.surveyId.value,e);return i.setQueryData([r],(s=>s?e.optOut?void 0:{...s,surveyResponseId:t,status:o.IN_PROGRESS}:s)),t}})}export{i as useRespondActiveSurvey};

package/dist/hooks/useSignalRMessages.js

@@ -1 +1 @@
-import{useRef as e,useState as r,useMemo as t,useEffect as n}from"react";import*as o from"@microsoft/signalr";import{LogLevel as s}from"@microsoft/signalr";import{useQuery as i}from"@tanstack/react-query";import{getSAMToken as c}from"../api/core/OpenAPI.js";import"../api/models/ApplicationCategory.js";import"../api/models/ServiceNowUrgency.js";import"../api/models/TutorialPosition.js";import{EnvironmentType as a}from"../types/Environment.js";import"../types/ReleaseNotes.js";import{getEnvironmentName as u}from"../utils/environment.js";function m(m){const p=e(void 0),[d,l]=r([]),[g,f]=r(),[b,v]=r(),w=e(void 0),N=e(void 0),{data:S}=i({queryKey:["get-sam-token"],queryFn:()=>c()}),y=t((()=>{const e=u(import.meta.env.VITE_ENVIRONMENT_NAME);return`wss://api-sam-backend-${e===a.LOCALHOST?a.DEVELOP:e}.radix.equinor.com`}),[]);n((()=>{(async function(){if(void 0===S||w.current===m&&N.current===S)return;void 0!==p.current&&w.current&&N.current&&(w.current!==m||N.current!==S)&&await p.current.stop(),N.current=S,w.current=m;const e=(new o.HubConnectionBuilder).configureLogging(s.Error).withUrl(`${y}/hubs/notifications`,{accessTokenFactory:()=>S,withCredentials:!1,skipNegotiation:!0,transport:o.HttpTransportType.WebSockets}).withAutomaticReconnect().build();try{await e.start(),e.on("ActiveMessages",((e,r)=>{l(r.map((r=>({...r,Subject:e}))).reverse())})),e.onreconnected((()=>e.invoke("Subscribe",m))),e.on("NewMessage",((e,r)=>{l((t=>[{...r,Subject:e},...t]))})),e.on("UpdateMessage",((e,r)=>{v({...r,Subject:e})})),e.on("Delete",((e,r)=>{f(r)})),e.on("Error",(e=>{throw new Error("Connection error: "+e)})),await e.invoke("Subscribe",m),await e.invoke("PeekMessages")}catch(e){console.error("Connection failed",e)}p.current=e})().catch((e=>{console.error("Error setting up connection",e)}))}),[y,m,S]),n((()=>{if(b){const e=d.findIndex((e=>e.SequenceNumber===b.SequenceNumber)),r=[...d];e>-1&&(r[e]=b,l(r),v(void 0))}}),[b,d]),n((()=>{if(g){const e=d.findIndex((e=>e.SequenceNumber===g)),r=[...d];e>-1&&(r.splice(e,1),l(r),f(void 0))}}),[g,d]);const E=e=>{p.current&&(e.Read=!e.Read,p.current.invoke("PatchMessage",e.SequenceNumber,e).catch((e=>{console.error("Error setting message as read",e)})))},k=t((()=>d.some((e=>!1===e.Read))),[d]);return{messages:d,hasUnreadMessages:k,setMessageAsRead:E,setAllMessagesAsRead:()=>{d.forEach((e=>{e.Read||E(e)}))},deleteMessage:async function(e){p.current&&null!==e.SequenceNumber&&(await p.current.invoke("DeleteMessage",e.SequenceNumber),f(e.SequenceNumber))},closeConnection:async()=>{if(p.current)return await p.current.stop()}}}export{m as useSignalRMessages};
+import{useRef as e,useState as r,useMemo as t,useEffect as o}from"react";import*as n from"@microsoft/signalr";import{LogLevel as s}from"@microsoft/signalr";import{useQuery as i}from"@tanstack/react-query";import{getSAMToken as a}from"../api/core/OpenAPI.js";import"../api/models/ApplicationCategory.js";import"../api/models/ServiceNowUrgency.js";import"../api/models/TutorialPosition.js";import"../api/models/QuestionType.js";import"../api/models/SurveyType.js";import"../api/models/SurveyResponseStatus.js";import"../api/models/WorkItemType.js";import"../api/models/BugSeverity.js";import"../api/models/SamWorkItemState.js";import{EnvironmentType as c}from"../types/Environment.js";import"../types/ReleaseNotes.js";import{getEnvironmentName as u}from"../utils/environment.js";function m(m){const p=e(void 0),[d,l]=r([]),[g,f]=r(),[v,S]=r(),y=e(void 0),b=e(void 0),{data:j}=i({queryKey:["get-sam-token"],queryFn:()=>a()}),w=t((()=>{const e=u(import.meta.env.VITE_ENVIRONMENT_NAME);return`wss://api-sam-backend-${e===c.LOCALHOST?c.DEVELOP:e}.radix.equinor.com`}),[]);o((()=>{(async function(){if(void 0===j||y.current===m&&b.current===j)return;void 0!==p.current&&y.current&&b.current&&(y.current!==m||b.current!==j)&&await p.current.stop(),b.current=j,y.current=m;const e=(new n.HubConnectionBuilder).configureLogging(s.Error).withUrl(`${w}/hubs/notifications`,{accessTokenFactory:()=>j,withCredentials:!1,skipNegotiation:!0,transport:n.HttpTransportType.WebSockets}).withAutomaticReconnect().build();try{await e.start(),e.on("ActiveMessages",((e,r)=>{l(r.map((r=>({...r,Subject:e}))).reverse())})),e.onreconnected((()=>e.invoke("Subscribe",m))),e.on("NewMessage",((e,r)=>{l((t=>[{...r,Subject:e},...t]))})),e.on("UpdateMessage",((e,r)=>{S({...r,Subject:e})})),e.on("Delete",((e,r)=>{f(r)})),e.on("Error",(e=>{throw new Error("Connection error: "+e)})),await e.invoke("Subscribe",m),await e.invoke("PeekMessages")}catch(e){console.error("Connection failed",e)}p.current=e})().catch((e=>{console.error("Error setting up connection",e)}))}),[w,m,j]),o((()=>{if(v){const e=d.findIndex((e=>e.SequenceNumber===v.SequenceNumber)),r=[...d];e>-1&&(r[e]=v,l(r),S(void 0))}}),[v,d]),o((()=>{if(g){const e=d.findIndex((e=>e.SequenceNumber===g)),r=[...d];e>-1&&(r.splice(e,1),l(r),f(void 0))}}),[g,d]);const N=e=>{p.current&&(e.Read=!e.Read,p.current.invoke("PatchMessage",e.SequenceNumber,e).catch((e=>{console.error("Error setting message as read",e)})))},k=t((()=>d.some((e=>!1===e.Read))),[d]);return{messages:d,hasUnreadMessages:k,setMessageAsRead:N,setAllMessagesAsRead:()=>{d.forEach((e=>{e.Read||N(e)}))},deleteMessage:async function(e){p.current&&null!==e.SequenceNumber&&(await p.current.invoke("DeleteMessage",e.SequenceNumber),f(e.SequenceNumber))},closeConnection:async()=>{if(p.current)return await p.current.stop()}}}export{m as useSignalRMessages};

package/dist/hooks/useTutorialsQuery.js

@@ -1 +1 @@
-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{EnvironmentType as t}from"../types/Environment.js";import"../types/ReleaseNotes.js";import{TutorialService as e}from"../api/services/TutorialService.js";import{GET_TUTORIALS_FOR_APP as o}from"../constants/queryKeys.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)===t.PRODUCTION){return(await e.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(await e.getDraftTutorialsForApplication(s(import.meta.env.VITE_NAME))).map((r=>({...r,steps:r.steps.sort(((r,t)=>(r.orderBy??0)-(t.orderBy??0)))})))}})}export{p as useTutorialsQuery};
+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"../api/models/QuestionType.js";import"../api/models/SurveyType.js";import"../api/models/SurveyResponseStatus.js";import"../api/models/WorkItemType.js";import"../api/models/BugSeverity.js";import"../api/models/SamWorkItemState.js";import{EnvironmentType as r}from"../types/Environment.js";import"../types/ReleaseNotes.js";import{TutorialService as e}from"../api/services/TutorialService.js";import{GET_TUTORIALS_FOR_APP as o}from"../constants/queryKeys.js";import{getEnvironmentName as i,getAppName as s}from"../utils/environment.js";function p(){return t({queryKey:[o],queryFn:async()=>{if(i(import.meta.env.VITE_ENVIRONMENT_NAME)===r.PRODUCTION){return(await e.getMyTutorialsForApplication(s(import.meta.env.VITE_NAME),!1)).map((t=>({...t,id:t.tutorialDraftId?t.tutorialDraftId:t.id,steps:t.steps.sort(((t,r)=>(t.orderBy??0)-(r.orderBy??0)))})))}return(await e.getDraftTutorialsForApplication(s(import.meta.env.VITE_NAME))).map((t=>({...t,steps:t.steps.sort(((t,r)=>(t.orderBy??0)-(r.orderBy??0)))})))}})}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{EnvironmentToggleFeatures,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,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{AppAnalyticsService}from"./api/services/AppAnalyticsService.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{ENVIRONMENT_TOGGLE_KEY}from"./constants/environmentToggle.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{useActiveSurvey}from"./hooks/useActiveSurvey.js";export{useRespondActiveSurvey}from"./hooks/useRespondActiveSurvey.js";export{useAnswerQuestionActiveSurvey}from"./hooks/useAnswerQuestionActiveSurvey.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{EnvironmentToggleFeatures,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,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{QuestionType}from"./api/models/QuestionType.js";export{SurveyType}from"./api/models/SurveyType.js";export{SurveyResponseStatus}from"./api/models/SurveyResponseStatus.js";export{WorkItemType}from"./api/models/WorkItemType.js";export{BugSeverity}from"./api/models/BugSeverity.js";export{SamWorkItemState}from"./api/models/SamWorkItemState.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{AppAnalyticsService}from"./api/services/AppAnalyticsService.js";export{SurveysPublicService}from"./api/services/SurveysPublicService.js";export{WorkItemsService}from"./api/services/WorkItemsService.js";export{GET_FEATURE_TOGGLES_FOR_APP,GET_RELEASE_NOTES,GET_SURVEY_FOR_APP,GET_TUTORIALS_FOR_APP,GET_TUTORIALS_SAS_TOKEN,GET_TUTORIAL_STEP_IMAGE,SAM_QUERIES}from"./constants/queryKeys.js";export{ENVIRONMENT_TOGGLE_KEY}from"./constants/environmentToggle.js";

package/dist/providers/TutorialProvider/TutorialProvider.js

@@ -1 +1 @@
-import{jsx as o}from"react/jsx-runtime";import{createContext as r,useState as t,useMemo as i,useContext as e}from"react";import{useMatchRoute as s}from"@tanstack/react-router";import{useSeenTutorials as a}from"./useSeenTutorials.js";import"../FeatureToggleProvider.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";import{useTutorialsQuery as n}from"../../hooks/useTutorialsQuery.js";import"../../types/Environment.js";import"../../types/ReleaseNotes.js";import"@microsoft/signalr";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import"../../api/models/TutorialPosition.js";import{usePrefetchTutorialStepImages as u}from"./hooks/usePrefetchTutorialStepImages.js";const p=r(void 0);function l(){const o=e(p);if(void 0===o)throw new Error("'useTutorials' must be used within provider");return o}const d=({children:r})=>{const{data:e=[]}=n(),[l,d]=t(void 0),[m,c]=t(void 0),[v,f]=a();u();const T=s(),h=e?.filter((o=>!!T({to:o.path}))),w=i((()=>h?.filter((o=>!v.includes(o.id)&&o.willPopUp))),[v,h]);return o(p.Provider,{value:{allTutorials:e,tutorialsOnThisPage:h,unseenTutorialsOnThisPage:w,activeTutorial:l,activeStep:m,seenTutorialIDs:v,startTutorial:o=>{if(!e?.some((r=>o===r.id)))throw new Error("Tutorial not found");d(e.find((r=>o===r.id))),c(0)},skipTutorial:o=>{l&&l.id===o&&(d(void 0),c(void 0)),f(o)},goToNextStep:()=>{if(!l)throw new Error("No currently active tutorial!");if(void 0===m)throw new Error("activeStep is undefined!");m+1>=l.steps.length?(f(l.id),d(void 0),c(void 0)):c(m+1)},goToPreviousStep:()=>{if(!l)throw new Error("No currently active tutorial!");if(void 0===m)throw new Error("activeStep is undefined!");0===m?(d(void 0),c(void 0)):c(m-1)}},children:r})};export{p as TutorialDataContext,d as TutorialProvider,l as useTutorials};
+import{jsx as o}from"react/jsx-runtime";import{createContext as r,useState as t,useMemo as i,useContext as e}from"react";import{useMatchRoute as s}from"@tanstack/react-router";import{useSeenTutorials as a}from"./useSeenTutorials.js";import"../FeatureToggleProvider.js";import"@tanstack/react-query";import"../../api/core/OpenAPI.js";import{useTutorialsQuery as p}from"../../hooks/useTutorialsQuery.js";import"../../types/Environment.js";import"../../types/ReleaseNotes.js";import"@microsoft/signalr";import"../../api/models/ApplicationCategory.js";import"../../api/models/ServiceNowUrgency.js";import"../../api/models/TutorialPosition.js";import"../../api/models/QuestionType.js";import"../../api/models/SurveyType.js";import"../../api/models/SurveyResponseStatus.js";import"../../api/models/WorkItemType.js";import"../../api/models/BugSeverity.js";import"../../api/models/SamWorkItemState.js";import{usePrefetchTutorialStepImages as n}from"./hooks/usePrefetchTutorialStepImages.js";const m=r(void 0);function u(){const o=e(m);if(void 0===o)throw new Error("'useTutorials' must be used within provider");return o}const l=({children:r})=>{const{data:e=[]}=p(),[u,l]=t(void 0),[d,c]=t(void 0),[v,f]=a();n();const T=s(),j=e?.filter((o=>!!T({to:o.path}))),h=i((()=>j?.filter((o=>!v.includes(o.id)&&o.willPopUp))),[v,j]);return o(m.Provider,{value:{allTutorials:e,tutorialsOnThisPage:j,unseenTutorialsOnThisPage:h,activeTutorial:u,activeStep:d,seenTutorialIDs:v,startTutorial:o=>{if(!e?.some((r=>o===r.id)))throw new Error("Tutorial not found");l(e.find((r=>o===r.id))),c(0)},skipTutorial:o=>{u&&u.id===o&&(l(void 0),c(void 0)),f(o)},goToNextStep:()=>{if(!u)throw new Error("No currently active tutorial!");if(void 0===d)throw new Error("activeStep is undefined!");d+1>=u.steps.length?(f(u.id),l(void 0),c(void 0)):c(d+1)},goToPreviousStep:()=>{if(!u)throw new Error("No currently active tutorial!");if(void 0===d)throw new Error("activeStep is undefined!");0===d?(l(void 0),c(void 0)):c(d-1)}},children:r})};export{m as TutorialDataContext,l as TutorialProvider,u as useTutorials};

package/dist/providers/TutorialProvider/hooks/usePrefetchTutorialStepImages.js

@@ -1 +1 @@
-import{useRef as r,useEffect as o}from"react";import{useQueryClient as e}from"@tanstack/react-query";import{TutorialService as t}from"../../../api/services/TutorialService.js";import{GET_TUTORIAL_STEP_IMAGE as i}from"../../../constants/queryKeys.js";import"../../FeatureToggleProvider.js";import"../../../api/core/OpenAPI.js";import{useTutorialsQuery as s}from"../../../hooks/useTutorialsQuery.js";import"@microsoft/signalr";import"../../../api/models/ApplicationCategory.js";import"../../../api/models/ServiceNowUrgency.js";import"../../../api/models/TutorialPosition.js";import"../../../types/Environment.js";import"../../../types/ReleaseNotes.js";function m(){const{data:m=[]}=s(),p=e(),a=r([]);o((()=>{const r=r=>{for(const o of r.steps)o.imgUrl&&p.prefetchQuery({queryKey:[i,o.imgUrl],queryFn:()=>t.getTutorialImage(o.imgUrl),staleTime:1/0,gcTime:1/0})};for(const o of m)a.current.includes(o.id)||(a.current.push(o.id),r(o))}),[p,m])}export{m as usePrefetchTutorialStepImages};
+import{useRef as e,useEffect as o}from"react";import{useQueryClient as r}from"@tanstack/react-query";import{TutorialService as t}from"../../../api/services/TutorialService.js";import{GET_TUTORIAL_STEP_IMAGE as i}from"../../../constants/queryKeys.js";import"../../FeatureToggleProvider.js";import"../../../api/core/OpenAPI.js";import{useTutorialsQuery as s}from"../../../hooks/useTutorialsQuery.js";import"@microsoft/signalr";import"../../../api/models/ApplicationCategory.js";import"../../../api/models/ServiceNowUrgency.js";import"../../../api/models/TutorialPosition.js";import"../../../api/models/QuestionType.js";import"../../../api/models/SurveyType.js";import"../../../api/models/SurveyResponseStatus.js";import"../../../api/models/WorkItemType.js";import"../../../api/models/BugSeverity.js";import"../../../api/models/SamWorkItemState.js";import"../../../types/Environment.js";import"../../../types/ReleaseNotes.js";function m(){const{data:m=[]}=s(),p=r(),a=e([]);o((()=>{const e=e=>{for(const o of e.steps)o.imgUrl&&p.prefetchQuery({queryKey:[i,o.imgUrl],queryFn:()=>t.getTutorialImage(o.imgUrl),staleTime:1/0,gcTime:1/0})};for(const o of m)a.current.includes(o.id)||(a.current.push(o.id),e(o))}),[p,m])}export{m as usePrefetchTutorialStepImages};

package/package.json

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