@empire-builder-kit/nx 1.0.0-beta.10

package/src/schemas/blueprint-v1.json

@@ -0,0 +1,186 @@
+{
+  "$id": "https://empirebuilderkit.dev/schemas/blueprint-v1.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string" },
+    "engine": { "minLength": 1, "type": "string" },
+    "foundation": {
+      "$id": "https://empirebuilderkit.dev/schemas/foundation-requirement-v1.json",
+      "$schema": "https://json-schema.org/draft/2020-12/schema",
+      "additionalProperties": false,
+      "properties": {
+        "capabilities": {
+          "items": {
+            "enum": [
+              "network",
+              "routing",
+              "container-compute",
+              "postgres",
+              "identity",
+              "events",
+              "observability",
+              "configuration",
+              "deployment"
+            ],
+            "type": "string"
+          },
+          "type": "array",
+          "uniqueItems": true
+        },
+        "contract": { "minLength": 1, "type": "string" }
+      },
+      "required": ["contract", "capabilities"],
+      "title": "Empire Builder Kit Standard Foundation Requirement v1",
+      "type": "object"
+    },
+    "generator": { "pattern": "^\\./", "type": "string" },
+    "inputs": { "pattern": "^\\./", "type": "string" },
+    "kind": { "const": "slice" },
+    "migrations": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "affectedManagedSurfaces": {
+            "items": { "minLength": 1, "type": "string" },
+            "minItems": 1,
+            "type": "array",
+            "uniqueItems": true
+          },
+          "contracts": {
+            "additionalProperties": false,
+            "properties": {
+              "consumes": {
+                "items": { "minLength": 1, "type": "string" },
+                "type": "array",
+                "uniqueItems": true
+              },
+              "publishes": {
+                "items": { "minLength": 1, "type": "string" },
+                "type": "array",
+                "uniqueItems": true
+              }
+            },
+            "required": ["consumes", "publishes"],
+            "type": "object"
+          },
+          "databaseChange": {
+            "enum": ["none", "ordered", "replacement", "manual"]
+          },
+          "dependencyChanges": {
+            "items": { "minLength": 1, "type": "string" },
+            "type": "array",
+            "uniqueItems": true
+          },
+          "executor": { "pattern": "^\\./", "type": "string" },
+          "from": { "minLength": 1, "type": "string" },
+          "id": { "minLength": 1, "type": "string" },
+          "infrastructureChanges": {
+            "items": { "minLength": 1, "type": "string" },
+            "type": "array",
+            "uniqueItems": true
+          },
+          "maintenanceWindowRequired": { "type": "boolean" },
+          "manualSuccession": { "pattern": "^\\./", "type": "string" },
+          "planSchemaVersion": { "const": 1 },
+          "preflight": {
+            "items": { "minLength": 1, "type": "string" },
+            "minItems": 1,
+            "type": "array",
+            "uniqueItems": true
+          },
+          "rollback": {
+            "additionalProperties": false,
+            "properties": {
+              "afterPointOfNoReturn": { "minLength": 1, "type": "string" },
+              "beforePointOfNoReturn": {
+                "minLength": 1,
+                "type": "string"
+              },
+              "pointOfNoReturn": { "minLength": 1, "type": "string" }
+            },
+            "required": [
+              "beforePointOfNoReturn",
+              "pointOfNoReturn",
+              "afterPointOfNoReturn"
+            ],
+            "type": "object"
+          },
+          "to": {
+            "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?(?:\\+[0-9A-Za-z.-]+)?$",
+            "type": "string"
+          },
+          "verification": {
+            "items": { "minLength": 1, "type": "string" },
+            "minItems": 1,
+            "type": "array",
+            "uniqueItems": true
+          }
+        },
+        "required": [
+          "id",
+          "from",
+          "to",
+          "planSchemaVersion",
+          "affectedManagedSurfaces",
+          "contracts",
+          "dependencyChanges",
+          "infrastructureChanges",
+          "maintenanceWindowRequired",
+          "databaseChange",
+          "preflight",
+          "verification",
+          "rollback",
+          "manualSuccession"
+        ],
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array"
+    },
+    "name": {
+      "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" },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "version": {
+      "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?(?:\\+[0-9A-Za-z.-]+)?$",
+      "type": "string"
+    }
+  },
+  "required": [
+    "type",
+    "name",
+    "version",
+    "engine",
+    "kind",
+    "generator",
+    "inputs",
+    "foundation",
+    "verification"
+  ],
+  "title": "Empire Builder Kit Blueprint Manifest v1",
+  "type": "object"
+}

