@oneuptime/common 14.0.7 → 14.0.8

package/build/dist/Types/CustomField/CustomFieldValueFormat.js

@@ -0,0 +1,126 @@
+import { isCustomFieldValueEmpty } from "./CustomFieldValueMapping";
+/*
+ * How a stored custom field value reads as words, for everything that puts a
+ * value in front of a person outside the Custom Fields card: an incident
+ * note's {{customFields.<key>}} placeholder (Common/Utils/Incident/
+ * IncidentNoteTemplateVariables) and the status page subscriber messages
+ * (Common/Server/Utils/StatusPage/IncidentTemplateVariableBuilder).
+ *
+ * Only the reading is shared here. Where the words then go decides the rest:
+ * a note escapes them as Markdown, an email as HTML, an SMS takes them as
+ * they are. A date and time reads in the note author's time zone in a note,
+ * and in the status page's subscriber time zones in its emails, so that is
+ * left to the caller too.
+ *
+ * Pure, with no database or React imports, so the server and the dashboard
+ * share it and it is tested directly.
+ */
+/*
+ * A day with no time zone: "2026-09-27", or a wall-clock time on it with no
+ * offset ("2026-09-27T00:00:00"). Its day is the one it names, wherever it is
+ * read.
+ */
+const DAY_WITHOUT_TIME_ZONE_PATTERN = /^(\d{4}-\d{2}-\d{2})(?:[T ]\d{2}:\d{2}(?::\d{2}(?:\.\d+)?)?)?$/;
+/*
+ * What a Date value's instant is moved by before its UTC day is read; see
+ * formatCustomFieldCalendarDate.
+ */
+const PICKED_DAY_SHIFT_MS = 13 * 60 * 60 * 1000;
+/**
+ * Plain text for a value of no particular type: a list joined with commas
+ * (its empty entries left out), a Date as its ISO string, an object as JSON,
+ * anything else as String() gives it. null and undefined are "".
+ */
+export const customFieldValueToText = (value) => {
+    if (value === null || value === undefined) {
+        return "";
+    }
+    if (Array.isArray(value)) {
+        return value
+            .filter((entry) => {
+            return !isCustomFieldValueEmpty(entry);
+        })
+            .map((entry) => {
+            return customFieldValueToText(entry);
+        })
+            .join(", ");
+    }
+    if (value instanceof Date) {
+        return isNaN(value.getTime()) ? "" : value.toISOString();
+    }
+    if (typeof value === "object") {
+        try {
+            return JSON.stringify(value);
+        }
+        catch (_a) {
+            return String(value);
+        }
+    }
+    return String(value);
+};
+/**
+ * The instant a Date or DateTime value holds, or null when it holds none
+ * (an empty string, text that is not a date).
+ */
+export const customFieldValueToDate = (value) => {
+    if (value instanceof Date) {
+        return isNaN(value.getTime()) ? null : value;
+    }
+    if (typeof value === "string" && value.trim().length > 0) {
+        const date = new Date(value.trim());
+        return isNaN(date.getTime()) ? null : date;
+    }
+    return null;
+};
+/**
+ * Yes or No for a Boolean value, which is stored as true or false (or, from
+ * an older form, as "true" or "false"). Anything else reads as it is.
+ */
+export const formatCustomFieldBoolean = (value) => {
+    if (value === true || value === "true") {
+        return "Yes";
+    }
+    if (value === false || value === "false") {
+        return "No";
+    }
+    return customFieldValueToText(value);
+};
+/**
+ * A Date value - a calendar day with no time of day - as the day that was
+ * picked, "2026-09-27". A value that is no date reads as it is.
+ *
+ * The dashboard does not store the day itself. Its date input stores the
+ * picked day's midnight in the author's time zone, as a UTC instant: 27 Sep
+ * picked in Berlin (UTC+2) is "2026-09-26T22:00:00.000Z", in New York
+ * (UTC-4) "2026-09-27T04:00:00.000Z". So neither the UTC day of the instant
+ * (26 Sep for Berlin: every author east of UTC would get the day before) nor
+ * the reader's day (a reader in another zone than the author's) is the day
+ * that was picked, and who picked it, and where, is not stored.
+ *
+ * The instant is read as the nearest plausible local midnight instead: moved
+ * 13 hours on, its UTC day is the picked day for an author anywhere from
+ * UTC-10:59 to UTC+13:00 - Hawaii to New Zealand in summer - and for a value
+ * an API client stored as UTC midnight. Only an author in UTC-11 or UTC-12,
+ * or past UTC+13, gets the day after or the day before. It is the same day
+ * whoever reads it, so a note and an email about one incident agree.
+ *
+ * A bare day ("2026-09-27"), or a time with no offset, is the day it names.
+ */
+export const formatCustomFieldCalendarDate = (value) => {
+    const match = typeof value === "string"
+        ? value.trim().match(DAY_WITHOUT_TIME_ZONE_PATTERN)
+        : null;
+    if (match) {
+        return match[1];
+    }
+    const date = customFieldValueToDate(value);
+    const pickedDay = date
+        ? new Date(date.getTime() + PICKED_DAY_SHIFT_MS)
+        : null;
+    // Invalid only at the very end of the range a Date can hold.
+    if (!pickedDay || isNaN(pickedDay.getTime())) {
+        return customFieldValueToText(value);
+    }
+    return pickedDay.toISOString().slice(0, 10);
+};
+//# sourceMappingURL=CustomFieldValueFormat.js.map

