@bleedingdev/modern-js-surface-resolution 0.0.0 → 3.9.0-ultramodern.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Modern.js
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/surface-resolution/env-static-provider.js

@@ -0,0 +1,318 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, getters, values)=>{
+        var define = (defs, kind)=>{
+            for(var key in defs)if (__webpack_require__.o(defs, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+                enumerable: true,
+                [kind]: defs[key]
+            });
+        };
+        define(getters, "get");
+        define(values, "value");
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    DEFAULT_LOCAL_ENVIRONMENTS: ()=>DEFAULT_LOCAL_ENVIRONMENTS,
+    ENV_STATIC_PROVIDER_NAME: ()=>ENV_STATIC_PROVIDER_NAME,
+    createEnvStaticSurfaceResolutionProvider: ()=>createEnvStaticSurfaceResolutionProvider
+});
+const external_surface_ref_js_namespaceObject = require("./surface-ref.js");
+const external_validation_js_namespaceObject = require("./validation.js");
+const DEFAULT_LOCAL_ENVIRONMENTS = [
+    'development',
+    'local'
+];
+const ENV_STATIC_PROVIDER_NAME = 'env-static';
+function trimTrailingSlashes(value) {
+    return value.replace(/\/+$/u, '');
+}
+function envValue(env, name) {
+    const value = env[name]?.trim();
+    return void 0 !== value && value.length > 0 ? value : void 0;
+}
+function stripMfNamePrefix(value, mfName) {
+    return value.startsWith(`${mfName}@`) ? value.slice(mfName.length + 1) : value;
+}
+function createEnvContext(env, allowLocalFallback) {
+    return {
+        env,
+        allowLocalFallback,
+        cloudflareDeployEnabled: 'cloudflare' === env.MODERNJS_DEPLOY,
+        workersDevSubdomain: envValue(env, 'ULTRAMODERN_CLOUDFLARE_WORKERS_DEV_SUBDOMAIN'),
+        requireCloudflarePublicUrls: 'true' === env.ULTRAMODERN_CLOUDFLARE_REQUIRE_PUBLIC_URLS
+    };
+}
+function resolveBaseUrl(context, unit) {
+    const publicUrlEnv = `ULTRAMODERN_PUBLIC_URL_${unit.envSegment}`;
+    const configuredPublicUrl = envValue(context.env, publicUrlEnv);
+    if (void 0 !== configuredPublicUrl) return {
+        ok: true,
+        baseUrl: trimTrailingSlashes(configuredPublicUrl)
+    };
+    if (context.cloudflareDeployEnabled && void 0 !== context.workersDevSubdomain && void 0 !== unit.workerName) return {
+        ok: true,
+        baseUrl: `https://${unit.workerName}.${context.workersDevSubdomain}.workers.dev`
+    };
+    if (context.cloudflareDeployEnabled && context.requireCloudflarePublicUrls) return {
+        ok: false,
+        reason: `Cloudflare deploy requires ${publicUrlEnv} (or a configured manifest env / ULTRAMODERN_CLOUDFLARE_WORKERS_DEV_SUBDOMAIN with a worker name)`,
+        details: {
+            publicUrlEnv
+        }
+    };
+    if (void 0 !== unit.port && context.allowLocalFallback) return {
+        ok: true,
+        baseUrl: `http://localhost:${unit.port}`
+    };
+    if (void 0 !== unit.port) return {
+        ok: false,
+        reason: `No base URL available: set ${publicUrlEnv} (localhost fallback is disabled outside designated local environments)`,
+        details: {
+            publicUrlEnv
+        }
+    };
+    return {
+        ok: false,
+        reason: `No base URL available: set ${publicUrlEnv} or configure a localhost port`,
+        details: {
+            publicUrlEnv
+        }
+    };
+}
+function resolveBrowserMfManifest(context, unit) {
+    const manifestEnv = `VERTICAL_${unit.envSegment}_MF_MANIFEST`;
+    const configuredManifest = envValue(context.env, manifestEnv);
+    if (void 0 !== configuredManifest) return {
+        ok: true,
+        location: {
+            platform: 'browser-mf-manifest',
+            manifestUrl: stripMfNamePrefix(configuredManifest, unit.mfName)
+        }
+    };
+    const base = resolveBaseUrl(context, unit);
+    if (!base.ok) return {
+        ok: false,
+        reason: `browser-mf-manifest unavailable (${manifestEnv} unset; ${base.reason})`,
+        details: {
+            manifestEnv,
+            ...base.details
+        }
+    };
+    return {
+        ok: true,
+        location: {
+            platform: 'browser-mf-manifest',
+            manifestUrl: `${base.baseUrl}/mf-manifest.json`
+        }
+    };
+}
+function resolveNodeMfManifest(context, unit) {
+    const manifestEnv = `VERTICAL_${unit.envSegment}_BACKEND_MF_MANIFEST`;
+    const configuredManifest = envValue(context.env, manifestEnv);
+    if (void 0 !== configuredManifest) return {
+        ok: true,
+        location: {
+            platform: 'node-mf-manifest',
+            manifestRef: configuredManifest
+        }
+    };
+    if (void 0 !== unit.port && context.allowLocalFallback) return {
+        ok: true,
+        location: {
+            platform: 'node-mf-manifest',
+            manifestRef: `http://localhost:${unit.port}/backend-mf-manifest.json`
+        }
+    };
+    if (void 0 !== unit.port) return {
+        ok: false,
+        reason: `node-mf-manifest unavailable: set ${manifestEnv} (localhost fallback is disabled outside designated local environments)`,
+        details: {
+            manifestEnv
+        }
+    };
+    return {
+        ok: false,
+        reason: `node-mf-manifest unavailable: set ${manifestEnv} or configure a localhost port`,
+        details: {
+            manifestEnv
+        }
+    };
+}
+function resolveHttpApi(context, unit, config) {
+    const base = resolveBaseUrl(context, unit);
+    if (!base.ok) return {
+        ok: false,
+        reason: `http-api unavailable (${base.reason})`,
+        details: base.details
+    };
+    return {
+        ok: true,
+        location: {
+            platform: 'http-api',
+            baseUrl: base.baseUrl,
+            prefix: config.prefix
+        }
+    };
+}
+function resolveCloudflareServiceBinding(config) {
+    if (0 === config.serviceBinding.length) return {
+        ok: false,
+        reason: 'cloudflare-service-binding unavailable: empty serviceBinding'
+    };
+    return {
+        ok: true,
+        location: {
+            platform: 'cloudflare-service-binding',
+            serviceBinding: config.serviceBinding,
+            ...void 0 === config.dispatchNamespace ? {} : {
+                dispatchNamespace: config.dispatchNamespace
+            }
+        }
+    };
+}
+function resolveSurfaceLocations(context, unit, surface) {
+    const outcomes = [];
+    if (surface.platforms.browserMfManifest) outcomes.push(resolveBrowserMfManifest(context, unit));
+    if (surface.platforms.nodeMfManifest) outcomes.push(resolveNodeMfManifest(context, unit));
+    if (void 0 !== surface.platforms.httpApi) outcomes.push(resolveHttpApi(context, unit, surface.platforms.httpApi));
+    if (void 0 !== surface.platforms.cloudflareServiceBinding) outcomes.push(resolveCloudflareServiceBinding(surface.platforms.cloudflareServiceBinding));
+    const failure = outcomes.find((outcome)=>!outcome.ok);
+    if (void 0 !== failure && !failure.ok) return {
+        ok: false,
+        reason: `surface ${surface.surfaceId}: ${failure.reason}`,
+        details: failure.details
+    };
+    const locations = outcomes.flatMap((outcome)=>outcome.ok ? [
+            outcome.location
+        ] : []);
+    if (0 === locations.length) return {
+        ok: false,
+        reason: `surface ${surface.surfaceId} declares no platform locations`
+    };
+    return {
+        ok: true,
+        surface: {
+            surfaceId: surface.surfaceId,
+            kind: surface.kind,
+            locations
+        }
+    };
+}
+function createEnvStaticSurfaceResolutionProvider(options) {
+    const env = options.env ?? {};
+    const localEnvironments = new Set(options.localEnvironments ?? DEFAULT_LOCAL_ENVIRONMENTS);
+    const identityVerification = options.identityVerification ?? 'static-trust';
+    const unitsById = new Map(options.units.map((unit)=>[
+            unit.unitId,
+            unit
+        ]));
+    return {
+        name: ENV_STATIC_PROVIDER_NAME,
+        resolve (ref, environment) {
+            const refString = (0, external_surface_ref_js_namespaceObject.formatSurfaceRef)(ref);
+            const unit = unitsById.get(ref.unitId);
+            if (void 0 === unit) return {
+                ok: false,
+                error: (0, external_validation_js_namespaceObject.createDiscoveryError)('unknown-unit', refString, `No statically configured delivery unit ${ref.unitId}.`, {
+                    environment,
+                    knownUnits: [
+                        ...unitsById.keys()
+                    ]
+                })
+            };
+            if (!unit.surfaces.some((surface)=>surface.surfaceId === ref.surfaceId)) return {
+                ok: false,
+                error: (0, external_validation_js_namespaceObject.createDiscoveryError)('unknown-surface', refString, `Unit ${unit.unitId} does not declare surface ${ref.surfaceId}.`, {
+                    environment,
+                    availableSurfaces: unit.surfaces.map((surface)=>surface.surfaceId)
+                })
+            };
+            let effectiveUnit = unit;
+            if (void 0 !== ref.major) {
+                const majorConfig = (unit.majors ?? []).find((candidate)=>candidate.major === ref.major);
+                if (void 0 === majorConfig) return {
+                    ok: false,
+                    error: (0, external_validation_js_namespaceObject.createDiscoveryError)('major-not-published', refString, `Unit ${unit.unitId} has no materialization for external major v${ref.major}.`, {
+                        environment,
+                        publishedMajors: (unit.majors ?? []).map((candidate)=>candidate.major)
+                    })
+                };
+                effectiveUnit = {
+                    ...unit,
+                    envSegment: majorConfig.envSegment ?? `${unit.envSegment}_V${majorConfig.major}`,
+                    port: majorConfig.port,
+                    workerName: majorConfig.workerName
+                };
+            }
+            const context = createEnvContext(env, localEnvironments.has(environment));
+            const surfaces = [];
+            for (const surfaceConfig of unit.surfaces){
+                const resolved = resolveSurfaceLocations(context, effectiveUnit, surfaceConfig);
+                if (!resolved.ok) return {
+                    ok: false,
+                    error: (0, external_validation_js_namespaceObject.createDiscoveryError)('provider-unavailable', refString, `env-static provider cannot assemble a complete record for ${unit.unitId}: ${resolved.reason}.`, {
+                        environment,
+                        ...resolved.details
+                    })
+                };
+                surfaces.push(void 0 === ref.major ? resolved.surface : {
+                    ...resolved.surface,
+                    servedMajor: ref.major
+                });
+            }
+            const record = {
+                unitId: unit.unitId,
+                buildMarker: unit.buildMarker,
+                sourceRevision: unit.sourceRevision,
+                baselineCohortId: unit.baselineCohortId,
+                surfaces,
+                compatibility: {
+                    status: 'compatible',
+                    baselineCohortId: unit.baselineCohortId,
+                    ...'static-trust' === identityVerification ? {
+                        reason: 'static-identity-unverified'
+                    } : {}
+                }
+            };
+            const validation = (0, external_validation_js_namespaceObject.validateResolvedDeliveryUnit)(record);
+            if (!validation.ok) return {
+                ok: false,
+                error: (0, external_validation_js_namespaceObject.createDiscoveryError)('provider-unavailable', refString, `env-static provider assembled an invalid record for ${unit.unitId}.`, {
+                    environment,
+                    issues: validation.issues
+                })
+            };
+            return {
+                ok: true,
+                unit: record
+            };
+        }
+    };
+}
+exports.DEFAULT_LOCAL_ENVIRONMENTS = __webpack_exports__.DEFAULT_LOCAL_ENVIRONMENTS;
+exports.ENV_STATIC_PROVIDER_NAME = __webpack_exports__.ENV_STATIC_PROVIDER_NAME;
+exports.createEnvStaticSurfaceResolutionProvider = __webpack_exports__.createEnvStaticSurfaceResolutionProvider;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "DEFAULT_LOCAL_ENVIRONMENTS",
+    "ENV_STATIC_PROVIDER_NAME",
+    "createEnvStaticSurfaceResolutionProvider"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/cjs/surface-resolution/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, getters, values)=>{
+        var define = (defs, kind)=>{
+            for(var key in defs)if (__webpack_require__.o(defs, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+                enumerable: true,
+                [kind]: defs[key]
+            });
+        };
+        define(getters, "get");
+        define(values, "value");
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    DEFAULT_LOCAL_ENVIRONMENTS: ()=>external_env_static_provider_js_namespaceObject.DEFAULT_LOCAL_ENVIRONMENTS,
+    ENV_STATIC_PROVIDER_NAME: ()=>external_env_static_provider_js_namespaceObject.ENV_STATIC_PROVIDER_NAME,
+    createDiscoveryError: ()=>external_validation_js_namespaceObject.createDiscoveryError,
+    createEnvStaticSurfaceResolutionProvider: ()=>external_env_static_provider_js_namespaceObject.createEnvStaticSurfaceResolutionProvider,
+    formatSurfaceRef: ()=>external_surface_ref_js_namespaceObject.formatSurfaceRef,
+    matchDeliveryUnitIdentity: ()=>external_validation_js_namespaceObject.matchDeliveryUnitIdentity,
+    parseSurfaceRef: ()=>external_surface_ref_js_namespaceObject.parseSurfaceRef,
+    selectResolvedSurface: ()=>external_validation_js_namespaceObject.selectResolvedSurface,
+    validateResolvedDeliveryUnit: ()=>external_validation_js_namespaceObject.validateResolvedDeliveryUnit,
+    validateSurfaceRef: ()=>external_surface_ref_js_namespaceObject.validateSurfaceRef
+});
+const external_env_static_provider_js_namespaceObject = require("./env-static-provider.js");
+const external_surface_ref_js_namespaceObject = require("./surface-ref.js");
+const external_validation_js_namespaceObject = require("./validation.js");
+exports.DEFAULT_LOCAL_ENVIRONMENTS = __webpack_exports__.DEFAULT_LOCAL_ENVIRONMENTS;
+exports.ENV_STATIC_PROVIDER_NAME = __webpack_exports__.ENV_STATIC_PROVIDER_NAME;
+exports.createDiscoveryError = __webpack_exports__.createDiscoveryError;
+exports.createEnvStaticSurfaceResolutionProvider = __webpack_exports__.createEnvStaticSurfaceResolutionProvider;
+exports.formatSurfaceRef = __webpack_exports__.formatSurfaceRef;
+exports.matchDeliveryUnitIdentity = __webpack_exports__.matchDeliveryUnitIdentity;
+exports.parseSurfaceRef = __webpack_exports__.parseSurfaceRef;
+exports.selectResolvedSurface = __webpack_exports__.selectResolvedSurface;
+exports.validateResolvedDeliveryUnit = __webpack_exports__.validateResolvedDeliveryUnit;
+exports.validateSurfaceRef = __webpack_exports__.validateSurfaceRef;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "DEFAULT_LOCAL_ENVIRONMENTS",
+    "ENV_STATIC_PROVIDER_NAME",
+    "createDiscoveryError",
+    "createEnvStaticSurfaceResolutionProvider",
+    "formatSurfaceRef",
+    "matchDeliveryUnitIdentity",
+    "parseSurfaceRef",
+    "selectResolvedSurface",
+    "validateResolvedDeliveryUnit",
+    "validateSurfaceRef"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/cjs/surface-resolution/surface-ref.js

