@via-profit/ability 3.4.1 → 3.5.1

package/dist/core/AbilityResult.d.ts

@@ -1,27 +0,0 @@
-import { AbilityExplain } from './AbilityExplain';
-import { ResourceObject } from './AbilityTypeGenerator';
-import AbilityPolicy from './AbilityPolicy';
-import AbilityPolicyEffect from './AbilityPolicyEffect';
-export declare class AbilityResult<Resource extends ResourceObject = Record<string, unknown>> {
-    /**
-     * Already checked policies (after call the policy.check())
-     */
-    readonly policies: readonly AbilityPolicy<Resource>[];
-    constructor(policies: readonly AbilityPolicy<Resource>[]);
-    /**
-     * Returns a list of explanations for each policy involved in the ability evaluation.
-     * Each item describes how a specific policy contributed to the final permission result.
-     *
-     * Useful for debugging, logging, or building UI tools that visualize permission logic.
-     */
-    explain(): readonly AbilityExplain[];
-    getLastMatchedPolicy(): AbilityPolicy<Resource> | null;
-    isAllowed(): boolean;
-    isDenied(): boolean;
-    /**
-     * Get the last effect of the policy
-     *
-     * @returns {AbilityPolicyEffect | null}
-     */
-    getLastEffectOfMatchedPolicy(): AbilityPolicyEffect | null;
-}

package/dist/core/AbilityRule.d.ts

@@ -1,88 +0,0 @@
-import AbilityMatch from './AbilityMatch';
-import { AbilityCondition, AbilityConditionCodeType } from './AbilityCondition';
-export type AbilityRuleConfig = {
-    readonly id?: string | null;
-    readonly name?: string | null;
-    /**
-     * Subject key path like a 'user.name'
-     */
-    readonly subject: string;
-    /**
-     * Resource key path like a 'user.name' or value
-     */
-    readonly resource: string | number | boolean | null | (string | number | boolean | null)[];
-    readonly condition: AbilityConditionCodeType;
-};
-export type AbilityRuleConstructorProps = Omit<AbilityRuleConfig, 'condition'> & {
-    readonly condition: AbilityCondition;
-};
-/**
- * Represents a rule that defines a condition to be checked against a subject and resource.
- */
-export declare class AbilityRule<Resources extends object = object, Environment = unknown> {
-    /**
-     * Subject key path like a 'user.name'
-     */
-    subject: string;
-    /**
-     * Resource key path like a 'user.name' or value
-     */
-    resource: AbilityRuleConfig['resource'];
-    condition: AbilityCondition;
-    name: string;
-    id: string;
-    state: AbilityMatch;
-    /**
-     * Creates an instance of AbilityRule.
-     * @param {string} params.id - The unique identifier of the rule.
-     * @param {string} params.name - The name of the rule.
-     * @param {AbilityCondition} params.condition - The condition to evaluate.
-     * @param {string} params.subject - The subject of the rule.
-     * @param {string} params.resource - The resource to compare against.
-     * @param params
-     */
-    constructor(params: AbilityRuleConstructorProps);
-    private isPrimitive;
-    private isNumber;
-    private isString;
-    private valueLen;
-    private operatorHandlers;
-    /**
-     * Check if the rule is matched
-     * @param resource - The resource to check
-     * @param environment
-     */
-    check(resource: Resources | null, environment?: Environment): Promise<AbilityMatch>;
-    /**
-     * Extract values from the resourceData
-     * @param resourceData - The resourceData to extract values from
-     * @param environment - Environment data
-     */
-    extractValues(resourceData: Resources | null, environment?: Environment | null): [AbilityRuleConfig['resource'] | undefined, AbilityRuleConfig['resource'] | undefined];
-    /**
-     * Get the value of the object by dot notation
-     * @param resource - The object to get the value from
-     * @param desc - The dot notation string
-     */
-    getDotNotationValue<T = unknown>(resource: unknown, desc: string): T | undefined;
-    toString(): string;
-    copyWith(props: Partial<{
-        id: string | null;
-        name: string | null;
-        subject: string;
-        resource: AbilityRuleConfig['resource'];
-        condition: AbilityCondition;
-    }>): AbilityRule<Resources, Environment>;
-    static equals<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static notEquals<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static contains<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static notContains<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static notIn<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static in<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static notEqual<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static lessThan<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static lessOrEqual<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static moreThan<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-    static moreOrEqual<Resources extends object = object, Environment = unknown>(subject: string, resource: AbilityRuleConfig['resource']): AbilityRule<Resources, Environment>;
-}
-export default AbilityRule;

