@bleedingdev/modern-js-create 3.4.0-ultramodern.3 → 3.4.0-ultramodern.5

package/dist/esm/ultramodern-workspace/effect-api.js

@@ -36,27 +36,51 @@ function serviceHasCheckoutCartState(service) {
 function createCheckoutCartSharedSchemas(service) {
     if (!serviceHasCheckoutCartState(service)) return '';
     return `
-export const checkoutCartLineSchema = Schema.Struct({
+export interface CheckoutCartLine {
+  readonly sku: string;
+  readonly name: string;
+  readonly quantity: number;
+  readonly unitPriceCents: number;
+}
+
+export interface CheckoutCart {
+  readonly lines: readonly CheckoutCartLine[];
+  readonly subtotalCents: number;
+  readonly totalQuantity: number;
+}
+
+export interface CheckoutAddCartItemPayload {
+  readonly sku: string;
+  readonly name?: string;
+  readonly quantity: number;
+  readonly unitPriceCents?: number;
+}
+
+export interface CheckoutRemoveCartItemPayload {
+  readonly sku: string;
+}
+
+export const checkoutCartLineSchema: Schema.Codec<CheckoutCartLine> = Schema.Struct({
   sku: Schema.String,
   name: Schema.String,
   quantity: Schema.Finite,
   unitPriceCents: Schema.Finite,
 });
 
-export const checkoutCartSchema = Schema.Struct({
+export const checkoutCartSchema: Schema.Codec<CheckoutCart> = Schema.Struct({
   lines: Schema.Array(checkoutCartLineSchema),
   subtotalCents: Schema.Finite,
   totalQuantity: Schema.Finite,
 });
 
-export const checkoutAddCartItemPayloadSchema = Schema.Struct({
+export const checkoutAddCartItemPayloadSchema: Schema.Codec<CheckoutAddCartItemPayload> = Schema.Struct({
   sku: Schema.String,
   name: Schema.optional(Schema.String),
   quantity: Schema.Finite,
   unitPriceCents: Schema.optional(Schema.Finite),
 });
 
-export const checkoutRemoveCartItemPayloadSchema = Schema.Struct({
+export const checkoutRemoveCartItemPayloadSchema: Schema.Codec<CheckoutRemoveCartItemPayload> = Schema.Struct({
   sku: Schema.String,
 });
 `;
@@ -209,6 +233,7 @@ function createCheckoutCartClientExports(service) {
     const pascalStem = toPascalCase(stem);
     const clientOptionsName = `${pascalStem}ClientOptions`;
     const createClientName = `create${pascalStem}Client`;
+    const clientEffectTypeName = `${pascalStem}ClientEffect`;
     return `
 export interface CheckoutCartLine {
   sku: string;
@@ -232,7 +257,7 @@ export interface CheckoutAddCartItemInput {
 
 export const getCheckoutCart = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -244,7 +269,7 @@ export const getCheckoutCart = (
 export const addCheckoutCartItem = (
   payload: CheckoutAddCartItemInput,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -258,7 +283,7 @@ export const addCheckoutCartItem = (
 export const removeCheckoutCartItem = (
   sku: string,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -271,7 +296,7 @@ export const removeCheckoutCartItem = (
 
 export const clearCheckoutCart = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -302,12 +327,63 @@ function createEffectSharedApiContract(service) {
     const apiName = verticalEffectApiName(service);
     const groupName = verticalEffectGroupName(service);
     const stem = effectApiStem(service);
+    const pascalStem = toPascalCase(stem);
+    const markerType = `${pascalStem}Marker`;
+    const itemType = `${pascalStem}Item`;
+    const readinessType = `${pascalStem}Readiness`;
+    const createPayloadType = `${pascalStem}CreatePayload`;
+    const createResponseType = `${pascalStem}CreateResponse`;
+    const listResponseType = `${pascalStem}ListResponse`;
     const apiPrefix = effectApiPrefix(service);
     const checkoutCartSharedSchemas = createCheckoutCartSharedSchemas(service);
     const checkoutCartSharedSchemaSection = '' === checkoutCartSharedSchemas ? '' : `${checkoutCartSharedSchemas}\n`;
     const checkoutCartOperationContexts = createCheckoutCartOperationContexts(service).trimStart();
     const checkoutCartOperationContextEntries = '' === checkoutCartOperationContexts ? '' : `${checkoutCartOperationContexts}\n`;
-    return `export const ${markerSchemaExport} = Schema.Struct({
+    return `export interface ${markerType} {
+  readonly appId: string;
+  readonly build: string;
+  readonly deployProfile: string;
+  readonly packageName: string;
+  readonly surface: string;
+  readonly version: string;
+}
+
+export interface ${itemType} {
+  readonly id: string;
+  readonly marker: ${markerType};
+  readonly title: string;
+}
+
+export interface ${readinessType} {
+  readonly checks: {
+    readonly effectBff: 'ready';
+    readonly moduleFederation: 'ready';
+    readonly ssr: 'ready';
+    readonly translations: 'ready';
+  };
+  readonly marker: ${markerType};
+  readonly status: 'ready';
+  readonly versionSkew: 'none';
+}
+
+export interface ${createPayloadType} {
+  readonly title: string;
+}
+
+export interface ${listResponseType} {
+  readonly items: readonly ${itemType}[];
+}
+
+export interface ${createResponseType} {
+  readonly item: ${itemType};
+}
+
+export interface ${notFoundErrorExport} {
+  readonly _tag: '${notFoundErrorExport}';
+  readonly id: string;
+}
+
+export const ${markerSchemaExport}: Schema.Codec<${markerType}> = Schema.Struct({
   appId: Schema.String,
   build: Schema.String,
   deployProfile: Schema.String,
@@ -316,13 +392,13 @@ function createEffectSharedApiContract(service) {
   version: Schema.String,
 });
 
-export const ${schemaExport} = Schema.Struct({
+export const ${schemaExport}: Schema.Codec<${itemType}> = Schema.Struct({
   id: Schema.String,
   marker: ${markerSchemaExport},
   title: Schema.String,
 });
 
-export const ${readinessSchemaExport} = Schema.Struct({
+export const ${readinessSchemaExport}: Schema.Codec<${readinessType}> = Schema.Struct({
   checks: Schema.Struct({
     effectBff: Schema.Literal('ready'),
     moduleFederation: Schema.Literal('ready'),
@@ -334,18 +410,13 @@ export const ${readinessSchemaExport} = Schema.Struct({
   versionSkew: Schema.Literal('none'),
 });
 
-export const ${createPayloadSchemaExport} = Schema.Struct({
+export const ${createPayloadSchemaExport}: Schema.Codec<${createPayloadType}> = Schema.Struct({
   title: Schema.String,
 });
 
-${checkoutCartSharedSchemaSection}export class ${notFoundErrorExport} extends Schema.TaggedErrorClass<${notFoundErrorExport}>()(
-  '${notFoundErrorExport}',
-  {
-    id: Schema.String,
-  },
-) {}
-
-export const ${notFoundSchemaExport} = ${notFoundErrorExport}.pipe(
+${checkoutCartSharedSchemaSection}export const ${notFoundSchemaExport}: Schema.Codec<${notFoundErrorExport}> = Schema.TaggedStruct('${notFoundErrorExport}', {
+  id: Schema.String,
+}).pipe(
   HttpApiSchema.status(404),
 );
 
@@ -449,13 +520,20 @@ function createEffectServiceEntry(service, contractImportPath) {
   HttpApiBuilder,
   Layer,
 } from '@modern-js/plugin-bff/effect-edge';
-import { ultramodernApiMarker } from '../../src/ultramodern-build.ts';
+import type {
+  EffectBffDefinition,
+  EffectBffRuntime,
+  EffectRuntimeLayer,
+} from '@modern-js/plugin-bff/effect-edge';
+import { ultramodernApiMarker } from '../../shared/ultramodern-build.ts';
 import {
   ${apiExport},
   ${groupName}OperationContexts,
+} from '${contractImportPath}';
+import type {
   ${notFoundErrorExport},
+  OperationContext,
 } from '${contractImportPath}';
-import type { OperationContext } from '${contractImportPath}';
 
 const ${groupName}Items = [
   {
@@ -516,9 +594,13 @@ const ${groupName}Layer = HttpApiBuilder.group(
         const matchedItem = ${groupName}Items.find(
           candidate => candidate.id === params.id,
         );
+        const notFound: ${notFoundErrorExport} = {
+          _tag: '${notFoundErrorExport}',
+          id: params.id,
+        };
         const result =
           matchedItem === undefined
-            ? Effect.fail(new ${notFoundErrorExport}({ id: params.id }))
+            ? Effect.fail(notFound)
             : Effect.succeed(matchedItem);
 
         return result.pipe(
@@ -549,12 +631,15 @@ const ${groupName}Layer = HttpApiBuilder.group(
 
 const layer = HttpApiBuilder.layer(${apiExport}).pipe(
   Layer.provide(${groupName}Layer),
-);
+) satisfies EffectRuntimeLayer;
 
-export default defineEffectBff({
+const effectBff: EffectBffDefinition<typeof ${apiExport}, EffectRuntimeLayer> &
+  EffectBffRuntime<typeof ${apiExport}, EffectRuntimeLayer> = defineEffectBff({
   api: ${apiExport},
   layer,
 });
+
+export default effectBff;
 `;
 }
 function createEffectClient(service, contractImportPath) {
@@ -565,25 +650,71 @@ function createEffectClient(service, contractImportPath) {
     const singular = verticalEffectErrorStem(service);
     const clientOptionsName = `${toPascalCase(stem)}ClientOptions`;
     const createClientName = `create${toPascalCase(stem)}Client`;
+    const clientTypeName = `${toPascalCase(stem)}Client`;
+    const clientEffectTypeName = `${toPascalCase(stem)}ClientEffect`;
     const listName = `list${toPascalCase(stem)}`;
     const readinessName = `get${toPascalCase(stem)}Readiness`;
     const getName = `get${toPascalCase(singular)}`;
     const createName = `create${toPascalCase(singular)}`;
+    const notFoundErrorExport = verticalEffectNotFoundErrorExport(service);
+    const pascalStem = toPascalCase(stem);
+    const itemType = `${pascalStem}Item`;
+    const readinessType = `${pascalStem}Readiness`;
+    const createResponseType = `${pascalStem}CreateResponse`;
+    const listResponseType = `${pascalStem}ListResponse`;
     const checkoutCartClientExports = createCheckoutCartClientExports(service);
     return `import {
   Effect,
   makeEffectHttpApiClient,
   runEffectRequest,
 } from '@modern-js/plugin-bff/effect-client';
+import type {
+  HttpClientError,
+  HttpApi,
+  HttpApiClient,
+  HttpApiGroup,
+  Schema,
+} from '@modern-js/plugin-bff/effect-client';
 import {
   ${contractExport}ApiContract,
   ${apiExport},
   ${groupName}OperationContexts,
 } from '${contractImportPath}';
-import type { OperationContext } from '${contractImportPath}';
+import type {
+  ${createResponseType},
+  ${itemType},
+  ${listResponseType},
+  ${notFoundErrorExport},
+  OperationContext,
+  ${readinessType},
+} from '${contractImportPath}';
 
 export { Effect, runEffectRequest };
 
+type ${pascalStem}EffectGroups = typeof ${apiExport} extends HttpApi.HttpApi<
+  infer _ApiId,
+  infer Groups
+>
+  ? Groups
+  : never;
+
+export type ${clientTypeName} = HttpApiClient.Client<
+  Extract<${pascalStem}EffectGroups, HttpApiGroup.Any>,
+  never,
+  never
+>;
+
+export type ${pascalStem}ClientError =
+  | ${notFoundErrorExport}
+  | HttpClientError.HttpClientError
+  | Schema.SchemaError;
+
+export type ${clientEffectTypeName}<Success> = Effect.Effect<
+  Success,
+  ${pascalStem}ClientError,
+  never
+>;
+
 export interface ${clientOptionsName} {
   baseUrl?: string | URL;
   locale?: string;
@@ -593,7 +724,7 @@ export interface ${clientOptionsName} {
 
 export const ${createClientName} = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${clientTypeName}> =>
   makeEffectHttpApiClient(${apiExport}, {
     baseUrl: options.baseUrl ?? ${contractExport}ApiContract.apiPrefix,
     requestContext: {
@@ -609,7 +740,7 @@ export const ${createClientName} = (
 
 export const ${listName} = (
   options: ${clientOptionsName} & { limit?: number } = {},
-) =>
+): ${clientEffectTypeName}<${listResponseType}> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -622,7 +753,7 @@ export const ${listName} = (
 
 export const ${readinessName} = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${readinessType}> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -634,7 +765,7 @@ export const ${readinessName} = (
 export const ${getName} = (
   id: string,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${itemType}> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -646,7 +777,7 @@ export const ${getName} = (
 export const ${createName} = (
   title: string,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${createResponseType}> =>
   ${createClientName}({
     ...options,
     operationContext:

package/dist/esm/ultramodern-workspace/module-federation.js

@@ -217,12 +217,12 @@ ${bffPluginEntry}        moduleFederationPlugin(),
 }
 function createSharedModuleFederationConfig() {
     return `  shared: {
-    '@modern-js/plugin-i18n/runtime/no-react-i18next': {
+    '@modern-js/plugin-i18n/runtime': {
       requiredVersion: pluginI18nVersion,
       singleton: true,
       treeShaking: false,
     },
-    '@modern-js/plugin-i18n/runtime': {
+    '@modern-js/plugin-i18n/runtime/no-react-i18next': {
       requiredVersion: pluginI18nVersion,
       singleton: true,
       treeShaking: false,
@@ -342,7 +342,9 @@ const reactVersion = (require('react/package.json') as { version: string }).vers
 const reactDomVersion = (require('react-dom/package.json') as { version: string }).version;
 
 ${createModuleFederationRemoteUrlHelpers(shellHost, remotes)}
-export default createModuleFederationConfig({
+const moduleFederationConfig: Parameters<
+  typeof createModuleFederationConfig
+>[0] = createModuleFederationConfig({
   bridge: {
     enableBridgeRouter: false,
   },
@@ -360,6 +362,8 @@ export default createModuleFederationConfig({
 ${createModuleFederationRemotesConfig(scope, shellHost, remotes)}${createSharedModuleFederationConfig()},
   treeShakingSharedExcludePlugins: ['RspackModuleFederationPlugin'],
 });
+
+export default moduleFederationConfig;
 `;
 }
 function createBuildMarker(scope, app) {
@@ -385,6 +389,14 @@ export const ultramodernApiMarker = {
 } as const;
 `;
 }
+function createUltramodernBuildReexportModule() {
+    return `export {
+  ultramodernApiMarker,
+  ultramodernUiMarker,
+  ultramodernVerticalIdentity,
+} from '../shared/ultramodern-build';
+`;
+}
 function createRemoteModuleFederationConfig(scope, app, remotes = []) {
     const exposes = formatTsObjectLiteral(app.exposes ?? {});
     return `// @effect-diagnostics nodeBuiltinImport:off
@@ -400,7 +412,9 @@ const reactVersion = (require('react/package.json') as { version: string }).vers
 const reactDomVersion = (require('react-dom/package.json') as { version: string }).version;
 
 ${createModuleFederationRemoteUrlHelpers(app, remotes)}
-export default createModuleFederationConfig({
+const moduleFederationConfig: Parameters<
+  typeof createModuleFederationConfig
+>[0] = createModuleFederationConfig({
   bridge: {
     enableBridgeRouter: false,
   },
@@ -419,6 +433,8 @@ export default createModuleFederationConfig({
 ${createModuleFederationRemotesConfig(scope, app, remotes)}${createSharedModuleFederationConfig()},
   treeShakingSharedExcludePlugins: ['RspackModuleFederationPlugin'],
 });
+
+export default moduleFederationConfig;
 `;
 }
-export { createAppModernConfig, createBuildMarker, createModuleFederationRemoteUrlHelpers, createModuleFederationRemotesConfig, createRemoteModuleFederationConfig, createSharedModuleFederationConfig, createShellModuleFederationConfig, createUltramodernBuildModule, formatTsObjectLiteral };
+export { createAppModernConfig, createBuildMarker, createModuleFederationRemoteUrlHelpers, createModuleFederationRemotesConfig, createRemoteModuleFederationConfig, createSharedModuleFederationConfig, createShellModuleFederationConfig, createUltramodernBuildModule, createUltramodernBuildReexportModule, formatTsObjectLiteral };

package/dist/esm/ultramodern-workspace/package-json.js

@@ -255,6 +255,10 @@ function createTsBuildInfoFile(packageDir) {
     const cacheKey = packageDir.replace(/[^a-zA-Z0-9._-]+/gu, '__');
     return `${relativeRootFor(packageDir)}/node_modules/.cache/tsgo/${cacheKey}.tsbuildinfo`;
 }
+function createTsDeclarationOutDir(packageDir) {
+    const cacheKey = packageDir.replace(/[^a-zA-Z0-9._-]+/gu, '__');
+    return `${relativeRootFor(packageDir)}/node_modules/.cache/tsgo/declarations/${cacheKey}`;
+}
 function createReferences(packageDir, references) {
     return [
         ...new Set(references)
@@ -268,16 +272,24 @@ function createPackageTsConfig(packageDir, options = {}) {
     } : options;
     const include = resolvedOptions.include ?? [
         'src',
+        'locales/**/*.json',
         'modern.config.ts',
-        'module-federation.config.ts'
+        'module-federation.config.ts',
+        'package.json',
+        'shared'
     ];
-    if (resolvedOptions.includeApi) include.push('api', 'shared');
+    if (resolvedOptions.includeApi) include.push('api');
     const references = createReferences(packageDir, resolvedOptions.references ?? []);
     const tsconfig = {
         extends: `${relativeRootFor(packageDir)}/tsconfig.base.json`,
         compilerOptions: {
             composite: true,
+            declaration: true,
+            declarationMap: false,
+            emitDeclarationOnly: true,
             incremental: true,
+            noEmit: false,
+            outDir: createTsDeclarationOutDir(packageDir),
             tsBuildInfoFile: createTsBuildInfoFile(packageDir)
         },
         include

package/dist/esm/ultramodern-workspace/write-workspace.js

@@ -7,7 +7,7 @@ import { createEffectClient, createEffectServiceEntry, createEffectSharedApi, cr
 import { copyRootTemplate, writeFile, writeJson } from "./fs-io.js";
 import { createFileSnapshot, createGenerationResult, diffFileSnapshots } from "./generation-result.js";
 import { createAppPublicLocaleMessages } from "./locales.js";
-import { createAppModernConfig, createRemoteModuleFederationConfig, createShellModuleFederationConfig, createUltramodernBuildModule } from "./module-federation.js";
+import { createAppModernConfig, createRemoteModuleFederationConfig, createShellModuleFederationConfig, createUltramodernBuildModule, createUltramodernBuildReexportModule } from "./module-federation.js";
 import { assertUniqueTailwindPrefixes, toPackageScope } from "./naming.js";
 import { runCodeSmithOverlays } from "./overlays.js";
 import { createAppPackage, createAppTsConfig, createRootPackageJson, createRootTsConfig, createSharedContractsIndex, createSharedPackage, createSharedPackageTsConfig, createTsConfigBase } from "./package-json.js";
@@ -24,7 +24,8 @@ function writeApp(targetDir, scope, app, packageSource, enableTailwind, remotes
     writeJson(targetDir, `${resolvedApp.directory}/package.json`, createAppPackage(scope, resolvedApp, packageSource, enableTailwind, remotes));
     writeJson(targetDir, `${resolvedApp.directory}/tsconfig.json`, createAppTsConfig(resolvedApp, remotes));
     writeFile(targetDir, `${resolvedApp.directory}/src/modern-app-env.d.ts`, createAppEnvDts(resolvedApp, remotes));
-    writeFile(targetDir, `${resolvedApp.directory}/src/ultramodern-build.ts`, createUltramodernBuildModule(scope, resolvedApp));
+    writeFile(targetDir, `${resolvedApp.directory}/src/ultramodern-build.ts`, createUltramodernBuildReexportModule());
+    writeFile(targetDir, `${resolvedApp.directory}/shared/ultramodern-build.ts`, createUltramodernBuildModule(scope, resolvedApp));
     writeFile(targetDir, publicWeb.jsonLdHelperFile.path, publicWeb.jsonLdHelperFile.content);
     writeFile(targetDir, publicWeb.routeMetadataFile.path, publicWeb.routeMetadataFile.content);
     writeFile(targetDir, publicWeb.routeHeadFile.path, publicWeb.routeHeadFile.content);

package/dist/esm-node/ultramodern-workspace/demo-components.js

@@ -86,10 +86,12 @@ const createRemoteFallback = (specifier: string) =>
   ({ error }: { error: Error }) => {
     const { t } = useModernI18n();
     const classification = classifyModuleFederationFallback(error);
+    const telemetryEntry =
+      typeof window === 'undefined' ? undefined : window.location.href;
     const telemetry = createModuleFederationFallbackTelemetry({
       appName: '${shellApp.id}',
       classification,
-      entry: typeof window === 'undefined' ? undefined : window.location.href,
+      ...(telemetryEntry === undefined ? {} : { entry: telemetryEntry }),
       error,
       eventName: 'mf.client.remote.fallback',
       exportName: 'default',
@@ -102,7 +104,7 @@ const createRemoteFallback = (specifier: string) =>
       void emitModuleFederationFallbackTelemetry({
         appName: telemetry.appName,
         classification,
-        entry: telemetry.entry,
+        ...(telemetry.entry === undefined ? {} : { entry: telemetry.entry }),
         error,
         eventName: telemetry.eventName,
         exportName: 'default',
@@ -111,7 +113,7 @@ const createRemoteFallback = (specifier: string) =>
         remote: specifier,
         status: 'degraded',
       });
-    }, [classification, error, specifier, telemetry]);
+    }, [classification, error, telemetry]);
 
     return <div className="${tw('rounded-xl border border-red-900/20 bg-red-50 px-4 py-3 text-sm font-semibold text-red-900')}" data-remote-error={error.name} {...toModuleFederationFallbackAttributes(telemetry)}>{t('shell.remoteUnavailable')}</div>;
   };