@servicenow/sdk-build-plugins 3.0.3 → 4.0.1

package/src/uxf/UxfFormulaParser/grammerParser/clientTransformMap.js

@@ -1,606 +0,0 @@
-// Copied from sn-uxf-formula-parser-library - https://code.devsnc.com/dev/uxf-formula-parser
-
-/**
- * https://code.devsnc.com/dev/uxf-formula-parser/blob/ci/master/src/uxf-formula-parser/grammar-parser/clientTransformMap.js
- */
-
-/**
- * @typedef ClientTransformDefinition
- * @type {object}
- * @property {string} name
- * @property {string} Type
- * @property {number} argCount
- * @property {string} documentation
- * @property {Array<string>} args
- * @property {string} insertText
- * @property {string|function} returnType
- */
-
-const filterLikeSignature = ['array', 'string', 'any']
-const emptyLikeSignature = ['array', 'string']
-const oneofLikeSignature = ['array', 'string', 'array']
-
-/**
- * @type {Object<string, ClientTransformDefinition>}
- */
-export default {
-    LEN: {
-        name: 'LEN',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'LEN(${1:list})',
-        documentation: 'Length of list',
-        args: ['array'],
-        returnType: 'number',
-    },
-    IF: {
-        name: 'IF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'IF(${1:if}, ${2:then}, ${3:else})',
-        documentation: 'If-Then-Else Statement',
-        args: ['boolean', 'any', 'any'],
-        returnType: (uxValue, getReturnTypeFromUxValue) =>
-            getReturnTypeFromUxValue(uxValue.transform?.operands?.container?.[0]),
-    },
-    CONCAT: {
-        name: 'CONCAT',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 'any',
-        insertText: 'CONCAT(${1:values})',
-        documentation: 'Concatenate values together',
-        args: ['string', '>string'],
-        returnType: 'string',
-    },
-    RANGE: {
-        name: 'RANGE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'RANGE(${1:from}, ${2:to})',
-        documentation: '',
-        args: ['number', 'number'],
-        returnType: 'array',
-    },
-    EMPTY: {
-        name: 'EMPTY',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'EMPTY(${1:value})',
-        documentation: '',
-        args: ['any'],
-        returnType: 'boolean',
-    },
-    PICK: {
-        name: 'PICK',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'PICK(${1:array}, ${2:field})',
-        documentation: '',
-        args: ['array', 'string'],
-        returnType: 'any',
-    },
-    WHERE_EQ: {
-        name: 'WHERE_EQ',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_EQ(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_NEQ: {
-        name: 'WHERE_NEQ',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_NEQ(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_GT: {
-        name: 'WHERE_GT',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_GT(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_GTE: {
-        name: 'WHERE_GTE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_GTE(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_LT: {
-        name: 'WHERE_LT',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_LT(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_LTE: {
-        name: 'WHERE_LTE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_LTE(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_EMPTY: {
-        name: 'WHERE_EMPTY',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'WHERE_EMPTY(${1:array}, ${2:field})',
-        documentation: '',
-        args: emptyLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_NOTEMPTY: {
-        name: 'WHERE_NOTEMPTY',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'WHERE_NOTEMPTY(${1:array}, ${2:field})',
-        documentation: '',
-        args: emptyLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_ONEOF: {
-        name: 'WHERE_ONEOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_ONEOF(${1:array}, ${2:field}, ${3:options})',
-        documentation: '',
-        args: oneofLikeSignature,
-        returnType: 'array',
-    },
-    WHERE_NOTONEOF: {
-        name: 'WHERE_NOTONEOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WHERE_NOTONEOF(${1:array}, ${2:field}, ${3:options})',
-        documentation: '',
-        args: oneofLikeSignature,
-        returnType: 'array',
-    },
-    ANY_EQ: {
-        name: 'ANY_EQ',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_EQ(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_NEQ: {
-        name: 'ANY_NEQ',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_NEQ(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_GT: {
-        name: 'ANY_GT',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_GT(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_GTE: {
-        name: 'ANY_GTE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_GTE(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_LT: {
-        name: 'ANY_LT',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_LT(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_LTE: {
-        name: 'ANY_LTE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_LTE(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_EMPTY: {
-        name: 'ANY_EMPTY',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'ANY_EMPTY(${1:array}, ${2:field})',
-        documentation: '',
-        args: emptyLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_NOTEMPTY: {
-        name: 'ANY_NOTEMPTY',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'ANY_NOTEMPTY(${1:array}, ${2:field})',
-        documentation: '',
-        args: emptyLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_ONEOF: {
-        name: 'ANY_ONEOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_ONEOF(${1:array}, ${2:field}, ${3:options})',
-        documentation: '',
-        args: oneofLikeSignature,
-        returnType: 'boolean',
-    },
-    ANY_NOTONEOF: {
-        name: 'ANY_NOTONEOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ANY_NOTONEOF(${1:array}, ${2:field}, ${3:options})',
-        documentation: '',
-        args: oneofLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_EQ: {
-        name: 'ALL_EQ',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_EQ(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_NEQ: {
-        name: 'ALL_NEQ',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_NEQ(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_GT: {
-        name: 'ALL_GT',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_GT(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_GTE: {
-        name: 'ALL_GTE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_GTE(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_LT: {
-        name: 'ALL_LT',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_LT(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_LTE: {
-        name: 'ALL_LTE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_LTE(${1:array}, ${2:field}, ${3:value})',
-        documentation: '',
-        args: filterLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_EMPTY: {
-        name: 'ALL_EMPTY',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'ALL_EMPTY(${1:array}, ${2:field})',
-        documentation: '',
-        args: emptyLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_NOTEMPTY: {
-        name: 'ALL_NOTEMPTY',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'ALL_NOTEMPTY(${1:array}, ${2:field})',
-        documentation: '',
-        args: emptyLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_ONEOF: {
-        name: 'ALL_ONEOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_ONEOF(${1:array}, ${2:field}, ${3:options})',
-        documentation: '',
-        args: oneofLikeSignature,
-        returnType: 'boolean',
-    },
-    ALL_NOTONEOF: {
-        name: 'ALL_NOTONEOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'ALL_NOTONEOF(${1:array}, ${2:field}, ${3:options})',
-        documentation: '',
-        args: oneofLikeSignature,
-        returnType: 'boolean',
-    },
-    SUM: {
-        name: 'SUM',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'SUM(${1:array})',
-        documentation: '',
-        args: ['array'],
-        returnType: 'number',
-    },
-    TRANSLATE: {
-        name: 'TRANSLATE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'TRANSLATE(${1:text})',
-        documentation: 'Make text translatable',
-        args: ['string'],
-        returnType: 'string',
-    },
-    LASTINDEXOF: {
-        name: 'LASTINDEXOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'LASTINDEXOF(${1:stringOrArray}, ${2:value})',
-        documentation: 'Find the last index where the value occurs in the string or array',
-        args: ['any', 'any'],
-        returnType: 'number',
-    },
-    INDEXOF: {
-        name: 'INDEXOF',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'INDEXOF(${1:stringOrArray}, ${2:value})',
-        documentation: 'Find the first index where the value occurs in the string or array',
-        args: ['any', 'any'],
-        returnType: 'number',
-    },
-    INCLUDES: {
-        name: 'INCLUDES',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'LASTINDEXOF(${1:stringOrArray}, ${2:value})',
-        documentation: 'Returns true if  the value occurs in the string or array, otherwise false',
-        args: ['any', 'any'],
-        returnType: 'boolean',
-    },
-    SLICE: {
-        name: 'SLICE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'SLICE(${1:stringOrArray}, ${2:start}, ${3:end})',
-        documentation: `
-Returns a part of the string or array, from the index specified in start
-and ending in the index specified in end.  If end is not specified, it will be the end of the
-string or array. Note that the index starts at 0, not 1.
-		`.trim(),
-        args: ['any', 'number', 'number'],
-        returnType: 'any',
-    },
-    /* TODO(anthony-bullard): Uncomment when Formula Builder is ready for advanced transforms
-	FIND: {
-		name: 'FIND',
-		type: 'CLIENT_TRANSFORM',
-		argCount: 2,
-		insertText: 'FIND(${1:array}, ${2:predicate})',
-		documentation: `
-Returns the first item in the array that matches the predicate.  The predicate should resolve to a
-boolean (true/false) value. Use the @vars.it binding to access the current item being evaluated.
-		`.trim(),
-		args: ['array', 'any'],
-		returnType: 'any'
-	},
-	MAP: {
-		name: 'MAP',
-		type: 'CLIENT_TRANSFORM',
-		argCount: 2,
-		insertText: 'MAP(${1:array}, ${2:mapping})',
-		documentation: `
-Returns a new array, with an item for every item in the original array using mapping. Use the
-@vars.it binding to access the current item from the original array.
-		`.trim(),
-		args: ['array', 'any'],
-		returnType: 'array'
-	},
-	REDUCE: {
-		name: 'REDUCE',
-		type: 'CLIENT_TRANSFORM',
-		argCount: 3,
-		insertText: 'REDUCE(${1:array}, ${2:start}, ${3:mapping}',
-		documentation: `
-Returns a new value based on evaluating the mapping on each item from the array as well as the
-result from start for the first item or the result of the previous evaluation of mapping.  The
-current item can be accessed in mapping with the @vars.it binding and the accumulated value is accessed
-from the @vars.acc binding.
-		`.trim(),
-		args: ['array', 'any', 'any'],
-		returnType: 'any'
-	},
-	LET: {
-		name: 'LET',
-		type: 'CLIENT_TRANSFORM',
-		argCount: 3,
-		insertText: 'LET(${1:name}, ${2:value}, ${3:expression})',
-		documentation: `
-Sets the value of a @var binding of the provided name to value and then evaluates expressions such
-that that binding is valid. LET("a", 5, @vars.a + 1) would return 6.
-		`.trim(),
-		args: ['string', 'any', 'any'],
-		returnType: 'any'
-	},
-	*/
-    REPLACE: {
-        name: 'REPLACE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'REPLACE(${1:string}, ${2:match}, ${3:replacement})',
-        documentation: `
-Replaces the first occurrence of match with replacement in string.
-		`.trim(),
-        args: ['string', 'string', 'string'],
-        returnType: 'string',
-    },
-    REPLACEALL: {
-        name: 'REPLACEALL',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'REPLACEALL(${1:string}, ${2:match}, ${3:replacement})',
-        documentation: `
-Replaces the first occurrence of match with replacement in string.
-		`.trim(),
-        args: ['string', 'string', 'string'],
-        returnType: 'string',
-    },
-    TRIM: {
-        name: 'TRIM',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'TRIM(${1:string})',
-        documentation: `
-Removes all spaces and other whitespace from the start and end of the string
-		`.trim(),
-        args: ['string'],
-        returnType: 'string',
-    },
-    TRIMSTART: {
-        name: 'TRIMSTART',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'TRIMSTART(${1:string})',
-        documentation: `
-Removes all spaces and other whitespace from the start of the string
-		`.trim(),
-        args: ['string'],
-        returnType: 'string',
-    },
-    TRIMEND: {
-        name: 'TRIMEND',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'TRIMEND(${1:string})',
-        documentation: `
-Removes all spaces and other whitespace from the end of the string
-		`.trim(),
-        args: ['string'],
-        returnType: 'string',
-    },
-    UPPERCASE: {
-        name: 'UPPERCASE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'UPPERCASE(${1:string})',
-        documentation: `
-Returns a new string with all characters in uppercase.
-		`.trim(),
-        args: ['string'],
-        returnType: 'string',
-    },
-    LOWERCASE: {
-        name: 'LOWERCASE',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'LOWERCASE(${1:string})',
-        documentation: `
-Returns a new string with all characters in lowercase.
-		`.trim(),
-        args: ['string'],
-        returnType: 'string',
-    },
-    KEYS: {
-        name: 'KEYS',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'KEYS(${1:object})',
-        documentation: `
-Returns an array of all the keys found in the object.
-		`.trim(),
-        args: ['object'],
-        returnType: 'array',
-    },
-    VALUES: {
-        name: 'VALUES',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'VALUES(${1:object})',
-        documentation: `
-Returns an array of all the values found in the object
-		`.trim(),
-        args: ['object'],
-        returnType: 'array',
-    },
-    ENTRIES: {
-        name: 'ENTRIES',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 1,
-        insertText: 'ENTRIES(${1:object})',
-        documentation: `
-Returns an array for each key/value pair in an object that is an array like [key, value].
-		`.trim(),
-        args: ['object'],
-        returnType: 'array',
-    },
-    WITH: {
-        name: 'WITH',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 3,
-        insertText: 'WITH(${1:object}, ${2:key}, ${3:value}',
-        documentation: `
-Returns a new object that consists of the given object plus a new key/value pair comprised of
-key and value.
-		`.trim(),
-        args: ['object', 'string', 'any'],
-        returnType: 'object',
-    },
-    DEBUG: {
-        name: 'DEBUG',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'DEBUG(${1:message}, ${2:value})',
-        documentation: `
-Logs out the given message and returns the given value
-		`.trim(),
-        args: ['string', 'any'],
-        returnType: 'any',
-    },
-    GET: {
-        name: 'GET',
-        type: 'CLIENT_TRANSFORM',
-        argCount: 2,
-        insertText: 'GET(${1:object}, ${2:path}',
-        documentation: `
-Returns the value found by dotwalking object using the path segments provided.
-		`.trim(),
-        args: ['object', '>string'],
-        returnType: 'any',
-    },
-}