@aws-cdk/service-spec-importers 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (114) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +89 -0
  3. package/bin/analyze-db +2 -0
  4. package/bin/diff-db +2 -0
  5. package/bin/import-db +2 -0
  6. package/lib/cli/analyze-db.d.ts +1 -0
  7. package/lib/cli/analyze-db.js +56 -0
  8. package/lib/cli/diff-db.d.ts +1 -0
  9. package/lib/cli/diff-db.js +36 -0
  10. package/lib/cli/import-db.d.ts +1 -0
  11. package/lib/cli/import-db.js +123 -0
  12. package/lib/cli/util.d.ts +4 -0
  13. package/lib/cli/util.js +23 -0
  14. package/lib/db-builder.d.ts +74 -0
  15. package/lib/db-builder.js +144 -0
  16. package/lib/db-diff.d.ts +24 -0
  17. package/lib/db-diff.js +104 -0
  18. package/lib/diff-fmt.d.ts +16 -0
  19. package/lib/diff-fmt.js +218 -0
  20. package/lib/diff-helpers.d.ts +21 -0
  21. package/lib/diff-helpers.js +123 -0
  22. package/lib/importers/import-canned-metrics.d.ts +4 -0
  23. package/lib/importers/import-canned-metrics.js +65 -0
  24. package/lib/importers/import-cloudformation-docs.d.ts +3 -0
  25. package/lib/importers/import-cloudformation-docs.js +44 -0
  26. package/lib/importers/import-cloudformation-registry.d.ts +10 -0
  27. package/lib/importers/import-cloudformation-registry.js +326 -0
  28. package/lib/importers/import-resource-spec.d.ts +67 -0
  29. package/lib/importers/import-resource-spec.js +255 -0
  30. package/lib/importers/import-sam.d.ts +42 -0
  31. package/lib/importers/import-sam.js +115 -0
  32. package/lib/importers/import-stateful-resources.d.ts +3 -0
  33. package/lib/importers/import-stateful-resources.js +12 -0
  34. package/lib/index.d.ts +6 -0
  35. package/lib/index.js +36 -0
  36. package/lib/loaders/index.d.ts +8 -0
  37. package/lib/loaders/index.js +25 -0
  38. package/lib/loaders/load-cloudformation-docs.d.ts +3 -0
  39. package/lib/loaders/load-cloudformation-docs.js +15 -0
  40. package/lib/loaders/load-cloudformation-registry.d.ts +16 -0
  41. package/lib/loaders/load-cloudformation-registry.js +72 -0
  42. package/lib/loaders/load-cloudwatch-console-service-directory.d.ts +3 -0
  43. package/lib/loaders/load-cloudwatch-console-service-directory.js +13 -0
  44. package/lib/loaders/load-resource-spec.d.ts +3 -0
  45. package/lib/loaders/load-resource-spec.js +54 -0
  46. package/lib/loaders/load-sam-schema.d.ts +11 -0
  47. package/lib/loaders/load-sam-schema.js +21 -0
  48. package/lib/loaders/load-sam-spec.d.ts +6 -0
  49. package/lib/loaders/load-sam-spec.js +20 -0
  50. package/lib/loaders/load-stateful-resources.d.ts +3 -0
  51. package/lib/loaders/load-stateful-resources.js +15 -0
  52. package/lib/loaders/loader.d.ts +77 -0
  53. package/lib/loaders/loader.js +181 -0
  54. package/lib/patches/index.d.ts +2 -0
  55. package/lib/patches/index.js +21 -0
  56. package/lib/patches/json-schema-patches.d.ts +70 -0
  57. package/lib/patches/json-schema-patches.js +215 -0
  58. package/lib/patches/registry-patches.d.ts +49 -0
  59. package/lib/patches/registry-patches.js +250 -0
  60. package/lib/patching/field-witnesses.d.ts +18 -0
  61. package/lib/patching/field-witnesses.js +93 -0
  62. package/lib/patching/format-patch-report.d.ts +5 -0
  63. package/lib/patching/format-patch-report.js +157 -0
  64. package/lib/patching/fp/index.d.ts +1 -0
  65. package/lib/patching/fp/index.js +18 -0
  66. package/lib/patching/fp/patch.d.ts +15 -0
  67. package/lib/patching/fp/patch.js +54 -0
  68. package/lib/patching/index.d.ts +6 -0
  69. package/lib/patching/index.js +36 -0
  70. package/lib/patching/json-lens.d.ts +54 -0
  71. package/lib/patching/json-lens.js +10 -0
  72. package/lib/patching/json-patch-set.d.ts +33 -0
  73. package/lib/patching/json-patch-set.js +269 -0
  74. package/lib/patching/patching.d.ts +65 -0
  75. package/lib/patching/patching.js +210 -0
  76. package/lib/patching/reason.d.ts +22 -0
  77. package/lib/patching/reason.js +37 -0
  78. package/lib/printable-tree.d.ts +19 -0
  79. package/lib/printable-tree.js +117 -0
  80. package/lib/report/index.d.ts +1 -0
  81. package/lib/report/index.js +18 -0
  82. package/lib/report/problem-report.d.ts +34 -0
  83. package/lib/report/problem-report.js +119 -0
  84. package/lib/report/sorting.d.ts +4 -0
  85. package/lib/report/sorting.js +29 -0
  86. package/lib/resource-builder.d.ts +88 -0
  87. package/lib/resource-builder.js +331 -0
  88. package/lib/schema-manipulation/unify-schemas.d.ts +8 -0
  89. package/lib/schema-manipulation/unify-schemas.js +213 -0
  90. package/lib/types/cloudformation-docs/CloudFormationDocumentation.d.ts +18 -0
  91. package/lib/types/cloudformation-docs/CloudFormationDocumentation.js +3 -0
  92. package/lib/types/cloudwatch-console-service-directory/CloudWatchConsoleServiceDirectory.d.ts +189 -0
  93. package/lib/types/cloudwatch-console-service-directory/CloudWatchConsoleServiceDirectory.js +12 -0
  94. package/lib/types/index.d.ts +7 -0
  95. package/lib/types/index.js +24 -0
  96. package/lib/types/registry-schema/CloudFormationRegistrySchema.d.ts +169 -0
  97. package/lib/types/registry-schema/CloudFormationRegistrySchema.js +17 -0
  98. package/lib/types/registry-schema/JsonSchema.d.ts +166 -0
  99. package/lib/types/registry-schema/JsonSchema.js +173 -0
  100. package/lib/types/resource-specification/resource-spec.d.ts +83 -0
  101. package/lib/types/resource-specification/resource-spec.js +17 -0
  102. package/lib/types/sam/SamTemplateSchema.d.ts +5 -0
  103. package/lib/types/sam/SamTemplateSchema.js +3 -0
  104. package/lib/types/stateful-resources/StatefulResources.d.ts +8 -0
  105. package/lib/types/stateful-resources/StatefulResources.js +3 -0
  106. package/package.json +119 -0
  107. package/schemas/CloudFormationDocumentation.schema.json +43 -0
  108. package/schemas/CloudFormationRegistryResource.schema.json +818 -0
  109. package/schemas/CloudFormationResourceSpecification.schema.json +184 -0
  110. package/schemas/CloudWatchConsoleServiceDirectory.schema.json +536 -0
  111. package/schemas/ResourceSpecification.schema.json +144 -0
  112. package/schemas/SAMResourceSpecification.schema.json +228 -0
  113. package/schemas/SamTemplateSchema.schema.json +534 -0
  114. package/schemas/StatefulResources.schema.json +30 -0