package/build/dist/Types/CustomField/CustomFieldValueFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomFieldValueFormat.js","sourceRoot":"","sources":["../../../../Types/CustomField/CustomFieldValueFormat.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;;;;;;;;;;;;;GAeG;AAEH;;;;GAIG;AACH,MAAM,6BAA6B,GACjC,gEAAgE,CAAC;AAEnE;;;GAGG;AACH,MAAM,mBAAmB,GAAW,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAIxD;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAmC,CACpE,KAAc,EACN,EAAE;IACV,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK;aACT,MAAM,CAAC,CAAC,KAAc,EAAW,EAAE;YAClC,OAAO,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,KAAc,EAAU,EAAE;YAC9B,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IAED,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAC3D,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAmC,CACpE,KAAc,EACD,EAAE;IACf,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC/C,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,GAAS,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1C,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAqC,CACxE,KAAc,EACN,EAAE;IACV,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC;AACvC,CAAC,CAAC;AAIF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,CAAC,KAAc,EAAU,EAAE;IACzB,MAAM,KAAK,GACT,OAAO,KAAK,KAAK,QAAQ;QACvB,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,6BAA6B,CAAC;QACnD,CAAC,CAAC,IAAI,CAAC;IAEX,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,KAAK,CAAC,CAAC,CAAE,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAgB,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAExD,MAAM,SAAS,GAAgB,IAAI;QACjC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,mBAAmB,CAAC;QAChD,CAAC,CAAC,IAAI,CAAC;IAET,6DAA6D;IAC7D,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QAC7C,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,OAAO,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC9C,CAAC,CAAC"}

package/build/dist/Types/CustomField/CustomFieldValueValidator.js

