@propulsionworks/cfn-resource-schemas 0.1.25 → 0.1.27
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.
- package/README.md +52 -1
- package/out/types.d.ts +14 -9
- package/out/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/schemas.ndjson.gz +0 -0
- package/src/types.ts +17 -9
- package/supplemental.ndjson.gz +0 -0
package/README.md
CHANGED
|
@@ -2,10 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
This repository contains the [CloudFormation resource provider schemas](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-type-schemas.html) for the `us-east-1` region.
|
|
4
4
|
|
|
5
|
-
The schemas are checked
|
|
5
|
+
The schemas are checked weekly (on Monday) for changes, and if there are any, a new version of this package is automatically published.
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
|
9
|
+
### Schemas
|
|
10
|
+
|
|
11
|
+
The resource schemas are available via `loadSchemas()`. These are as-published by Amazon, with two additional fields:
|
|
12
|
+
|
|
13
|
+
- `$id`: the original filename, without the `.json` extension
|
|
14
|
+
- `$integrity`: an [Subresource Integrity](https://w3c.github.io/webappsec-subresource-integrity/) value for the schema (excluding `$id` and `$integrity` attributes)
|
|
15
|
+
|
|
9
16
|
```typescript
|
|
10
17
|
import { loadSchemas } from "@propulsionworks/cfn-resource-schemas";
|
|
11
18
|
import { ResourceTypeSchemaWithMeta } from "@propulsionworks/cfn-resource-schemas/types";
|
|
@@ -16,3 +23,47 @@ for await (const schema of schemas) {
|
|
|
16
23
|
// schema is a ResourceTypeSchemaWithMeta
|
|
17
24
|
}
|
|
18
25
|
```
|
|
26
|
+
|
|
27
|
+
### Supplemental
|
|
28
|
+
|
|
29
|
+
Extra data is available via `loadSupplemental()`. This contains improved documentation (sourced from [@aws-cdk/aws-service-spec](https://www.npmjs.com/package/@aws-cdk/aws-service-spec)) and a field `wellKnownType` for some properties that provides more information about the property type not available in the resource schema. At present, the only possible value for this field is `"iam-policy"`, which means that the field should contain a [IAM Policy document](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html).
|
|
30
|
+
|
|
31
|
+
For each resource, definition, and property, a `documentationUrl` value is provided, containing a generated link to the AWS documentation (e.g. [`AWS::Lambda::Function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html)).
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import { loadSupplemental } from "@propulsionworks/cfn-resource-schemas";
|
|
35
|
+
import { ResourceSupplemental } from "@propulsionworks/cfn-resource-schemas/types";
|
|
36
|
+
|
|
37
|
+
const resources = loadSupplemental();
|
|
38
|
+
|
|
39
|
+
for await (const resource of resources) {
|
|
40
|
+
// resource is a ResourceSupplemental
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The supplemental data has the following shape:
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
export type ResourceSupplemental = {
|
|
48
|
+
attributes: ObjectSupplemental;
|
|
49
|
+
definitions: Record<string, ObjectSupplemental>;
|
|
50
|
+
description?: string | undefined;
|
|
51
|
+
documentationUrl?: string | undefined;
|
|
52
|
+
properties: Record<string, PropertySupplemental>;
|
|
53
|
+
typeName: string;
|
|
54
|
+
};
|
|
55
|
+
|
|
56
|
+
export type ObjectSupplemental = {
|
|
57
|
+
description?: string | undefined;
|
|
58
|
+
documentationUrl?: string | undefined;
|
|
59
|
+
properties: Record<string, PropertySupplemental>;
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
export type PropertySupplemental = {
|
|
63
|
+
description?: string | undefined;
|
|
64
|
+
documentationUrl?: string | undefined;
|
|
65
|
+
wellKnownType?: WellKnownType | undefined;
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
export type WellKnownType = "iam-policy";
|
|
69
|
+
```
|
package/out/types.d.ts
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
export type JsonPrimitive = boolean | null | number | string;
|
|
2
|
+
export type JsonValue = JsonPrimitive | JsonValue[] | {
|
|
3
|
+
[key: string]: JsonValue;
|
|
4
|
+
};
|
|
1
5
|
/**
|
|
2
6
|
* A {@link ResourceTypeSchema} with additional metadata.
|
|
3
7
|
*/
|
|
@@ -34,6 +38,7 @@ export type ResourceSupplemental = {
|
|
|
34
38
|
definitions: Record<string, ObjectSupplemental>;
|
|
35
39
|
description?: string | undefined;
|
|
36
40
|
documentationUrl?: string | undefined;
|
|
41
|
+
id: string;
|
|
37
42
|
properties: Record<string, PropertySupplemental>;
|
|
38
43
|
typeName: string;
|
|
39
44
|
};
|
|
@@ -46,11 +51,11 @@ export type JsonSchemaObject = {
|
|
|
46
51
|
additionalProperties?: JsonSchema | undefined;
|
|
47
52
|
allOf?: JsonSchema[] | undefined;
|
|
48
53
|
anyOf?: JsonSchema[] | undefined;
|
|
49
|
-
const?:
|
|
54
|
+
const?: JsonValue;
|
|
50
55
|
contains?: JsonSchema | undefined;
|
|
51
56
|
contentEncoding?: string | undefined;
|
|
52
57
|
contentMediaType?: string | undefined;
|
|
53
|
-
default?:
|
|
58
|
+
default?: JsonValue;
|
|
54
59
|
/**
|
|
55
60
|
* @default {}
|
|
56
61
|
*/
|
|
@@ -58,8 +63,8 @@ export type JsonSchemaObject = {
|
|
|
58
63
|
dependencies?: Record<string, JsonSchema | string[]> | undefined;
|
|
59
64
|
description?: string | undefined;
|
|
60
65
|
else?: JsonSchema | undefined;
|
|
61
|
-
enum?:
|
|
62
|
-
examples?:
|
|
66
|
+
enum?: JsonValue[] | undefined;
|
|
67
|
+
examples?: JsonValue[] | undefined;
|
|
63
68
|
exclusiveMaximum?: number | undefined;
|
|
64
69
|
exclusiveMinimum?: number | undefined;
|
|
65
70
|
format?: string | undefined;
|
|
@@ -286,16 +291,16 @@ export type PropertySchema = {
|
|
|
286
291
|
* @default Standard
|
|
287
292
|
*/
|
|
288
293
|
arrayType?: "Standard" | "AttributeList" | undefined;
|
|
289
|
-
const?:
|
|
294
|
+
const?: JsonValue;
|
|
290
295
|
/**
|
|
291
296
|
* @default true
|
|
292
297
|
*/
|
|
293
298
|
contains?: JsonSchema | undefined;
|
|
294
|
-
default?:
|
|
299
|
+
default?: JsonValue;
|
|
295
300
|
dependencies?: Record<string, PropertySchema | string[]> | undefined;
|
|
296
301
|
description?: string | undefined;
|
|
297
|
-
enum?:
|
|
298
|
-
examples?:
|
|
302
|
+
enum?: JsonValue[] | undefined;
|
|
303
|
+
examples?: JsonValue[] | undefined;
|
|
299
304
|
exclusiveMaximum?: number | undefined;
|
|
300
305
|
exclusiveMinimum?: number | undefined;
|
|
301
306
|
format?: string | undefined;
|
|
@@ -340,7 +345,7 @@ export type PropertySchema = {
|
|
|
340
345
|
multipleOf?: number | undefined;
|
|
341
346
|
oneOf?: PropertySchema[] | undefined;
|
|
342
347
|
pattern?: string | undefined;
|
|
343
|
-
patternProperties?: Record<string,
|
|
348
|
+
patternProperties?: Record<string, PropertySchema> | undefined;
|
|
344
349
|
properties?: Record<string, PropertySchema> | undefined;
|
|
345
350
|
relationshipRef?: RelationshipRef | undefined;
|
|
346
351
|
/**
|
package/out/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,kBAAkB,CAAC;AAEvB;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,kBAAkB,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAChD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IACjD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,eAAe,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACzC,oBAAoB,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC9C,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC;AAE7D,MAAM,MAAM,SAAS,GACjB,aAAa,GACb,SAAS,EAAE,GACX;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,kBAAkB,CAAC;AAEvB;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,kBAAkB,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAChD,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IACjD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,eAAe,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACzC,oBAAoB,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC9C,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC;IACrD,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC;IACjE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACnC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,EAAE,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,GAAG,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,KAAK,CAAC,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC;IAC3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC;IACpD,aAAa,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,cAAc,GAAG,cAAc,EAAE,GAAG,SAAS,CAAC;IACrD;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,OAAO,CAAC;AAEpD,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,SAAS,GACT,SAAS,GACT,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,SAAS,CAAC;IAC/C,oBAAoB,EAAE,KAAK,CAAC;IAC5B,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,+BAA+B,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACvD;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;IACzD;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC3C,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC3C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IACvD;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAC;IAClD,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IACtD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,OAAO,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACvC,MAAM,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACvC,IAAI,CAAC,EAAE,mCAAmC,GAAG,SAAS,CAAC;IACvD,IAAI,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IACrC,MAAM,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/C,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;IACzD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,oBAAoB,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IACzC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS,CAAC;IACrD,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAClC,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC;IACrE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACnC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;IAC/D,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,SAAS,CAAC;IACxD,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,cAAc,GAAG,cAAc,EAAE,GAAG,SAAS,CAAC;IACrD;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oBAAoB,EAAE,KAAK,CAAC;IAC5B,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC5C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,oBAAoB,CAAC;AAE9E,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IAC1C,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;IACrC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;CACjC,CAAC"}
|
package/package.json
CHANGED
package/schemas.ndjson.gz
CHANGED
|
Binary file
|
package/src/types.ts
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
export type JsonPrimitive = boolean | null | number | string;
|
|
2
|
+
|
|
3
|
+
export type JsonValue =
|
|
4
|
+
| JsonPrimitive
|
|
5
|
+
| JsonValue[]
|
|
6
|
+
| { [key: string]: JsonValue };
|
|
7
|
+
|
|
1
8
|
/**
|
|
2
9
|
* A {@link ResourceTypeSchema} with additional metadata.
|
|
3
10
|
*/
|
|
@@ -38,6 +45,7 @@ export type ResourceSupplemental = {
|
|
|
38
45
|
definitions: Record<string, ObjectSupplemental>;
|
|
39
46
|
description?: string | undefined;
|
|
40
47
|
documentationUrl?: string | undefined;
|
|
48
|
+
id: string;
|
|
41
49
|
properties: Record<string, PropertySupplemental>;
|
|
42
50
|
typeName: string;
|
|
43
51
|
};
|
|
@@ -51,11 +59,11 @@ export type JsonSchemaObject = {
|
|
|
51
59
|
additionalProperties?: JsonSchema | undefined;
|
|
52
60
|
allOf?: JsonSchema[] | undefined;
|
|
53
61
|
anyOf?: JsonSchema[] | undefined;
|
|
54
|
-
const?:
|
|
62
|
+
const?: JsonValue;
|
|
55
63
|
contains?: JsonSchema | undefined;
|
|
56
64
|
contentEncoding?: string | undefined;
|
|
57
65
|
contentMediaType?: string | undefined;
|
|
58
|
-
default?:
|
|
66
|
+
default?: JsonValue;
|
|
59
67
|
/**
|
|
60
68
|
* @default {}
|
|
61
69
|
*/
|
|
@@ -63,8 +71,8 @@ export type JsonSchemaObject = {
|
|
|
63
71
|
dependencies?: Record<string, JsonSchema | string[]> | undefined;
|
|
64
72
|
description?: string | undefined;
|
|
65
73
|
else?: JsonSchema | undefined;
|
|
66
|
-
enum?:
|
|
67
|
-
examples?:
|
|
74
|
+
enum?: JsonValue[] | undefined;
|
|
75
|
+
examples?: JsonValue[] | undefined;
|
|
68
76
|
exclusiveMaximum?: number | undefined;
|
|
69
77
|
exclusiveMinimum?: number | undefined;
|
|
70
78
|
format?: string | undefined;
|
|
@@ -305,16 +313,16 @@ export type PropertySchema = {
|
|
|
305
313
|
* @default Standard
|
|
306
314
|
*/
|
|
307
315
|
arrayType?: "Standard" | "AttributeList" | undefined;
|
|
308
|
-
const?:
|
|
316
|
+
const?: JsonValue;
|
|
309
317
|
/**
|
|
310
318
|
* @default true
|
|
311
319
|
*/
|
|
312
320
|
contains?: JsonSchema | undefined;
|
|
313
|
-
default?:
|
|
321
|
+
default?: JsonValue;
|
|
314
322
|
dependencies?: Record<string, PropertySchema | string[]> | undefined;
|
|
315
323
|
description?: string | undefined;
|
|
316
|
-
enum?:
|
|
317
|
-
examples?:
|
|
324
|
+
enum?: JsonValue[] | undefined;
|
|
325
|
+
examples?: JsonValue[] | undefined;
|
|
318
326
|
exclusiveMaximum?: number | undefined;
|
|
319
327
|
exclusiveMinimum?: number | undefined;
|
|
320
328
|
format?: string | undefined;
|
|
@@ -359,7 +367,7 @@ export type PropertySchema = {
|
|
|
359
367
|
multipleOf?: number | undefined;
|
|
360
368
|
oneOf?: PropertySchema[] | undefined;
|
|
361
369
|
pattern?: string | undefined;
|
|
362
|
-
patternProperties?: Record<string,
|
|
370
|
+
patternProperties?: Record<string, PropertySchema> | undefined;
|
|
363
371
|
properties?: Record<string, PropertySchema> | undefined;
|
|
364
372
|
relationshipRef?: RelationshipRef | undefined;
|
|
365
373
|
/**
|
package/supplemental.ndjson.gz
CHANGED
|
Binary file
|