@servicenow/sdk-build-plugins 3.0.3 → 4.0.0

package/dist/column/column-helper.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_COLUMN_CALCULATION = exports.COLUMN_API_TO_TYPE = exports.COLUMN_TYPE_TO_API = void 0;
+exports.addFieldsToColumn = addFieldsToColumn;
+exports.getDefaultMaxLength = getDefaultMaxLength;
+const sdk_build_core_1 = require("@servicenow/sdk-build-core");
+const db_1 = require("@servicenow/sdk-core/runtime/db");
+exports.COLUMN_TYPE_TO_API = {
+    string: db_1.StringColumn.name,
+    boolean: db_1.BooleanColumn.name,
+    choice: db_1.ChoiceColumn.name,
+    conditions: db_1.ConditionsColumn.name,
+    date: db_1.OtherDateColumn.name,
+    calendar_date_time: db_1.CalendarDateTimeColumn.name,
+    datetime: db_1.BasicDateTimeColumn.name,
+    due_date: db_1.DueDateColumn.name,
+    glide_date: db_1.DateColumn.name,
+    glide_date_time: db_1.DateTimeColumn.name,
+    integer_date: db_1.IntegerDateColumn.name,
+    schedule_date_time: db_1.ScheduleDateTimeColumn.name,
+    decimal: db_1.DecimalColumn.name,
+    document_id: db_1.DocumentIdColumn.name,
+    domain_id: db_1.DomainIdColumn.name,
+    domain_path: db_1.DomainPathColumn.name,
+    field_name: db_1.FieldNameColumn.name,
+    integer: db_1.IntegerColumn.name,
+    radio: db_1.RadioColumn.name,
+    reference: db_1.ReferenceColumn.name,
+    script: db_1.ScriptColumn.name,
+    sys_class_name: db_1.SystemClassNameColumn.name,
+    table_name: db_1.TableNameColumn.name,
+    translated_field: db_1.TranslatedFieldColumn.name,
+    translated_text: db_1.TranslatedTextColumn.name,
+    user_roles: db_1.UserRolesColumn.name,
+    version: db_1.VersionColumn.name,
+    glide_list: db_1.ListColumn.name,
+    image: db_1.BasicImageColumn.name,
+};
+exports.COLUMN_API_TO_TYPE = Object.fromEntries(Object.entries(exports.COLUMN_TYPE_TO_API).map(([key, value]) => [value, key]));
+exports.DEFAULT_COLUMN_CALCULATION = `(function calculatedFieldValue(current) {
+
+	// Add your code here
+	return '';  // return the calculated value
+
+})(current);`;
+function addFieldsToColumn(fields, column) {
+    const additionalFields = sdk_build_core_1.Shape.from(column, fields).asObject();
+    return new sdk_build_core_1.CallExpressionShape({
+        source: column.getSource(),
+        callee: column.getCallee(),
+        args: [column.getArgument(0).asObject().merge(additionalFields)],
+    });
+}
+function getDefaultMaxLength(columnType) {
+    switch (columnType) {
+        case 'conditions':
+        case 'glide_list':
+            return 4000;
+        case 'decimal':
+            return 20;
+        case 'domain_id':
+        case 'document_id':
+        case 'reference':
+            return 32;
+        case 'domain_path':
+        case 'user_roles':
+            return 255;
+        case 'script':
+            return 8000;
+        case 'table_name':
+        case 'field_name':
+            return 80;
+        default:
+            /**
+             * For types mentioned below it default to 40 on instance
+             * boolean | integer | image | choice | radio | sys_class_name | translated_field | translated_text | version | glide_date | glide_date_time | calendar_date_time
+             * datetime | due_date | integer_date | schedule_date_time | date | generic
+             *
+             * TODO::We need to request max_length from user for string column type because its mandatory on instance.
+             */
+            return 40;
+    }
+}
+//# sourceMappingURL=column-helper.js.map

