Interface IProjectSettingsService

Provides utility functions that project data providers should call when handling project settings

interface IProjectSettingsService {
    getDefault<ProjectSettingName extends keyof ProjectSettingTypes>(
        key: ProjectSettingName,
    ): Promise<ProjectSettingTypes[ProjectSettingName]>;
    getLocalizedContributionInfo(): Promise<
        | undefined
        | {
            contributions: {
                [key: string]: | undefined
                | {
                    description?: string;
                    label: string;
                    properties: {
                        [key: `${string}.${string}`]: {
                            default: unknown;
                            derivesFrom?: string;
                            description?: string;
                            excludePdpFactoryIds?: string
                            | (...)[];
                            excludeProjectInterfaces?: string | (...)[];
                            includePdpFactoryIds?: string | (...)[];
                            includeProjectInterfaces?: string | (...)[];
                            isHidden?: boolean;
                            label: string;
                            platformType?: undefined;
                            type?: undefined;
                            [key: string]: unknown;
                        };
                    };
                    [key: string]: unknown;
                }[];
            };
            settings: {
                "platform.fullName"?: {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string
                    | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    isHidden?: boolean;
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                    [key: string]: unknown;
                };
                "platform.isEditable"?: {
                    default: boolean;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string
                    | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    isHidden?: boolean;
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                    [key: string]: unknown;
                };
                "platform.language"?: {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string
                    | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    isHidden?: boolean;
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                    [key: string]: unknown;
                };
                "platform.name"?: {
                    default: string;
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string
                    | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    isHidden?: boolean;
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                    [key: string]: unknown;
                };
                "platform.textDirection"?: {
                    default: undefined
                    | ""
                    | "ltr"
                    | "rtl";
                    derivesFrom?: string;
                    description?: string;
                    excludePdpFactoryIds?: string | string[];
                    excludeProjectInterfaces?: string | (string | string[])[];
                    includePdpFactoryIds?: string | string[];
                    includeProjectInterfaces?: string | (string | string[])[];
                    isHidden?: boolean;
                    label: string;
                    platformType?: undefined;
                    type?: undefined;
                    [key: string]: unknown;
                };
            };
        },
    >;
    isValid<ProjectSettingName extends keyof ProjectSettingTypes>(
        key: ProjectSettingName,
        newValue: ProjectSettingTypes[ProjectSettingName],
        currentValue: ProjectSettingTypes[ProjectSettingName],
        allChanges?: SimultaneousProjectSettingsChanges,
    ): Promise<boolean>;
    registerValidator<ProjectSettingName extends keyof ProjectSettingTypes>(
        key: ProjectSettingName,
        validatorCallback: ProjectSettingValidator<ProjectSettingName>,
    ): Promise<UnsubscriberAsync>;
}

Index

Methods

getDefault getLocalizedContributionInfo isValid registerValidator

Methods

getDefault

getDefault<ProjectSettingName extends keyof ProjectSettingTypes>(
key: ProjectSettingName,
): Promise<ProjectSettingTypes[ProjectSettingName]>
Gets default value for a project setting

Every Project Data Providers must run this function when it receives a request to get a project setting if the project does not have a value for the project setting requested. It should return the response from this function directly, either the returned default value or throw.
Type Parameters
- ProjectSettingName extends keyof ProjectSettingTypes
Parameters
- key: ProjectSettingName
  The project setting key for which to get the default value
Returns Promise<ProjectSettingTypes[ProjectSettingName]>
The default value for the setting if a default value is registered

Throws
If a default value is not registered for the setting
- Defined in lib/papi-dts/papi.d.ts:6492

getLocalizedContributionInfo

