# All files / lib index.ts

76.71% Statements 56/73
51.85% Branches 14/27
88.23% Functions 15/17
76.11% Lines 51/67

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    1848x

    8x
    8x
    8x

    8x

    1752x

    8x

    2x

    8x
    11x
    11x

    11x

    8x
    2x
    2x
    2x

    2x

    8x
    6x
    6x

    6x

    8x

    3x

    3x

    8x
    7x
    7x

    7x

    8x
    872x

    8x
    1734x

    8x
    869x

    869x
    869x
    869x
    753423x
    879x
    879x
    2604477x
    3108x

    869x
    869x

    869x
    751689x
    2x
    1x

    867x

    8x

    8x

     import * as crypto from 'crypto';
    import { CfnLintFileSchema } from './_private_schema/cfn-lint';
    import * as schema from './schema';
    export { schema };
    export * from './canned-metrics';

    /**
     * The complete AWS CloudFormation Resource specification, having any CDK patches and enhancements included in it.
     */
    export function specification(): schema.Specification {
      // eslint-disable-next-line @typescript-eslint/no-require-imports
      return require('../spec/specification.json');
    }

    /**
     * The complete AWS CloudFormation Resource specification, having any CDK patches and enhancements included in it.
     */
    export function docs(): schema.CloudFormationDocsFile {
      // eslint-disable-next-line @typescript-eslint/no-require-imports
      return require('../spec/cfn-docs.json');
    }

    /**
     * Return the resource specification for the given typename
     *
     * Validates that the resource exists. If you don't want this validating behavior, read from
     * specification() directly.
     */
    export function resourceSpecification(typeName: string): schema.ResourceType {
      const ret = specification().ResourceTypes[typeName];
      Iif (!ret) {
        throw new Error(`No such resource type: ${typeName}`);
      }
      return ret;
    }

    /**
     * Return documentation for the given type
     */
    export function typeDocs(resourceName: string, propertyTypeName?: string): schema.CloudFormationTypeDocs {
      const key = propertyTypeName ? `${resourceName}.${propertyTypeName}` : resourceName;
      const ret = docs().Types[key];
      Iif (!ret) {
        return {
          description: '',
          properties: {},
        };
      }
      return ret;
    }

    /**
     * Get the resource augmentations for a given type
     */
    export function resourceAugmentation(typeName: string): schema.ResourceAugmentation {
      const fileName = typeName.replace(/::/g, '_');
      try {
        // eslint-disable-next-line @typescript-eslint/no-require-imports
        return require(`./augmentations/${fileName}.json`);
      } catch (e) {
        return {};
      }
    }

    /**
     * Get the resource augmentations for a given type
     */
    export function cfnLintAnnotations(typeName: string): schema.CfnLintResourceAnnotations {
      // eslint-disable-next-line @typescript-eslint/no-require-imports
      const allAnnotations: CfnLintFileSchema = require('../spec/cfn-lint.json');

      return {
        stateful: !!allAnnotations.StatefulResources.ResourceTypes[typeName],
        mustBeEmptyToDelete: allAnnotations.StatefulResources.ResourceTypes[typeName]?.DeleteRequiresEmptyResource ?? false,
      };
    }

    /**
     * Return the property specification for the given resource's property
     */
    export function propertySpecification(typeName: string, propertyName: string): schema.Property {
      const ret = resourceSpecification(typeName).Properties![propertyName];
      Iif (!ret) {
        throw new Error(`Resource ${typeName} has no property: ${propertyName}`);
      }
      return ret;
    }

    /**
     * The list of resource type names defined in the ``specification``.
     */
    export function resourceTypes() {
      return Object.keys(specification().ResourceTypes);
    }

    /**
     * The list of namespaces defined in the ``specification``, that is resource name prefixes down to the second ``::``.
     */
    export function namespaces() {
      return Array.from(new Set(resourceTypes().map(n => n.split('::', 2).join('::'))));
    }

    /**
     * Obtain a filtered version of the AWS CloudFormation specification.
     *
     * @param filter the predicate to be used in order to filter which resource types from the ``Specification`` to extract.
     *         When passed as a ``string``, only the specified resource type will be extracted. When passed as a
     *         ``RegExp``, all matching resource types will be extracted. When passed as a ``function``, all resource
     *         types for which the function returned ``true`` will be extracted.
     *
     * @return a coherent sub-set of the AWS CloudFormation Resource specification, including all property types related
     *     to the selected resource types.
     */
    export function filteredSpecification(filter: string | RegExp | Filter): schema.Specification {
      const spec = specification();

      const result: schema.Specification = { ResourceTypes: {}, PropertyTypes: {}, Fingerprint: spec.Fingerprint };
      const predicate: Filter = makePredicate(filter);
      for (const type of resourceTypes()) {
        if (!predicate(type)) { continue; }
        result.ResourceTypes[type] = spec.ResourceTypes[type];
        const prefix = `${type}.`;
        for (const propType of Object.keys(spec.PropertyTypes!).filter(n => n.startsWith(prefix))) {
          result.PropertyTypes[propType] = spec.PropertyTypes![propType];
        }
      }
      result.Fingerprint = crypto.createHash('sha256').update(JSON.stringify(result)).digest('base64');
      return result;
    }

    export type Filter = (name: string) => boolean;

    /**
     * Creates a predicate function from a given filter.
     *
     * @param filter when provided as a ``string``, performs an exact match comparison.
     *         when provided as a ``RegExp``, performs uses ``str.match(RegExp)``.
     *         when provided as a ``function``, use the function as-is.
     *
     * @returns a predicate function.
     */
    function makePredicate(filter: string | RegExp | Filter): Filter {
      if (typeof filter === 'string') {
        return s => s === filter;
      } else if (typeof filter === 'function') {
        return filter as Filter;
      } else {
        return s => s.match(filter) != null;
      }
    }

    /**
     * Return the properties of the given type that require the given scrutiny type
     */
    export function scrutinizablePropertyNames(resourceType: string, scrutinyTypes: schema.PropertyScrutinyType[]): string[] {
      const impl = specification().ResourceTypes[resourceType];
      Iif (!impl) { return []; }

      const ret = new Array<string>();

      for (const [propertyName, propertySpec] of Object.entries(impl.Properties || {})) {
        Iif (scrutinyTypes.includes(propertySpec.ScrutinyType || schema.PropertyScrutinyType.None)) {
          ret.push(propertyName);
        }
      }

      return ret;
    }

    /**
     * Return the names of the resource types that need to be subjected to additional scrutiny
     */
    export function scrutinizableResourceTypes(scrutinyTypes: schema.ResourceScrutinyType[]): string[] {
      const ret = new Array<string>();
      for (const [resourceType, resourceSpec] of Object.entries(specification().ResourceTypes)) {
        Iif (scrutinyTypes.includes(resourceSpec.ScrutinyType || schema.ResourceScrutinyType.None)) {
          ret.push(resourceType);
        }
      }

      return ret;
    }