feat(core): getClientManifest()

Part of the effort to make external qwik libraries independent from the build process

Author: wmertens

.changeset/modern-emus-share.md

@@ -0,0 +1,5 @@
+---
+'@qwik.dev/core': minor
+---
+
+FEAT: `getClientManifest()` is now the way to get the client build manifest. Importing from `@qwik-client-manifest` is deprecated.

packages/docs/src/routes/api/qwik/api.json

@@ -731,6 +731,20 @@
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-node.ts",
       "mdFile": "core.functioncomponent.md"
     },
+    {
+      "name": "getClientManifest",
+      "id": "getclientmanifest",
+      "hierarchy": [
+        {
+          "name": "getClientManifest",
+          "id": "getclientmanifest"
+        }
+      ],
+      "kind": "Function",
+      "content": "Returns the client build manifest, which includes the mappings from symbols to bundles, the bundlegraph etc.\n\n\n```typescript\ngetClientManifest: () => ServerQwikManifest\n```\n**Returns:**\n\nServerQwikManifest",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/get-client-manifest.ts",
+      "mdFile": "core.getclientmanifest.md"
+    },
     {
       "name": "getDomContainer",
       "id": "getdomcontainer",

packages/docs/src/routes/api/qwik/index.mdx

@@ -1655,6 +1655,20 @@ export type FunctionComponent<P = unknown> = {
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/jsx/types/jsx-node.ts)
 
+## getClientManifest
+
+Returns the client build manifest, which includes the mappings from symbols to bundles, the bundlegraph etc.
+
+```typescript
+getClientManifest: () => ServerQwikManifest;
+```
+
+**Returns:**
+
+ServerQwikManifest
+
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/shared/get-client-manifest.ts)
+
 ## getDomContainer
 
 ```typescript

packages/insights/tsconfig.json

@@ -19,8 +19,7 @@
     "noEmit": true,
     "types": ["node", "vite/client"],
     "paths": {
-      "~/*": ["./src/*"],
-      "@qwik-client-manifest": ["../../qwik/src/server/server-modules.d.ts"]
+      "~/*": ["./src/*"]
     }
   },
   "exclude": ["./dist", "eslint.config.mjs"]

packages/qwik-router/src/buildtime/vite/plugin.ts

@@ -24,6 +24,10 @@ import { validatePlugin } from './validate-plugin';
 import { getRouterIndexTags, makeRouterDevMiddleware } from './dev-middleware';
 
 export const QWIK_ROUTER_CONFIG_ID = '@qwik-router-config';
+/**
+ * This virtual module is used to generate dynamic entries for user route files, which are added as
+ * dynamic imports to the qwik-router-config as a way to create new entry points for the build.
+ */
 const QWIK_ROUTER_ENTRIES_ID = '@qwik-router-entries';
 const QWIK_ROUTER = '@qwik.dev/router';
 const QWIK_ROUTER_SW_REGISTER = '@qwik-router-sw-register';

packages/qwik/src/core/index.ts

@@ -58,6 +58,7 @@ export { getPlatform, setPlatform } from './shared/platform/platform';
 export type { CorePlatform } from './shared/platform/types';
 export type { ClientContainer } from './client/types';
 export type { DomContainer } from './client/dom-container';
+export { getClientManifest } from './shared/get-client-manifest';
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // JSX Runtime

packages/qwik/src/core/qwik.core.api.md

@@ -8,6 +8,7 @@ import * as CSS_2 from 'csstype';
 import { isBrowser } from '@qwik.dev/core/build';
 import { isDev } from '@qwik.dev/core/build';
 import { isServer } from '@qwik.dev/core/build';
+import type { ServerQwikManifest } from '@qwik.dev/core/optimizer';
 
 // @public
 export const $: <T>(expression: T) => QRL<T>;
@@ -398,6 +399,9 @@ export type FunctionComponent<P = unknown> = {
     renderFn(props: P, key: string | null, flags: number, dev?: DevJSX): JSXOutput;
 }['renderFn'];
 
+// @public
+export const getClientManifest: () => ServerQwikManifest;
+
 // Warning: (ae-forgotten-export) The symbol "PropsProxy" needs to be exported by the entry point index.d.ts
 //
 // @internal

packages/qwik/src/core/shared/get-client-manifest.ts

@@ -0,0 +1,10 @@
+import { manifest } from '@qwik-client-manifest';
+import type { ServerQwikManifest } from '@qwik.dev/core/optimizer';
+
+/**
+ * Returns the client build manifest, which includes the mappings from symbols to bundles, the
+ * bundlegraph etc.
+ *
+ * @public
+ */
+export const getClientManifest = (): ServerQwikManifest => manifest;

packages/qwik/src/optimizer/src/plugins/plugin.ts

@@ -539,6 +539,11 @@ export function createQwikPlugin(optimizerOptions: OptimizerOptions = {}) {
         };
       }
     } else if (pathId.endsWith(QWIK_CLIENT_MANIFEST_ID)) {
+      if (!importerId || !importerId.includes('core')) {
+        console.error(
+          `${importerId}: importing ${QWIK_CLIENT_MANIFEST_ID} is deprecated. Use \`getClientManifest()\` instead.`
+        );
+      }
       debug(`resolveId(${count})`, 'Resolved', QWIK_CLIENT_MANIFEST_ID);
       result = {
         id: QWIK_CLIENT_MANIFEST_ID,
@@ -1207,10 +1212,11 @@ export const QWIK_JSX_DEV_RUNTIME_ID = '@qwik.dev/core/jsx-dev-runtime';
 
 export const QWIK_CORE_SERVER = '@qwik.dev/core/server';
 
+/** Internal use only - use `getClientManifest()` instead */
 export const QWIK_CLIENT_MANIFEST_ID = '@qwik-client-manifest';
 
 export const QWIK_PRELOADER_ID = '@qwik.dev/core/preloader';
-
+/** @internal virtual import to ensure the _run etc handlers are exported as-is */
 export const QWIK_HANDLERS_ID = '@qwik-handlers';
 
 export const SRC_DIR_DEFAULT = 'src';

packages/qwik/src/optimizer/src/plugins/plugin.unit.ts

@@ -296,7 +296,7 @@ describe('resolveId', () => {
       'id',
       '@qwik.dev/core/build'
     );
-    expect(await plugin.resolveId(null!, '@qwik-client-manifest', '/foo/bar')).toHaveProperty(
+    expect(await plugin.resolveId(null!, '@qwik-client-manifest', '/foo/bar/core')).toHaveProperty(
       'id',
       '@qwik-client-manifest'
     );