@@ -0,0 +1,280 @@
+import { parseCustomFieldDropdownOptions, } from "./CustomFieldDropdownOption";
+import CustomFieldType from "./CustomFieldType";
+import { isCustomFieldValueEmpty } from "./CustomFieldValueMapping";
+/*
+ * Values and option lists are quoted back in the message, bounded so that a
+ * pasted essay or a field with two hundred options still reads as one line.
+ */
+const MAX_QUOTED_VALUE_LENGTH = 80;
+const MAX_LISTED_OPTIONS = 10;
+const quote = (value) => {
+    let text;
+    try {
+        text = typeof value === "string" ? value : JSON.stringify(value);
+    }
+    catch (_a) {
+        text = String(value);
+    }
+    if (text === undefined) {
+        text = String(value);
+    }
+    if (text.length > MAX_QUOTED_VALUE_LENGTH) {
+        text = `${text.slice(0, MAX_QUOTED_VALUE_LENGTH)}...`;
+    }
+    return `"${text}"`;
+};
+const listOptions = (options) => {
+    const listed = options
+        .slice(0, MAX_LISTED_OPTIONS)
+        .map((option) => {
+        return quote(option);
+    })
+        .join(", ");
+    const more = options.length - MAX_LISTED_OPTIONS;
+    return more > 0 ? `${listed} and ${more} more` : listed;
+};
+const canonicalize = (value) => {
+    if (Array.isArray(value)) {
+        return JSON.stringify([...value]
+            .map((entry) => {
+            return String(entry);
+        })
+            .sort());
+    }
+    if (value instanceof Date) {
+        // toISOString throws on an invalid date; that one is checked, not compared.
+        return isNaN(value.getTime())
+            ? "invalid-date"
+            : JSON.stringify(value.toISOString());
+    }
+    return JSON.stringify(value !== null && value !== void 0 ? value : null);
+};
+const isPlainObject = (value) => {
+    return (value !== null &&
+        typeof value === "object" &&
+        !Array.isArray(value) &&
+        !(value instanceof Date));
+};
+// The values a dropdown option can be written as: its text, or a bare number.
+const isOptionScalar = (value) => {
+    return (typeof value === "string" ||
+        (typeof value === "number" && Number.isFinite(value)) ||
+        typeof value === "boolean");
+};
+const isNumberValue = (value) => {
+    if (typeof value === "number") {
+        return Number.isFinite(value);
+    }
+    /*
+     * The dashboard's number input submits what was typed, as a string -
+     * "0", "42", "3.5" - which is how most stored Number values look.
+     */
+    if (typeof value === "string") {
+        const trimmed = value.trim();
+        return trimmed.length > 0 && Number.isFinite(Number(trimmed));
+    }
+    return false;
+};
+const isBooleanValue = (value) => {
+    /*
+     * The strings are accepted because the table and filters already read them
+     * as Yes and No, and hand-written API requests send them.
+     */
+    return typeof value === "boolean" || value === "true" || value === "false";
+};
+const isDateValue = (value) => {
+    if (value instanceof Date) {
+        return !isNaN(value.getTime());
+    }
+    if (typeof value !== "string" || value.trim().length === 0) {
+        return false;
+    }
+    return !isNaN(new Date(value.trim()).getTime());
+};
+// Text of any kind: what was typed, or a number or yes/no sent over the API.
+const isTextValue = (value) => {
+    return (typeof value === "string" ||
+        (typeof value === "number" && Number.isFinite(value)) ||
+        typeof value === "boolean");
+};
+const validateDropdownValue = (data) => {
+    const name = data.definition.name;
+    if (!isOptionScalar(data.value)) {
+        return `${quote(name)} holds one of its options, but was sent ${quote(data.value)}.`;
+    }
+    const options = parseCustomFieldDropdownOptions(data.definition.dropdownOptions).map((option) => {
+        return option.value;
+    });
+    /*
+     * A dropdown nobody has given options to cannot be checked against them;
+     * refusing every value would make the field unusable over the API until an
+     * admin finishes defining it.
+     */
+    if (options.length === 0 || options.includes(String(data.value))) {
+        return null;
+    }
+    return `${quote(data.value)} is not one of the options for ${quote(name)}. Choose one of: ${listOptions(options)}.`;
+};
+const validateMultiSelectValue = (data) => {
+    const name = data.definition.name;
+    /*
+     * A single value is accepted as a selection of one: a field that was
+     * switched from single to multi select still holds bare strings, and the
+     * table renders one that way.
+     */
+    const entries = Array.isArray(data.value)
+        ? data.value
+        : [data.value];
+    const invalidShape = entries.find((entry) => {
+        return !isOptionScalar(entry);
+    });
+    if (invalidShape !== undefined) {
+        return `${quote(name)} holds a list of its options, but was sent ${quote(data.value)}.`;
+    }
+    const options = parseCustomFieldDropdownOptions(data.definition.dropdownOptions).map((option) => {
+        return option.value;
+    });
+    if (options.length === 0) {
+        return null;
+    }
+    // Entries the record already holds stay valid, removed options included.
+    const alreadyHeld = new Set((Array.isArray(data.storedValue)
+        ? data.storedValue
+        : data.storedValue === undefined || data.storedValue === null
+            ? []
+            : [data.storedValue]).map((entry) => {
+        return String(entry);
+    }));
+    const notOptions = entries
+        .map((entry) => {
+        return String(entry);
+    })
+        .filter((entry) => {
+        return !alreadyHeld.has(entry) && !options.includes(entry);
+    });
+    if (notOptions.length === 0) {
+        return null;
+    }
+    return `${notOptions
+        .map((entry) => {
+        return quote(entry);
+    })
+        .join(", ")} ${notOptions.length === 1 ? "is not one of" : "are not among"} the options for ${quote(name)}. Choose from: ${listOptions(options)}.`;
+};
+const validateValue = (data) => {
+    const name = data.definition.name;
+    switch (data.definition.customFieldType) {
+        case CustomFieldType.Text:
+        case CustomFieldType.LongText:
+        case CustomFieldType.Markdown:
+            return isTextValue(data.value)
+                ? null
+                : `${quote(name)} holds text, but was sent ${quote(data.value)}.`;
+        case CustomFieldType.Number:
+            return isNumberValue(data.value)
+                ? null
+                : `${quote(name)} holds a number, but was sent ${quote(data.value)}.`;
+        case CustomFieldType.Boolean:
+            return isBooleanValue(data.value)
+                ? null
+                : `${quote(name)} holds true or false, but was sent ${quote(data.value)}.`;
+        case CustomFieldType.Date:
+            return isDateValue(data.value)
+                ? null
+                : `${quote(name)} holds a date, but was sent ${quote(data.value)}.`;
+        case CustomFieldType.DateTime:
+            return isDateValue(data.value)
+                ? null
+                : `${quote(name)} holds a date and time, but was sent ${quote(data.value)}.`;
+        case CustomFieldType.Dropdown:
+            return validateDropdownValue(data);
+        case CustomFieldType.MultiSelectDropdown:
+            return validateMultiSelectValue(data);
+        default:
+            // No type, or one this version does not know: nothing to check.
+            return null;
+    }
+};
+/**
+ * Every value this write changes that does not fit its field, in the order
+ * the write lists them. Empty when the write is fine.
+ */
+export const validateCustomFieldValues = (data) => {
+    if (!isPlainObject(data.customFields)) {
+        return [];
+    }
+    const stored = isPlainObject(data.storedCustomFields)
+        ? data.storedCustomFields
+        : {};
+    const definitionsByName = new Map();
+    for (const definition of data.definitions || []) {
+        if (definition && typeof definition.name === "string") {
+            definitionsByName.set(definition.name, definition);
+        }
+    }
+    const errors = [];
+    for (const [fieldName, value] of Object.entries(data.customFields)) {
+        const definition = definitionsByName.get(fieldName);
+        if (!definition) {
+            continue;
+        }
+        if (isCustomFieldValueEmpty(value)) {
+            continue;
+        }
+        const storedValue = Object.prototype.hasOwnProperty.call(stored, fieldName)
+            ? stored[fieldName]
+            : undefined;
+        if (canonicalize(value) === canonicalize(storedValue)) {
+            continue;
+        }
+        const message = validateValue({
+            definition: definition,
+            value: value,
+            storedValue: storedValue,
+        });
+        if (message) {
+            errors.push({ fieldName: fieldName, message: message });
+        }
+    }
+    return errors;
+};
+/** One message for an API error response. */
+export const formatCustomFieldValueValidationErrors = (errors) => {
+    return errors
+        .map((error) => {
+        return error.message;
+    })
+        .join(" ");
+};
+/**
+ * The values of a bag that a create would accept, each judged on its own as
+ * if it were new: an option since removed from a dropdown, or a word in a
+ * Number field, is left out.
+ *
+ * For a bag copied onto a new record from elsewhere - an incident template's
+ * values, when an incident is declared from it. Those were written long
+ * before the incident and may no longer fit their fields; sent as they are,
+ * one stale value would refuse the whole declaration over a field the person
+ * declaring may not even be shown. Keys with no definition, and empty values,
+ * are kept, as validateCustomFieldValues passes them.
+ */
+export const keepValidCustomFieldValues = (data) => {
+    if (!isPlainObject(data.customFields)) {
+        return {};
+    }
+    const invalidFieldNames = new Set(validateCustomFieldValues({
+        definitions: data.definitions,
+        customFields: data.customFields,
+        storedCustomFields: {},
+    }).map((error) => {
+        return error.fieldName;
+    }));
+    const result = {};
+    for (const [fieldName, value] of Object.entries(data.customFields)) {
+        if (!invalidFieldNames.has(fieldName)) {
+            result[fieldName] = value;
+        }
+    }
+    return result;
+};
+//# sourceMappingURL=CustomFieldValueValidator.js.map

