@adguard/agtree 2.1.3 → 3.0.0-alpha.1

package/dist/cjs/compatibility-tables/modifiers.js

@@ -0,0 +1,57 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var base = require('./base.js');
+var compatibilityTableData = require('./compatibility-table-data.js');
+var constants = require('../utils/constants.js');
+var deepFreeze = require('../utils/deep-freeze.js');
+
+/**
+ * @file Compatibility tables for modifiers.
+ */
+/**
+ * Transforms the name of the modifier to a normalized form.
+ * This is a special case: the noop modifier normally '_', but it can consist of any number of characters,
+ * e.g. '____' is also valid. In this case, we need to normalize the name to '_'.
+ *
+ * @param name Modifier name to normalize.
+ * @returns Normalized modifier name.
+ */
+const noopModifierNameNormalizer = (name) => {
+    if (name.startsWith(constants.UNDERSCORE)) {
+        if (name.split(constants.EMPTY).every((char) => char === constants.UNDERSCORE)) {
+            // in compatibility tables, we just store '_', so we need to reduce the number of underscores to 1
+            // before checking the existence of the noop modifier
+            return constants.UNDERSCORE;
+        }
+    }
+    return name;
+};
+/**
+ * Compatibility table for modifiers.
+ */
+class ModifiersCompatibilityTable extends base.CompatibilityTableBase {
+    /**
+     * Creates a new instance of the compatibility table for modifiers.
+     *
+     * @param data Compatibility table data.
+     */
+    constructor(data) {
+        super(data, noopModifierNameNormalizer);
+    }
+}
+/**
+ * Deep freeze the compatibility table data to avoid accidental modifications.
+ */
+deepFreeze.deepFreeze(compatibilityTableData.modifiersCompatibilityTableData);
+/**
+ * Compatibility table instance for modifiers.
+ */
+const modifiersCompatibilityTable = new ModifiersCompatibilityTable(compatibilityTableData.modifiersCompatibilityTableData);
+
+exports.modifiersCompatibilityTable = modifiersCompatibilityTable;

package/dist/cjs/compatibility-tables/platforms.js

@@ -0,0 +1,58 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+/* eslint-disable no-bitwise */
+/**
+ * @file Provides platform enums.
+ * The difference between specific and generic platforms is that specific platforms are individual platforms
+ * (e.g. AdGuard for Windows, AdGuard for Android, etc.),
+ * while generic platforms are groups of specific platforms
+ * (e.g. AdGuard for any OS, AdGuard for any Chromium-based extension, etc.).
+ */
+/**
+ * List of specific platforms.
+ */
+exports.SpecificPlatform = void 0;
+(function (SpecificPlatform) {
+    SpecificPlatform[SpecificPlatform["AdgOsWindows"] = 1] = "AdgOsWindows";
+    SpecificPlatform[SpecificPlatform["AdgOsMac"] = 2] = "AdgOsMac";
+    SpecificPlatform[SpecificPlatform["AdgOsAndroid"] = 4] = "AdgOsAndroid";
+    SpecificPlatform[SpecificPlatform["AdgExtChrome"] = 8] = "AdgExtChrome";
+    SpecificPlatform[SpecificPlatform["AdgExtOpera"] = 16] = "AdgExtOpera";
+    SpecificPlatform[SpecificPlatform["AdgExtEdge"] = 32] = "AdgExtEdge";
+    SpecificPlatform[SpecificPlatform["AdgExtFirefox"] = 64] = "AdgExtFirefox";
+    SpecificPlatform[SpecificPlatform["AdgCbAndroid"] = 128] = "AdgCbAndroid";
+    SpecificPlatform[SpecificPlatform["AdgCbIos"] = 256] = "AdgCbIos";
+    SpecificPlatform[SpecificPlatform["AdgCbSafari"] = 512] = "AdgCbSafari";
+    SpecificPlatform[SpecificPlatform["UboExtChrome"] = 1024] = "UboExtChrome";
+    SpecificPlatform[SpecificPlatform["UboExtOpera"] = 2048] = "UboExtOpera";
+    SpecificPlatform[SpecificPlatform["UboExtEdge"] = 4096] = "UboExtEdge";
+    SpecificPlatform[SpecificPlatform["UboExtFirefox"] = 8192] = "UboExtFirefox";
+    SpecificPlatform[SpecificPlatform["AbpExtChrome"] = 16384] = "AbpExtChrome";
+    SpecificPlatform[SpecificPlatform["AbpExtOpera"] = 32768] = "AbpExtOpera";
+    SpecificPlatform[SpecificPlatform["AbpExtEdge"] = 65536] = "AbpExtEdge";
+    SpecificPlatform[SpecificPlatform["AbpExtFirefox"] = 131072] = "AbpExtFirefox";
+})(exports.SpecificPlatform || (exports.SpecificPlatform = {}));
+/**
+ * List of generic platforms (combinations of specific platforms).
+ */
+exports.GenericPlatform = void 0;
+(function (GenericPlatform) {
+    GenericPlatform[GenericPlatform["AdgOsAny"] = 7] = "AdgOsAny";
+    GenericPlatform[GenericPlatform["AdgSafariAny"] = 768] = "AdgSafariAny";
+    GenericPlatform[GenericPlatform["AdgExtChromium"] = 56] = "AdgExtChromium";
+    GenericPlatform[GenericPlatform["AdgExtAny"] = 120] = "AdgExtAny";
+    GenericPlatform[GenericPlatform["AdgAny"] = 1023] = "AdgAny";
+    GenericPlatform[GenericPlatform["UboExtChromium"] = 7168] = "UboExtChromium";
+    GenericPlatform[GenericPlatform["UboExtAny"] = 15360] = "UboExtAny";
+    GenericPlatform[GenericPlatform["UboAny"] = 15360] = "UboAny";
+    GenericPlatform[GenericPlatform["AbpExtChromium"] = 114688] = "AbpExtChromium";
+    GenericPlatform[GenericPlatform["AbpExtAny"] = 245760] = "AbpExtAny";
+    GenericPlatform[GenericPlatform["AbpAny"] = 245760] = "AbpAny";
+    GenericPlatform[GenericPlatform["Any"] = 262143] = "Any";
+})(exports.GenericPlatform || (exports.GenericPlatform = {}));

