@appsemble/lang-sdk/reference-schemas/remappers/strings.js

Language SDK for Appsemble

import { schemaExample } from '../../examples.js';
export const stringRemappers = {
    'string.case': {
        enum: ['lower', 'upper'],
        description: `Convert a string to upper or lower case.

${schemaExample('string.case')}
`,
    },
    'string.startsWith': {
        type: 'string',
        description: `Check if the initial characters of the string matches with the input string,
this remapper is case-sensitive.
${schemaExample('string.startsWith')}
`,
    },
    'string.endsWith': {
        oneOf: [
            {
                type: 'string',
            },
            {
                type: 'object',
                description: 'Alternative way to define input to facilitate the case-insensitive matching',
                required: ['substring'],
                additionalProperties: false,
                properties: {
                    substring: {
                        type: 'string',
                    },
                    strict: {
                        type: 'boolean',
                    },
                },
            },
        ],
        description: `Check if the last characters of the string matches with the input string,
this remapper is case-sensitive unless specified explicitly,
To make the remapper ignore casing of the input and passed string, use the following example
${schemaExample('string.endsWith')}
`,
    },
    'string.format': {
        type: 'object',
        additionalProperties: false,
        properties: {
            messageId: {
                $ref: '#/components/schemas/RemapperDefinition',
                description: 'The message id pointing to the template string to format.',
            },
            template: {
                type: 'string',
                description: 'The template default string to format.',
            },
            values: {
                description: 'A set of remappers to convert the input to usable values.',
                additionalProperties: {
                    $ref: '#/components/schemas/RemapperDefinition',
                },
            },
        },
        description: `Format a string using remapped input variables.
Useful for replacing static text with generated values.

${schemaExample('string.format')}

> **Tip:** Considering this can be inserted anywhere a remapper is accepted. You can also use this
> to choose specific URL’s more accurately.

`,
    },
    'string.replace': {
        type: 'object',
        minProperties: 1,
        maxProperties: 1,
        additionalProperties: {
            type: 'string',
        },
        description: `
Uses RegEx to find a value in a string and replace it with a given value.

${schemaExample('string.replace')}
`,
    },
    'string.contains': {
        type: 'string',
        description: `
Checks if the provided string is a substring of the input string.
${schemaExample('string.contains')}
`,
    },
};
//# sourceMappingURL=strings.js.map