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

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 (38) hide show
  1. package/LICENSE +21 -0
  2. package/dist/cjs/backend-federation-contract/build-artifact.js +185 -0
  3. package/dist/cjs/backend-federation-contract/constants.js +92 -0
  4. package/dist/cjs/backend-federation-contract/delivery-unit.js +130 -0
  5. package/dist/cjs/backend-federation-contract/index.js +137 -0
  6. package/dist/cjs/backend-federation-contract/metadata.js +133 -0
  7. package/dist/cjs/backend-federation-contract/types.js +18 -0
  8. package/dist/cjs/backend-federation-contract/validation-core.js +85 -0
  9. package/dist/esm/backend-federation-contract/build-artifact.mjs +135 -0
  10. package/dist/esm/backend-federation-contract/constants.mjs +18 -0
  11. package/dist/esm/backend-federation-contract/delivery-unit.mjs +74 -0
  12. package/dist/esm/backend-federation-contract/index.mjs +5 -0
  13. package/dist/esm/backend-federation-contract/metadata.mjs +80 -0
  14. package/dist/esm/backend-federation-contract/types.mjs +0 -0
  15. package/dist/esm/backend-federation-contract/validation-core.mjs +29 -0
  16. package/dist/esm-node/backend-federation-contract/build-artifact.mjs +136 -0
  17. package/dist/esm-node/backend-federation-contract/constants.mjs +19 -0
  18. package/dist/esm-node/backend-federation-contract/delivery-unit.mjs +75 -0
  19. package/dist/esm-node/backend-federation-contract/index.mjs +6 -0
  20. package/dist/esm-node/backend-federation-contract/metadata.mjs +81 -0
  21. package/dist/esm-node/backend-federation-contract/types.mjs +1 -0
  22. package/dist/esm-node/backend-federation-contract/validation-core.mjs +30 -0
  23. package/dist/types/backend-federation-contract/build-artifact.d.ts +9 -0
  24. package/dist/types/backend-federation-contract/constants.d.ts +14 -0
  25. package/dist/types/backend-federation-contract/delivery-unit.d.ts +9 -0
  26. package/dist/types/backend-federation-contract/index.d.ts +7 -0
  27. package/dist/types/backend-federation-contract/metadata.d.ts +7 -0
  28. package/dist/types/backend-federation-contract/types.d.ts +60 -0
  29. package/dist/types/backend-federation-contract/validation-core.d.ts +8 -0
  30. package/package.json +38 -5
  31. package/src/backend-federation-contract/build-artifact.ts +224 -0
  32. package/src/backend-federation-contract/constants.ts +33 -0
  33. package/src/backend-federation-contract/delivery-unit.ts +170 -0
  34. package/src/backend-federation-contract/index.ts +56 -0
  35. package/src/backend-federation-contract/metadata.ts +225 -0
  36. package/src/backend-federation-contract/types.ts +73 -0
  37. package/src/backend-federation-contract/validation-core.ts +67 -0
  38. package/README.md +0 -3