package/dist/cjs/compatibility-tables/redirects.js

@@ -0,0 +1,102 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var base = require('./base.js');
+var compatibilityTableData = require('./compatibility-table-data.js');
+var deepFreeze = require('../utils/deep-freeze.js');
+var constants = require('../utils/constants.js');
+var resourceTypeHelpers = require('./utils/resource-type-helpers.js');
+var typeGuards = require('../utils/type-guards.js');
+
+/**
+ * @file Compatibility tables for redirects.
+ */
+/**
+ * Prefix for resource redirection names.
+ */
+const ABP_RESOURCE_PREFIX = 'abp-resource:';
+const ABP_RESOURCE_PREFIX_LENGTH = ABP_RESOURCE_PREFIX.length;
+/**
+ * Normalizes the redirect name.
+ *
+ * @param name Redirect name to normalize.
+ *
+ * @returns Normalized redirect name.
+ *
+ * @example
+ * redirectNameNormalizer('abp-resource:my-resource') // => 'my-resource'
+ * redirectNameNormalizer('noop.js:99') // => 'noop.js'
+ */
+const redirectNameNormalizer = (name) => {
+    // Remove ABP resource prefix, if present
+    if (name.startsWith(ABP_RESOURCE_PREFIX)) {
+        return name.slice(ABP_RESOURCE_PREFIX_LENGTH);
+    }
+    // Remove :[integer] priority suffix from the name, if present
+    // See:
+    // - https://github.com/AdguardTeam/tsurlfilter/issues/59
+    // - https://github.com/gorhill/uBlock/wiki/Static-filter-syntax#redirect
+    const colonIndex = name.lastIndexOf(constants.COLON);
+    if (colonIndex !== -1 && /^\d+$/.test(name.slice(colonIndex + 1))) {
+        return name.slice(0, colonIndex);
+    }
+    return name;
+};
+/**
+ * Compatibility table for redirects.
+ */
+class RedirectsCompatibilityTable extends base.CompatibilityTableBase {
+    /**
+     * Creates a new instance of the compatibility table for redirects.
+     *
+     * @param data Compatibility table data.
+     */
+    constructor(data) {
+        super(data, redirectNameNormalizer);
+    }
+    /**
+     * Gets the resource type adblock modifiers for the redirect for the given platform
+     * based on the `resourceTypes` field.
+     *
+     * @param redirect Redirect name or redirect data.
+     * @param platform Platform to get the modifiers for.
+     *
+     * @returns Set of resource type modifiers or an empty set if the redirect is not found or has no resource types.
+     */
+    getResourceTypeModifiers(redirect, platform) {
+        let redirectData = null;
+        if (typeGuards.isString(redirect)) {
+            redirectData = this.getFirst(redirect, platform);
+        }
+        else {
+            redirectData = redirect;
+        }
+        const modifierNames = new Set();
+        if (typeGuards.isNull(redirectData) || typeGuards.isUndefined(redirectData.resourceTypes)) {
+            return modifierNames;
+        }
+        for (const resourceType of redirectData.resourceTypes) {
+            const modifierName = resourceTypeHelpers.getResourceTypeModifier(resourceType, platform);
+            if (typeGuards.isNull(modifierName)) {
+                continue;
+            }
+            modifierNames.add(modifierName);
+        }
+        return modifierNames;
+    }
+}
+/**
+ * Deep freeze the compatibility table data to avoid accidental modifications.
+ */
+deepFreeze.deepFreeze(compatibilityTableData.redirectsCompatibilityTableData);
+/**
+ * Compatibility table instance for redirects.
+ */
+const redirectsCompatibilityTable = new RedirectsCompatibilityTable(compatibilityTableData.redirectsCompatibilityTableData);
+
+exports.redirectsCompatibilityTable = redirectsCompatibilityTable;