package/dist/column/column-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"column-helper.js","sourceRoot":"","sources":["../../src/column/column-helper.ts"],"names":[],"mappings":";;;AA4EA,8CAWC;AAED,kDA6BC;AAtHD,+DAAuE;AACvE,wDA8BwC;AAE3B,QAAA,kBAAkB,GAA2B;IACtD,MAAM,EAAE,iBAAY,CAAC,IAAI;IACzB,OAAO,EAAE,kBAAa,CAAC,IAAI;IAC3B,MAAM,EAAE,iBAAY,CAAC,IAAI;IACzB,UAAU,EAAE,qBAAgB,CAAC,IAAI;IACjC,IAAI,EAAE,oBAAe,CAAC,IAAI;IAC1B,kBAAkB,EAAE,2BAAsB,CAAC,IAAI;IAC/C,QAAQ,EAAE,wBAAmB,CAAC,IAAI;IAClC,QAAQ,EAAE,kBAAa,CAAC,IAAI;IAC5B,UAAU,EAAE,eAAU,CAAC,IAAI;IAC3B,eAAe,EAAE,mBAAc,CAAC,IAAI;IACpC,YAAY,EAAE,sBAAiB,CAAC,IAAI;IACpC,kBAAkB,EAAE,2BAAsB,CAAC,IAAI;IAC/C,OAAO,EAAE,kBAAa,CAAC,IAAI;IAC3B,WAAW,EAAE,qBAAgB,CAAC,IAAI;IAClC,SAAS,EAAE,mBAAc,CAAC,IAAI;IAC9B,WAAW,EAAE,qBAAgB,CAAC,IAAI;IAClC,UAAU,EAAE,oBAAe,CAAC,IAAI;IAChC,OAAO,EAAE,kBAAa,CAAC,IAAI;IAC3B,KAAK,EAAE,gBAAW,CAAC,IAAI;IACvB,SAAS,EAAE,oBAAe,CAAC,IAAI;IAC/B,MAAM,EAAE,iBAAY,CAAC,IAAI;IACzB,cAAc,EAAE,0BAAqB,CAAC,IAAI;IAC1C,UAAU,EAAE,oBAAe,CAAC,IAAI;IAChC,gBAAgB,EAAE,0BAAqB,CAAC,IAAI;IAC5C,eAAe,EAAE,yBAAoB,CAAC,IAAI;IAC1C,UAAU,EAAE,oBAAe,CAAC,IAAI;IAChC,OAAO,EAAE,kBAAa,CAAC,IAAI;IAC3B,UAAU,EAAE,eAAU,CAAC,IAAI;IAC3B,KAAK,EAAE,qBAAgB,CAAC,IAAI;CAC/B,CAAA;AAEY,QAAA,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAChD,MAAM,CAAC,OAAO,CAAC,0BAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CACzE,CAAA;AAEY,QAAA,0BAA0B,GAAG;;;;;aAK7B,CAAA;AAEb,SAAgB,iBAAiB,CAC7B,MAAyD,EACzD,MAA2B;IAE3B,MAAM,gBAAgB,GAAG,sBAAK,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAA;IAE9D,OAAO,IAAI,oCAAmB,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE;QAC1B,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE;QAC1B,IAAI,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;KACnE,CAAC,CAAA;AACN,CAAC;AAED,SAAgB,mBAAmB,CAAC,UAAkB;IAClD,QAAQ,UAAU,EAAE,CAAC;QACjB,KAAK,YAAY,CAAC;QAClB,KAAK,YAAY;YACb,OAAO,IAAI,CAAA;QACf,KAAK,SAAS;YACV,OAAO,EAAE,CAAA;QACb,KAAK,WAAW,CAAC;QACjB,KAAK,aAAa,CAAC;QACnB,KAAK,WAAW;YACZ,OAAO,EAAE,CAAA;QACb,KAAK,aAAa,CAAC;QACnB,KAAK,YAAY;YACb,OAAO,GAAG,CAAA;QACd,KAAK,QAAQ;YACT,OAAO,IAAI,CAAA;QACf,KAAK,YAAY,CAAC;QAClB,KAAK,YAAY;YACb,OAAO,EAAE,CAAA;QACb;YACI;;;;;;eAMG;YACH,OAAO,EAAE,CAAA;IACjB,CAAC;AACL,CAAC"}

package/dist/column/column-to-record.d.ts

@@ -0,0 +1,3 @@
+import { type CallExpressionShape, type Diagnostics, type Factory } from '@servicenow/sdk-build-core';
+export declare function getDocumentationRecords(callExpression: CallExpressionShape, aliasedKeys: globalThis.Record<string, string[]>, factory: Factory, diagnostics: Diagnostics, generateDefaultDoc?: boolean): import("@servicenow/sdk-build-core").Record[];
+export declare function getChoiceRecords(callExpression: CallExpressionShape, aliasedKeys: globalThis.Record<string, string[]>, factory: Factory, diagnostics: Diagnostics): import("@servicenow/sdk-build-core").Record[];

