deprecte event$

Author: sreeisalso

.changeset/hip-lemons-move.md

@@ -0,0 +1,5 @@
+---
+'@builder.io/qwik': patch
+---
+
+Deprecated event$, it will be removed in v2. Instead, use `$()`, and inside the function add `if (isServer) { return; }`

packages/docs/src/components/theme-toggle/theme-toggle.tsx

@@ -1,4 +1,4 @@
-import { component$, event$, useContext, useStyles$ } from '@builder.io/qwik';
+import { component$, $, useContext, useStyles$ } from '@builder.io/qwik';
 import { SunAndMoon } from './sun-and-moon';
 import { themeStorageKey } from '../router-head/theme-script';
 import themeToggle from './theme-toggle.css?inline';
@@ -45,7 +45,7 @@ export const ThemeToggle = component$(() => {
   useStyles$(themeToggle);
   const state = useContext(GlobalStore);
 
-  const onClick$ = event$(() => {
+  const onClick$ = $(() => {
     state.theme = state.theme === 'light' ? 'dark' : 'light';
     setPreference(state.theme);
   });

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

@@ -819,7 +819,7 @@
         }
       ],
       "kind": "Function",
-      "content": "```typescript\nevent$: <T>(qrl: T) => QRL<T>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nqrl\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n\n**Returns:**\n\n[QRL](#qrl)<!-- -->&lt;T&gt;",
+      "content": "> Warning: This API is now obsolete.\n> \n> It will be removed in v2. Instead, use `$()`<!-- -->, and inside the function add `if (isServer) { return; }`\n> \n\n\n```typescript\nevent$: <T>(qrl: T) => QRL<T>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nqrl\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n\n**Returns:**\n\n[QRL](#qrl)<!-- -->&lt;T&gt;",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/qrl/qrl.public.ts",
       "mdFile": "qwik.event_.md"
     },

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

@@ -2176,6 +2176,10 @@ any \| undefined
 
 ## event$
 
+> Warning: This API is now obsolete.
+>
+> It will be removed in v2. Instead, use `$()`, and inside the function add `if (isServer) { return; }`
+
 ```typescript
 event$: <T>(qrl: T) => QRL<T>;
 ```

packages/qwik-city/src/middleware/bun/middleware.bun.api.md

@@ -3,25 +3,27 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+
 import type { ClientConn } from '@builder.io/qwik-city/middleware/request-handler';
 import type { ServerRenderOptions } from '@builder.io/qwik-city/middleware/request-handler';
 
 // @public (undocumented)
 export function createQwikCity(opts: QwikCityBunOptions): {
-  router: (request: Request) => Promise<Response | null>;
-  notFound: (request: Request) => Promise<Response>;
-  staticFile: (request: Request) => Promise<Response | null>;
+    router: (request: Request) => Promise<Response | null>;
+    notFound: (request: Request) => Promise<Response>;
+    staticFile: (request: Request) => Promise<Response | null>;
 };
 
 // @public (undocumented)
 export interface QwikCityBunOptions extends ServerRenderOptions {
-  // (undocumented)
-  getClientConn?: (request: Request) => ClientConn;
-  static?: {
-    root?: string;
-    cacheControl?: string;
-  };
+    // (undocumented)
+    getClientConn?: (request: Request) => ClientConn;
+    static?: {
+        root?: string;
+        cacheControl?: string;
+    };
 }
 
 // (No @packageDocumentation comment for this package)
+
 ```

packages/qwik-city/src/middleware/deno/middleware.deno.api.md

@@ -3,41 +3,43 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+
 import type { ClientConn } from '@builder.io/qwik-city/middleware/request-handler';
 import type { ServerRenderOptions } from '@builder.io/qwik-city/middleware/request-handler';
 
 // @public (undocumented)
 export function createQwikCity(opts: QwikCityDenoOptions): {
-  router: (request: Request, info: ServeHandlerInfo) => Promise<Response | null>;
-  notFound: (request: Request) => Promise<Response>;
-  staticFile: (request: Request) => Promise<Response | null>;
+    router: (request: Request, info: ServeHandlerInfo) => Promise<Response | null>;
+    notFound: (request: Request) => Promise<Response>;
+    staticFile: (request: Request) => Promise<Response | null>;
 };
 
 // @public (undocumented)
 export interface NetAddr {
-  // (undocumented)
-  hostname: string;
-  // (undocumented)
-  port: number;
-  // (undocumented)
-  transport: 'tcp' | 'udp';
+    // (undocumented)
+    hostname: string;
+    // (undocumented)
+    port: number;
+    // (undocumented)
+    transport: 'tcp' | 'udp';
 }
 
 // @public (undocumented)
 export interface QwikCityDenoOptions extends ServerRenderOptions {
-  // (undocumented)
-  getClientConn?: (request: Request, info: ServeHandlerInfo) => ClientConn;
-  static?: {
-    root?: string;
-    cacheControl?: string;
-  };
+    // (undocumented)
+    getClientConn?: (request: Request, info: ServeHandlerInfo) => ClientConn;
+    static?: {
+        root?: string;
+        cacheControl?: string;
+    };
 }
 
 // @public (undocumented)
 export interface ServeHandlerInfo {
-  // (undocumented)
-  remoteAddr: NetAddr;
+    // (undocumented)
+    remoteAddr: NetAddr;
 }
 
 // (No @packageDocumentation comment for this package)
+
 ```

packages/qwik-city/src/runtime/src/service-worker/qwik-city.service-worker.api.md

@@ -3,8 +3,10 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+
 // @public @deprecated (undocumented)
 export const setupServiceWorker: () => void;
 
 // (No @packageDocumentation comment for this package)
+
 ```

packages/qwik-city/src/runtime/src/spa-init.ts

@@ -2,8 +2,8 @@ import type { ClientSPAWindow } from './qwik-city-component';
 import type { ScrollHistoryState } from './scroll-restoration';
 import type { ScrollState } from './types';
 
-import { isDev } from '@builder.io/qwik';
-import { event$ } from '@builder.io/qwik';
+import { isDev, isServer } from '@builder.io/qwik';
+import { $ } from '@builder.io/qwik';
 
 // TODO Dedupe handler code from here and QwikCityProvider?
 // TODO Navigation API; check for support & simplify.
@@ -14,13 +14,18 @@ import { event$ } from '@builder.io/qwik';
 // - Robust, fully relies only on history. (scrollRestoration = 'manual')
 
 // ! DO NOT IMPORT OR USE ANY EXTERNAL REFERENCES IN THIS SCRIPT.
-export default event$((_: Event, el: Element) => {
+export default $((_: Event, el: Element) => {
   const win: ClientSPAWindow = window;
   const spa = '_qCitySPA';
   const initPopstate = '_qCityInitPopstate';
   const initAnchors = '_qCityInitAnchors';
   const initVisibility = '_qCityInitVisibility';
   const initScroll = '_qCityInitScroll';
+
+  if (isServer) {
+    return;
+  }
+
   if (
     !win[spa] &&
     !win[initPopstate] &&

packages/qwik-city/src/static/qwik-city.static.api.md

@@ -3,6 +3,7 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+
 /// <reference types="node" />
 
 import type { RenderOptions } from '@builder.io/qwik/server';
@@ -12,39 +13,40 @@ export function generate(opts: StaticGenerateOptions): Promise<StaticGenerateRes
 
 // @public (undocumented)
 export interface StaticGenerateOptions extends StaticGenerateRenderOptions {
-  basePathname?: string;
-  qwikCityPlanModulePath: string;
-  renderModulePath: string;
-  // (undocumented)
-  rootDir?: string;
+    basePathname?: string;
+    qwikCityPlanModulePath: string;
+    renderModulePath: string;
+    // (undocumented)
+    rootDir?: string;
 }
 
 // @public (undocumented)
 export interface StaticGenerateRenderOptions extends RenderOptions {
-  emit404Pages?: boolean;
-  emitData?: boolean;
-  emitHtml?: boolean;
-  exclude?: string[];
-  include?: string[];
-  log?: 'debug';
-  maxTasksPerWorker?: number;
-  maxWorkers?: number;
-  origin: string;
-  outDir: string;
-  sitemapOutFile?: string | null;
+    emit404Pages?: boolean;
+    emitData?: boolean;
+    emitHtml?: boolean;
+    exclude?: string[];
+    include?: string[];
+    log?: 'debug';
+    maxTasksPerWorker?: number;
+    maxWorkers?: number;
+    origin: string;
+    outDir: string;
+    sitemapOutFile?: string | null;
 }
 
 // @public (undocumented)
 export interface StaticGenerateResult {
-  // (undocumented)
-  duration: number;
-  // (undocumented)
-  errors: number;
-  // (undocumented)
-  rendered: number;
-  // (undocumented)
-  staticPaths: string[];
+    // (undocumented)
+    duration: number;
+    // (undocumented)
+    errors: number;
+    // (undocumented)
+    rendered: number;
+    // (undocumented)
+    staticPaths: string[];
 }
 
 // (No @packageDocumentation comment for this package)
+
 ```

packages/qwik/src/build/qwik.build.api.md

@@ -3,6 +3,7 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+
 // @public
 export const isBrowser: boolean;
 
@@ -13,4 +14,5 @@ export const isDev: boolean;
 export const isServer: boolean;
 
 // (No @packageDocumentation comment for this package)
+
 ```