package/src/schemas/foundation-ownership-v2.json

@@ -0,0 +1,42 @@
+{
+  "$id": "https://empirebuilderkit.dev/schemas/foundation-ownership-v2.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "frameworkVersion": { "minLength": 1, "type": "string" },
+    "kind": { "const": "foundation" },
+    "paths": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "managedJsonPointers": {
+            "items": {
+              "pattern": "^(?:/(?:[^~/]|~[01])*)+$",
+              "type": "string"
+            },
+            "minItems": 1,
+            "type": "array",
+            "uniqueItems": true
+          },
+          "mode": { "enum": ["managed", "seeded"] },
+          "origin": { "const": "framework" },
+          "path": {
+            "minLength": 1,
+            "not": {
+              "pattern": "(^[\\\\/])|(^|[\\\\/])\\.\\.([\\\\/]|$)"
+            },
+            "type": "string"
+          },
+          "sha256": { "pattern": "^[a-f0-9]{64}$", "type": "string" }
+        },
+        "required": ["path", "mode", "origin", "sha256"],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "schemaVersion": { "const": 2 }
+  },
+  "required": ["schemaVersion", "kind", "frameworkVersion", "paths"],
+  "title": "Empire Builder Kit Standard Foundation Ownership Record v2",
+  "type": "object"
+}

package/src/schemas/foundation-requirement-v1.json

@@ -0,0 +1,32 @@
+{
+  "$id": "https://empirebuilderkit.dev/schemas/foundation-requirement-v1.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "capabilities": {
+      "items": {
+        "enum": [
+          "network",
+          "routing",
+          "container-compute",
+          "postgres",
+          "identity",
+          "events",
+          "observability",
+          "configuration",
+          "deployment"
+        ],
+        "type": "string"
+      },
+      "type": "array",
+      "uniqueItems": true
+    },
+    "contract": {
+      "minLength": 1,
+      "type": "string"
+    }
+  },
+  "required": ["contract", "capabilities"],
+  "title": "Empire Builder Kit Standard Foundation Requirement v1",
+  "type": "object"
+}

package/src/schemas/generated-ownership-v2.json