package/build/dist/Types/CustomField/CustomFieldValueValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomFieldValueValidator.js","sourceRoot":"","sources":["../../../../Types/CustomField/CustomFieldValueValidator.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,+BAA+B,GAChC,MAAM,6BAA6B,CAAC;AACrC,OAAO,eAAe,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAwCpE;;;GAGG;AACH,MAAM,uBAAuB,GAAW,EAAE,CAAC;AAC3C,MAAM,kBAAkB,GAAW,EAAE,CAAC;AAItC,MAAM,KAAK,GAAkB,CAAC,KAAc,EAAU,EAAE;IACtD,IAAI,IAAY,CAAC;IAEjB,IAAI,CAAC;QACH,IAAI,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACnE,CAAC;IAAC,WAAM,CAAC;QACP,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,GAAG,uBAAuB,EAAE,CAAC;QAC1C,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,uBAAuB,CAAC,KAAK,CAAC;IACxD,CAAC;IAED,OAAO,IAAI,IAAI,GAAG,CAAC;AACrB,CAAC,CAAC;AAIF,MAAM,WAAW,GAAwB,CAAC,OAAsB,EAAU,EAAE;IAC1E,MAAM,MAAM,GAAW,OAAO;SAC3B,KAAK,CAAC,CAAC,EAAE,kBAAkB,CAAC;SAC5B,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE;QACtB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,MAAM,IAAI,GAAW,OAAO,CAAC,MAAM,GAAG,kBAAkB,CAAC;IAEzD,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;AAC1D,CAAC,CAAC;AAQF,MAAM,YAAY,GAAyB,CAAC,KAAc,EAAU,EAAE;IACpE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,SAAS,CACnB,CAAC,GAAG,KAAK,CAAC;aACP,GAAG,CAAC,CAAC,KAAc,EAAE,EAAE;YACtB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;aACD,IAAI,EAAE,CACV,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,4EAA4E;QAC5E,OAAO,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAC3B,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,IAAI,CAAC,CAAC;AACvC,CAAC,CAAC;AAMF,MAAM,aAAa,GAA0B,CAC3C,KAAc,EACoB,EAAE;IACpC,OAAO,CACL,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CACzB,CAAC;AACJ,CAAC,CAAC;AAIF,8EAA8E;AAC9E,MAAM,cAAc,GAAqB,CAAC,KAAc,EAAW,EAAE;IACnE,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,aAAa,GAAqB,CAAC,KAAc,EAAW,EAAE;IAClE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAW,KAAK,CAAC,IAAI,EAAE,CAAC;QAErC,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,cAAc,GAAqB,CAAC,KAAc,EAAW,EAAE;IACnE;;;OAGG;IACH,OAAO,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,OAAO,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,WAAW,GAAqB,CAAC,KAAc,EAAW,EAAE;IAChE,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3D,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF,6EAA6E;AAC7E,MAAM,WAAW,GAAqB,CAAC,KAAc,EAAW,EAAE;IAChE,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrD,OAAO,KAAK,KAAK,SAAS,CAC3B,CAAC;AACJ,CAAC,CAAC;AAQF,MAAM,qBAAqB,GAAwB,CAAC,IAInD,EAAiB,EAAE;IAClB,MAAM,IAAI,GAAW,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAE1C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,2CAA2C,KAAK,CACnE,IAAI,CAAC,KAAK,CACX,GAAG,CAAC;IACP,CAAC;IAED,MAAM,OAAO,GAAkB,+BAA+B,CAC5D,IAAI,CAAC,UAAU,CAAC,eAAe,CAChC,CAAC,GAAG,CAAC,CAAC,MAAiC,EAAE,EAAE;QAC1C,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH;;;;OAIG;IACH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,kCAAkC,KAAK,CAChE,IAAI,CACL,oBAAoB,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAwB,CAAC,IAItD,EAAiB,EAAE;IAClB,MAAM,IAAI,GAAW,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAE1C;;;;OAIG;IACH,MAAM,OAAO,GAAmB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QACvD,CAAC,CAAC,IAAI,CAAC,KAAK;QACZ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAEjB,MAAM,YAAY,GAAY,OAAO,CAAC,IAAI,CAAC,CAAC,KAAc,EAAE,EAAE;QAC5D,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,8CAA8C,KAAK,CACtE,IAAI,CAAC,KAAK,CACX,GAAG,CAAC;IACP,CAAC;IAED,MAAM,OAAO,GAAkB,+BAA+B,CAC5D,IAAI,CAAC,UAAU,CAAC,eAAe,CAChC,CAAC,GAAG,CAAC,CAAC,MAAiC,EAAE,EAAE;QAC1C,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,yEAAyE;IACzE,MAAM,WAAW,GAAgB,IAAI,GAAG,CACtC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;QAC9B,CAAC,CAAC,IAAI,CAAC,WAAW;QAClB,CAAC,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI;YAC3D,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CACvB,CAAC,GAAG,CAAC,CAAC,KAAc,EAAE,EAAE;QACvB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC,CACH,CAAC;IAEF,MAAM,UAAU,GAAkB,OAAO;SACtC,GAAG,CAAC,CAAC,KAAc,EAAE,EAAE;QACtB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,KAAa,EAAE,EAAE;QACxB,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEL,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,GAAG,UAAU;SACjB,GAAG,CAAC,CAAC,KAAa,EAAE,EAAE;QACrB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,IACX,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,eAC9C,oBAAoB,KAAK,CAAC,IAAI,CAAC,kBAAkB,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;AAC3E,CAAC,CAAC;AAEF,MAAM,aAAa,GAAwB,CAAC,IAI3C,EAAiB,EAAE;IAClB,MAAM,IAAI,GAAW,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAE1C,QAAQ,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;QACxC,KAAK,eAAe,CAAC,IAAI,CAAC;QAC1B,KAAK,eAAe,CAAC,QAAQ,CAAC;QAC9B,KAAK,eAAe,CAAC,QAAQ;YAC3B,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC5B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,6BAA6B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAEtE,KAAK,eAAe,CAAC,MAAM;YACzB,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC9B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,iCAAiC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAE1E,KAAK,eAAe,CAAC,OAAO;YAC1B,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC/B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,sCAAsC,KAAK,CACvD,IAAI,CAAC,KAAK,CACX,GAAG,CAAC;QAEX,KAAK,eAAe,CAAC,IAAI;YACvB,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC5B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,+BAA+B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAExE,KAAK,eAAe,CAAC,QAAQ;YAC3B,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC5B,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,wCAAwC,KAAK,CACzD,IAAI,CAAC,KAAK,CACX,GAAG,CAAC;QAEX,KAAK,eAAe,CAAC,QAAQ;YAC3B,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAErC,KAAK,eAAe,CAAC,mBAAmB;YACtC,OAAO,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAExC;YACE,gEAAgE;YAChE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC,CAAC;AAWF;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GACpC,CAAC,IAIA,EAA0C,EAAE;IAC3C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,MAAM,GAA4B,aAAa,CACnD,IAAI,CAAC,kBAAkB,CACxB;QACC,CAAC,CAAC,IAAI,CAAC,kBAAkB;QACzB,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,iBAAiB,GAAuC,IAAI,GAAG,EAGlE,CAAC;IAEJ,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC;QAChD,IAAI,UAAU,IAAI,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtD,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAA2C,EAAE,CAAC;IAE1D,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACnE,MAAM,UAAU,GACd,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAEnC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,SAAS;QACX,CAAC;QAED,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,SAAS;QACX,CAAC;QAED,MAAM,WAAW,GAAY,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAC/D,MAAM,EACN,SAAS,CACV;YACC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;YACnB,CAAC,CAAC,SAAS,CAAC;QAEd,IAAI,YAAY,CAAC,KAAK,CAAC,KAAK,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;YACtD,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAkB,aAAa,CAAC;YAC3C,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,WAAW;SACzB,CAAC,CAAC;QAEH,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAMJ,6CAA6C;AAC7C,MAAM,CAAC,MAAM,sCAAsC,GACjD,CAAC,MAA8C,EAAU,EAAE;IACzD,OAAO,MAAM;SACV,GAAG,CAAC,CAAC,KAAsC,EAAE,EAAE;QAC9C,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC,CAAC;AAOJ;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,0BAA0B,GACrC,CAAC,IAGA,EAA2B,EAAE;IAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,iBAAiB,GAAgB,IAAI,GAAG,CAC5C,yBAAyB,CAAC;QACxB,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,kBAAkB,EAAE,EAAE;KACvB,CAAC,CAAC,GAAG,CAAC,CAAC,KAAsC,EAAE,EAAE;QAChD,OAAO,KAAK,CAAC,SAAS,CAAC;IACzB,CAAC,CAAC,CACH,CAAC;IAEF,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YACtC,MAAM,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}