@@ -0,0 +1,18 @@
1
+ export interface CloudFormationDocumentation {
2
+ /**
3
+ * Mapping type name to type documentation
4
+ *
5
+ * Name will be either:
6
+ *
7
+ * - `AWS::Service::Resource`
8
+ * - `AWS::Service::Resource.PropertyType`
9
+ */
10
+ readonly Types: Record<string, cfndocs.TypeDocumentation>;
11
+ }
12
+ export declare namespace cfndocs {
13
+ interface TypeDocumentation {
14
+ readonly description?: string;
15
+ readonly attributes?: Record<string, string>;
16
+ readonly properties?: Record<string, string>;
17
+ }
18
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ2xvdWRGb3JtYXRpb25Eb2N1bWVudGF0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2Nsb3VkZm9ybWF0aW9uLWRvY3MvQ2xvdWRGb3JtYXRpb25Eb2N1bWVudGF0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgaW50ZXJmYWNlIENsb3VkRm9ybWF0aW9uRG9jdW1lbnRhdGlvbiB7XG4gIC8qKlxuICAgKiBNYXBwaW5nIHR5cGUgbmFtZSB0byB0eXBlIGRvY3VtZW50YXRpb25cbiAgICpcbiAgICogTmFtZSB3aWxsIGJlIGVpdGhlcjpcbiAgICpcbiAgICogLSBgQVdTOjpTZXJ2aWNlOjpSZXNvdXJjZWBcbiAgICogLSBgQVdTOjpTZXJ2aWNlOjpSZXNvdXJjZS5Qcm9wZXJ0eVR5cGVgXG4gICAqL1xuICByZWFkb25seSBUeXBlczogUmVjb3JkPHN0cmluZywgY2ZuZG9jcy5UeXBlRG9jdW1lbnRhdGlvbj47XG59XG5cbmV4cG9ydCBuYW1lc3BhY2UgY2ZuZG9jcyB7XG4gIGV4cG9ydCBpbnRlcmZhY2UgVHlwZURvY3VtZW50YXRpb24ge1xuICAgIHJlYWRvbmx5IGRlc2NyaXB0aW9uPzogc3RyaW5nO1xuICAgIHJlYWRvbmx5IGF0dHJpYnV0ZXM/OiBSZWNvcmQ8c3RyaW5nLCBzdHJpbmc+O1xuICAgIHJlYWRvbmx5IHByb3BlcnRpZXM/OiBSZWNvcmQ8c3RyaW5nLCBzdHJpbmc+O1xuICB9XG59XG4iXX0=
@@ -0,0 +1,189 @@
1
+ /**
2
+ * CloudWatchConsoleServiceDirectory
3
+ *
4
+ * This source of AWS metrics is kindly provided to us
5
+ * by the CloudWatch Explorer team (and used in their console).
6
+ *
7
+ * !! While this file contains types for the full source spec,
8
+ * !! only `metricTemplates` data is currently used.
9
+ */
10
+ export type CloudWatchConsoleServiceDirectory = ServiceDirectoryEntry[];
11
+ export interface ServiceDirectoryEntry {
12
+ readonly id: string;
13
+ readonly dashboard?: string;
14
+ readonly crossServiceDashboard?: string;
15
+ readonly resourceTypes?: ResourceType[];
16
+ readonly controls?: Record<string, Control>;
17
+ readonly metricTemplates?: MetricTemplate[];
18
+ readonly dashboards?: Dashboard[];
19
+ }
20
+ /**
21
+ * A single metric template for a resource
22
+ */
23
+ export interface MetricTemplate {
24
+ readonly id?: string;
25
+ /**
26
+ * CloudFormation resource name
27
+ */
28
+ readonly resourceType: string;
29
+ /**
30
+ * Metric namespace
31
+ */
32
+ readonly namespace: string;
33
+ /**
34
+ * The recommended default period for this set of metrics
35
+ */
36
+ readonly defaultPeriod?: number;
37
+ /**
38
+ * Set of dimensions for this set of metrics
39
+ */
40
+ readonly dimensions: Dimension[];
41
+ /**
42
+ * Set of metrics these dimensions apply to
43
+ */
44
+ readonly metrics: Metric[];
45
+ }
46
+ /**
47
+ * Dimension for this set of metric templates
48
+ */
49
+ export interface Dimension {
50
+ /**
51
+ * Name of the dimension
52
+ */
53
+ readonly dimensionName: string;
54
+ /**
55
+ * Label for this dimension
56
+ */
57
+ readonly labelName?: string;
58
+ /**
59
+ * A potential fixed value for this dimension
60
+ *
61
+ * (Currently unused by the spec reader, but could be used)
62
+ */
63
+ readonly dimensionValue?: string;
64
+ }
65
+ /**
66
+ * A description of an available metric
67
+ */
68
+ export interface Metric {
69
+ /**
70
+ * Id of the metric
71
+ */
72
+ readonly id: string;
73
+ /**
74
+ * Name of the metric
75
+ */
76
+ readonly name: string;
77
+ /**
78
+ * Default (suggested) statistic for this metric
79
+ */
80
+ readonly defaultStat: string;
81
+ /**
82
+ * Default (suggested) period for this metric
83
+ */
84
+ readonly defaultPeriod?: number;
85
+ }
86
+ /**
87
+ *
88
+ * !! Here be dragons
89
+ * !! The following types and associated data are not currently used
90
+ *
91
+ */
92
+ export interface ResourceType {
93
+ readonly type: string;
94
+ readonly keyMetric: string;
95
+ readonly arnRegex?: string;
96
+ readonly identifyingLabels?: string[];
97
+ readonly describe?: string;
98
+ readonly resourceDecorator?: string;
99
+ readonly metricTransformer?: string;
100
+ readonly consoleLink?: string;
101
+ readonly alarmPatterns?: AlarmPattern[];
102
+ readonly nodeNameRegex?: string;
103
+ readonly dashboard?: string;
104
+ readonly isResourceNode?: boolean;
105
+ readonly entityType?: string;
106
+ readonly list?: string;
107
+ readonly drawerDashboard?: string;
108
+ readonly foreignKeys?: ForeignKey[];
109
+ }
110
+ export interface AlarmPattern {
111
+ readonly namespace: string;
112
+ readonly dimensions: Dimension[];
113
+ }
114
+ export interface ForeignKey {
115
+ readonly resourceType: string;
116
+ readonly fields: string[];
117
+ }
118
+ export interface Control {
119
+ readonly type: string;
120
+ readonly resourceType: string;
121
+ readonly labelField: string;
122
+ readonly valueField: string;
123
+ readonly resourceDashboard?: string;
124
+ readonly serviceDashboard?: string;
125
+ }
126
+ export interface Dashboard {
127
+ readonly id: string;
128
+ readonly name?: string;
129
+ readonly dependencies?: Dependency[];
130
+ readonly controls?: string[];
131
+ readonly tables?: Table[];
132
+ readonly rows?: Row[];
133
+ }
134
+ export interface Dependency {
135
+ readonly namespace: string;
136
+ }
137
+ export interface Table {
138
+ readonly resourceType: string;
139
+ readonly columns: string[];
140
+ }
141
+ export interface Row {
142
+ readonly widgets: Widget[];
143
+ }
144
+ export interface Widget {
145
+ readonly type: string;
146
+ readonly width?: number;
147
+ readonly height?: number;
148
+ readonly properties?: WidgetProperties;
149
+ readonly metrics?: WidgetMetric[];
150
+ readonly source?: string;
151
+ }
152
+ export interface WidgetProperties {
153
+ readonly title?: string;
154
+ readonly legend?: WidgetLegend;
155
+ readonly view?: string;
156
+ readonly yAxis?: WidgetYAxis;
157
+ readonly markdown?: string;
158
+ readonly stat?: string;
159
+ readonly metrics?: Array<Array<string | WidgetMetricOptions>>;
160
+ }
161
+ export interface WidgetLegend {
162
+ position: string;
163
+ }
164
+ export interface WidgetYAxis {
165
+ left?: Axis;
166
+ right?: Axis;
167
+ }
168
+ export interface Axis {
169
+ readonly max?: number;
170
+ readonly min?: number;
171
+ readonly showUnits?: boolean;
172
+ readonly label?: string;
173
+ }
174
+ export interface WidgetMetric {
175
+ readonly metricTemplate?: string;
176
+ readonly metricOptions?: WidgetMetricOptions;
177
+ readonly metricExpression?: string;
178
+ readonly resourceType?: string | false;
179
+ }
180
+ export interface WidgetMetricOptions {
181
+ readonly id?: string;
182
+ readonly label?: string;
183
+ readonly visible?: boolean;
184
+ readonly yAxis?: string;
185
+ readonly expression?: string;
186
+ readonly stat?: string;
187
+ readonly period?: number;
188
+ readonly color?: string;
189
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ /**
3
+ * CloudWatchConsoleServiceDirectory
4
+ *
5
+ * This source of AWS metrics is kindly provided to us
6
+ * by the CloudWatch Explorer team (and used in their console).
7
+ *
8
+ * !! While this file contains types for the full source spec,
9
+ * !! only `metricTemplates` data is currently used.
10
+ */
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ2xvdWRXYXRjaENvbnNvbGVTZXJ2aWNlRGlyZWN0b3J5LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2Nsb3Vkd2F0Y2gtY29uc29sZS1zZXJ2aWNlLWRpcmVjdG9yeS9DbG91ZFdhdGNoQ29uc29sZVNlcnZpY2VEaXJlY3RvcnkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7OztHQVFHIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBDbG91ZFdhdGNoQ29uc29sZVNlcnZpY2VEaXJlY3RvcnlcbiAqXG4gKiBUaGlzIHNvdXJjZSBvZiBBV1MgbWV0cmljcyBpcyBraW5kbHkgcHJvdmlkZWQgdG8gdXNcbiAqIGJ5IHRoZSBDbG91ZFdhdGNoIEV4cGxvcmVyIHRlYW0gKGFuZCB1c2VkIGluIHRoZWlyIGNvbnNvbGUpLlxuICpcbiAqICEhIFdoaWxlIHRoaXMgZmlsZSBjb250YWlucyB0eXBlcyBmb3IgdGhlIGZ1bGwgc291cmNlIHNwZWMsXG4gKiAhISBvbmx5IGBtZXRyaWNUZW1wbGF0ZXNgIGRhdGEgaXMgY3VycmVudGx5IHVzZWQuXG4gKi9cblxuZXhwb3J0IHR5cGUgQ2xvdWRXYXRjaENvbnNvbGVTZXJ2aWNlRGlyZWN0b3J5ID0gU2VydmljZURpcmVjdG9yeUVudHJ5W107XG5cbmV4cG9ydCBpbnRlcmZhY2UgU2VydmljZURpcmVjdG9yeUVudHJ5IHtcbiAgcmVhZG9ubHkgaWQ6IHN0cmluZztcbiAgcmVhZG9ubHkgZGFzaGJvYXJkPzogc3RyaW5nO1xuICByZWFkb25seSBjcm9zc1NlcnZpY2VEYXNoYm9hcmQ/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IHJlc291cmNlVHlwZXM/OiBSZXNvdXJjZVR5cGVbXTtcbiAgcmVhZG9ubHkgY29udHJvbHM/OiBSZWNvcmQ8c3RyaW5nLCBDb250cm9sPjtcbiAgcmVhZG9ubHkgbWV0cmljVGVtcGxhdGVzPzogTWV0cmljVGVtcGxhdGVbXTtcbiAgcmVhZG9ubHkgZGFzaGJvYXJkcz86IERhc2hib2FyZFtdO1xufVxuXG4vKipcbiAqIEEgc2luZ2xlIG1ldHJpYyB0ZW1wbGF0ZSBmb3IgYSByZXNvdXJjZVxuICovXG5leHBvcnQgaW50ZXJmYWNlIE1ldHJpY1RlbXBsYXRlIHtcbiAgcmVhZG9ubHkgaWQ/OiBzdHJpbmc7XG4gIC8qKlxuICAgKiBDbG91ZEZvcm1hdGlvbiByZXNvdXJjZSBuYW1lXG4gICAqL1xuICByZWFkb25seSByZXNvdXJjZVR5cGU6IHN0cmluZztcblxuICAvKipcbiAgICogTWV0cmljIG5hbWVzcGFjZVxuICAgKi9cbiAgcmVhZG9ubHkgbmFtZXNwYWNlOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFRoZSByZWNvbW1lbmRlZCBkZWZhdWx0IHBlcmlvZCBmb3IgdGhpcyBzZXQgb2YgbWV0cmljc1xuICAgKi9cbiAgcmVhZG9ubHkgZGVmYXVsdFBlcmlvZD86IG51bWJlcjtcblxuICAvKipcbiAgICogU2V0IG9mIGRpbWVuc2lvbnMgZm9yIHRoaXMgc2V0IG9mIG1ldHJpY3NcbiAgICovXG4gIHJlYWRvbmx5IGRpbWVuc2lvbnM6IERpbWVuc2lvbltdO1xuXG4gIC8qKlxuICAgKiBTZXQgb2YgbWV0cmljcyB0aGVzZSBkaW1lbnNpb25zIGFwcGx5IHRvXG4gICAqL1xuICByZWFkb25seSBtZXRyaWNzOiBNZXRyaWNbXTtcbn1cblxuLyoqXG4gKiBEaW1lbnNpb24gZm9yIHRoaXMgc2V0IG9mIG1ldHJpYyB0ZW1wbGF0ZXNcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBEaW1lbnNpb24ge1xuICAvKipcbiAgICogTmFtZSBvZiB0aGUgZGltZW5zaW9uXG4gICAqL1xuICByZWFkb25seSBkaW1lbnNpb25OYW1lOiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIExhYmVsIGZvciB0aGlzIGRpbWVuc2lvblxuICAgKi9cbiAgcmVhZG9ubHkgbGFiZWxOYW1lPzogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBBIHBvdGVudGlhbCBmaXhlZCB2YWx1ZSBmb3IgdGhpcyBkaW1lbnNpb25cbiAgICpcbiAgICogKEN1cnJlbnRseSB1bnVzZWQgYnkgdGhlIHNwZWMgcmVhZGVyLCBidXQgY291bGQgYmUgdXNlZClcbiAgICovXG4gIHJlYWRvbmx5IGRpbWVuc2lvblZhbHVlPzogc3RyaW5nO1xufVxuXG4vKipcbiAqIEEgZGVzY3JpcHRpb24gb2YgYW4gYXZhaWxhYmxlIG1ldHJpY1xuICovXG5leHBvcnQgaW50ZXJmYWNlIE1ldHJpYyB7XG4gIC8qKlxuICAgKiBJZCBvZiB0aGUgbWV0cmljXG4gICAqL1xuICByZWFkb25seSBpZDogc3RyaW5nO1xuICAvKipcbiAgICogTmFtZSBvZiB0aGUgbWV0cmljXG4gICAqL1xuICByZWFkb25seSBuYW1lOiBzdHJpbmc7XG4gIC8qKlxuICAgKiBEZWZhdWx0IChzdWdnZXN0ZWQpIHN0YXRpc3RpYyBmb3IgdGhpcyBtZXRyaWNcbiAgICovXG4gIHJlYWRvbmx5IGRlZmF1bHRTdGF0OiBzdHJpbmc7XG4gIC8qKlxuICAgKiBEZWZhdWx0IChzdWdnZXN0ZWQpIHBlcmlvZCBmb3IgdGhpcyBtZXRyaWNcbiAgICovXG4gIHJlYWRvbmx5IGRlZmF1bHRQZXJpb2Q/OiBudW1iZXI7XG59XG5cbi8qKlxuICpcbiAqICEhIEhlcmUgYmUgZHJhZ29uc1xuICogISEgVGhlIGZvbGxvd2luZyB0eXBlcyBhbmQgYXNzb2NpYXRlZCBkYXRhIGFyZSBub3QgY3VycmVudGx5IHVzZWRcbiAqXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgUmVzb3VyY2VUeXBlIHtcbiAgcmVhZG9ubHkgdHlwZTogc3RyaW5nO1xuICByZWFkb25seSBrZXlNZXRyaWM6IHN0cmluZztcbiAgcmVhZG9ubHkgYXJuUmVnZXg/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGlkZW50aWZ5aW5nTGFiZWxzPzogc3RyaW5nW107XG4gIHJlYWRvbmx5IGRlc2NyaWJlPzogc3RyaW5nO1xuICByZWFkb25seSByZXNvdXJjZURlY29yYXRvcj86IHN0cmluZztcbiAgcmVhZG9ubHkgbWV0cmljVHJhbnNmb3JtZXI/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGNvbnNvbGVMaW5rPzogc3RyaW5nO1xuICByZWFkb25seSBhbGFybVBhdHRlcm5zPzogQWxhcm1QYXR0ZXJuW107XG4gIHJlYWRvbmx5IG5vZGVOYW1lUmVnZXg/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGRhc2hib2FyZD86IHN0cmluZztcbiAgcmVhZG9ubHkgaXNSZXNvdXJjZU5vZGU/OiBib29sZWFuO1xuICByZWFkb25seSBlbnRpdHlUeXBlPzogc3RyaW5nO1xuICByZWFkb25seSBsaXN0Pzogc3RyaW5nO1xuICByZWFkb25seSBkcmF3ZXJEYXNoYm9hcmQ/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGZvcmVpZ25LZXlzPzogRm9yZWlnbktleVtdO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIEFsYXJtUGF0dGVybiB7XG4gIHJlYWRvbmx5IG5hbWVzcGFjZTogc3RyaW5nO1xuICByZWFkb25seSBkaW1lbnNpb25zOiBEaW1lbnNpb25bXTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBGb3JlaWduS2V5IHtcbiAgcmVhZG9ubHkgcmVzb3VyY2VUeXBlOiBzdHJpbmc7XG4gIHJlYWRvbmx5IGZpZWxkczogc3RyaW5nW107XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQ29udHJvbCB7XG4gIHJlYWRvbmx5IHR5cGU6IHN0cmluZztcbiAgcmVhZG9ubHkgcmVzb3VyY2VUeXBlOiBzdHJpbmc7XG4gIHJlYWRvbmx5IGxhYmVsRmllbGQ6IHN0cmluZztcbiAgcmVhZG9ubHkgdmFsdWVGaWVsZDogc3RyaW5nO1xuICByZWFkb25seSByZXNvdXJjZURhc2hib2FyZD86IHN0cmluZztcbiAgcmVhZG9ubHkgc2VydmljZURhc2hib2FyZD86IHN0cmluZztcbn1cblxuZXhwb3J0IGludGVyZmFjZSBEYXNoYm9hcmQge1xuICByZWFkb25seSBpZDogc3RyaW5nO1xuICByZWFkb25seSBuYW1lPzogc3RyaW5nO1xuICByZWFkb25seSBkZXBlbmRlbmNpZXM/OiBEZXBlbmRlbmN5W107XG4gIHJlYWRvbmx5IGNvbnRyb2xzPzogc3RyaW5nW107XG4gIHJlYWRvbmx5IHRhYmxlcz86IFRhYmxlW107XG4gIHJlYWRvbmx5IHJvd3M/OiBSb3dbXTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBEZXBlbmRlbmN5IHtcbiAgcmVhZG9ubHkgbmFtZXNwYWNlOiBzdHJpbmc7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgVGFibGUge1xuICByZWFkb25seSByZXNvdXJjZVR5cGU6IHN0cmluZztcbiAgcmVhZG9ubHkgY29sdW1uczogc3RyaW5nW107XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgUm93IHtcbiAgcmVhZG9ubHkgd2lkZ2V0czogV2lkZ2V0W107XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgV2lkZ2V0IHtcbiAgcmVhZG9ubHkgdHlwZTogc3RyaW5nO1xuICByZWFkb25seSB3aWR0aD86IG51bWJlcjtcbiAgcmVhZG9ubHkgaGVpZ2h0PzogbnVtYmVyO1xuICByZWFkb25seSBwcm9wZXJ0aWVzPzogV2lkZ2V0UHJvcGVydGllcztcbiAgcmVhZG9ubHkgbWV0cmljcz86IFdpZGdldE1ldHJpY1tdO1xuICByZWFkb25seSBzb3VyY2U/OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgV2lkZ2V0UHJvcGVydGllcyB7XG4gIHJlYWRvbmx5IHRpdGxlPzogc3RyaW5nO1xuICByZWFkb25seSBsZWdlbmQ/OiBXaWRnZXRMZWdlbmQ7XG4gIHJlYWRvbmx5IHZpZXc/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IHlBeGlzPzogV2lkZ2V0WUF4aXM7XG4gIHJlYWRvbmx5IG1hcmtkb3duPzogc3RyaW5nO1xuICByZWFkb25seSBzdGF0Pzogc3RyaW5nO1xuICByZWFkb25seSBtZXRyaWNzPzogQXJyYXk8QXJyYXk8c3RyaW5nIHwgV2lkZ2V0TWV0cmljT3B0aW9ucz4+O1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIFdpZGdldExlZ2VuZCB7XG4gIHBvc2l0aW9uOiBzdHJpbmc7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgV2lkZ2V0WUF4aXMge1xuICBsZWZ0PzogQXhpcztcbiAgcmlnaHQ/OiBBeGlzO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIEF4aXMge1xuICByZWFkb25seSBtYXg/OiBudW1iZXI7XG4gIHJlYWRvbmx5IG1pbj86IG51bWJlcjtcbiAgcmVhZG9ubHkgc2hvd1VuaXRzPzogYm9vbGVhbjtcbiAgcmVhZG9ubHkgbGFiZWw/OiBzdHJpbmc7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgV2lkZ2V0TWV0cmljIHtcbiAgcmVhZG9ubHkgbWV0cmljVGVtcGxhdGU/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IG1ldHJpY09wdGlvbnM/OiBXaWRnZXRNZXRyaWNPcHRpb25zO1xuICByZWFkb25seSBtZXRyaWNFeHByZXNzaW9uPzogc3RyaW5nO1xuICByZWFkb25seSByZXNvdXJjZVR5cGU/OiBzdHJpbmcgfCBmYWxzZTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBXaWRnZXRNZXRyaWNPcHRpb25zIHtcbiAgcmVhZG9ubHkgaWQ/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGxhYmVsPzogc3RyaW5nO1xuICByZWFkb25seSB2aXNpYmxlPzogYm9vbGVhbjtcbiAgcmVhZG9ubHkgeUF4aXM/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IGV4cHJlc3Npb24/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IHN0YXQ/OiBzdHJpbmc7XG4gIHJlYWRvbmx5IHBlcmlvZD86IG51bWJlcjtcbiAgcmVhZG9ubHkgY29sb3I/OiBzdHJpbmc7XG59XG4iXX0=
@@ -0,0 +1,7 @@
1
+ export * from './registry-schema/CloudFormationRegistrySchema';
2
+ export * from './registry-schema/JsonSchema';
3
+ export * from './sam/SamTemplateSchema';
4
+ export * from './resource-specification/resource-spec';
5
+ export * from './cloudformation-docs/CloudFormationDocumentation';
6
+ export * from './stateful-resources/StatefulResources';
7
+ export * from './cloudwatch-console-service-directory/CloudWatchConsoleServiceDirectory';
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./registry-schema/CloudFormationRegistrySchema"), exports);
18
+ __exportStar(require("./registry-schema/JsonSchema"), exports);
19
+ __exportStar(require("./sam/SamTemplateSchema"), exports);
20
+ __exportStar(require("./resource-specification/resource-spec"), exports);
21
+ __exportStar(require("./cloudformation-docs/CloudFormationDocumentation"), exports);
22
+ __exportStar(require("./stateful-resources/StatefulResources"), exports);
23
+ __exportStar(require("./cloudwatch-console-service-directory/CloudWatchConsoleServiceDirectory"), exports);
24
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLGlGQUErRDtBQUMvRCwrREFBNkM7QUFDN0MsMERBQXdDO0FBQ3hDLHlFQUF1RDtBQUN2RCxvRkFBa0U7QUFDbEUseUVBQXVEO0FBQ3ZELDJHQUF5RiIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCAqIGZyb20gJy4vcmVnaXN0cnktc2NoZW1hL0Nsb3VkRm9ybWF0aW9uUmVnaXN0cnlTY2hlbWEnO1xuZXhwb3J0ICogZnJvbSAnLi9yZWdpc3RyeS1zY2hlbWEvSnNvblNjaGVtYSc7XG5leHBvcnQgKiBmcm9tICcuL3NhbS9TYW1UZW1wbGF0ZVNjaGVtYSc7XG5leHBvcnQgKiBmcm9tICcuL3Jlc291cmNlLXNwZWNpZmljYXRpb24vcmVzb3VyY2Utc3BlYyc7XG5leHBvcnQgKiBmcm9tICcuL2Nsb3VkZm9ybWF0aW9uLWRvY3MvQ2xvdWRGb3JtYXRpb25Eb2N1bWVudGF0aW9uJztcbmV4cG9ydCAqIGZyb20gJy4vc3RhdGVmdWwtcmVzb3VyY2VzL1N0YXRlZnVsUmVzb3VyY2VzJztcbmV4cG9ydCAqIGZyb20gJy4vY2xvdWR3YXRjaC1jb25zb2xlLXNlcnZpY2UtZGlyZWN0b3J5L0Nsb3VkV2F0Y2hDb25zb2xlU2VydmljZURpcmVjdG9yeSc7XG4iXX0=
@@ -0,0 +1,169 @@
1
+ import { jsonschema } from './JsonSchema';
2
+ /**
3
+ * Root class of a CloudFormation Resource Registry Schema
4
+ *
5
+ * @see https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html
6
+ */
7
+ export interface CloudFormationRegistryResource extends ImplicitJsonSchemaRecord {
8
+ readonly $schema?: string;
9
+ readonly $comment?: string;
10
+ readonly typeName: string;
11
+ readonly sourceUrl?: string;
12
+ readonly documentationUrl?: string;
13
+ readonly description: string;
14
+ /**
15
+ * JSON pointers for properties that will cause a resource replacement if they are changed
16
+ */
17
+ readonly createOnlyProperties?: string[];
18
+ /**
19
+ * JSON pointers for properties that *may* cause a resource replacement if they are changed
20
+ */
21
+ readonly conditionalCreateOnlyProperties?: string[];
22
+ /**
23
+ * JSON pointers for properties that can only be read, not updated.
24
+ *
25
+ * This is typically used for generated identifiers and such.
26
+ */
27
+ readonly readOnlyProperties?: string[];
28
+ /**
29
+ * JSON pointers for properties that can only be written, never read.
30
+ *
31
+ * This is typically used for secrets.
32
+ */
33
+ readonly writeOnlyProperties?: string[];
34
+ /**
35
+ * The properties that make up the primary identifier of the resource.
36
+ *
37
+ * This is the value that is returned by `{ Ref }`. If there is more than one property
38
+ * they are joined using the symbol `"|"`.
39
+ */
40
+ readonly primaryIdentifier?: string[];
41
+ /**
42
+ * Reusable schema type definitions used in this schema.
43
+ */
44
+ readonly definitions?: Record<string, jsonschema.Schema>;
45
+ readonly handlers?: Handlers;
46
+ /**
47
+ * Whether the resource is taggable
48
+ *
49
+ * @deprecated use 'tagging' instead
50
+ * @default true
51
+ */
52
+ readonly taggable?: boolean;
53
+ /**
54
+ * Extended tagging settings
55
+ */
56
+ readonly tagging?: ResourceTagging;
57
+ /**
58
+ * Not sure what this is
59
+ */
60
+ readonly additionalIdentifiers?: string[][];
61
+ readonly replacementStrategy?: ReplacementStrategy;
62
+ readonly deprecatedProperties?: string[];
63
+ /**
64
+ * How to construct a console link for a resource
65
+ */
66
+ readonly resourceLink?: ResourceLink;
67
+ /**
68
+ * Functions to apply to properties
69
+ *
70
+ * Example:
71
+ *
72
+ * ```
73
+ * "propertyTransform" : {
74
+ * "/properties/DBClusterIdentifier" : "$lowercase(DBClusterIdentifier)",
75
+ * "/properties/DBClusterSnapshotIdentifier" : "$lowercase(DBClusterSnapshotIdentifier)",
76
+ * "/properties/MasterUserSecret/KmsKeyId" : "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])",
77
+ * "/properties/KmsKeyId" : "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", KmsKeyId])",
78
+ * "/properties/PerformanceInsightsKMSKeyId" : "$join([\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\/\", PerformanceInsightsKMSKeyId])"
79
+ * },
80
+ * ```
81
+ */
82
+ readonly propertyTransform?: Record<string, string>;
83
+ /**
84
+ * Technically this should have been canonicalized out, but that will complicate a lot of the rest of the code.
85
+ *
86
+ * So we allow embedded oneOfs/anyOfs, only at the top level.
87
+ */
88
+ readonly oneOf?: CommonTypeCombinatorFields[];
89
+ readonly anyOf?: CommonTypeCombinatorFields[];
90
+ }
91
+ /**
92
+ * Type combinator fields we commonly see at the resource level
93
+ *
94
+ * (They can be nested)
95
+ */
96
+ interface CommonTypeCombinatorFields {
97
+ readonly required?: string[];
98
+ readonly type?: string;
99
+ readonly oneOf?: CommonTypeCombinatorFields[];
100
+ readonly anyOf?: CommonTypeCombinatorFields[];
101
+ readonly allOf?: CommonTypeCombinatorFields[];
102
+ }
103
+ export type ReplacementStrategy = 'delete_then_create';
104
+ export interface Handlers {
105
+ readonly create?: Handler;
106
+ readonly read?: Handler;
107
+ readonly update?: Handler;
108
+ readonly delete?: Handler;
109
+ readonly list?: Handler;
110
+ }
111
+ export interface Handler {
112
+ readonly permissions: string[];
113
+ readonly timeoutInMinutes?: number;
114
+ }
115
+ export type ImplicitJsonSchemaRecord = Omit<jsonschema.RecordLikeObject, 'type'>;
116
+ export interface ResourceTagging {
117
+ /**
118
+ * Whether the resource is taggable
119
+ *
120
+ * @default true
121
+ */
122
+ readonly taggable?: boolean;
123
+ /**
124
+ * Whether this resource type supports tagging resources upon creation.
125
+ *
126
+ * @default true
127
+ */
128
+ readonly tagOnCreate?: boolean;
129
+ /**
130
+ * Whether this resource type supports updating tags during resource update operations.
131
+ *
132
+ * @default true
133
+ */
134
+ readonly tagUpdatable?: boolean;
135
+ /**
136
+ * Whether this resource type supports CloudFormation system tags.
137
+ * @default true
138
+ */
139
+ readonly cloudFormationSystemTags?: boolean;
140
+ /**
141
+ * A reference to where you have defined the Tags property in this resource type schema.
142
+ *
143
+ * @default '/properties/Tags'
144
+ */
145
+ readonly tagProperty?: string;
146
+ }
147
+ export interface ResourceLink {
148
+ /**
149
+ * Example:
150
+ *
151
+ * ```
152
+ * /cloudwatch/home?region=${awsRegion}#logsV2:log-groups/log-group/${LogGroupName}/edit-metric-filter/${MetricName}
153
+ * ```
154
+ */
155
+ readonly templateUri: string;
156
+ /**
157
+ * Example:
158
+ *
159
+ * `{ MetricName: '/MetricName', 'LogGroupName': '/LogGroupName' }`
160
+ */
161
+ readonly mappings?: Record<string, string>;
162
+ }
163
+ /**
164
+ * Turn a JSON pointer into a property name
165
+ *
166
+ * Turns `"/properties/hello"`, which the CloudFormation Registry Schema uses -> `"hello"`.
167
+ */
168
+ export declare function simplePropNameFromJsonPtr(propRef: string): string;
169
+ export {};
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.simplePropNameFromJsonPtr = void 0;
4
+ /**
5
+ * Turn a JSON pointer into a property name
6
+ *
7
+ * Turns `"/properties/hello"`, which the CloudFormation Registry Schema uses -> `"hello"`.
8
+ */
9
+ function simplePropNameFromJsonPtr(propRef) {
10
+ const prefix = '/properties/';
11
+ if (!propRef.startsWith(prefix)) {
12
+ throw new Error(`'${propRef}' should start with '${prefix}'`);
13
+ }
14
+ return propRef.substring(prefix.length);
15
+ }
16
+ exports.simplePropNameFromJsonPtr = simplePropNameFromJsonPtr;
17
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"CloudFormationRegistrySchema.js","sourceRoot":"","sources":["../../../src/types/registry-schema/CloudFormationRegistrySchema.ts"],"names":[],"mappings":";;;AA8LA;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,OAAe;IACvD,MAAM,MAAM,GAAG,cAAc,CAAC;IAC9B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,IAAI,OAAO,wBAAwB,MAAM,GAAG,CAAC,CAAC;KAC/D;IACD,OAAO,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAND,8DAMC","sourcesContent":["import { jsonschema } from './JsonSchema';\n\n/**\n * Root class of a CloudFormation Resource Registry Schema\n *\n * @see https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html\n */\nexport interface CloudFormationRegistryResource extends ImplicitJsonSchemaRecord {\n  readonly $schema?: string;\n  readonly $comment?: string;\n\n  readonly typeName: string;\n  readonly sourceUrl?: string;\n  readonly documentationUrl?: string;\n  readonly description: string;\n\n  /**\n   * JSON pointers for properties that will cause a resource replacement if they are changed\n   */\n  readonly createOnlyProperties?: string[];\n\n  /**\n   * JSON pointers for properties that *may* cause a resource replacement if they are changed\n   */\n  readonly conditionalCreateOnlyProperties?: string[];\n\n  /**\n   * JSON pointers for properties that can only be read, not updated.\n   *\n   * This is typically used for generated identifiers and such.\n   */\n  readonly readOnlyProperties?: string[];\n\n  /**\n   * JSON pointers for properties that can only be written, never read.\n   *\n   * This is typically used for secrets.\n   */\n  readonly writeOnlyProperties?: string[];\n\n  /**\n   * The properties that make up the primary identifier of the resource.\n   *\n   * This is the value that is returned by `{ Ref }`. If there is more than one property\n   * they are joined using the symbol `\"|\"`.\n   */\n  readonly primaryIdentifier?: string[];\n\n  /**\n   * Reusable schema type definitions used in this schema.\n   */\n  readonly definitions?: Record<string, jsonschema.Schema>; // FIXME: Kaizen changed this from ConcreteSchema to fix 1 isue.\n  readonly handlers?: Handlers;\n\n  /**\n   * Whether the resource is taggable\n   *\n   * @deprecated use 'tagging' instead\n   * @default true\n   */\n  readonly taggable?: boolean;\n\n  /**\n   * Extended tagging settings\n   */\n  readonly tagging?: ResourceTagging;\n\n  /**\n   * Not sure what this is\n   */\n  readonly additionalIdentifiers?: string[][];\n  readonly replacementStrategy?: ReplacementStrategy;\n\n  readonly deprecatedProperties?: string[];\n\n  /**\n   * How to construct a console link for a resource\n   */\n  readonly resourceLink?: ResourceLink;\n\n  /**\n   * Functions to apply to properties\n   *\n   * Example:\n   *\n   * ```\n   * \"propertyTransform\" : {\n   *   \"/properties/DBClusterIdentifier\" : \"$lowercase(DBClusterIdentifier)\",\n   *   \"/properties/DBClusterSnapshotIdentifier\" : \"$lowercase(DBClusterSnapshotIdentifier)\",\n   *   \"/properties/MasterUserSecret/KmsKeyId\" : \"$join([\\\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\\\/\\\", KmsKeyId])\",\n   *   \"/properties/KmsKeyId\" : \"$join([\\\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\\\/\\\", KmsKeyId])\",\n   *   \"/properties/PerformanceInsightsKMSKeyId\" : \"$join([\\\"arn:(aws)[-]{0,1}[a-z]{0,2}[-]{0,1}[a-z]{0,3}:kms:[a-z]{2}[-]{1}[a-z]{3,10}[-]{0,1}[a-z]{0,10}[-]{1}[1-3]{1}:[0-9]{12}[:]{1}key\\\\/\\\", PerformanceInsightsKMSKeyId])\"\n   * },\n   * ```\n   */\n  readonly propertyTransform?: Record<string, string>;\n\n  /**\n   * Technically this should have been canonicalized out, but that will complicate a lot of the rest of the code.\n   *\n   * So we allow embedded oneOfs/anyOfs, only at the top level.\n   */\n  readonly oneOf?: CommonTypeCombinatorFields[];\n  readonly anyOf?: CommonTypeCombinatorFields[];\n}\n\n/**\n * Type combinator fields we commonly see at the resource level\n *\n * (They can be nested)\n */\ninterface CommonTypeCombinatorFields {\n  readonly required?: string[];\n  readonly type?: string;\n  readonly oneOf?: CommonTypeCombinatorFields[];\n  readonly anyOf?: CommonTypeCombinatorFields[];\n  readonly allOf?: CommonTypeCombinatorFields[];\n}\n\nexport type ReplacementStrategy = 'delete_then_create';\n\nexport interface Handlers {\n  readonly create?: Handler;\n  readonly read?: Handler;\n  readonly update?: Handler;\n  readonly delete?: Handler;\n  readonly list?: Handler;\n}\n\nexport interface Handler {\n  readonly permissions: string[];\n  readonly timeoutInMinutes?: number;\n}\n\nexport type ImplicitJsonSchemaRecord = Omit<jsonschema.RecordLikeObject, 'type'>;\n\nexport interface ResourceTagging {\n  /**\n   * Whether the resource is taggable\n   *\n   * @default true\n   */\n  readonly taggable?: boolean;\n\n  /**\n   * Whether this resource type supports tagging resources upon creation.\n   *\n   * @default true\n   */\n  readonly tagOnCreate?: boolean;\n\n  /**\n   * Whether this resource type supports updating tags during resource update operations.\n   *\n   * @default true\n   */\n  readonly tagUpdatable?: boolean;\n\n  /**\n   * Whether this resource type supports CloudFormation system tags.\n   * @default true\n   */\n  readonly cloudFormationSystemTags?: boolean;\n\n  /**\n   * A reference to where you have defined the Tags property in this resource type schema.\n   *\n   * @default '/properties/Tags'\n   */\n  readonly tagProperty?: string;\n}\n\nexport interface ResourceLink {\n  /**\n   * Example:\n   *\n   * ```\n   * /cloudwatch/home?region=${awsRegion}#logsV2:log-groups/log-group/${LogGroupName}/edit-metric-filter/${MetricName}\n   * ```\n   */\n  readonly templateUri: string;\n\n  /**\n   * Example:\n   *\n   * `{ MetricName: '/MetricName', 'LogGroupName': '/LogGroupName' }`\n   */\n  readonly mappings?: Record<string, string>;\n}\n\n/**\n * Turn a JSON pointer into a property name\n *\n * Turns `\"/properties/hello\"`, which the CloudFormation Registry Schema uses -> `\"hello\"`.\n */\nexport function simplePropNameFromJsonPtr(propRef: string) {\n  const prefix = '/properties/';\n  if (!propRef.startsWith(prefix)) {\n    throw new Error(`'${propRef}' should start with '${prefix}'`);\n  }\n  return propRef.substring(prefix.length);\n}\n"]}
@@ -0,0 +1,166 @@
1
+ export declare namespace jsonschema {
2
+ type Schema = SingletonSchema | OneOf<Schema> | AnyOf<Schema> | AllOf<Schema>;
3
+ type SingletonSchema = Reference | ConcreteSingletonSchema;
4
+ type ConcreteSchema = ConcreteSingletonSchema | OneOf<ConcreteSchema> | AnyOf<ConcreteSchema> | AllOf<ConcreteSchema>;
5
+ type ConcreteSingletonSchema = Object | String | SchemaArray | Boolean | Number | Null | AnyType;
6
+ type AnyType = true;
7
+ function isAnyType(x: Schema): x is AnyType;
8
+ interface Annotatable {
9
+ readonly $comment?: string;
10
+ readonly description?: string;
11
+ readonly title?: string;
12
+ }
13
+ interface Reference extends Annotatable {
14
+ readonly $ref: string;
15
+ }
16
+ type CombiningSchema<X> = UnionSchema<X> | AllOf<X>;
17
+ type UnionSchema<X> = AnyOf<X> | OneOf<X>;
18
+ function isUnionSchema(x: jsonschema.Schema): x is UnionSchema<jsonschema.Schema>;
19
+ function isUnionSchema(x: jsonschema.ConcreteSchema): x is UnionSchema<jsonschema.ConcreteSchema>;
20
+ function isCombining(x: ConcreteSchema): x is CombiningSchema<ConcreteSchema>;
21
+ function isConcreteSingleton(x: ConcreteSchema): x is ConcreteSingletonSchema;
22
+ function isObject(x: ConcreteSchema): x is Object;
23
+ type Object = MapLikeObject | RecordLikeObject;
24
+ interface AnyOf<S> extends Annotatable {
25
+ readonly anyOf: Array<S>;
26
+ }
27
+ function isAnyOf(x: Schema): x is AnyOf<any>;
28
+ interface OneOf<S> extends Annotatable {
29
+ readonly oneOf: Array<S>;
30
+ }
31
+ function innerSchemas<E extends Schema>(x: CombiningSchema<E>): E[];
32
+ function isOneOf(x: Schema): x is OneOf<any>;
33
+ interface AllOf<S> extends Annotatable {
34
+ readonly allOf: Array<S>;
35
+ }
36
+ function isAllOf(x: Schema): x is AllOf<any>;
37
+ interface MapLikeObject extends Annotatable {
38
+ readonly type: 'object';
39
+ /**
40
+ * additionalProperties validates all keys that aren't otherwise validated by properties or patternProperties
41
+ *
42
+ * @default true
43
+ */
44
+ readonly additionalProperties?: false | Schema;
45
+ readonly patternProperties?: Record<string, Schema>;
46
+ readonly minProperties?: number;
47
+ readonly maxProperties?: number;
48
+ /**
49
+ * Required keys in a map
50
+ *
51
+ * Doesn't really make a whole lot of sense, but this is used to support mixed map/record types.
52
+ */
53
+ readonly required?: string[];
54
+ }
55
+ interface Null extends Annotatable {
56
+ readonly type: 'null';
57
+ }
58
+ type ObjectProperties = Record<string, Schema>;
59
+ interface RecordLikeObject extends Annotatable {
60
+ readonly type: 'object';
61
+ readonly properties: ObjectProperties;
62
+ readonly required?: string[];
63
+ /**
64
+ * FIXME: should be required but some service teams have omitted it.
65
+ */
66
+ readonly additionalProperties?: false;
67
+ /**
68
+ * FIXME: these are weird but oh hey?
69
+ */
70
+ readonly minProperties?: number;
71
+ readonly maxProperties?: number;
72
+ }
73
+ function isRecordLikeObject(x: Object): x is RecordLikeObject;
74
+ function isMapLikeObject(x: Object): x is MapLikeObject;
75
+ interface String extends Annotatable {
76
+ readonly type: 'string';
77
+ readonly default?: string;
78
+ readonly minLength?: number;
79
+ readonly maxLength?: number;
80
+ readonly pattern?: string;
81
+ readonly const?: string;
82
+ readonly enum?: string[];
83
+ readonly format?: 'date-time' | 'uri' | 'timestamp';
84
+ readonly examples?: string[];
85
+ }
86
+ function isString(x: ConcreteSchema): x is String;
87
+ interface Number extends Annotatable {
88
+ readonly type: 'number' | 'integer';
89
+ readonly default?: number;
90
+ readonly enum?: number[];
91
+ readonly minimum?: number;
92
+ readonly maximum?: number;
93
+ readonly format?: 'int64' | 'double';
94
+ readonly multipleOf?: number;
95
+ }
96
+ interface SchemaArray extends Annotatable {
97
+ readonly type: 'array';
98
+ readonly items?: Schema;
99
+ readonly uniqueItems?: boolean;
100
+ /**
101
+ * Whether to treat the order as significant
102
+ *
103
+ * In other words, does this array model a "sequence" or a "multiset".
104
+ *
105
+ * - `true` (default): order is significant, the array is a sequence.
106
+ * - `false`: order is insignificant, the array is a set.
107
+ */
108
+ readonly insertionOrder?: boolean;
109
+ readonly maxItems?: number;
110
+ readonly minItems?: number;
111
+ readonly default?: any[];
112
+ readonly examples?: any[];
113
+ /**
114
+ * Does this array describe full reality?
115
+ *
116
+ * - If `Standard`, real elements must be exactly equal to the given array.
117
+ * - If `AttributeList`, the real array may be a superset of the given array.
118
+ *
119
+ * @see https://github.com/aws-cloudformation/cloudformation-resource-schema#arraytype
120
+ */
121
+ readonly arrayType?: 'AttributeList' | 'Standard';
122
+ }
123
+ function isArray(x: ConcreteSchema): x is SchemaArray;
124
+ interface Boolean extends Annotatable {
125
+ readonly type: 'boolean';
126
+ readonly default?: boolean;
127
+ }
128
+ const RESOLVED_REFERENCE_SYMBOL: unique symbol;
129
+ type IsResolved = {
130
+ /**
131
+ * If the sub-schema was resolved from a reference, the full reference is in here
132
+ */
133
+ readonly [RESOLVED_REFERENCE_SYMBOL]: string | undefined;
134
+ };
135
+ type ResolvedSchema = (Exclude<ConcreteSchema, AnyType> & IsResolved) | AnyType;
136
+ function isResolvedSchema(x: Schema): x is ResolvedSchema;
137
+ /**
138
+ * Returns the full reference if the given sub-schema was resolved from a reference
139
+ */
140
+ function setResolvedReference(x: ConcreteSchema, ref?: string | undefined): ResolvedSchema;
141
+ /**
142
+ * Returns the full reference if the given sub-schema was resolved from a reference
143
+ */
144
+ function resolvedReference(x: jsonschema.Schema): string | undefined;
145
+ /**
146
+ * Returns the reference name (the last part of it), if the given sub-schema was resolved from a reference
147
+ */
148
+ function resolvedReferenceName(x: jsonschema.Schema): string | undefined;
149
+ /**
150
+ * Make a resolver function that will resolve `$ref` entries with respect to the given document root.
151
+ */
152
+ function makeResolver(root: any): (ref: Schema) => ResolvedSchema;
153
+ /**
154
+ * The type of a resolver function
155
+ */
156
+ type Resolver = ReturnType<typeof makeResolver>;
157
+ function isReference(x: Schema): x is Reference;
158
+ interface TopLevelFields {
159
+ readonly $id?: string;
160
+ /**
161
+ * Reusable schema type definitions used in this schema.
162
+ */
163
+ readonly definitions?: Record<string, jsonschema.Schema>;
164
+ }
165
+ type SchemaFile = jsonschema.RecordLikeObject & jsonschema.TopLevelFields;
166
+ }