@o2s/modules.surveyjs

A module that handles fetching, rendering and submitting SurveyJS-based forms.

Installation

npm install @o2s/modules.surveyjs

Usage

Backend (API Harmonization)

Register the module in app.module.ts:

import * as SurveyJs from '@o2s/modules.surveyjs/api-harmonization';
import { AppConfig } from './app.config';

@Module({
    imports: [
        SurveyJs.Module.register(AppConfig),
    ],
})
export class AppModule {}

Frontend

Use the SurveyJS components:

import { SurveyJsRenderer } from '@o2s/modules.surveyjs/frontend';

export const SurveyPage = async ({ surveyId }) => {
    return <SurveyJsRenderer surveyId={surveyId} />;
};

SDK

The SDK exports a pre-configured instance (uses NEXT_PUBLIC_API_URL for the API base URL):

import { sdk } from '@o2s/modules.surveyjs/sdk';

// Fetch survey (code is the survey identifier from CMS)
const survey = await sdk.modules.getSurvey({ code: surveyCode }, { 'x-locale': 'en' }, accessToken);

// Submit survey
await sdk.modules.submitSurvey(
    { code: surveyCode, surveyPayload: answers },
    { 'x-locale': 'en' },
    accessToken,
);

Configuration

This module requires CMS integration to be configured in AppConfig:

import { CMS } from '@o2s/configs.integrations';

export const AppConfig: ApiConfig = {
    integrations: {
        cms: CMS.CmsIntegrationConfig,
    },
};

Related Packages

• @o2s/blocks.surveyjs-form - SurveyJS form block
• @o2s/configs.integrations - Integration configuration
• survey-core - SurveyJS core library
• survey-react-ui - SurveyJS React UI components