package/dist/column/column-to-record.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentationRecords = getDocumentationRecords;
+exports.getChoiceRecords = getChoiceRecords;
+const sdk_build_core_1 = require("@servicenow/sdk-build-core");
+const utils_1 = require("../utils");
+const column_plugin_1 = require("../column-plugin");
+function getDocumentationRecords(callExpression, aliasedKeys, factory, diagnostics, generateDefaultDoc = false) {
+    const column = callExpression.getArgument(0).asObject();
+    const documentation = column.get('label');
+    const columnName = column.get('name');
+    if (!documentation.if([sdk_build_core_1.ArrayShape, sdk_build_core_1.StringShape])) {
+        return [
+            factory.createRecord({
+                source: callExpression,
+                table: 'sys_documentation',
+                properties: column.transform(({ $ }) => ({
+                    name: $.from('table'),
+                    element: $.val(columnName),
+                    language: $.def('en'),
+                    label: $.val(documentation.ifDefined() ?? columnName),
+                    plural: $.val((0, column_plugin_1.generatePlural)(documentation.ifDefined()?.asString().getValue() ?? columnName.asString().getValue())),
+                })),
+            }),
+        ];
+    }
+    if (documentation.ifArray()) {
+        return (documentation
+            .asArray()
+            .getElements()
+            .map((documentation) => {
+            const docObject = documentation.asObject().withAliasedKeys(aliasedKeys);
+            (0, utils_1.generateDeprecatedDiagnostics)(docObject, diagnostics);
+            return factory.createRecord({
+                source: callExpression,
+                table: 'sys_documentation',
+                properties: docObject.transform(({ $ }) => ({
+                    name: $.val(column.get('table')),
+                    element: $.val(column.get('name')),
+                    language: $,
+                    hint: $,
+                    help: $,
+                    label: $,
+                    plural: $,
+                    url: $,
+                    url_target: $.from('urlTarget'),
+                })),
+            });
+        }) ?? []);
+    }
+    if (!generateDefaultDoc) {
+        return [];
+    }
+    return [
+        factory.createRecord({
+            source: callExpression,
+            table: 'sys_documentation',
+            properties: column.transform(({ $ }) => ({
+                name: $.from('table'),
+                element: $.val(columnName),
+                language: $.def('en'),
+                label: $.val(documentation.ifDefined() ?? columnName),
+                plural: $.val((0, column_plugin_1.generatePlural)(documentation.ifDefined()?.asString().getValue() ?? columnName.asString().getValue())),
+            })),
+        }),
+    ];
+}
+function getChoiceRecords(callExpression, aliasedKeys, factory, diagnostics) {
+    const column = callExpression.getArgument(0).asObject();
+    const choiceArg = column.has('choices') ? column.get('choices').asObject().withAliasedKeys(aliasedKeys) : undefined;
+    if (!choiceArg) {
+        return [];
+    }
+    return Object.keys(choiceArg.getValue()).map((choiceValue) => {
+        // TODO Should have proper type here
+        const choice = choiceArg.get(choiceValue);
+        if (choice.isObject()) {
+            (0, utils_1.generateDeprecatedDiagnostics)(choice.withAliasedKeys(aliasedKeys), diagnostics);
+        }
+        return factory.createRecord({
+            source: callExpression,
+            table: 'sys_choice',
+            properties: choice.isString()
+                ? {
+                    name: column.get('table').asString().getValue(),
+                    element: column.get('name').asString().getValue(),
+                    label: choice,
+                    value: choiceValue,
+                }
+                : choice.asObject().transform(({ $ }) => ({
+                    name: $.val(column.get('table')),
+                    element: $.val(column.get('name')),
+                    label: $,
+                    value: $.val(choiceValue),
+                    sequence: $,
+                    dependent_value: $.from('dependentValue'),
+                    hint: $,
+                    inactive: $.toBoolean().def(false),
+                    inactive_on_update: $.from('inactiveOnUpdate').toBoolean().def(false),
+                    language: $.def('en'),
+                })),
+        });
+    });
+}
+//# sourceMappingURL=column-to-record.js.map