@@ -0,0 +1,117 @@
+{
+  "$id": "https://empirebuilderkit.dev/schemas/generated-ownership-v2.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "blueprint": {
+      "additionalProperties": false,
+      "properties": {
+        "name": { "minLength": 1, "type": "string" },
+        "version": { "minLength": 1, "type": "string" }
+      },
+      "required": ["name", "version"],
+      "type": "object"
+    },
+    "contracts": {
+      "additionalProperties": false,
+      "properties": {
+        "consumes": {
+          "items": { "minLength": 1, "type": "string" },
+          "type": "array"
+        },
+        "publishes": {
+          "items": { "minLength": 1, "type": "string" },
+          "type": "array"
+        }
+      },
+      "required": ["publishes", "consumes"],
+      "type": "object"
+    },
+    "foundation": {
+      "$ref": "https://empirebuilderkit.dev/schemas/foundation-requirement-v1.json"
+    },
+    "inputs": { "type": "object" },
+    "migrationHistory": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "managedPlanDigest": {
+            "pattern": "^[a-f0-9]{64}$",
+            "type": "string"
+          },
+          "migrationId": { "minLength": 1, "type": "string" },
+          "sourceVersion": {
+            "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?(?:\\+[0-9A-Za-z.-]+)?$",
+            "type": "string"
+          },
+          "targetVersion": {
+            "pattern": "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?(?:\\+[0-9A-Za-z.-]+)?$",
+            "type": "string"
+          }
+        },
+        "required": [
+          "sourceVersion",
+          "targetVersion",
+          "migrationId",
+          "managedPlanDigest"
+        ],
+        "type": "object"
+      },
+      "minItems": 1,
+      "type": "array",
+      "uniqueItems": true
+    },
+    "paths": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "managedJsonPointers": {
+            "items": {
+              "pattern": "^(?:/(?:[^~/]|~[01])*)+$",
+              "type": "string"
+            },
+            "minItems": 1,
+            "type": "array",
+            "uniqueItems": true
+          },
+          "mode": { "enum": ["managed", "seeded"] },
+          "origin": { "enum": ["blueprint", "composition", "framework"] },
+          "path": {
+            "minLength": 1,
+            "not": {
+              "pattern": "(^[\\\\/])|(^|[\\\\/])\\.\\.([\\\\/]|$)"
+            },
+            "type": "string"
+          },
+          "sha256": { "pattern": "^[a-f0-9]{64}$", "type": "string" }
+        },
+        "required": ["path", "mode", "origin", "sha256"],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "projects": {
+      "items": { "minLength": 1, "type": "string" },
+      "type": "array"
+    },
+    "schemaVersion": { "const": 2 },
+    "slice": { "minLength": 1, "type": "string" },
+    "verification": {
+      "items": { "minLength": 1, "type": "string" },
+      "type": "array"
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "slice",
+    "blueprint",
+    "foundation",
+    "inputs",
+    "paths",
+    "projects",
+    "verification",
+    "contracts"
+  ],
+  "title": "Empire Builder Kit Generated Ownership Record v2",
+  "type": "object"
+}

package/src/schemas/repository-policy-v1.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://empirebuilderkit.dev/schemas/repository-policy-v1.json",
+  "title": "Empire Builder Kit repository operating policy v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schemaVersion",
+    "productionAccess",
+    "productionApproval",
+    "slices"
+  ],
+  "properties": {
+    "$schema": { "type": "string", "minLength": 1 },
+    "schemaVersion": { "const": 1 },
+    "productionAccess": {
+      "type": "string",
+      "enum": ["disabled", "controlled"]
+    },
+    "productionApproval": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mode"],
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": ["promotion-pr", "environment-reviewer"]
+        }
+      }
+    },
+    "productionFoundation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["profile"],
+      "properties": {
+        "profile": {
+          "type": "string",
+          "enum": ["cost-optimized", "standard"]
+        }
+      }
+    },
+    "slices": {
+      "type": "object",
+      "propertyNames": { "pattern": "^[a-z0-9][a-z0-9-]*$" },
+      "additionalProperties": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["productionStatus"],
+        "properties": {
+          "productionStatus": {
+            "type": "string",
+            "enum": ["blocked", "pilot", "ready"]
+          }
+        }
+      }
+    }
+  }
+}

package/src/schemas/workspace-ownership-v2.json

@@ -0,0 +1,42 @@
+{
+  "$id": "https://empirebuilderkit.dev/schemas/workspace-ownership-v2.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": false,
+  "properties": {
+    "frameworkVersion": { "minLength": 1, "type": "string" },
+    "kind": { "const": "workspace" },
+    "paths": {
+      "items": {
+        "additionalProperties": false,
+        "properties": {
+          "managedJsonPointers": {
+            "items": {
+              "pattern": "^(?:/(?:[^~/]|~[01])*)+$",
+              "type": "string"
+            },
+            "minItems": 1,
+            "type": "array",
+            "uniqueItems": true
+          },
+          "mode": { "enum": ["managed", "seeded"] },
+          "origin": { "const": "framework" },
+          "path": {
+            "minLength": 1,
+            "not": {
+              "pattern": "(^[\\\\/])|(^|[\\\\/])\\.\\.([\\\\/]|$)"
+            },
+            "type": "string"
+          },
+          "sha256": { "pattern": "^[a-f0-9]{64}$", "type": "string" }
+        },
+        "required": ["path", "mode", "origin", "sha256"],
+        "type": "object"
+      },
+      "type": "array"
+    },
+    "schemaVersion": { "const": 2 }
+  },
+  "required": ["schemaVersion", "kind", "frameworkVersion", "paths"],
+  "title": "Empire Builder Kit Workspace Ownership Record v2",
+  "type": "object"
+}