package/dist/core/AbilityRuleSet.d.ts

@@ -1,51 +0,0 @@
-import AbilityRule, { AbilityRuleConfig } from './AbilityRule';
-import AbilityCompare, { AbilityCompareCodeType } from './AbilityCompare';
-import AbilityMatch from './AbilityMatch';
-import { ResourceObject } from './AbilityTypeGenerator';
-export type AbilityRuleSetConfig = {
-    readonly id?: string | null;
-    readonly name?: string | null;
-    readonly compareMethod: AbilityCompareCodeType;
-    readonly rules: readonly AbilityRuleConfig[];
-};
-export type AbilityRuleSetConstructorProps = {
-    readonly id?: string | null;
-    readonly name?: string | null;
-    readonly compareMethod: AbilityCompare;
-};
-export declare class AbilityRuleSet<Resources extends ResourceObject = Record<string, unknown>, Environment = unknown> {
-    state: AbilityMatch;
-    /**
-     * List of rules
-     */
-    rules: AbilityRule<Resources, Environment>[];
-    /**
-     * Rules compare method.\
-     * For the «and» method the rule will be permitted if all\
-     * rules will be returns «permit» status and for the «or» - if\
-     * one of the rules returns as «permit»
-     */
-    compareMethod: AbilityCompare;
-    /**
-     * Group name
-     */
-    name: string;
-    /**
-     * Group ID
-     */
-    id: string;
-    constructor(params: AbilityRuleSetConstructorProps);
-    addRule(rule: AbilityRule<Resources, Environment>): this;
-    addRules(rules: AbilityRule<Resources, Environment>[]): this;
-    check(resources: Resources | null, environment?: Environment): Promise<AbilityMatch>;
-    toString(): string;
-    copyWith(props: Partial<{
-        id: string | null;
-        name: string | null;
-        compareMethod: AbilityCompare;
-        rules: AbilityRule<Resources, Environment>[];
-    }>): AbilityRuleSet<Resources, Environment>;
-    static and(rules: AbilityRule[]): AbilityRuleSet<Record<string, unknown>, unknown>;
-    static or(rules: AbilityRule[]): AbilityRuleSet<Record<string, unknown>, unknown>;
-}
-export default AbilityRuleSet;

package/dist/core/AbilityTypeGenerator.d.ts

@@ -1,55 +0,0 @@
-import AbilityPolicy from './AbilityPolicy';
-export type Primitive = string | number | boolean | null | undefined;
-export type NestedDict<T = Primitive> = {
-    [key: string]: NestedDict<T> | T;
-};
-export type ResourceObject = Record<string, unknown>;
-export type ResourcesMap = Record<string, ResourceObject>;
-export declare class AbilityTypeGenerator {
-    readonly policies: readonly AbilityPolicy[];
-    constructor(policies: readonly AbilityPolicy[]);
-    /**
-     * Generates TypeScript type definitions based on the provided policies.
-     * @returns A generated type definitions.
-     */
-    generateTypeDefs(): string;
-    /**
-     * Determines TypeScript type based on the rule
-     * @param rule - The rule to analyze
-     * @returns TypeScript type as string
-     */
-    private determineTypeFromRule;
-    /**
-     * Gets TypeScript type for array values
-     * @param resource - The resource value to analyze
-     * @returns TypeScript array type as string
-     */
-    private getArrayType;
-    /**
-     * Gets primitive TypeScript type for a value
-     * @param value - The value to analyze
-     * @returns TypeScript primitive type as string
-     */
-    private getPrimitiveType;
-    /**
-     * Builds nested structure from flat paths
-     * Example: 'user.profile.name' -> { user: { profile: { name: 'string' } } }
-     * @param flatStructure - Flat structure with dot notation paths
-     * @returns Nested object structure
-     */
-    private buildNestedStructure;
-    /**
-     * Formats type structure into a string
-     * @param structure - Nested type structure
-     * @returns Formatted TypeScript type definition string
-     */
-    private formatTypeDefinitions;
-    /**
-     * Recursively formats nested object
-     * @param obj - Object to format
-     * @param indent - Current indentation level
-     * @returns Formatted string
-     */
-    private formatNestedObject;
-}
-export default AbilityTypeGenerator;

package/dist/parsers/dsl/AbilityDSLLexer.d.ts