package/build/dist/Types/CustomField/CustomFieldVariableKey.js

@@ -0,0 +1,150 @@
+import SubscriberNotificationTemplateCompiler from "../StatusPage/SubscriberNotificationTemplateCompiler";
+/*
+ * The key an incident custom field is reached by in a template:
+ * {{customFields.<key>}} in a status page's custom subscriber email, and in
+ * anything else that fills placeholders the same way.
+ *
+ * Why a key at all, rather than the field's name: values are stored under
+ * the display name ("Expected Resolution"), and a name can hold anything a
+ * person types - spaces, hyphens, accents, emoji, other scripts. The template
+ * compiler only fills placeholders made of ASCII word characters and dots
+ * (SubscriberNotificationTemplateCompiler.isPlaceholderName), so a name is
+ * not something a template can refer to. The key is made from the name once,
+ * when the field is created, and never changes: renaming a field must not
+ * silently break every template that already uses it.
+ *
+ * Why not Slug.getSlug: it joins words with hyphens and appends a random
+ * number, and a hyphen is exactly what the placeholder pattern rejects.
+ *
+ * The shape: lowercase letters and digits in runs joined by single
+ * underscores - "expected_resolution" - with no leading, trailing or doubled
+ * underscore. A key already taken in the project gets "_2", "_3", ... in the
+ * order fields were created.
+ *
+ * Pure, and free of database and React imports, so the service that stamps a
+ * new field, the migration that stamps the existing ones and the dashboard
+ * all produce the same key from the same name.
+ */
+/*
+ * Long enough for any name a person would give a field, short enough to type
+ * into a template. The column itself allows 100 characters.
+ */
+export const CUSTOM_FIELD_VARIABLE_KEY_MAX_LENGTH = 64;
+/*
+ * What a name with nothing usable in it becomes: "!!!", or a name written
+ * wholly in a script with no Latin transliteration here, such as "影响" or
+ * "Влияние". Numbered like any other collision, so a project with several
+ * gets field, field_2, field_3.
+ */
+export const CUSTOM_FIELD_VARIABLE_KEY_FALLBACK = "field";
+/*
+ * Where a key sits among the template variables: {{customFields.<key>}}.
+ */
+export const CUSTOM_FIELD_TEMPLATE_VARIABLE_PREFIX = "customFields.";
+const VARIABLE_KEY_PATTERN = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
+/*
+ * Latin letters that Unicode normalisation does not take apart into a base
+ * letter and an accent, so stripping accents alone would lose them: "Größe"
+ * would become "gr_e". Everything else accented (é, ñ, å, ç, ő, ...) is
+ * handled by NFKD below.
+ */
+const LETTERS_WITHOUT_DECOMPOSITION = {
+    ß: "ss",
+    ẞ: "ss",
+    æ: "ae",
+    Æ: "ae",
+    œ: "oe",
+    Œ: "oe",
+    ø: "o",
+    Ø: "o",
+    đ: "d",
+    Đ: "d",
+    ð: "d",
+    Ð: "d",
+    þ: "th",
+    Þ: "th",
+    ł: "l",
+    Ł: "l",
+    ı: "i",
+    ħ: "h",
+    Ħ: "h",
+    ŧ: "t",
+    Ŧ: "t",
+    ŋ: "ng",
+    Ŋ: "ng",
+    ĸ: "k",
+};
+const transliterate = (name) => {
+    var _a;
+    let result = "";
+    for (const character of name) {
+        result += (_a = LETTERS_WITHOUT_DECOMPOSITION[character]) !== null && _a !== void 0 ? _a : character;
+    }
+    /*
+     * NFKD splits "é" into "e" plus a combining accent, and also folds
+     * compatibility forms: full-width "Ａ" to "A", "fi" to "fi", "①" to "1".
+     * Dropping the combining marks then leaves the base letters.
+     */
+    return result.normalize("NFKD").replace(/\p{M}/gu, "");
+};
+// Cut to a length without leaving a dangling underscore at the end.
+const trimToLength = (key, maxLength) => {
+    return key.slice(0, Math.max(maxLength, 0)).replace(/_+$/, "");
+};
+/**
+ * The key a field of this name gets when nothing else in the project has it.
+ * Never empty, and always a valid key.
+ */
+export const getCustomFieldVariableKeyBase = (name) => {
+    const words = transliterate(typeof name === "string" ? name : "")
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, "_")
+        .replace(/^_+|_+$/g, "");
+    const key = trimToLength(words, CUSTOM_FIELD_VARIABLE_KEY_MAX_LENGTH);
+    return key || CUSTOM_FIELD_VARIABLE_KEY_FALLBACK;
+};
+/**
+ * Whether a key has the generator's shape and can be used as
+ * {{customFields.<key>}} in a template the compiler fills.
+ */
+export const isValidCustomFieldVariableKey = (key) => {
+    return (typeof key === "string" &&
+        key.length > 0 &&
+        key.length <= CUSTOM_FIELD_VARIABLE_KEY_MAX_LENGTH &&
+        VARIABLE_KEY_PATTERN.test(key) &&
+        SubscriberNotificationTemplateCompiler.isPlaceholderName(`${CUSTOM_FIELD_TEMPLATE_VARIABLE_PREFIX}${key}`));
+};
+/**
+ * The key for a new field: its name's key, or the first of name_2, name_3,
+ * ... that no other field in the project holds.
+ */
+export const generateCustomFieldVariableKey = (data) => {
+    const taken = new Set();
+    for (const key of data.existingKeys) {
+        if (typeof key === "string" && key.length > 0) {
+            taken.add(key);
+        }
+    }
+    const base = getCustomFieldVariableKeyBase(data.name);
+    if (!taken.has(base)) {
+        return base;
+    }
+    /*
+     * One more than there are keys is always enough: at most that many of the
+     * candidates can be taken.
+     */
+    for (let suffix = 2; suffix <= taken.size + 2; suffix++) {
+        const ending = `_${suffix}`;
+        const candidate = `${trimToLength(base, CUSTOM_FIELD_VARIABLE_KEY_MAX_LENGTH - ending.length)}${ending}`;
+        if (!taken.has(candidate)) {
+            return candidate;
+        }
+    }
+    // Unreachable (see the loop bound); kept so the function always returns.
+    return `${CUSTOM_FIELD_VARIABLE_KEY_FALLBACK}_${taken.size + 2}`;
+};
+/** "expected_resolution" -> "customFields.expected_resolution". */
+export const getCustomFieldTemplateVariableName = (key) => {
+    return `${CUSTOM_FIELD_TEMPLATE_VARIABLE_PREFIX}${key}`;
+};
+//# sourceMappingURL=CustomFieldVariableKey.js.map