package/dist/cjs/compatibility-tables/schemas/base.js

@@ -0,0 +1,116 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var zod = require('zod');
+require('./platform.js');
+var zodCamelcase = require('../utils/zod-camelcase.js');
+
+/**
+ * @file Base compatibility data schema, which is commonly used in compatibility tables.
+ */
+/**
+ * Zod schema for boolean values. Accepts both boolean and string values.
+ */
+const booleanSchema = zod.union([
+    zod.string().transform((val) => val.trim().toLowerCase() === 'true'),
+    zod.boolean(),
+]);
+/**
+ * Zod schema for non-empty string values.
+ */
+const nonEmptyStringSchema = zod
+    .string()
+    .transform((val) => val.trim())
+    .pipe(zod.string().min(1));
+/**
+ * Zod schema for base compatibility data.
+ * Here we use snake_case properties because the compatibility data is stored in YAML files.
+ */
+const baseCompatibilityDataSchema = zod.object({
+    /**
+     * Name of the actual entity.
+     */
+    name: nonEmptyStringSchema,
+    /**
+     * List of aliases for the entity (if any).
+     */
+    aliases: zod.array(nonEmptyStringSchema).nullable().default(null),
+    /**
+     * Short description of the actual entity.
+     * If not specified or it's value is `null`, then the description is not available.
+     */
+    description: nonEmptyStringSchema.nullable().default(null),
+    /**
+     * Link to the documentation. If not specified or it's value is `null`, then the documentation is not available.
+     */
+    docs: nonEmptyStringSchema.nullable().default(null),
+    /**
+     * The version of the adblocker in which the entity was added.
+     * For AdGuard resources, the version of the library is specified.
+     */
+    version_added: nonEmptyStringSchema.nullable().default(null),
+    /**
+     * The version of the adblocker when the entity was removed.
+     */
+    version_removed: nonEmptyStringSchema.nullable().default(null),
+    /**
+     * Describes whether the entity is deprecated.
+     */
+    deprecated: booleanSchema.default(false),
+    /**
+     * Message that describes why the entity is deprecated.
+     * If not specified or it's value is `null`, then the message is not available.
+     * It's value is omitted if the entity is not marked as deprecated.
+     */
+    deprecation_message: nonEmptyStringSchema.nullable().default(null),
+    /**
+     * Describes whether the entity is removed; for *already removed* features.
+     */
+    removed: booleanSchema.default(false),
+    /**
+     * Message that describes why the entity is removed.
+     * If not specified or it's value is `null`, then the message is not available.
+     * It's value is omitted if the entity is not marked as deprecated.
+     */
+    removal_message: nonEmptyStringSchema.nullable().default(null),
+});
+/**
+ * Zod schema for base compatibility data with camelCase properties.
+ */
+zodCamelcase.zodToCamelCase(baseCompatibilityDataSchema);
+/**
+ * Refinement logic for base compatibility data.
+ *
+ * @param data Base compatibility data.
+ * @param ctx Refinement context.
+ */
+const baseRefineLogic = (data, ctx) => {
+    if (data.deprecated && !data.deprecation_message) {
+        ctx.addIssue({
+            code: zod.ZodIssueCode.custom,
+            message: 'deprecation_message is required for deprecated modifiers',
+        });
+    }
+    if (!data.deprecated && data.deprecation_message) {
+        ctx.addIssue({
+            code: zod.ZodIssueCode.custom,
+            message: 'deprecation_message is only allowed for deprecated modifiers',
+        });
+    }
+    if (data.aliases && data.aliases.length !== new Set(data.aliases).size) {
+        ctx.addIssue({
+            code: zod.ZodIssueCode.custom,
+            message: 'Aliases must be unique',
+        });
+    }
+};
+
+exports.baseCompatibilityDataSchema = baseCompatibilityDataSchema;
+exports.baseRefineLogic = baseRefineLogic;
+exports.booleanSchema = booleanSchema;
+exports.nonEmptyStringSchema = nonEmptyStringSchema;

