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

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

@@ -37,27 +37,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: ReadonlyArray<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.Schema<CheckoutCartLine> = Schema.Struct({
   sku: Schema.String,
   name: Schema.String,
   quantity: Schema.Finite,
   unitPriceCents: Schema.Finite,
 });
 
-export const checkoutCartSchema = Schema.Struct({
+export const checkoutCartSchema: Schema.Schema<CheckoutCart> = Schema.Struct({
   lines: Schema.Array(checkoutCartLineSchema),
   subtotalCents: Schema.Finite,
   totalQuantity: Schema.Finite,
 });
 
-export const checkoutAddCartItemPayloadSchema = Schema.Struct({
+export const checkoutAddCartItemPayloadSchema: Schema.Schema<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.Schema<CheckoutRemoveCartItemPayload> = Schema.Struct({
   sku: Schema.String,
 });
 `;
@@ -210,6 +234,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;
@@ -233,7 +258,7 @@ export interface CheckoutAddCartItemInput {
 
 export const getCheckoutCart = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -245,7 +270,7 @@ export const getCheckoutCart = (
 export const addCheckoutCartItem = (
   payload: CheckoutAddCartItemInput,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -259,7 +284,7 @@ export const addCheckoutCartItem = (
 export const removeCheckoutCartItem = (
   sku: string,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -272,7 +297,7 @@ export const removeCheckoutCartItem = (
 
 export const clearCheckoutCart = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<CheckoutCart> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -303,12 +328,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: ReadonlyArray<${itemType}>;
+}
+
+export interface ${createResponseType} {
+  readonly item: ${itemType};
+}
+
+export interface ${notFoundErrorExport} {
+  readonly _tag: '${notFoundErrorExport}';
+  readonly id: string;
+}
+
+export const ${markerSchemaExport}: Schema.Schema<${markerType}> = Schema.Struct({
   appId: Schema.String,
   build: Schema.String,
   deployProfile: Schema.String,
@@ -317,13 +393,13 @@ function createEffectSharedApiContract(service) {
   version: Schema.String,
 });
 
-export const ${schemaExport} = Schema.Struct({
+export const ${schemaExport}: Schema.Schema<${itemType}> = Schema.Struct({
   id: Schema.String,
   marker: ${markerSchemaExport},
   title: Schema.String,
 });
 
-export const ${readinessSchemaExport} = Schema.Struct({
+export const ${readinessSchemaExport}: Schema.Schema<${readinessType}> = Schema.Struct({
   checks: Schema.Struct({
     effectBff: Schema.Literal('ready'),
     moduleFederation: Schema.Literal('ready'),
@@ -335,18 +411,13 @@ export const ${readinessSchemaExport} = Schema.Struct({
   versionSkew: Schema.Literal('none'),
 });
 
-export const ${createPayloadSchemaExport} = Schema.Struct({
+export const ${createPayloadSchemaExport}: Schema.Schema<${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.Schema<${notFoundErrorExport}> = Schema.TaggedStruct('${notFoundErrorExport}', {
+  id: Schema.String,
+}).pipe(
   HttpApiSchema.status(404),
 );
 
@@ -450,13 +521,20 @@ function createEffectServiceEntry(service, contractImportPath) {
   HttpApiBuilder,
   Layer,
 } from '@modern-js/plugin-bff/effect-edge';
+import type {
+  EffectBffDefinition,
+  EffectBffRuntime,
+  EffectRuntimeLayer,
+} from '@modern-js/plugin-bff/effect-edge';
 import { ultramodernApiMarker } from '../../src/ultramodern-build.ts';
 import {
   ${apiExport},
   ${groupName}OperationContexts,
+} from '${contractImportPath}';
+import type {
   ${notFoundErrorExport},
+  OperationContext,
 } from '${contractImportPath}';
-import type { OperationContext } from '${contractImportPath}';
 
 const ${groupName}Items = [
   {
@@ -517,9 +595,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(
@@ -550,12 +632,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) {
@@ -566,25 +651,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;
@@ -594,7 +725,7 @@ export interface ${clientOptionsName} {
 
 export const ${createClientName} = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${clientTypeName}> =>
   makeEffectHttpApiClient(${apiExport}, {
     baseUrl: options.baseUrl ?? ${contractExport}ApiContract.apiPrefix,
     requestContext: {
@@ -610,7 +741,7 @@ export const ${createClientName} = (
 
 export const ${listName} = (
   options: ${clientOptionsName} & { limit?: number } = {},
-) =>
+): ${clientEffectTypeName}<${listResponseType}> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -623,7 +754,7 @@ export const ${listName} = (
 
 export const ${readinessName} = (
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${readinessType}> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -635,7 +766,7 @@ export const ${readinessName} = (
 export const ${getName} = (
   id: string,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${itemType}> =>
   ${createClientName}({
     ...options,
     operationContext:
@@ -647,7 +778,7 @@ export const ${getName} = (
 export const ${createName} = (
   title: string,
   options: ${clientOptionsName} = {},
-) =>
+): ${clientEffectTypeName}<${createResponseType}> =>
   ${createClientName}({
     ...options,
     operationContext:

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

@@ -218,12 +218,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,
@@ -343,7 +343,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,
   },
@@ -361,6 +363,8 @@ export default createModuleFederationConfig({
 ${createModuleFederationRemotesConfig(scope, shellHost, remotes)}${createSharedModuleFederationConfig()},
   treeShakingSharedExcludePlugins: ['RspackModuleFederationPlugin'],
 });
+
+export default moduleFederationConfig;
 `;
 }
 function createBuildMarker(scope, app) {
@@ -401,7 +405,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,
   },
@@ -420,6 +426,8 @@ export default createModuleFederationConfig({
 ${createModuleFederationRemotesConfig(scope, app, remotes)}${createSharedModuleFederationConfig()},
   treeShakingSharedExcludePlugins: ['RspackModuleFederationPlugin'],
 });
+
+export default moduleFederationConfig;
 `;
 }
 export { createAppModernConfig, createBuildMarker, createModuleFederationRemoteUrlHelpers, createModuleFederationRemotesConfig, createRemoteModuleFederationConfig, createSharedModuleFederationConfig, createShellModuleFederationConfig, createUltramodernBuildModule, formatTsObjectLiteral };

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

@@ -256,6 +256,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)
@@ -269,8 +273,10 @@ 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'
     ];
     if (resolvedOptions.includeApi) include.push('api', 'shared');
     const references = createReferences(packageDir, resolvedOptions.references ?? []);
@@ -278,7 +284,12 @@ function createPackageTsConfig(packageDir, options = {}) {
         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/package.json

@@ -21,7 +21,7 @@
   "engines": {
     "node": ">=20"
   },
-  "version": "3.4.0-ultramodern.3",
+  "version": "3.4.0-ultramodern.4",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/esm-node/index.js",
   "bin": {
@@ -75,7 +75,7 @@
   ],
   "dependencies": {
     "@modern-js/codesmith": "2.6.9",
-    "@modern-js/i18n-utils": "npm:@bleedingdev/modern-js-i18n-utils@3.4.0-ultramodern.3"
+    "@modern-js/i18n-utils": "npm:@bleedingdev/modern-js-i18n-utils@3.4.0-ultramodern.4"
   },
   "devDependencies": {
     "@rslib/core": "0.23.0",
@@ -97,6 +97,6 @@
     "test": "rm -rf dist && rslib build -c rslibconfig.mts && rstest --passWithNoTests"
   },
   "ultramodern": {
-    "frameworkVersion": "3.4.0-ultramodern.3"
+    "frameworkVersion": "3.4.0-ultramodern.4"
   }
 }

package/templates/app/ultramodern-route-head.tsx.handlebars

@@ -143,9 +143,9 @@ export const UltramodernRouteHead = () => {
           <meta content="summary_large_image" name="twitter:card" />
           <meta content={title} name="twitter:title" />
           <meta content={description} name="twitter:description" />
-          {jsonLd !== undefined ? (
+          {jsonLd === undefined ? null : (
             <script type="application/ld+json">{sanitiseJsonLd(jsonLd)}</script>
-          ) : null}
+          )}
         </>
       )}
     </Helmet>

package/templates/workspace-scripts/validate-ultramodern-workspace.mjs.handlebars

@@ -398,6 +398,24 @@ const sharedPackagePaths = [
   'packages/shared-contracts',
   'packages/shared-design-tokens',
 ];
+const tsgoCacheKey = packagePath => packagePath.replace(/[^a-zA-Z0-9._-]+/gu, '__');
+const assertProjectReferenceEmitConfig = (tsConfig, packagePath) => {
+  const compilerOptions = tsConfig.compilerOptions ?? {};
+  const relativeRoot = toPosixPath(path.relative(packagePath, '.')) || '.';
+  assert(compilerOptions.composite === true, `${packagePath} must stay a composite TS-Go project`);
+  assert(compilerOptions.declaration === true, `${packagePath} must emit declarations for TS-Go build mode`);
+  assert(compilerOptions.declarationMap === false, `${packagePath} must not emit declaration maps during checks`);
+  assert(compilerOptions.emitDeclarationOnly === true, `${packagePath} must only emit declarations during checks`);
+  assert(compilerOptions.noEmit === false, `${packagePath} must override root noEmit for TS-Go build mode`);
+  assert(
+    compilerOptions.outDir === `${relativeRoot}/node_modules/.cache/tsgo/declarations/${tsgoCacheKey(packagePath)}`,
+    `${packagePath} must emit TS-Go declarations into the generated cache`,
+  );
+  assert(
+    compilerOptions.tsBuildInfoFile === `${relativeRoot}/node_modules/.cache/tsgo/${tsgoCacheKey(packagePath)}.tsbuildinfo`,
+    `${packagePath} must keep TS-Go build info in the generated cache`,
+  );
+};
 const assertTsConfigReferenceGraph = () => {
   const rootTsConfig = readJson('tsconfig.json');
   const shellTsConfig = readJson('apps/shell-super-app/tsconfig.json');
@@ -431,6 +449,16 @@ const assertTsConfigReferenceGraph = () => {
     'apps/shell-super-app/tsconfig.json references',
     'restore the generated shell project-reference graph',
   );
+  assertProjectReferenceEmitConfig(
+    shellTsConfig,
+    'apps/shell-super-app',
+  );
+  for (const sharedPackagePath of sharedPackagePaths) {
+    assertProjectReferenceEmitConfig(
+      readJson(`${sharedPackagePath}/tsconfig.json`),
+      sharedPackagePath,
+    );
+  }
 
   for (const vertical of fullStackVerticals) {
     const verticalTsConfig = readJson(`${vertical.path}/tsconfig.json`);
@@ -449,6 +477,7 @@ const assertTsConfigReferenceGraph = () => {
       `${vertical.path}/tsconfig.json references`,
       'restore the generated MicroVertical project-reference graph',
     );
+    assertProjectReferenceEmitConfig(verticalTsConfig, vertical.path);
   }
 };
 const packageJsonFiles = startDir => {