File

libs/sdk/src/lib/model/split-journey-configuration.schema.ts

Extends

Omit<PagesJsonSchema, 'pages'>,PfeConfig,WithSchema

Index

Properties

Properties

$schema (Optional)
Type string
Description

The JSON Schema for this file

description (Optional)
Type string
Description

Application Description. Will be used for the meta description tag.

frame (Optional)
Type Frame
Description

Configuration for Frame Parts (Navigation, Footer etc)

libraries
Type LibraryConfiguration[]
Default value []
Description

Provide a list of all used Building Block Libraries with the package name & version. Unused packages (i.e. not referred to in any 'Building Block Configuration') will be ignored. []

plugins (Optional)
Type PluginConfiguration[]
Default value []
Description

Configuration for plugins []

title (Optional)
Type string
Description

Application Title. Will be used as the website title. If omitted the app name is used.

webcomponent (Optional)
Type WebcomponentConfiguration
Description

Configuration for generating a webcomponent out of this application

workInProgressIndicator (Optional)
Type boolean
Default value false
Description

set to true to show WORK IN PROGRESS text on top of the application. false

import type {
  NavServiceActivatorConfig,
  PfeActionConfig,
  PfeConfig,
  PfeNavigationConfiguration
} from '@allianz/ngx-pfe';
import type { PageConfiguration } from '@allianz/taly-core/schemas';
import type { PagesJsonSchema } from './pages-json.schema';

export interface WithSchema {
  /** The JSON Schema for this file */
  $schema?: string;
}

export interface ApplicationJsonSchema
  extends Omit<PagesJsonSchema, 'pages'>,
    PfeConfig,
    WithSchema {}
export interface PageJsonSchema extends PageConfiguration, WithSchema {}
export interface NavigationJsonSchema
  extends Omit<PfeNavigationConfiguration, 'serviceActivators'>,
    WithSchema {}

// We need to use `type` for the next two types because the base types are defined using an
// index type that is not `string` and we can't add a string-typed property (like "$schema").
// `interface` doesn't allow this but `type` does.
// See https://www.typescriptlang.org/docs/handbook/2/objects.html#index-signatures for details
export type GlobalServiceActivatorsJsonSchema = {
  [key: string]: NavServiceActivatorConfig;
} & WithSchema;
export type GlobalActionsJsonSchema = { [key: string]: PfeActionConfig } & WithSchema;

results matching ""

    No results matching ""