package/dist/cjs/compatibility-tables/schemas/modifier.js

@@ -0,0 +1,107 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var zod = require('zod');
+var XRegExp = require('xregexp');
+var zodCamelcase = require('../utils/zod-camelcase.js');
+var base = require('./base.js');
+var error = require('../../utils/error.js');
+
+/**
+ * @file Schema for modifier data.
+ */
+/**
+ * Known validators that don't need to be validated as regex.
+ */
+const KNOWN_VALIDATORS = new Set([
+    'domain',
+    'pipe_separated_domains',
+    'regexp',
+    'url',
+]);
+/**
+ * Zod schema for modifier data.
+ */
+zodCamelcase.zodToCamelCase(base.baseCompatibilityDataSchema.extend({
+    /**
+     * List of modifiers that are incompatible with the actual one.
+     */
+    conflicts: zod.array(base.nonEmptyStringSchema).nullable().default(null),
+    /**
+     * The actual modifier is incompatible with all other modifiers, except the ones listed in `conflicts`.
+     */
+    inverse_conflicts: base.booleanSchema.default(false),
+    /**
+     * Describes whether the actual modifier supports value assignment. For example, `$domain` is assignable,
+     * so it can be used like this: `$domain=domain.com\|~subdomain.domain.com`, where `=` is the assignment operator
+     * and `domain.com\|~subdomain.domain.com` is the value.
+     */
+    assignable: base.booleanSchema.default(false),
+    /**
+     * Describes whether the actual modifier can be negated. For example, `$third-party` is negatable,
+     * so it can be used like this: `$~third-party`.
+     */
+    negatable: base.booleanSchema.default(true),
+    /**
+     * The actual modifier can only be used in blocking rules, it cannot be used in exceptions.
+     * If it's value is `true`, then the modifier can be used only in blocking rules.
+     * `exception_only` and `block_only` cannot be used together (they are mutually exclusive).
+     */
+    block_only: base.booleanSchema.default(false),
+    /**
+     * The actual modifier can only be used in exceptions, it cannot be used in blocking rules.
+     * If it's value is `true`, then the modifier can be used only in exceptions.
+     * `exception_only` and `block_only` cannot be used together (they are mutually exclusive).
+     */
+    exception_only: base.booleanSchema.default(false),
+    /**
+     * Describes whether the *assignable* modifier value is required.
+     * For example, `$cookie` is assignable but it can be used without a value in exception rules:
+     * `@@\|\|example.com^$cookie`.
+     * If `false`, the `value_format` is required, e.g. the value of `$app` should always be specified
+     */
+    value_optional: base.booleanSchema.default(false),
+    /**
+     * Describes the format of the value for the *assignable* modifier.
+     * Its value can be a regex pattern or a known validator name (e.g. `domain`, `pipe_separated_domains`, etc.).
+     */
+    value_format: base.nonEmptyStringSchema.nullable().default(null),
+}).superRefine((data, ctx) => {
+    // TODO: find something better, for now we can't add refine logic to the base schema:
+    // https://github.com/colinhacks/zod/issues/454#issuecomment-848370721
+    base.baseRefineLogic(data, ctx);
+    if (data.block_only && data.exception_only) {
+        ctx.addIssue({
+            code: zod.ZodIssueCode.custom,
+            message: 'block_only and exception_only are mutually exclusive',
+        });
+    }
+    if (data.assignable && !data.value_format) {
+        ctx.addIssue({
+            code: zod.ZodIssueCode.custom,
+            message: 'value_format is required for assignable modifiers',
+        });
+    }
+    if (data.value_format) {
+        const valueFormat = data.value_format.trim();
+        // if it is a known validator, we don't need to validate it further
+        if (KNOWN_VALIDATORS.has(valueFormat)) {
+            return;
+        }
+        // otherwise, we need to validate it as a regex
+        try {
+            XRegExp(valueFormat);
+        }
+        catch (error$1) {
+            ctx.addIssue({
+                code: zod.ZodIssueCode.custom,
+                message: error.getErrorMessage(error$1),
+            });
+        }
+    }
+}));

