@bleedingdev/modern-js-backend-federation-contracts 0.0.0 → 3.9.0-ultramodern.6

package/src/backend-federation-contract/types.ts

@@ -0,0 +1,73 @@
+import type {
+  DELIVERY_UNIT_DEPLOY_PROFILE,
+  DELIVERY_UNIT_KIND,
+  DELIVERY_UNIT_SCHEMA_VERSION,
+} from './constants';
+
+export type DeliveryUnitIdentity = {
+  unitId: string;
+  buildMarker: string;
+  sourceRevision: string;
+};
+
+export type DeliveryUnitRecord = DeliveryUnitIdentity & {
+  schemaVersion: typeof DELIVERY_UNIT_SCHEMA_VERSION;
+  kind: typeof DELIVERY_UNIT_KIND;
+  appId: string;
+  packageName: string;
+  version: string;
+  deployProfile: typeof DELIVERY_UNIT_DEPLOY_PROFILE;
+};
+
+export type DeliveryUnitContractBlock = Omit<
+  DeliveryUnitRecord,
+  'appId' | 'deployProfile'
+>;
+
+export type UltramodernBuildDeliveryUnit = DeliveryUnitRecord & {
+  build: string;
+};
+
+export type UltramodernBuildSurface =
+  | (UltramodernBuildDeliveryUnit & { surface: 'ui' })
+  | (UltramodernBuildDeliveryUnit & { surface: 'api' });
+
+export type UltramodernBuildArtifact = {
+  schemaVersion: typeof DELIVERY_UNIT_SCHEMA_VERSION;
+  kind: 'ultramodern-build-artifact';
+  deliveryUnit: UltramodernBuildDeliveryUnit;
+  surfaces: {
+    ui: UltramodernBuildDeliveryUnit & { surface: 'ui' };
+    api: UltramodernBuildDeliveryUnit & { surface: 'api' };
+  };
+};
+
+export type BackendFederationContractValidationError = {
+  path: string;
+  message: string;
+};
+
+export type BackendFederationContractValidationResult = {
+  ok: boolean;
+  errors: BackendFederationContractValidationError[];
+};
+
+export type ValidateDeliveryUnitIdentityOptions = {
+  path?: string;
+  allowBuildAlias?: boolean;
+};
+
+export type ValidateBackendFederationMetadataOptions = {
+  path?: string;
+  expectedContractVersion?: string | false;
+  expectedNodeAdapterVersion?: string | false;
+  validateDeliveryUnit?: boolean;
+  requireEffectExpose?: boolean;
+  requireEffectRuntime?: boolean;
+  requireVersionFields?: boolean;
+};
+
+export type ValidateBackendFederationManifestOptions =
+  ValidateBackendFederationMetadataOptions & {
+    requireBackendFederation?: boolean;
+  };

package/src/backend-federation-contract/validation-core.ts

@@ -0,0 +1,67 @@
+import type {
+  BackendFederationContractValidationError,
+  BackendFederationContractValidationResult,
+} from './types';
+
+export const isRecord = (value: unknown): value is Record<string, unknown> =>
+  typeof value === 'object' && value !== null && !Array.isArray(value);
+
+export const nonEmptyString = (value: unknown): string | undefined =>
+  typeof value === 'string' && value.trim().length > 0 ? value : undefined;
+
+export const validationResult = (
+  errors: BackendFederationContractValidationError[],
+): BackendFederationContractValidationResult => ({
+  ok: errors.length === 0,
+  errors,
+});
+
+export const addError = (
+  errors: BackendFederationContractValidationError[],
+  path: string,
+  message: string,
+) => {
+  errors.push({ path, message });
+};
+
+export const recordField = (
+  value: Record<string, unknown> | undefined,
+  field: string,
+) => {
+  const fieldValue = value?.[field];
+  return isRecord(fieldValue) ? fieldValue : undefined;
+};
+
+export const formatBackendFederationValidationErrors = (
+  errors: BackendFederationContractValidationError[],
+): string => errors.map(error => `${error.path}: ${error.message}`).join('; ');
+
+export const validateVersionField = (
+  errors: BackendFederationContractValidationError[],
+  record: Record<string, unknown>,
+  field: 'contractVersion' | 'nodeAdapterVersion',
+  expected: string | false,
+  path: string,
+  required: boolean,
+) => {
+  const compatibility = recordField(record, 'compatibility');
+  const executionSurfaces = recordField(record, 'executionSurfaces');
+  const nodeSurface = recordField(executionSurfaces, 'node');
+  const actual =
+    nonEmptyString(record[field]) ??
+    nonEmptyString(compatibility?.[field]) ??
+    (field === 'nodeAdapterVersion'
+      ? nonEmptyString(nodeSurface?.adapterVersion)
+      : undefined);
+
+  if (!actual) {
+    if (required) {
+      addError(errors, `${path}.${field}`, 'must be a non-empty string.');
+    }
+    return;
+  }
+
+  if (expected !== false && actual !== expected) {
+    addError(errors, `${path}.${field}`, `must be "${expected}".`);
+  }
+};

package/README.md

@@ -1,3 +0,0 @@
-# @bleedingdev/modern-js-backend-federation-contracts
-
-This 0.0.0 version only registers the package name so npm trusted publishing can be configured. It contains no runtime implementation. Use the subsequent UltraModern.js release, published from the repository workflow with provenance.