getLocalizedContributionInfo(): Promise<
    | undefined
    | {
        contributions: {
            [key: string]: | undefined
            | {
                description?: string;
                label: string;
                properties: {
                    [key: `${string}.${string}`]: {
                        default: unknown;
                        derivesFrom?: string;
                        description?: string;
                        excludePdpFactoryIds?: string
                        | (...)[];
                        excludeProjectInterfaces?: string | (...)[];
                        includePdpFactoryIds?: string | (...)[];
                        includeProjectInterfaces?: string | (...)[];
                        isHidden?: boolean;
                        label: string;
                        platformType?: undefined;
                        type?: undefined;
                        [key: string]: unknown;
                    };
                };
                [key: string]: unknown;
            }[];
        };
        settings: {
            "platform.fullName"?: {
                default: string;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.isEditable"?: {
                default: boolean;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.language"?: {
                default: string;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.name"?: {
                default: string;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.textDirection"?: {
                default: undefined
                | ""
                | "ltr"
                | "rtl";
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
        };
    },
>
Get the current set of project settings contribution info given all the input documents with all localized string keys localized properly.

Returns Promise<
    | undefined
    | {
        contributions: {
            [key: string]: | undefined
            | {
                description?: string;
                label: string;
                properties: {
                    [key: `${string}.${string}`]: {
                        default: unknown;
                        derivesFrom?: string;
                        description?: string;
                        excludePdpFactoryIds?: string
                        | (...)[];
                        excludeProjectInterfaces?: string | (...)[];
                        includePdpFactoryIds?: string | (...)[];
                        includeProjectInterfaces?: string | (...)[];
                        isHidden?: boolean;
                        label: string;
                        platformType?: undefined;
                        type?: undefined;
                        [key: string]: unknown;
                    };
                };
                [key: string]: unknown;
            }[];
        };
        settings: {
            "platform.fullName"?: {
                default: string;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.isEditable"?: {
                default: boolean;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.language"?: {
                default: string;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.name"?: {
                default: string;
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string
                | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
            "platform.textDirection"?: {
                default: undefined
                | ""
                | "ltr"
                | "rtl";
                derivesFrom?: string;
                description?: string;
                excludePdpFactoryIds?: string | string[];
                excludeProjectInterfaces?: string | (string | string[])[];
                includePdpFactoryIds?: string | string[];
                includeProjectInterfaces?: string | (string | string[])[];
                isHidden?: boolean;
                label: string;
                platformType?: undefined;
                type?: undefined;
                [key: string]: unknown;
            };
        };
    },
>
Localized project settings contribution info or undefined
- Defined in lib/papi-dts/papi.d.ts:6513

isValid

isValid<ProjectSettingName extends keyof ProjectSettingTypes>(
    key: ProjectSettingName,
    newValue: ProjectSettingTypes[ProjectSettingName],
    currentValue: ProjectSettingTypes[ProjectSettingName],
    allChanges?: SimultaneousProjectSettingsChanges,
): Promise<boolean>
Calls registered project settings validators to determine whether or not a project setting change is valid.

Every Project Data Provider must run this function when it receives a request to set a project setting before changing the value of the setting.
Type Parameters
- ProjectSettingName extends keyof ProjectSettingTypes
Parameters
- key: ProjectSettingName
  The project setting key being set
- newValue: ProjectSettingTypes[ProjectSettingName]
  The new value requested to set the project setting value to
- currentValue: ProjectSettingTypes[ProjectSettingName]
  The current project setting value
- OptionalallChanges: SimultaneousProjectSettingsChanges
  All project settings changes being set in one batch
Returns Promise<boolean>
true if change is valid, false otherwise
- Defined in lib/papi-dts/papi.d.ts:6474

registerValidator

registerValidator<ProjectSettingName extends keyof ProjectSettingTypes>(
key: ProjectSettingName,
validatorCallback: ProjectSettingValidator<ProjectSettingName>,
): Promise<UnsubscriberAsync>
Registers a function that validates whether a new project setting value is allowed to be set.
Type Parameters
- ProjectSettingName extends keyof ProjectSettingTypes
Parameters
- key: ProjectSettingName
  The string id of the setting to validate
- validatorCallback: ProjectSettingValidator<ProjectSettingName>
Returns Promise<UnsubscriberAsync>
Unsubscriber that should be called whenever the providing extension is deactivated
- Defined in lib/papi-dts/papi.d.ts:6503

Interface IProjectSettingsService

Index

Methods

Methods

getDefault

Type Parameters

Parameters

Returns Promise<ProjectSettingTypes[ProjectSettingName]>

Throws

getLocalizedContributionInfo

isValid

Type Parameters

Parameters

Returns Promise<boolean>

registerValidator

Type Parameters

Parameters

Returns Promise<UnsubscriberAsync>

Settings

On This Page