package/dist/cjs/compatibility-tables/schemas/platform.js

@@ -0,0 +1,71 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var zod = require('zod');
+var platformHelpers = require('../utils/platform-helpers.js');
+var typeGuards = require('../../utils/type-guards.js');
+
+/* eslint-disable no-bitwise */
+/**
+ * @file Platform schema.
+ */
+/**
+ * Platform separator, e.g. 'adg_os_any|adg_safari_any' means any AdGuard OS platform and
+ * any AdGuard Safari content blocker platform.
+ */
+const PLATFORM_SEPARATOR = '|';
+/**
+ * Platform negation character, e.g. 'adg_any|~adg_safari_any' means any AdGuard product except
+ * Safari content blockers.
+ */
+const PLATFORM_NEGATION = '~';
+/**
+ * Parses a raw platform string into a platform bitmask.
+ *
+ * @param rawPlatforms Raw platform string, e.g. 'adg_safari_any|adg_os_any'.
+ *
+ * @returns Platform bitmask.
+ */
+const parseRawPlatforms = (rawPlatforms) => {
+    // e.g. 'adg_safari_any|adg_os_any'
+    const rawPlatformList = rawPlatforms
+        .split(PLATFORM_SEPARATOR)
+        .map((rawPlatform) => rawPlatform.trim());
+    let result = 0;
+    for (let rawPlatform of rawPlatformList) {
+        // negation, e.g. 'adg_any|~adg_safari_any' means any AdGuard product except Safari content blockers
+        let negated = false;
+        if (rawPlatform.startsWith(PLATFORM_NEGATION)) {
+            negated = true;
+            rawPlatform = rawPlatform.slice(1).trim();
+        }
+        const platform = platformHelpers.SPECIFIC_PLATFORM_MAP.get(rawPlatform) ?? platformHelpers.GENERIC_PLATFORM_MAP.get(rawPlatform);
+        if (typeGuards.isUndefined(platform)) {
+            throw new Error(`Unknown platform: ${rawPlatform}`);
+        }
+        if (negated) {
+            result &= ~platform;
+        }
+        else {
+            result |= platform;
+        }
+    }
+    if (result === 0) {
+        throw new Error('No platforms specified');
+    }
+    return result;
+};
+/**
+ * Platform schema.
+ */
+zod
+    .string()
+    .min(1)
+    .transform((value) => parseRawPlatforms(value));
+
+exports.parseRawPlatforms = parseRawPlatforms;

package/dist/cjs/compatibility-tables/schemas/redirect.js

@@ -0,0 +1,31 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var zod = require('zod');
+var zodCamelcase = require('../utils/zod-camelcase.js');
+var base = require('./base.js');
+var resourceType = require('./resource-type.js');
+
+/**
+ * @file Schema for redirect data.
+ */
+/**
+ * Zod schema for redirect data.
+ */
+zodCamelcase.zodToCamelCase(base.baseCompatibilityDataSchema.extend({
+    /**
+     * Whether the redirect is blocking.
+     */
+    is_blocking: base.booleanSchema.default(false),
+    /**
+     * Resource type(s) belonging to the redirect.
+     *
+     * @see {@link https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#type-ResourceType}
+     */
+    resource_types: zod.array(resourceType.resourceTypeSchema).default([]),
+}).superRefine(base.baseRefineLogic));