package/build/dist/Types/CustomField/CustomFieldVariableKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomFieldVariableKey.js","sourceRoot":"","sources":["../../../../Types/CustomField/CustomFieldVariableKey.ts"],"names":[],"mappings":"AAAA,OAAO,sCAAsC,MAAM,sDAAsD,CAAC;AAE1G;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAW,EAAE,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAW,OAAO,CAAC;AAElE;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAW,eAAe,CAAC;AAE7E,MAAM,oBAAoB,GAAW,4BAA4B,CAAC;AAElE;;;;;GAKG;AACH,MAAM,6BAA6B,GAA2B;IAC5D,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,GAAG;CACP,CAAC;AAIF,MAAM,aAAa,GAA0B,CAAC,IAAY,EAAU,EAAE;;IACpE,IAAI,MAAM,GAAW,EAAE,CAAC;IAExB,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;QAC7B,MAAM,IAAI,MAAA,6BAA6B,CAAC,SAAS,CAAC,mCAAI,SAAS,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,OAAO,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;AACzD,CAAC,CAAC;AAIF,oEAAoE;AACpE,MAAM,YAAY,GAAyB,CACzC,GAAW,EACX,SAAiB,EACT,EAAE;IACV,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AACjE,CAAC,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,CAAC,IAAY,EAAU,EAAE;IACvB,MAAM,KAAK,GAAW,aAAa,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;SACtE,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAE3B,MAAM,GAAG,GAAW,YAAY,CAC9B,KAAK,EACL,oCAAoC,CACrC,CAAC;IAEF,OAAO,GAAG,IAAI,kCAAkC,CAAC;AACnD,CAAC,CAAC;AAIJ;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,CAAC,GAAY,EAAW,EAAE;IACxB,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,CAAC,MAAM,GAAG,CAAC;QACd,GAAG,CAAC,MAAM,IAAI,oCAAoC;QAClD,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC;QAC9B,sCAAsC,CAAC,iBAAiB,CACtD,GAAG,qCAAqC,GAAG,GAAG,EAAE,CACjD,CACF,CAAC;AACJ,CAAC,CAAC;AAWJ;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GACzC,CAAC,IAGA,EAAU,EAAE;IACX,MAAM,KAAK,GAAgB,IAAI,GAAG,EAAU,CAAC;IAE7C,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9C,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAW,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE9D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,KAAK,IAAI,MAAM,GAAW,CAAC,EAAE,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;QAChE,MAAM,MAAM,GAAW,IAAI,MAAM,EAAE,CAAC;QACpC,MAAM,SAAS,GAAW,GAAG,YAAY,CACvC,IAAI,EACJ,oCAAoC,GAAG,MAAM,CAAC,MAAM,CACrD,GAAG,MAAM,EAAE,CAAC;QAEb,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,yEAAyE;IACzE,OAAO,GAAG,kCAAkC,IAAI,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;AACnE,CAAC,CAAC;AAMJ,mEAAmE;AACnE,MAAM,CAAC,MAAM,kCAAkC,GAC7C,CAAC,GAAW,EAAU,EAAE;IACtB,OAAO,GAAG,qCAAqC,GAAG,GAAG,EAAE,CAAC;AAC1D,CAAC,CAAC"}