@@ -1,24 +0,0 @@
-import { AbilityDSLToken } from '../../parsers/dsl/AbilityDSLToken';
-export declare class AbilityDSLLexer {
-    private readonly input;
-    private pos;
-    private tokens;
-    private line;
-    private column;
-    private readonly keywords;
-    constructor(input: string);
-    tokenize(): AbilityDSLToken[];
-    private readComment;
-    private readString;
-    private readNumber;
-    private readSymbol;
-    private readWord;
-    private skipWhitespace;
-    private isDigit;
-    private isAlpha;
-    private isSymbol;
-    private isNewline;
-    private peek;
-    private advance;
-    private isAtEnd;
-}

package/dist/parsers/dsl/AbilityDSLParser.d.ts

@@ -1,85 +0,0 @@
-import AbilityPolicy from '../../core/AbilityPolicy';
-import { ResourceObject } from '../../core/AbilityTypeGenerator';
-/**
- * Parser for the Ability DSL.
- *
- * Converts a DSL string into one or more AbilityPolicy instances.
- * The grammar follows the structure:
- *
- *   <effect> <permission> if <group> [ <group> ... ]
- *
- * where <group> is either "all of:" or "any of:", followed by a colon,
- * and then a list of rules (one per line).
- *
- * Each rule is: <identifier> <operator> <value>
- *
- * Operators can be simple (equals, contains, in) or
- * composed (is null, is not null, greater than, less than or equal, etc.).
- */
-export declare class AbilityDSLParser<Resource extends ResourceObject = Record<string, unknown>, Environment = unknown> {
-    private dsl;
-    private tokens;
-    private pos;
-    private annotationBuffer;
-    constructor(dsl: string);
-    /**
-     * Main entry point: tokenize the input and parse all policies.
-     * @returns Array of AbilityPolicy instances.
-     */
-    parse(): readonly AbilityPolicy<Resource, Environment>[];
-    /**
-     * Parses a single policy from the current token position.
-     *
-     * Grammar:
-     *   policy = EFFECT PERMISSION IF (ALL | ANY) COLON ruleSets
-     */
-    private parsePolicy;
-    /**
-     * Parses a sequence of rule sets (groups) until a new policy starts or EOF.
-     */
-    private parseRuleSets;
-    /**
-     * Parses a single group, e.g. "all of:" or "any of:", and returns a RuleSet.
-     */
-    private parseGroup;
-    /**
-     * Parses a single rule: subject operator value
-     */
-    private parseRule;
-    /**
-     * Parses the comparison operator part of a rule.
-     * Returns both the resulting AbilityCondition and the token type that was consumed.
-     */
-    private parseConditionOperator;
-    /**
-     * Helper to match and consume a specific word token (KEYWORD or IDENTIFIER).
-     * @param word The exact string to look for.
-     * @returns True if the next token has that value.
-     */
-    private matchWord;
-    private matchSymbol;
-    /**
-     * Parses a resource value. Can be a string literal, number, boolean,
-     * null, a path (identifier), or an array.
-     */
-    private parseValue;
-    /**
-     * Parses an array literal: [ <value>, <value>, ... ]
-     * The opening bracket has already been consumed.
-     */
-    private parseArray;
-    private consumeLeadingComments;
-    private processCommentToken;
-    private takeAnnotations;
-    private syntaxError;
-    private suggest;
-    private levenshteinDistance;
-    private consumeOneOf;
-    private consume;
-    private check;
-    private isStartOfPolicy;
-    private isStartOfGroup;
-    private advance;
-    private peek;
-    private isAtEnd;
-}

package/dist/parsers/dsl/AbilityDSLSyntaxError.d.ts

@@ -1,13 +0,0 @@
-export declare class AbilityDSLSyntaxError extends Error {
-    readonly line: number;
-    readonly column: number;
-    readonly context: string;
-    readonly details: string;
-    private readonly _formattedMessage;
-    private readonly _originalStack?;
-    constructor(line: number, column: number, context: string, // строка DSL + ^ + соседние строки
-    details: string);
-    private static supportsColor;
-    private formatMessage;
-    toString(): string;
-}

package/dist/parsers/dsl/AbilityDSLToken.d.ts