package/dist/cjs/compatibility-tables/schemas/resource-type.js

@@ -0,0 +1,39 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var zod = require('zod');
+
+/**
+ * @file Resource type schema.
+ */
+/**
+ * Resource type.
+ *
+ * @see {@link https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#type-ResourceType}
+ */
+exports.ResourceType = void 0;
+(function (ResourceType) {
+    ResourceType["MainFrame"] = "main_frame";
+    ResourceType["SubFrame"] = "sub_frame";
+    ResourceType["Stylesheet"] = "stylesheet";
+    ResourceType["Script"] = "script";
+    ResourceType["Image"] = "image";
+    ResourceType["Font"] = "font";
+    ResourceType["Object"] = "object";
+    ResourceType["XmlHttpRequest"] = "xmlhttprequest";
+    ResourceType["Ping"] = "ping";
+    ResourceType["Media"] = "media";
+    ResourceType["WebSocket"] = "websocket";
+    ResourceType["Other"] = "other";
+})(exports.ResourceType || (exports.ResourceType = {}));
+/**
+ * Resource type schema.
+ */
+const resourceTypeSchema = zod.nativeEnum(exports.ResourceType);
+
+exports.resourceTypeSchema = resourceTypeSchema;

package/dist/cjs/compatibility-tables/schemas/scriptlet.js

@@ -0,0 +1,81 @@
+/*
+ * AGTree v3.0.0-alpha.1 (build date: Tue, 12 Nov 2024 16:11:58 GMT)
+ * (c) 2024 Adguard Software Ltd.
+ * Released under the MIT license
+ * https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree#readme
+ */
+'use strict';
+
+var zod = require('zod');
+var zodCamelcase = require('../utils/zod-camelcase.js');
+var base = require('./base.js');
+
+/**
+ * @file Schema for scriptlet data.
+ */
+/**
+ * Zod schema for scriptlet parameter data.
+ */
+const scriptletParameterSchema = zod.object({
+    /**
+     * Name of the actual parameter.
+     */
+    name: base.nonEmptyStringSchema,
+    /**
+     * Describes whether the parameter is required. Empty parameters are not allowed.
+     */
+    required: base.booleanSchema,
+    /**
+     * Short description of the parameter.
+     * If not specified or it's value is `null`,then the description is not available.
+     */
+    description: base.nonEmptyStringSchema.nullable().default(null),
+    /**
+     * Regular expression that matches the value of the parameter.
+     * If it's value is `null`, then the parameter value is not checked.
+     */
+    pattern: base.nonEmptyStringSchema.nullable().default(null),
+    /**
+     * Default value of the parameter (if any).
+     */
+    default: base.nonEmptyStringSchema.nullable().default(null),
+    /**
+     * Describes whether the parameter is used only for debugging purposes.
+     */
+    debug: base.booleanSchema.default(false),
+});
+/**
+ * Zod schema for scriptlet parameters.
+ */
+const scriptletParametersSchema = zod.array(scriptletParameterSchema);
+/**
+ * Zod schema for scriptlet data.
+ */
+zodCamelcase.zodToCamelCase(base.baseCompatibilityDataSchema.extend({
+    /**
+     * List of parameters that the scriptlet accepts.
+     * **Every** parameter should be listed here, because we check that the scriptlet is used correctly
+     * (e.g. that the number of parameters is correct).
+     */
+    parameters: scriptletParametersSchema.optional(),
+}).superRefine((data, ctx) => {
+    // TODO: find something better, for now we can't add refine logic to the base schema:
+    // https://github.com/colinhacks/zod/issues/454#issuecomment-848370721
+    base.baseRefineLogic(data, ctx);
+    // we don't allow required parameters after optional ones
+    if (!data.parameters) {
+        return;
+    }
+    let optionalFound = false;
+    for (const parameter of data.parameters) {
+        if (optionalFound && parameter.required) {
+            ctx.addIssue({
+                code: zod.ZodIssueCode.custom,
+                message: 'Required parameters must be before optional ones',
+            });
+        }
+        if (!parameter.required) {
+            optionalFound = true;
+        }
+    }
+}));