@@ -0,0 +1,136 @@
1
+ import "node:module";
2
+ import { DELIVERY_UNIT_IDENTITY_FIELDS, DELIVERY_UNIT_SCHEMA_VERSION } from "./constants.mjs";
3
+ import { deliveryUnitIdentityFieldValue, validateDeliveryUnitRecord } from "./delivery-unit.mjs";
4
+ import { addError, isRecord, nonEmptyString, recordField, validationResult } from "./validation-core.mjs";
5
+ const createUltramodernBuildArtifact = (record)=>{
6
+ const deliveryUnit = {
7
+ appId: record.appId,
8
+ build: record.buildMarker,
9
+ buildMarker: record.buildMarker,
10
+ deployProfile: record.deployProfile,
11
+ kind: record.kind,
12
+ packageName: record.packageName,
13
+ schemaVersion: record.schemaVersion,
14
+ sourceRevision: record.sourceRevision,
15
+ unitId: record.unitId,
16
+ version: record.version
17
+ };
18
+ const api = {
19
+ appId: deliveryUnit.appId,
20
+ build: deliveryUnit.build,
21
+ buildMarker: deliveryUnit.buildMarker,
22
+ deployProfile: deliveryUnit.deployProfile,
23
+ kind: deliveryUnit.kind,
24
+ packageName: deliveryUnit.packageName,
25
+ schemaVersion: deliveryUnit.schemaVersion,
26
+ sourceRevision: deliveryUnit.sourceRevision,
27
+ surface: 'api',
28
+ unitId: deliveryUnit.unitId,
29
+ version: deliveryUnit.version
30
+ };
31
+ const ui = {
32
+ appId: deliveryUnit.appId,
33
+ build: deliveryUnit.build,
34
+ buildMarker: deliveryUnit.buildMarker,
35
+ deployProfile: deliveryUnit.deployProfile,
36
+ kind: deliveryUnit.kind,
37
+ packageName: deliveryUnit.packageName,
38
+ schemaVersion: deliveryUnit.schemaVersion,
39
+ sourceRevision: deliveryUnit.sourceRevision,
40
+ surface: 'ui',
41
+ unitId: deliveryUnit.unitId,
42
+ version: deliveryUnit.version
43
+ };
44
+ return {
45
+ deliveryUnit,
46
+ kind: 'ultramodern-build-artifact',
47
+ schemaVersion: DELIVERY_UNIT_SCHEMA_VERSION,
48
+ surfaces: {
49
+ api,
50
+ ui
51
+ }
52
+ };
53
+ };
54
+ const validateUltramodernBuildArtifact = (value, path = 'artifact')=>{
55
+ const errors = [];
56
+ if (!isRecord(value)) {
57
+ addError(errors, path, 'must be an object.');
58
+ return validationResult(errors);
59
+ }
60
+ if (value.schemaVersion !== DELIVERY_UNIT_SCHEMA_VERSION) addError(errors, `${path}.schemaVersion`, `must be ${DELIVERY_UNIT_SCHEMA_VERSION}.`);
61
+ if ('ultramodern-build-artifact' !== value.kind) addError(errors, `${path}.kind`, 'must be "ultramodern-build-artifact".');
62
+ const deliveryUnit = value.deliveryUnit;
63
+ errors.push(...validateDeliveryUnitRecord(deliveryUnit, {
64
+ path: `${path}.deliveryUnit`,
65
+ allowBuildAlias: true
66
+ }).errors);
67
+ if (isRecord(deliveryUnit)) {
68
+ const build = nonEmptyString(deliveryUnit.build);
69
+ const buildMarker = nonEmptyString(deliveryUnit.buildMarker);
70
+ if (build) {
71
+ if (buildMarker && build !== buildMarker) addError(errors, `${path}.deliveryUnit.build`, 'must match deliveryUnit.buildMarker.');
72
+ } else addError(errors, `${path}.deliveryUnit.build`, 'must be a non-empty string.');
73
+ }
74
+ const surfaces = recordField(value, 'surfaces');
75
+ if (!surfaces) {
76
+ addError(errors, `${path}.surfaces`, 'must be an object.');
77
+ return validationResult(errors);
78
+ }
79
+ for (const surface of [
80
+ 'ui',
81
+ 'api'
82
+ ]){
83
+ const marker = surfaces[surface];
84
+ const markerPath = `${path}.surfaces.${surface}`;
85
+ errors.push(...validateDeliveryUnitRecord(marker, {
86
+ path: markerPath,
87
+ allowBuildAlias: true
88
+ }).errors);
89
+ if (!isRecord(marker)) continue;
90
+ const markerBuild = nonEmptyString(marker.build);
91
+ const markerBuildMarker = nonEmptyString(marker.buildMarker);
92
+ if (markerBuild) {
93
+ if (markerBuildMarker && markerBuild !== markerBuildMarker) addError(errors, `${markerPath}.build`, 'must match buildMarker.');
94
+ } else addError(errors, `${markerPath}.build`, 'must be non-empty string.');
95
+ if (marker.surface !== surface) addError(errors, `${markerPath}.surface`, `must be "${surface}".`);
96
+ for (const field of DELIVERY_UNIT_IDENTITY_FIELDS){
97
+ const deliveryUnitValue = deliveryUnitIdentityFieldValue(deliveryUnit, field, {
98
+ allowBuildAlias: true
99
+ });
100
+ const markerValue = deliveryUnitIdentityFieldValue(marker, field, {
101
+ allowBuildAlias: true
102
+ });
103
+ if (void 0 !== deliveryUnitValue && void 0 !== markerValue && deliveryUnitValue !== markerValue) addError(errors, `${markerPath}.${field}`, `must match ${path}.deliveryUnit.${field}.`);
104
+ }
105
+ }
106
+ return validationResult(errors);
107
+ };
108
+ const isUltramodernBuildArtifact = (value)=>validateUltramodernBuildArtifact(value).ok;
109
+ const stampUltramodernBuildArtifactIdentity = (artifact, identity)=>({
110
+ ...artifact,
111
+ deliveryUnit: {
112
+ ...artifact.deliveryUnit,
113
+ build: identity.buildMarker,
114
+ buildMarker: identity.buildMarker,
115
+ sourceRevision: identity.sourceRevision
116
+ },
117
+ surfaces: {
118
+ ui: {
119
+ ...artifact.surfaces.ui,
120
+ build: identity.buildMarker,
121
+ buildMarker: identity.buildMarker,
122
+ sourceRevision: identity.sourceRevision
123
+ },
124
+ api: {
125
+ ...artifact.surfaces.api,
126
+ build: identity.buildMarker,
127
+ buildMarker: identity.buildMarker,
128
+ sourceRevision: identity.sourceRevision
129
+ }
130
+ }
131
+ });
132
+ const stampUltramodernBuildArtifactSourceRevision = (artifact, sourceRevision)=>stampUltramodernBuildArtifactIdentity(artifact, {
133
+ buildMarker: artifact.deliveryUnit.buildMarker,
134
+ sourceRevision
135
+ });
136
+ export { createUltramodernBuildArtifact, isUltramodernBuildArtifact, stampUltramodernBuildArtifactIdentity, stampUltramodernBuildArtifactSourceRevision, validateUltramodernBuildArtifact };
@@ -0,0 +1,19 @@
1
+ import "node:module";
2
+ const BACKEND_FEDERATION_EFFECT_EXPOSE = './effect-api';
3
+ const BACKEND_FEDERATION_MANIFEST_FILE = 'backend-mf-manifest.json';
4
+ const BACKEND_FEDERATION_REMOTE_ENTRY_FILE = 'backendRemoteEntry.cjs';
5
+ const BACKEND_FEDERATION_CONTRACT_VERSION = 'microvertical-server-effect-v1';
6
+ const BACKEND_FEDERATION_NODE_ADAPTER_VERSION = 'backend-mf-effect-v1';
7
+ const DELIVERY_UNIT_SCHEMA_VERSION = 1;
8
+ const DELIVERY_UNIT_KIND = 'microvertical-delivery-unit';
9
+ const DELIVERY_UNIT_DEPLOY_PROFILE = 'cloudflare-ssr-mf-effect-v1';
10
+ const DELIVERY_UNIT_IDENTITY_FIELDS = [
11
+ 'unitId',
12
+ 'buildMarker',
13
+ 'sourceRevision'
14
+ ];
15
+ const ULTRAMODERN_BUILD_ARTIFACT_FILE = 'ultramodern-build.json';
16
+ const ULTRAMODERN_BUILD_ARTIFACT_PATH = `shared/${ULTRAMODERN_BUILD_ARTIFACT_FILE}`;
17
+ const ULTRAMODERN_BUILD_MODULE_FILE = 'ultramodern-build.ts';
18
+ const ULTRAMODERN_BUILD_MODULE_PATH = `shared/${ULTRAMODERN_BUILD_MODULE_FILE}`;
19
+ export { BACKEND_FEDERATION_CONTRACT_VERSION, BACKEND_FEDERATION_EFFECT_EXPOSE, BACKEND_FEDERATION_MANIFEST_FILE, BACKEND_FEDERATION_NODE_ADAPTER_VERSION, BACKEND_FEDERATION_REMOTE_ENTRY_FILE, DELIVERY_UNIT_DEPLOY_PROFILE, DELIVERY_UNIT_IDENTITY_FIELDS, DELIVERY_UNIT_KIND, DELIVERY_UNIT_SCHEMA_VERSION, ULTRAMODERN_BUILD_ARTIFACT_FILE, ULTRAMODERN_BUILD_ARTIFACT_PATH, ULTRAMODERN_BUILD_MODULE_FILE, ULTRAMODERN_BUILD_MODULE_PATH };
@@ -0,0 +1,75 @@
1
+ import "node:module";
2
+ import { DELIVERY_UNIT_DEPLOY_PROFILE, DELIVERY_UNIT_IDENTITY_FIELDS, DELIVERY_UNIT_KIND, DELIVERY_UNIT_SCHEMA_VERSION } from "./constants.mjs";
3
+ import { addError, isRecord, nonEmptyString, validationResult } from "./validation-core.mjs";
4
+ const deliveryUnitIdentityFieldValue = (value, field, options = {})=>{
5
+ if (!isRecord(value)) return;
6
+ if ('buildMarker' === field && options.allowBuildAlias) return nonEmptyString(value.buildMarker) ?? nonEmptyString(value.build);
7
+ return nonEmptyString(value[field]);
8
+ };
9
+ const validateDeliveryUnitIdentity = (value, options = {})=>{
10
+ const path = options.path ?? 'deliveryUnit';
11
+ const errors = [];
12
+ if (!isRecord(value)) {
13
+ addError(errors, path, 'must be an object.');
14
+ return validationResult(errors);
15
+ }
16
+ for (const field of DELIVERY_UNIT_IDENTITY_FIELDS)if (!deliveryUnitIdentityFieldValue(value, field, options)) addError(errors, `${path}.${field}`, 'must be a non-empty string.');
17
+ return validationResult(errors);
18
+ };
19
+ const validateDeliveryUnitContractBlock = (value, options = {})=>{
20
+ const path = options.path ?? 'deliveryUnit';
21
+ const errors = [
22
+ ...validateDeliveryUnitIdentity(value, options).errors
23
+ ];
24
+ if (!isRecord(value)) return validationResult(errors);
25
+ if (value.schemaVersion !== DELIVERY_UNIT_SCHEMA_VERSION) addError(errors, `${path}.schemaVersion`, `must be ${DELIVERY_UNIT_SCHEMA_VERSION}.`);
26
+ if (value.kind !== DELIVERY_UNIT_KIND) addError(errors, `${path}.kind`, `must be "${DELIVERY_UNIT_KIND}".`);
27
+ if (!nonEmptyString(value.packageName)) addError(errors, `${path}.packageName`, 'must be a non-empty string.');
28
+ if (!nonEmptyString(value.version)) addError(errors, `${path}.version`, 'must be a non-empty string.');
29
+ return validationResult(errors);
30
+ };
31
+ const validateDeliveryUnitRecord = (value, options = {})=>{
32
+ const path = options.path ?? 'deliveryUnit';
33
+ const errors = [
34
+ ...validateDeliveryUnitContractBlock(value, {
35
+ ...options,
36
+ path
37
+ }).errors
38
+ ];
39
+ if (!isRecord(value)) return validationResult(errors);
40
+ if (!nonEmptyString(value.appId)) addError(errors, `${path}.appId`, 'must be a non-empty string.');
41
+ if (value.deployProfile !== DELIVERY_UNIT_DEPLOY_PROFILE) addError(errors, `${path}.deployProfile`, `must be "${DELIVERY_UNIT_DEPLOY_PROFILE}".`);
42
+ return validationResult(errors);
43
+ };
44
+ const validateDeliveryUnitBoundaryIdentity = (value, path)=>{
45
+ const errors = [];
46
+ if (!isRecord(value)) {
47
+ addError(errors, path, 'must be an object.');
48
+ return errors;
49
+ }
50
+ for (const field of DELIVERY_UNIT_IDENTITY_FIELDS)if (!deliveryUnitIdentityFieldValue(value, field)) addError(errors, `${path}.${field}`, 'must be a non-empty string.');
51
+ return errors;
52
+ };
53
+ const deliveryUnitContractBlock = (record)=>({
54
+ schemaVersion: record.schemaVersion,
55
+ kind: record.kind,
56
+ unitId: record.unitId,
57
+ packageName: record.packageName,
58
+ version: record.version,
59
+ buildMarker: record.buildMarker,
60
+ sourceRevision: record.sourceRevision
61
+ });
62
+ const toDeliveryUnitIdentity = (value)=>{
63
+ const unitId = deliveryUnitIdentityFieldValue(value, 'unitId');
64
+ const buildMarker = deliveryUnitIdentityFieldValue(value, 'buildMarker', {
65
+ allowBuildAlias: true
66
+ });
67
+ const sourceRevision = deliveryUnitIdentityFieldValue(value, 'sourceRevision');
68
+ if (!unitId || !buildMarker || !sourceRevision) return;
69
+ return {
70
+ unitId,
71
+ buildMarker,
72
+ sourceRevision
73
+ };
74
+ };
75
+ export { deliveryUnitContractBlock, deliveryUnitIdentityFieldValue, toDeliveryUnitIdentity, validateDeliveryUnitBoundaryIdentity, validateDeliveryUnitContractBlock, validateDeliveryUnitIdentity, validateDeliveryUnitRecord };
@@ -0,0 +1,6 @@
1
+ import "node:module";
2
+ export { createUltramodernBuildArtifact, isUltramodernBuildArtifact, stampUltramodernBuildArtifactIdentity, stampUltramodernBuildArtifactSourceRevision, validateUltramodernBuildArtifact } from "./build-artifact.mjs";
3
+ export { BACKEND_FEDERATION_CONTRACT_VERSION, BACKEND_FEDERATION_EFFECT_EXPOSE, BACKEND_FEDERATION_MANIFEST_FILE, BACKEND_FEDERATION_NODE_ADAPTER_VERSION, BACKEND_FEDERATION_REMOTE_ENTRY_FILE, DELIVERY_UNIT_DEPLOY_PROFILE, DELIVERY_UNIT_IDENTITY_FIELDS, DELIVERY_UNIT_KIND, DELIVERY_UNIT_SCHEMA_VERSION, ULTRAMODERN_BUILD_ARTIFACT_FILE, ULTRAMODERN_BUILD_ARTIFACT_PATH, ULTRAMODERN_BUILD_MODULE_FILE, ULTRAMODERN_BUILD_MODULE_PATH } from "./constants.mjs";
4
+ export { deliveryUnitContractBlock, deliveryUnitIdentityFieldValue, toDeliveryUnitIdentity, validateDeliveryUnitContractBlock, validateDeliveryUnitIdentity, validateDeliveryUnitRecord } from "./delivery-unit.mjs";
5
+ export { backendFederationExposeNames, backendFederationMetadata, backendFederationVersionBoundary, toBackendFederationExposeNames, validateBackendFederationManifest, validateBackendFederationMetadata } from "./metadata.mjs";
6
+ export { formatBackendFederationValidationErrors, nonEmptyString } from "./validation-core.mjs";
@@ -0,0 +1,81 @@
1
+ import "node:module";
2
+ import { BACKEND_FEDERATION_CONTRACT_VERSION, BACKEND_FEDERATION_EFFECT_EXPOSE, BACKEND_FEDERATION_NODE_ADAPTER_VERSION, DELIVERY_UNIT_IDENTITY_FIELDS, DELIVERY_UNIT_SCHEMA_VERSION } from "./constants.mjs";
3
+ import { deliveryUnitIdentityFieldValue, validateDeliveryUnitBoundaryIdentity, validateDeliveryUnitContractBlock } from "./delivery-unit.mjs";
4
+ import { addError, isRecord, nonEmptyString, recordField, validateVersionField, validationResult } from "./validation-core.mjs";
5
+ const toBackendFederationExposeNames = (value)=>{
6
+ const names = [];
7
+ if (Array.isArray(value)) for (const expose of value){
8
+ const name = nonEmptyString(expose) ?? (isRecord(expose) ? nonEmptyString(expose.name) : void 0);
9
+ if (name) names.push(name);
10
+ }
11
+ else if (isRecord(value)) names.push(...Object.keys(value).filter((name)=>name.length > 0));
12
+ return Array.from(new Set(names));
13
+ };
14
+ const backendFederationExposeNames = (value)=>{
15
+ if (!isRecord(value)) return [];
16
+ const exposes = toBackendFederationExposeNames(value.exposes);
17
+ const expose = nonEmptyString(value.expose);
18
+ return Array.from(new Set([
19
+ ...exposes,
20
+ ...expose ? [
21
+ expose
22
+ ] : []
23
+ ]));
24
+ };
25
+ const backendFederationMetadata = (value)=>isRecord(value) ? recordField(value, 'backendFederation') : void 0;
26
+ const backendFederationVersionBoundary = (value)=>recordField(backendFederationMetadata(value), 'versionBoundary');
27
+ const validateBackendFederationMetadata = (value, options = {})=>{
28
+ const path = options.path ?? 'backendFederation';
29
+ const errors = [];
30
+ if (!isRecord(value)) {
31
+ addError(errors, path, 'must be an object.');
32
+ return validationResult(errors);
33
+ }
34
+ if (options.requireEffectRuntime && 'effect' !== value.runtimeFramework) addError(errors, `${path}.runtimeFramework`, 'must be "effect".');
35
+ if (options.requireEffectRuntime && true !== value.strictEffectApproach) addError(errors, `${path}.strictEffectApproach`, 'must be true.');
36
+ validateVersionField(errors, value, 'contractVersion', options.expectedContractVersion ?? BACKEND_FEDERATION_CONTRACT_VERSION, path, options.requireVersionFields ?? false);
37
+ validateVersionField(errors, value, 'nodeAdapterVersion', options.expectedNodeAdapterVersion ?? BACKEND_FEDERATION_NODE_ADAPTER_VERSION, path, options.requireVersionFields ?? false);
38
+ if (options.requireEffectExpose && !backendFederationExposeNames(value).includes(BACKEND_FEDERATION_EFFECT_EXPOSE)) addError(errors, `${path}.expose`, `must include "${BACKEND_FEDERATION_EFFECT_EXPOSE}".`);
39
+ if (options.validateDeliveryUnit ?? true) {
40
+ const deliveryUnit = recordField(value, 'deliveryUnit');
41
+ if (deliveryUnit) errors.push(...validateDeliveryUnitContractBlock(deliveryUnit, {
42
+ path: `${path}.deliveryUnit`
43
+ }).errors);
44
+ const versionBoundary = recordField(value, 'versionBoundary');
45
+ const versionBoundaryDeliveryUnit = recordField(versionBoundary, 'deliveryUnit');
46
+ if (versionBoundaryDeliveryUnit) errors.push(...validateDeliveryUnitBoundaryIdentity(versionBoundaryDeliveryUnit, `${path}.versionBoundary.deliveryUnit`));
47
+ if (deliveryUnit && versionBoundaryDeliveryUnit) for (const field of DELIVERY_UNIT_IDENTITY_FIELDS){
48
+ const deliveryUnitValue = deliveryUnitIdentityFieldValue(deliveryUnit, field);
49
+ const versionBoundaryDeliveryUnitValue = deliveryUnitIdentityFieldValue(versionBoundaryDeliveryUnit, field);
50
+ if (deliveryUnitValue && versionBoundaryDeliveryUnitValue && deliveryUnitValue !== versionBoundaryDeliveryUnitValue) addError(errors, `${path}.versionBoundary.deliveryUnit.${field}`, `must match ${path}.deliveryUnit.${field}.`);
51
+ }
52
+ }
53
+ return validationResult(errors);
54
+ };
55
+ const validateBackendFederationManifest = (value, options = {})=>{
56
+ const path = options.path ?? 'manifest';
57
+ const errors = [];
58
+ if (!isRecord(value)) {
59
+ addError(errors, path, 'must be an object.');
60
+ return validationResult(errors);
61
+ }
62
+ if (void 0 !== value.schemaVersion && value.schemaVersion !== DELIVERY_UNIT_SCHEMA_VERSION) addError(errors, `${path}.schemaVersion`, `must be ${DELIVERY_UNIT_SCHEMA_VERSION}.`);
63
+ const metadata = backendFederationMetadata(value);
64
+ if (metadata) errors.push(...validateBackendFederationMetadata(metadata, {
65
+ ...options,
66
+ path: `${path}.backendFederation`,
67
+ requireEffectExpose: false
68
+ }).errors);
69
+ else if (options.requireBackendFederation ?? true) addError(errors, `${path}.backendFederation`, 'must be an object.');
70
+ if (options.requireEffectExpose) {
71
+ const topLevelExposeNames = toBackendFederationExposeNames(value.exposes);
72
+ const metadataExposeNames = backendFederationExposeNames(metadata);
73
+ const exposeNames = new Set([
74
+ ...topLevelExposeNames,
75
+ ...metadataExposeNames
76
+ ]);
77
+ if (!exposeNames.has(BACKEND_FEDERATION_EFFECT_EXPOSE)) addError(errors, `${path}.exposes`, `must include "${BACKEND_FEDERATION_EFFECT_EXPOSE}".`);
78
+ }
79
+ return validationResult(errors);
80
+ };
81
+ export { backendFederationExposeNames, backendFederationMetadata, backendFederationVersionBoundary, toBackendFederationExposeNames, validateBackendFederationManifest, validateBackendFederationMetadata };
@@ -0,0 +1 @@
1
+ import "node:module";
@@ -0,0 +1,30 @@
1
+ import "node:module";
2
+ const isRecord = (value)=>'object' == typeof value && null !== value && !Array.isArray(value);
3
+ const nonEmptyString = (value)=>'string' == typeof value && value.trim().length > 0 ? value : void 0;
4
+ const validationResult = (errors)=>({
5
+ ok: 0 === errors.length,
6
+ errors
7
+ });
8
+ const addError = (errors, path, message)=>{
9
+ errors.push({
10
+ path,
11
+ message
12
+ });
13
+ };
14
+ const recordField = (value, field)=>{
15
+ const fieldValue = value?.[field];
16
+ return isRecord(fieldValue) ? fieldValue : void 0;
17
+ };
18
+ const formatBackendFederationValidationErrors = (errors)=>errors.map((error)=>`${error.path}: ${error.message}`).join('; ');
19
+ const validateVersionField = (errors, record, field, expected, path, required)=>{
20
+ const compatibility = recordField(record, 'compatibility');
21
+ const executionSurfaces = recordField(record, 'executionSurfaces');
22
+ const nodeSurface = recordField(executionSurfaces, 'node');
23
+ const actual = nonEmptyString(record[field]) ?? nonEmptyString(compatibility?.[field]) ?? ('nodeAdapterVersion' === field ? nonEmptyString(nodeSurface?.adapterVersion) : void 0);
24
+ if (!actual) {
25
+ if (required) addError(errors, `${path}.${field}`, 'must be a non-empty string.');
26
+ return;
27
+ }
28
+ if (false !== expected && actual !== expected) addError(errors, `${path}.${field}`, `must be "${expected}".`);
29
+ };
30
+ export { addError, formatBackendFederationValidationErrors, isRecord, nonEmptyString, recordField, validateVersionField, validationResult };
@@ -0,0 +1,9 @@
1
+ import type { BackendFederationContractValidationResult, DeliveryUnitRecord, UltramodernBuildArtifact } from './types.js';
2
+ export declare const createUltramodernBuildArtifact: (record: DeliveryUnitRecord) => UltramodernBuildArtifact;
3
+ export declare const validateUltramodernBuildArtifact: (value: unknown, path?: string) => BackendFederationContractValidationResult;
4
+ export declare const isUltramodernBuildArtifact: (value: unknown) => value is UltramodernBuildArtifact;
5
+ export declare const stampUltramodernBuildArtifactIdentity: (artifact: UltramodernBuildArtifact, identity: {
6
+ buildMarker: string;
7
+ sourceRevision: string;
8
+ }) => UltramodernBuildArtifact;
9
+ export declare const stampUltramodernBuildArtifactSourceRevision: (artifact: UltramodernBuildArtifact, sourceRevision: string) => UltramodernBuildArtifact;
@@ -0,0 +1,14 @@
1
+ export declare const BACKEND_FEDERATION_EFFECT_EXPOSE = "./effect-api";
2
+ export declare const BACKEND_FEDERATION_MANIFEST_FILE = "backend-mf-manifest.json";
3
+ export declare const BACKEND_FEDERATION_REMOTE_ENTRY_FILE = "backendRemoteEntry.cjs";
4
+ export declare const BACKEND_FEDERATION_CONTRACT_VERSION = "microvertical-server-effect-v1";
5
+ export declare const BACKEND_FEDERATION_NODE_ADAPTER_VERSION = "backend-mf-effect-v1";
6
+ export declare const DELIVERY_UNIT_SCHEMA_VERSION = 1;
7
+ export declare const DELIVERY_UNIT_KIND = "microvertical-delivery-unit";
8
+ export declare const DELIVERY_UNIT_DEPLOY_PROFILE = "cloudflare-ssr-mf-effect-v1";
9
+ export declare const DELIVERY_UNIT_IDENTITY_FIELDS: readonly ['unitId', 'buildMarker', 'sourceRevision'];
10
+ export type DeliveryUnitIdentityField = (typeof DELIVERY_UNIT_IDENTITY_FIELDS)[number];
11
+ export declare const ULTRAMODERN_BUILD_ARTIFACT_FILE = "ultramodern-build.json";
12
+ export declare const ULTRAMODERN_BUILD_ARTIFACT_PATH = "shared/ultramodern-build.json";
13
+ export declare const ULTRAMODERN_BUILD_MODULE_FILE = "ultramodern-build.ts";
14
+ export declare const ULTRAMODERN_BUILD_MODULE_PATH = "shared/ultramodern-build.ts";
@@ -0,0 +1,9 @@
1
+ import type { DeliveryUnitIdentityField } from './constants.js';
2
+ import type { BackendFederationContractValidationError, BackendFederationContractValidationResult, DeliveryUnitContractBlock, DeliveryUnitIdentity, DeliveryUnitRecord, ValidateDeliveryUnitIdentityOptions } from './types.js';
3
+ export declare const deliveryUnitIdentityFieldValue: (value: unknown, field: DeliveryUnitIdentityField, options?: Pick<ValidateDeliveryUnitIdentityOptions, 'allowBuildAlias'>) => string | undefined;
4
+ export declare const validateDeliveryUnitIdentity: (value: unknown, options?: ValidateDeliveryUnitIdentityOptions) => BackendFederationContractValidationResult;
5
+ export declare const validateDeliveryUnitContractBlock: (value: unknown, options?: ValidateDeliveryUnitIdentityOptions) => BackendFederationContractValidationResult;
6
+ export declare const validateDeliveryUnitRecord: (value: unknown, options?: ValidateDeliveryUnitIdentityOptions) => BackendFederationContractValidationResult;
7
+ export declare const validateDeliveryUnitBoundaryIdentity: (value: unknown, path: string) => BackendFederationContractValidationError[];
8
+ export declare const deliveryUnitContractBlock: (record: DeliveryUnitRecord) => DeliveryUnitContractBlock;
9
+ export declare const toDeliveryUnitIdentity: (value: unknown) => DeliveryUnitIdentity | undefined;
@@ -0,0 +1,7 @@
1
+ export { createUltramodernBuildArtifact, isUltramodernBuildArtifact, stampUltramodernBuildArtifactIdentity, stampUltramodernBuildArtifactSourceRevision, validateUltramodernBuildArtifact, } from './build-artifact.js';
2
+ export type { DeliveryUnitIdentityField } from './constants.js';
3
+ export { BACKEND_FEDERATION_CONTRACT_VERSION, BACKEND_FEDERATION_EFFECT_EXPOSE, BACKEND_FEDERATION_MANIFEST_FILE, BACKEND_FEDERATION_NODE_ADAPTER_VERSION, BACKEND_FEDERATION_REMOTE_ENTRY_FILE, DELIVERY_UNIT_DEPLOY_PROFILE, DELIVERY_UNIT_IDENTITY_FIELDS, DELIVERY_UNIT_KIND, DELIVERY_UNIT_SCHEMA_VERSION, ULTRAMODERN_BUILD_ARTIFACT_FILE, ULTRAMODERN_BUILD_ARTIFACT_PATH, ULTRAMODERN_BUILD_MODULE_FILE, ULTRAMODERN_BUILD_MODULE_PATH, } from './constants.js';
4
+ export { deliveryUnitContractBlock, deliveryUnitIdentityFieldValue, toDeliveryUnitIdentity, validateDeliveryUnitContractBlock, validateDeliveryUnitIdentity, validateDeliveryUnitRecord, } from './delivery-unit.js';
5
+ export { backendFederationExposeNames, backendFederationMetadata, backendFederationVersionBoundary, toBackendFederationExposeNames, validateBackendFederationManifest, validateBackendFederationMetadata, } from './metadata.js';
6
+ export type { BackendFederationContractValidationError, BackendFederationContractValidationResult, DeliveryUnitContractBlock, DeliveryUnitIdentity, DeliveryUnitRecord, UltramodernBuildArtifact, UltramodernBuildDeliveryUnit, UltramodernBuildSurface, ValidateBackendFederationManifestOptions, ValidateBackendFederationMetadataOptions, ValidateDeliveryUnitIdentityOptions, } from './types.js';
7
+ export { formatBackendFederationValidationErrors, nonEmptyString, } from './validation-core.js';
@@ -0,0 +1,7 @@
1
+ import type { BackendFederationContractValidationResult, ValidateBackendFederationManifestOptions, ValidateBackendFederationMetadataOptions } from './types.js';
2
+ export declare const toBackendFederationExposeNames: (value: unknown) => string[];
3
+ export declare const backendFederationExposeNames: (value: unknown) => string[];
4
+ export declare const backendFederationMetadata: (value: unknown) => Record<string, unknown> | undefined;
5
+ export declare const backendFederationVersionBoundary: (value: unknown) => Record<string, unknown> | undefined;
6
+ export declare const validateBackendFederationMetadata: (value: unknown, options?: ValidateBackendFederationMetadataOptions) => BackendFederationContractValidationResult;
7
+ export declare const validateBackendFederationManifest: (value: unknown, options?: ValidateBackendFederationManifestOptions) => BackendFederationContractValidationResult;
@@ -0,0 +1,60 @@
1
+ import type { DELIVERY_UNIT_DEPLOY_PROFILE, DELIVERY_UNIT_KIND, DELIVERY_UNIT_SCHEMA_VERSION } from './constants.js';
2
+ export type DeliveryUnitIdentity = {
3
+ unitId: string;
4
+ buildMarker: string;
5
+ sourceRevision: string;
6
+ };
7
+ export type DeliveryUnitRecord = DeliveryUnitIdentity & {
8
+ schemaVersion: typeof DELIVERY_UNIT_SCHEMA_VERSION;
9
+ kind: typeof DELIVERY_UNIT_KIND;
10
+ appId: string;
11
+ packageName: string;
12
+ version: string;
13
+ deployProfile: typeof DELIVERY_UNIT_DEPLOY_PROFILE;
14
+ };
15
+ export type DeliveryUnitContractBlock = Omit<DeliveryUnitRecord, 'appId' | 'deployProfile'>;
16
+ export type UltramodernBuildDeliveryUnit = DeliveryUnitRecord & {
17
+ build: string;
18
+ };
19
+ export type UltramodernBuildSurface = (UltramodernBuildDeliveryUnit & {
20
+ surface: 'ui';
21
+ }) | (UltramodernBuildDeliveryUnit & {
22
+ surface: 'api';
23
+ });
24
+ export type UltramodernBuildArtifact = {
25
+ schemaVersion: typeof DELIVERY_UNIT_SCHEMA_VERSION;
26
+ kind: 'ultramodern-build-artifact';
27
+ deliveryUnit: UltramodernBuildDeliveryUnit;
28
+ surfaces: {
29
+ ui: UltramodernBuildDeliveryUnit & {
30
+ surface: 'ui';
31
+ };
32
+ api: UltramodernBuildDeliveryUnit & {
33
+ surface: 'api';
34
+ };
35
+ };
36
+ };
37
+ export type BackendFederationContractValidationError = {
38
+ path: string;
39
+ message: string;
40
+ };
41
+ export type BackendFederationContractValidationResult = {
42
+ ok: boolean;
43
+ errors: BackendFederationContractValidationError[];
44
+ };
45
+ export type ValidateDeliveryUnitIdentityOptions = {
46
+ path?: string;
47
+ allowBuildAlias?: boolean;
48
+ };
49
+ export type ValidateBackendFederationMetadataOptions = {
50
+ path?: string;
51
+ expectedContractVersion?: string | false;
52
+ expectedNodeAdapterVersion?: string | false;
53
+ validateDeliveryUnit?: boolean;
54
+ requireEffectExpose?: boolean;
55
+ requireEffectRuntime?: boolean;
56
+ requireVersionFields?: boolean;
57
+ };
58
+ export type ValidateBackendFederationManifestOptions = ValidateBackendFederationMetadataOptions & {
59
+ requireBackendFederation?: boolean;
60
+ };
@@ -0,0 +1,8 @@
1
+ import type { BackendFederationContractValidationError, BackendFederationContractValidationResult } from './types.js';
2
+ export declare const isRecord: (value: unknown) => value is Record<string, unknown>;
3
+ export declare const nonEmptyString: (value: unknown) => string | undefined;
4
+ export declare const validationResult: (errors: BackendFederationContractValidationError[]) => BackendFederationContractValidationResult;
5
+ export declare const addError: (errors: BackendFederationContractValidationError[], path: string, message: string) => void;
6
+ export declare const recordField: (value: Record<string, unknown> | undefined, field: string) => Record<string, unknown> | undefined;
7
+ export declare const formatBackendFederationValidationErrors: (errors: BackendFederationContractValidationError[]) => string;
8
+ export declare const validateVersionField: (errors: BackendFederationContractValidationError[], record: Record<string, unknown>, field: 'contractVersion' | 'nodeAdapterVersion', expected: string | false, path: string, required: boolean) => void;
package/package.json CHANGED
@@ -1,16 +1,49 @@
1
1
  {
2
2
  "name": "@bleedingdev/modern-js-backend-federation-contracts",
3
- "version": "0.0.0",
4
- "description": "Package-name registration for the forthcoming UltraModern.js release. This setup version contains no runtime implementation.",
5
- "license": "MIT",
3
+ "description": "Fork-owned universal backend federation and delivery-unit contracts.",
4
+ "homepage": "https://github.com/BleedingDev/ultramodern.js#readme",
5
+ "bugs": {
6
+ "url": "https://github.com/BleedingDev/ultramodern.js/issues"
7
+ },
6
8
  "repository": {
7
9
  "type": "git",
8
- "url": "git+https://github.com/BleedingDev/ultramodern.js.git"
10
+ "url": "git+https://github.com/BleedingDev/ultramodern.js.git",
11
+ "directory": "packages/toolkit/backend-federation-contracts"
9
12
  },
13
+ "license": "MIT",
14
+ "version": "3.9.0-ultramodern.11",
10
15
  "files": [
11
- "README.md"
16
+ "dist",
17
+ "src"
12
18
  ],
19
+ "types": "./dist/types/backend-federation-contract/index.d.ts",
20
+ "main": "./dist/cjs/backend-federation-contract/index.js",
21
+ "module": "./dist/esm/backend-federation-contract/index.mjs",
22
+ "exports": {
23
+ ".": {
24
+ "types": "./dist/types/backend-federation-contract/index.d.ts",
25
+ "node": {
26
+ "import": "./dist/esm-node/backend-federation-contract/index.mjs",
27
+ "require": "./dist/cjs/backend-federation-contract/index.js"
28
+ },
29
+ "import": "./dist/esm/backend-federation-contract/index.mjs",
30
+ "default": "./dist/esm/backend-federation-contract/index.mjs"
31
+ }
32
+ },
33
+ "devDependencies": {
34
+ "@modern-js/tsconfig": "npm:@bleedingdev/modern-js-tsconfig@3.9.0-ultramodern.11",
35
+ "@rslib/core": "1.0.0",
36
+ "@rstest/core": "0.11.12",
37
+ "@scripts/rstest-config": "2.66.0",
38
+ "@typescript/native-preview": "7.0.0-dev.20260707.2"
39
+ },
40
+ "sideEffects": false,
13
41
  "publishConfig": {
14
42
  "access": "public"
43
+ },
44
+ "scripts": {
45
+ "dev": "rslib build --watch",
46
+ "build": "rslib build",
47
+ "test": "rstest"
15
48
  }
16
49
  }