package/build/dist/Types/SafeHtml.js

@@ -0,0 +1,84 @@
+/*
+ * A value that is ALREADY HTML and may go into an HTML document as written.
+ *
+ * Status page subscriber emails are filled from two kinds of value, and a
+ * plain string cannot say which one it holds:
+ *
+ *   - plain text: an incident, episode, maintenance or announcement title, a
+ *     severity or state name, a status page or resource name, a URL. Project
+ *     members type these, and a title is exactly what someone outside the
+ *     team gets to influence (an incident created from a monitor, an API
+ *     call, a Slack command). Put into HTML as written, a title such as
+ *     `<a href="https://evil.example">Reset your password</a>` becomes a live
+ *     link in an email the recipient trusts.
+ *   - HTML this code produced itself: Markdown.convertToHTML output (which
+ *     escapes the raw HTML an author typed and keeps only http, https and
+ *     mailto links), the date helper's multi-timezone HTML, and the resource
+ *     list StatusPageResourceUtil.getResourcesGroupedByGroupName builds from
+ *     escaped names.
+ *
+ * So the HTML ones travel wrapped in this type, and anything that is still a
+ * string is treated as plain text and escaped where it meets HTML (see
+ * SubscriberNotificationTemplateCompiler.compileEmailBodyTemplate). A value
+ * nobody thought about is therefore escaped, which at worst shows the reader
+ * an "&amp;" too many; it can never become markup by accident.
+ *
+ * Kept free of server dependencies so both the server and the dashboard can
+ * use it.
+ */
+var _a;
+/*
+ * Marks instances without instanceof, which a second copy of this module (a
+ * test's isolated module registry, a duplicated bundle) would defeat.
+ */
+const SAFE_HTML_BRAND = Symbol.for("OneUptime.SafeHtml");
+class SafeHtml {
+    constructor(html) {
+        // Read by isSafeHtml; a symbol key, so JSON.stringify leaves it out.
+        this[_a] = true;
+        this.html = html;
+    }
+    /*
+     * Wraps markup this code produced from values it had already made safe:
+     * Markdown.convertToHTML(..., MarkdownContentType.Email) output,
+     * OneUptimeDate.getDateAsFormattedHTMLInMultipleTimezones output, and
+     * StatusPageResourceUtil.getResourcesGroupedByGroupName output. Never a
+     * value a user typed.
+     */
+    static fromTrustedHtml(html) {
+        return new SafeHtml(html || "");
+    }
+    // Plain text, escaped so it reads the same in HTML.
+    static fromPlainText(text) {
+        return new SafeHtml(SafeHtml.escape(text || ""));
+    }
+    /*
+     * Escapes the five characters that can break out of HTML text or a quoted
+     * attribute value. The ampersand goes first, so the entities the other
+     * four become are not escaped a second time.
+     *
+     * This is the one implementation: Markdown.escapeHtml calls it.
+     */
+    static escape(text) {
+        return String(text)
+            .replace(/&/g, "&amp;")
+            .replace(/</g, "&lt;")
+            .replace(/>/g, "&gt;")
+            .replace(/"/g, "&quot;")
+            .replace(/'/g, "&#39;");
+    }
+    static isSafeHtml(value) {
+        return (typeof value === "object" &&
+            value !== null &&
+            value[SAFE_HTML_BRAND] === true);
+    }
+    toHtml() {
+        return this.html;
+    }
+    toString() {
+        return this.html;
+    }
+}
+_a = SAFE_HTML_BRAND;
+export default SafeHtml;
+//# sourceMappingURL=SafeHtml.js.map