package/src/validation.d.ts

@@ -0,0 +1,14 @@
+export interface ValidationIssue {
+    message: string;
+    path: string;
+}
+export type ValidationResult<T> = {
+    issues: [];
+    valid: true;
+    value: T;
+} | {
+    issues: ValidationIssue[];
+    valid: false;
+};
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+export declare function validationResult<T>(value: unknown, issues: ValidationIssue[]): ValidationResult<T>;

package/src/validation.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRecord = isRecord;
+exports.validationResult = validationResult;
+function isRecord(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function validationResult(value, issues) {
+    if (issues.length > 0) {
+        return { issues, valid: false };
+    }
+    return { issues: [], valid: true, value: value };
+}
+//# sourceMappingURL=validation.js.map

package/src/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../../../packages/nx/src/validation.ts"],"names":[],"mappings":";;AASA,4BAEC;AAED,4CASC;AAbD,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAgB,gBAAgB,CAC9B,KAAc,EACd,MAAyB;IAEzB,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IAClC,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAU,EAAE,CAAC;AACxD,CAAC"}

package/src/work-markers/index.d.ts

@@ -0,0 +1 @@
+export * from './work-markers.js';

package/src/work-markers/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./work-markers.js"), exports);
+//# sourceMappingURL=index.js.map

package/src/work-markers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/nx/src/work-markers/index.ts"],"names":[],"mappings":";;;AAAA,4DAAkC"}

package/src/work-markers/work-markers.d.ts

@@ -0,0 +1,39 @@
+import { type GeneratedPathMode } from '../ownership/index.js';
+export declare const WORK_MARKER_KINDS: readonly ["TODO", "ASSUMPTION", "QUESTION", "SECURITY", "BLOCKER"];
+export type WorkMarkerKind = (typeof WORK_MARKER_KINDS)[number];
+export type WorkMarkerOwnership = GeneratedPathMode | 'user-owned';
+export type WorkMarkerCommentPrefix = '//' | '#' | '--' | '/*' | '<!--';
+export interface WorkMarkerCommentInput {
+    commentPrefix?: WorkMarkerCommentPrefix;
+    description: string;
+    kind: WorkMarkerKind;
+    reference: string;
+}
+export interface WorkMarker {
+    description: string;
+    kind: WorkMarkerKind;
+    line: number;
+    ownership: WorkMarkerOwnership;
+    path: string;
+    reference: string;
+}
+export type WorkMarkerIssueCode = 'invalid-marker-syntax' | 'invalid-ownership-record' | 'managed-file-marker' | 'ownership-conflict' | 'unreadable-path' | 'unknown-marker-kind';
+export interface WorkMarkerIssue {
+    code: WorkMarkerIssueCode;
+    line: number;
+    message: string;
+    path: string;
+}
+export interface WorkMarkerReport {
+    blockingMarkers: WorkMarker[];
+    issues: WorkMarkerIssue[];
+    markers: WorkMarker[];
+    root: string;
+}
+export interface WorkMarkerAssertionOptions {
+    protectedPromotion?: boolean;
+}
+export declare function scanWorkMarkers(root: string): WorkMarkerReport;
+export declare function formatWorkMarkerComment(input: WorkMarkerCommentInput): string;
+export declare function formatWorkMarkerReport(report: WorkMarkerReport): string;
+export declare function assertWorkMarkerReport(report: WorkMarkerReport, options?: WorkMarkerAssertionOptions): void;