@@ -1,57 +0,0 @@
-import AbilityCode from '../../core/AbilityCode';
-export type TokenType = 'EFFECT' | 'IF' | 'PERMISSION' | 'IDENTIFIER' | 'COLON' | 'COMMA' | 'DOT' | 'LBRACKET' | 'RBRACKET' | 'ALL' | 'ANY' | 'OF' | 'EOF' | 'COMMENT' | 'EQ' | 'CONTAINS' | 'IN' | 'NOT_IN' | 'NOT_CONTAINS' | 'GT' | 'GTE' | 'LT' | 'LTE' | 'NULL' | 'EQ_NULL' | 'NOT_EQ_NULL' | 'NOT_EQ' | 'LEN_GT' | 'LEN_LT' | 'LEN_EQ' | 'ALWAYS' | 'NEVER' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'SYMBOL' | 'KEYWORD' | 'UNKNOWN';
-/**
- * Represents a single token produced by the Ability DSL lexer.
- * Each token carries a type (e.g., EFFECT, IDENTIFIER, STRING) and its raw string value.
- */
-export declare class AbilityDSLToken<Code extends TokenType = TokenType> extends AbilityCode<Code> {
-    /** The literal text of the token as it appeared in the input (e.g., "permit", "user.roles", "admin"). */
-    readonly value: string;
-    /** The line number in DSL */
-    readonly line: number;
-    /** The column in dsl */
-    readonly column: number;
-    constructor(type: Code, value: string, line: number, column: number);
-    /**
-     * Returns a human-readable representation of the token, useful for debugging.
-     * Example output: "AbilityDSLToken([EFFECT] permit"
-     */
-    toString(): string;
-    static readonly EFFECT: TokenType;
-    static readonly IF: TokenType;
-    static readonly PERMISSION: TokenType;
-    static readonly IDENTIFIER: TokenType;
-    static readonly COLON: TokenType;
-    static readonly COMMA: TokenType;
-    static readonly DOT: TokenType;
-    static readonly LBRACKET: TokenType;
-    static readonly RBRACKET: TokenType;
-    static readonly ALL: TokenType;
-    static readonly ANY: TokenType;
-    static readonly OF: TokenType;
-    static readonly EOF: TokenType;
-    static readonly COMMENT: TokenType;
-    static readonly EQ: TokenType;
-    static readonly CONTAINS: TokenType;
-    static readonly IN: TokenType;
-    static readonly NOT_IN: TokenType;
-    static readonly NOT_CONTAINS: TokenType;
-    static readonly GT: TokenType;
-    static readonly GTE: TokenType;
-    static readonly LT: TokenType;
-    static readonly LTE: TokenType;
-    static readonly NULL: TokenType;
-    static readonly EQ_NULL: TokenType;
-    static readonly NOT_EQ_NULL: TokenType;
-    static readonly LEN_GT: TokenType;
-    static readonly LEN_LT: TokenType;
-    static readonly LEN_EQ: TokenType;
-    static readonly NOT_EQ: TokenType;
-    static readonly ALWAYS: TokenType;
-    static readonly NEVER: TokenType;
-    static readonly STRING: TokenType;
-    static readonly NUMBER: TokenType;
-    static readonly BOOLEAN: TokenType;
-    static readonly SYMBOL: TokenType;
-    static readonly KEYWORD: TokenType;
-}

package/dist/parsers/json/AbilityJSONParser.d.ts

@@ -1,22 +0,0 @@
-import { AbilityRule, AbilityRuleConfig } from '../../core/AbilityRule';
-import { AbilityRuleSet, AbilityRuleSetConfig } from '../../core/AbilityRuleSet';
-import { ResourceObject } from '../../core/AbilityTypeGenerator';
-import { AbilityPolicy, AbilityPolicyConfig } from '../../core/AbilityPolicy';
-export declare class AbilityJSONParser {
-    /**
-     * Parses an array of policy configurations into an array of AbilityPolicy instances.
-     * @param configs - Array of policy configurations
-     * @returns Array of AbilityPolicy instances
-     */
-    static parse<Resource extends ResourceObject, Environment = unknown>(configs: readonly AbilityPolicyConfig[]): AbilityPolicy<Resource, Environment>[];
-    static parsePolicy<Resource extends ResourceObject = Record<string, unknown>, Environment = unknown>(config: AbilityPolicyConfig): AbilityPolicy<Resource, Environment>;
-    static parseRule<Resources extends object, Environment = unknown>(config: AbilityRuleConfig): AbilityRule<Resources, Environment>;
-    /**
-     * Parse the config JSON format to Group class instance
-     */
-    static parseRuleSet<Resource extends ResourceObject = Record<string, unknown>, Environment = unknown>(config: AbilityRuleSetConfig): AbilityRuleSet<Resource, Environment>;
-    static ruleToJSON(rule: AbilityRule): AbilityRuleConfig;
-    static ruleSetToJSON(ruleSet: AbilityRuleSet): AbilityRuleSetConfig;
-    static policyToJSON(policy: AbilityPolicy): AbilityPolicyConfig;
-    static toJSON(policies: readonly AbilityPolicy[]): AbilityPolicyConfig[];
-}