@empire-builder-kit/nx 1.0.0-beta.9 → 1.0.0-rc.2

package/src/schemas/api-contract-compatibility-report-v1.json

@@ -0,0 +1,126 @@
+{
+  "$id": "https://empirebuilderkit.dev/schemas/api-contract-compatibility-report-v1.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$defs": {
+    "artifact": {
+      "additionalProperties": false,
+      "properties": {
+        "digest": {
+          "pattern": "^[a-f0-9]{64}$",
+          "type": "string"
+        },
+        "version": {
+          "maxLength": 256,
+          "pattern": "^(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)$",
+          "type": "string"
+        }
+      },
+      "required": ["digest", "version"],
+      "type": "object"
+    },
+    "classification": {
+      "enum": ["compatible", "conditionally-compatible", "breaking"]
+    },
+    "finding": {
+      "additionalProperties": false,
+      "properties": {
+        "classification": { "$ref": "#/$defs/classification" },
+        "code": {
+          "enum": [
+            "contract-slice-changed",
+            "contract-title-changed",
+            "contract-version-advanced",
+            "contract-version-regressed",
+            "operation-added",
+            "operation-removed",
+            "http-method-changed",
+            "route-changed",
+            "authentication-changed",
+            "authorization-actions-changed",
+            "success-status-changed",
+            "feature-changed",
+            "summary-changed",
+            "operation-lifecycle-changed",
+            "problem-added",
+            "problem-removed",
+            "problem-changed",
+            "idempotency-added",
+            "idempotency-removed",
+            "idempotency-changed",
+            "pagination-added",
+            "pagination-removed",
+            "pagination-changed",
+            "conditional-write-added",
+            "conditional-write-removed",
+            "conditional-write-changed",
+            "request-location-added",
+            "request-location-removed",
+            "request-body-limit-changed",
+            "request-property-added",
+            "request-property-removed",
+            "request-required-added",
+            "request-required-removed",
+            "response-property-added",
+            "response-property-removed",
+            "response-required-added",
+            "response-required-removed",
+            "schema-type-widened",
+            "schema-type-narrowed",
+            "schema-type-changed",
+            "schema-nullability-changed",
+            "schema-enum-expanded",
+            "schema-enum-narrowed",
+            "schema-constraint-widened",
+            "schema-constraint-narrowed",
+            "schema-format-changed",
+            "schema-additional-properties-changed",
+            "schema-composition-changed",
+            "schema-const-changed",
+            "schema-description-changed",
+            "schema-review-required"
+          ]
+        },
+        "location": { "enum": ["baseline", "candidate"] },
+        "operationId": {
+          "pattern": "^[a-z][a-z0-9-]*\\.[a-z][a-z0-9.-]*$",
+          "type": "string"
+        },
+        "pointer": { "pattern": "^/", "type": "string" },
+        "summary": {
+          "maxLength": 1024,
+          "minLength": 1,
+          "type": "string"
+        }
+      },
+      "required": ["classification", "code", "location", "pointer", "summary"],
+      "type": "object"
+    },
+    "slice": {
+      "pattern": "^[a-z][a-z0-9-]{0,62}$",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "baseline": { "$ref": "#/$defs/artifact" },
+    "candidate": { "$ref": "#/$defs/artifact" },
+    "classification": { "$ref": "#/$defs/classification" },
+    "findings": {
+      "items": { "$ref": "#/$defs/finding" },
+      "type": "array"
+    },
+    "kind": { "const": "api-contract-compatibility-report" },
+    "schemaVersion": { "const": 1 },
+    "slice": { "$ref": "#/$defs/slice" }
+  },
+  "required": [
+    "baseline",
+    "candidate",
+    "classification",
+    "findings",
+    "kind",
+    "schemaVersion",
+    "slice"
+  ],
+  "type": "object"
+}

package/src/schemas/aws-billing-actual-evidence-v1.json

@@ -0,0 +1,407 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://empire-builder-kit.dev/schemas/aws-billing-actual-evidence-v1.json",
+  "title": "Empire Builder Kit AWS billing-actual evidence v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "aggregateCounts",
+    "allocations",
+    "authority",
+    "collectedAt",
+    "collection",
+    "collectorIdentity",
+    "environment",
+    "kind",
+    "materialDigest",
+    "period",
+    "queries",
+    "reconciliation",
+    "release",
+    "schemaVersion"
+  ],
+  "properties": {
+    "aggregateCounts": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "aggregateId",
+          "capabilityId",
+          "count",
+          "evidenceDigest",
+          "sourceRef"
+        ],
+        "properties": {
+          "aggregateId": { "$ref": "#/$defs/reference" },
+          "capabilityId": { "$ref": "#/$defs/reference" },
+          "count": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 9007199254740991
+          },
+          "evidenceDigest": { "$ref": "#/$defs/digest" },
+          "sourceRef": { "$ref": "#/$defs/reference" }
+        }
+      }
+    },
+    "allocations": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "allocatedCostUsd",
+          "allocationId",
+          "capabilityId",
+          "sourceRowDigest"
+        ],
+        "properties": {
+          "allocatedCostUsd": {
+            "type": "number",
+            "exclusiveMinimum": 0,
+            "maximum": 999999999
+          },
+          "allocationId": { "$ref": "#/$defs/reference" },
+          "capabilityId": { "$ref": "#/$defs/reference" },
+          "sourceRowDigest": { "$ref": "#/$defs/digest" }
+        }
+      }
+    },
+    "authority": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["collector", "mode", "provider"],
+      "properties": {
+        "collector": { "const": "ebk-aws-cost-explorer-v1" },
+        "mode": { "const": "external-read-only" },
+        "provider": { "const": "aws-billing-actual" }
+      }
+    },
+    "collectedAt": { "$ref": "#/$defs/instant" },
+    "collection": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "aggregateArtifact",
+        "releaseArtifact",
+        "repository",
+        "runAttempt",
+        "runId",
+        "sourceCommit",
+        "workflow"
+      ],
+      "properties": {
+        "aggregateArtifact": { "$ref": "#/$defs/inputArtifact" },
+        "releaseArtifact": { "$ref": "#/$defs/inputArtifact" },
+        "repository": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$"
+        },
+        "runAttempt": {
+          "type": "string",
+          "pattern": "^[1-9][0-9]{0,8}$"
+        },
+        "runId": {
+          "type": "string",
+          "pattern": "^[1-9][0-9]{0,19}$"
+        },
+        "sourceCommit": {
+          "type": "string",
+          "pattern": "^(?:[a-f0-9]{40}|[a-f0-9]{64})$"
+        },
+        "workflow": {
+          "const": ".github/workflows/performance-cost-actual.yml"
+        }
+      }
+    },
+    "collectorIdentity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["callerIdentityRequestId"],
+      "properties": {
+        "callerIdentityRequestId": { "$ref": "#/$defs/reference" }
+      }
+    },
+    "environment": { "$ref": "#/$defs/environment" },
+    "kind": { "const": "ebk-aws-billing-actual-evidence" },
+    "materialDigest": { "$ref": "#/$defs/digest" },
+    "period": { "$ref": "#/$defs/period" },
+    "queries": {
+      "type": "array",
+      "minItems": 2,
+      "maxItems": 2,
+      "prefixItems": [
+        { "$ref": "#/$defs/allocationQuery" },
+        { "$ref": "#/$defs/totalQuery" }
+      ],
+      "items": false
+    },
+    "reconciliation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "allocatedCostUsd",
+        "allocationCount",
+        "billedCostUsd",
+        "differenceUsd"
+      ],
+      "properties": {
+        "allocatedCostUsd": {
+          "type": "number",
+          "exclusiveMinimum": 0,
+          "maximum": 999999999
+        },
+        "allocationCount": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 32
+        },
+        "billedCostUsd": {
+          "type": "number",
+          "exclusiveMinimum": 0,
+          "maximum": 999999999
+        },
+        "differenceUsd": { "const": 0 }
+      }
+    },
+    "release": { "$ref": "#/$defs/release" },
+    "schemaVersion": { "const": 1 }
+  },
+  "$defs": {
+    "allocationQuery": {
+      "allOf": [
+        { "$ref": "#/$defs/queryBase" },
+        {
+          "type": "object",
+          "properties": {
+            "purpose": { "const": "allocation" },
+            "request": {
+              "allOf": [
+                { "$ref": "#/$defs/requestBase" },
+                {
+                  "type": "object",
+                  "properties": {
+                    "groupBy": {
+                      "type": "object",
+                      "additionalProperties": false,
+                      "required": ["key", "type"],
+                      "properties": {
+                        "key": { "const": "ebk:cost-allocation" },
+                        "type": { "const": "TAG" }
+                      }
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      ]
+    },
+    "date": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+    },
+    "digest": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "environment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "accountFingerprint",
+        "region",
+        "slice",
+        "stage",
+        "workspace"
+      ],
+      "properties": {
+        "accountFingerprint": {
+          "type": "string",
+          "pattern": "^sha256:[a-f0-9]{64}$"
+        },
+        "region": {
+          "type": "string",
+          "pattern": "^(?:af|ap|ca|cn|eu|il|me|mx|sa|us)(?:-gov|-iso|-isob)?-[a-z]+-\\d$"
+        },
+        "slice": { "$ref": "#/$defs/reference" },
+        "stage": { "enum": ["production", "staging"] },
+        "workspace": { "$ref": "#/$defs/reference" }
+      }
+    },
+    "filter": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["tags"],
+      "properties": {
+        "tags": {
+          "type": "array",
+          "minItems": 3,
+          "maxItems": 3,
+          "prefixItems": [
+            { "$ref": "#/$defs/workspaceTag" },
+            { "$ref": "#/$defs/sliceTag" },
+            { "$ref": "#/$defs/stageTag" }
+          ],
+          "items": false
+        }
+      }
+    },
+    "instant": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?Z$"
+    },
+    "inputArtifact": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "runId", "sha256"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$"
+        },
+        "runId": {
+          "type": "string",
+          "pattern": "^[1-9][0-9]{0,19}$"
+        },
+        "sha256": { "$ref": "#/$defs/digest" }
+      }
+    },
+    "period": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["end", "start"],
+      "properties": {
+        "end": { "$ref": "#/$defs/instant" },
+        "start": { "$ref": "#/$defs/instant" }
+      }
+    },
+    "queryBase": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "operation",
+        "purpose",
+        "request",
+        "requestDigest",
+        "requestId",
+        "responseDigest"
+      ],
+      "properties": {
+        "operation": { "const": "ce:GetCostAndUsage" },
+        "purpose": { "enum": ["allocation", "total"] },
+        "request": {},
+        "requestDigest": { "$ref": "#/$defs/digest" },
+        "requestId": { "$ref": "#/$defs/reference" },
+        "responseDigest": { "$ref": "#/$defs/digest" }
+      }
+    },
+    "reference": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "pattern": "^[A-Za-z0-9.][A-Za-z0-9._:/#@+\\-]*$"
+    },
+    "release": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "candidateDigest",
+        "releaseId",
+        "releaseMaterialDigest",
+        "sourceCommit"
+      ],
+      "properties": {
+        "candidateDigest": { "$ref": "#/$defs/digest" },
+        "releaseId": { "$ref": "#/$defs/reference" },
+        "releaseMaterialDigest": { "$ref": "#/$defs/digest" },
+        "sourceCommit": {
+          "type": "string",
+          "pattern": "^(?:[a-f0-9]{40}|[a-f0-9]{64})$"
+        }
+      }
+    },
+    "requestBase": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "filter",
+        "granularity",
+        "groupBy",
+        "metric",
+        "operation",
+        "timePeriod"
+      ],
+      "properties": {
+        "filter": { "$ref": "#/$defs/filter" },
+        "granularity": { "const": "MONTHLY" },
+        "groupBy": {},
+        "metric": { "const": "UnblendedCost" },
+        "operation": { "const": "ce:GetCostAndUsage" },
+        "timePeriod": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["end", "start"],
+          "properties": {
+            "end": { "$ref": "#/$defs/date" },
+            "start": { "$ref": "#/$defs/date" }
+          }
+        }
+      }
+    },
+    "sliceTag": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "value"],
+      "properties": {
+        "key": { "const": "ebk:slice" },
+        "value": { "$ref": "#/$defs/reference" }
+      }
+    },
+    "stageTag": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "value"],
+      "properties": {
+        "key": { "const": "ebk:stage" },
+        "value": { "enum": ["production", "staging"] }
+      }
+    },
+    "totalQuery": {
+      "allOf": [
+        { "$ref": "#/$defs/queryBase" },
+        {
+          "type": "object",
+          "properties": {
+            "purpose": { "const": "total" },
+            "request": {
+              "allOf": [
+                { "$ref": "#/$defs/requestBase" },
+                {
+                  "type": "object",
+                  "properties": { "groupBy": { "type": "null" } }
+                }
+              ]
+            }
+          }
+        }
+      ]
+    },
+    "workspaceTag": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "value"],
+      "properties": {
+        "key": { "const": "ebk:workspace" },
+        "value": { "$ref": "#/$defs/reference" }
+      }
+    }
+  }
+}

package/src/schemas/blueprint-v1.json

@@ -142,9 +142,26 @@
       "pattern": "^(?:@[a-z0-9][a-z0-9._-]*\\/)?[a-z0-9][a-z0-9._-]*$",
       "type": "string"
     },
+    "secrets": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "description": { "minLength": 1, "type": "string" },
+          "documentation": { "pattern": "^\\./", "type": "string" },
+          "name": { "pattern": "^[A-Z][A-Za-z0-9]*$", "type": "string" },
+          "schema": { "pattern": "^\\./", "type": "string" },
+          "valueType": { "enum": ["string", "json", "binary"] }
+        },
+        "required": ["name", "description", "valueType", "documentation"],
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array"
+    },
     "type": { "const": "empire-builder-kit-blueprint" },
     "verification": {
-      "items": { "minLength": 1, "type": "string" },
+      "items": { "const": "verify" },
+      "maxItems": 1,
       "minItems": 1,
       "type": "array",
       "uniqueItems": true