package/dist/column/column-to-record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"column-to-record.js","sourceRoot":"","sources":["../../src/column/column-to-record.ts"],"names":[],"mappings":";;AAUA,0DA4EC;AAED,4CA0CC;AAlID,+DAMmC;AACnC,oCAAwD;AACxD,oDAAiD;AAEjD,SAAgB,uBAAuB,CACnC,cAAmC,EACnC,WAAgD,EAChD,OAAgB,EAChB,WAAwB,EACxB,qBAA8B,KAAK;IAEnC,MAAM,MAAM,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;IACvD,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACzC,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IACrC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,2BAAU,EAAE,4BAAW,CAAC,CAAC,EAAE,CAAC;QAC/C,OAAO;YACH,OAAO,CAAC,YAAY,CAAC;gBACjB,MAAM,EAAE,cAAc;gBACtB,KAAK,EAAE,mBAAmB;gBAC1B,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBACrC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;oBACrB,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;oBAC1B,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;oBACrB,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,UAAU,CAAC;oBACrD,MAAM,EAAE,CAAC,CAAC,GAAG,CACT,IAAA,8BAAc,EACV,aAAa,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CACvF,CACJ;iBACJ,CAAC,CAAC;aACN,CAAC;SACL,CAAA;IACL,CAAC;IAED,IAAI,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC;QAC1B,OAAO,CACH,aAAa;aACR,OAAO,EAAE;aACT,WAAW,EAAE;aACb,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE;YACnB,MAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;YACvE,IAAA,qCAA6B,EAAC,SAAS,EAAE,WAAW,CAAC,CAAA;YACrD,OAAO,OAAO,CAAC,YAAY,CAAC;gBACxB,MAAM,EAAE,cAAc;gBACtB,KAAK,EAAE,mBAAmB;gBAC1B,UAAU,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBACxC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAChC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBAClC,QAAQ,EAAE,CAAC;oBACX,IAAI,EAAE,CAAC;oBACP,IAAI,EAAE,CAAC;oBACP,KAAK,EAAE,CAAC;oBACR,MAAM,EAAE,CAAC;oBACT,GAAG,EAAE,CAAC;oBACN,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;iBAClC,CAAC,CAAC;aACN,CAAC,CAAA;QACN,CAAC,CAAC,IAAI,EAAE,CACf,CAAA;IACL,CAAC;IAED,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACtB,OAAO,EAAE,CAAA;IACb,CAAC;IAED,OAAO;QACH,OAAO,CAAC,YAAY,CAAC;YACjB,MAAM,EAAE,cAAc;YACtB,KAAK,EAAE,mBAAmB;YAC1B,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;gBACrB,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC;gBAC1B,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;gBACrB,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,UAAU,CAAC;gBACrD,MAAM,EAAE,CAAC,CAAC,GAAG,CACT,IAAA,8BAAc,EAAC,aAAa,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,CACvG;aACJ,CAAC,CAAC;SACN,CAAC;KACL,CAAA;AACL,CAAC;AAED,SAAgB,gBAAgB,CAC5B,cAAmC,EACnC,WAAgD,EAChD,OAAgB,EAChB,WAAwB;IAExB,MAAM,MAAM,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;IACvD,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACnH,IAAI,CAAC,SAAS,EAAE,CAAC;QACb,OAAO,EAAE,CAAA;IACb,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE;QACzD,oCAAoC;QACpC,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QACzC,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpB,IAAA,qCAA6B,EAAC,MAAM,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,CAAA;QACnF,CAAC;QACD,OAAO,OAAO,CAAC,YAAY,CAAC;YACxB,MAAM,EAAE,cAAc;YACtB,KAAK,EAAE,YAAY;YACnB,UAAU,EAAE,MAAM,CAAC,QAAQ,EAAE;gBACzB,CAAC,CAAC;oBACI,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;oBAC/C,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;oBACjD,KAAK,EAAE,MAAM;oBACb,KAAK,EAAE,WAAW;iBACrB;gBACH,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;oBACpC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;oBAChC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBAClC,KAAK,EAAE,CAAC;oBACR,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC;oBACzB,QAAQ,EAAE,CAAC;oBACX,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;oBACzC,IAAI,EAAE,CAAC;oBACP,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;oBAClC,kBAAkB,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC;oBACrE,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;iBACxB,CAAC,CAAC;SACZ,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACN,CAAC"}

package/dist/column-plugin.d.ts

@@ -0,0 +1,8 @@
+import { CallExpressionShape, Plugin, type Record } from '@servicenow/sdk-build-core';
+export declare const ColumnPlugin: Plugin;
+export declare function columnToCallExpression(column: Record, related: {
+    choices: Record[];
+    documentation: Record[];
+}): CallExpressionShape;
+export declare function generatePlural(label: string): string | undefined;
+export declare function isDefaultDocumentation(columnName: string, documentation: Record[]): boolean;