@@ -0,0 +1,132 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, getters, values)=>{
+        var define = (defs, kind)=>{
+            for(var key in defs)if (__webpack_require__.o(defs, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+                enumerable: true,
+                [kind]: defs[key]
+            });
+        };
+        define(getters, "get");
+        define(values, "value");
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+const SEGMENT_PATTERN = /^[A-Za-z0-9._-]+$/;
+const MAJOR_PATTERN = /^v[1-9][0-9]*$/;
+function parseSurfaceRef(input) {
+    if ('' === input) return {
+        ok: false,
+        error: {
+            code: 'empty'
+        }
+    };
+    const hashCount = countChar(input, '#');
+    if (0 === hashCount) return {
+        ok: false,
+        error: {
+            code: 'missing-surface-separator'
+        }
+    };
+    if (hashCount > 1) return {
+        ok: false,
+        error: {
+            code: 'multiple-surface-separators'
+        }
+    };
+    const hashIndex = input.indexOf('#');
+    const unitPart = input.slice(0, hashIndex);
+    const rest = input.slice(hashIndex + 1);
+    const atIndex = rest.indexOf('@');
+    const surfaceId = -1 === atIndex ? rest : rest.slice(0, atIndex);
+    const ref = {
+        unitId: unitPart,
+        surfaceId
+    };
+    if (-1 !== atIndex) {
+        const majorPart = rest.slice(atIndex + 1);
+        if ('' === majorPart) return {
+            ok: false,
+            error: {
+                code: 'empty-major'
+            }
+        };
+        if (!MAJOR_PATTERN.test(majorPart)) return {
+            ok: false,
+            error: {
+                code: 'invalid-major',
+                value: majorPart
+            }
+        };
+        ref.major = Number(majorPart.slice(1));
+    }
+    const error = validateSurfaceRef(ref);
+    return void 0 === error ? {
+        ok: true,
+        ref
+    } : {
+        ok: false,
+        error
+    };
+}
+function formatSurfaceRef(ref) {
+    const error = validateSurfaceRef(ref);
+    if (void 0 !== error) throw new TypeError(`Cannot format invalid SurfaceRef: ${error.code}.`);
+    const base = `${ref.unitId}#${ref.surfaceId}`;
+    return void 0 === ref.major ? base : `${base}@v${ref.major}`;
+}
+function validateSurfaceRef(ref) {
+    if ('' === ref.unitId) return {
+        code: 'empty-unit-id'
+    };
+    for (const segment of ref.unitId.split('/'))if (!SEGMENT_PATTERN.test(segment)) return {
+        code: 'invalid-unit-id',
+        segment
+    };
+    if ('' === ref.surfaceId) return {
+        code: 'empty-surface-id'
+    };
+    if (!SEGMENT_PATTERN.test(ref.surfaceId)) return {
+        code: 'invalid-surface-id'
+    };
+    if (void 0 !== ref.major && (!Number.isSafeInteger(ref.major) || ref.major < 1)) return {
+        code: 'invalid-major',
+        value: String(ref.major)
+    };
+}
+function countChar(input, char) {
+    let count = 0;
+    for (const current of input)if (current === char) count += 1;
+    return count;
+}
+__webpack_require__.d(__webpack_exports__, {
+    formatSurfaceRef: ()=>formatSurfaceRef,
+    parseSurfaceRef: ()=>parseSurfaceRef,
+    validateSurfaceRef: ()=>validateSurfaceRef
+});
+exports.formatSurfaceRef = __webpack_exports__.formatSurfaceRef;
+exports.parseSurfaceRef = __webpack_exports__.parseSurfaceRef;
+exports.validateSurfaceRef = __webpack_exports__.validateSurfaceRef;
+for(var __rspack_i in __webpack_exports__)if (-1 === [
+    "formatSurfaceRef",
+    "parseSurfaceRef",
+    "validateSurfaceRef"
+].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/cjs/surface-resolution/types.js

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __rspack_i in __webpack_exports__)exports[__rspack_i] = __webpack_exports__[__rspack_i];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});