Fix session type after changing Customer Account client

.changeset/twenty-taxis-taste.md

@@ -0,0 +1,22 @@
+---
+'skeleton': patch
+---
+
+Fix types returned by the `session` object.
+In `remix.env.d.ts` or `env.d.ts`, add the following types:
+
+```diff
+import type {
+  // ...
+  HydrogenCart,
++ HydrogenSessionData,
+} from '@shopify/hydrogen';
+
+// ...
+
+declare module '@shopify/remix-oxygen' {
+  // ...
+
++ interface SessionData extends HydrogenSessionData {}
+}
+```

examples/custom-cart-method/remix.env.d.ts

@@ -10,6 +10,7 @@ import type {
   CustomerAccount,
   HydrogenCart,
   HydrogenCartCustom,
+  HydrogenSessionData,
   CartQueryDataReturn,
 } from '@shopify/hydrogen';
 import type {
@@ -42,7 +43,7 @@ declare module '@shopify/remix-oxygen' {
   /**
    * Declare local additions to the Remix loader context.
    */
-  export interface AppLoadContext {
+  interface AppLoadContext {
     env: Env;
     /***********************************************/
     /**********  EXAMPLE UPDATE STARTS  ************/
@@ -60,4 +61,9 @@ declare module '@shopify/remix-oxygen' {
     session: AppSession;
     waitUntil: ExecutionContext['waitUntil'];
   }
+
+  /**
+   * Declare local additions to the Remix session data.
+   */
+  interface SessionData extends HydrogenSessionData {}
 }

examples/metaobjects/remix.env.d.ts

@@ -9,6 +9,7 @@ import type {
   Storefront,
   CustomerAccount,
   HydrogenCart,
+  HydrogenSessionData,
 } from '@shopify/hydrogen';
 import type {AppSession} from '~/lib/session';
 
@@ -41,12 +42,17 @@ declare module '@shopify/remix-oxygen' {
   /**
    * Declare local additions to the Remix loader context.
    */
-  export interface AppLoadContext {
+  interface AppLoadContext {
     env: Env;
     cart: HydrogenCart;
     storefront: Storefront;
     customerAccount: CustomerAccount;
     session: AppSession;
     waitUntil: ExecutionContext['waitUntil'];
   }
+
+  /**
+   * Declare local additions to the Remix session data.
+   */
+  interface SessionData extends HydrogenSessionData {}
 }

examples/third-party-queries-caching/remix.env.d.ts

@@ -9,6 +9,7 @@ import type {
   Storefront,
   CustomerAccount,
   HydrogenCart,
+  HydrogenSessionData,
 } from '@shopify/hydrogen';
 import type {AppSession} from '~/lib/session';
 import {createRickAndMortyClient} from './app/lib/createRickAndMortyClient.server';
@@ -46,4 +47,9 @@ declare module '@shopify/remix-oxygen' {
     session: AppSession;
     waitUntil: ExecutionContext['waitUntil'];
   }
+
+  /**
+   * Declare local additions to the Remix session data.
+   */
+  interface SessionData extends HydrogenSessionData {}
 }

examples/vite/env.d.ts

@@ -9,6 +9,7 @@ import type {
   Storefront,
   CustomerAccount,
   HydrogenCart,
+  HydrogenSessionData,
 } from '@shopify/hydrogen';
 import type {AppSession} from '~/lib/session';
 
@@ -36,12 +37,17 @@ declare module '@shopify/remix-oxygen' {
   /**
    * Declare local additions to the Remix loader context.
    */
-  export interface AppLoadContext {
+  interface AppLoadContext {
     env: Env;
     cart: HydrogenCart;
     storefront: Storefront;
     customerAccount: CustomerAccount;
     session: AppSession;
     waitUntil: ExecutionContext['waitUntil'];
   }
+
+  /**
+   * Declare local additions to the Remix session data.
+   */
+  interface SessionData extends HydrogenSessionData {}
 }

packages/cli/src/lib/transpile/morph/typedefs.ts

@@ -54,20 +54,24 @@ export function generateTypeDefs(sourceFile: SourceFile, code: string) {
 
   typedefs.push(''); // New line
 
+  const knownGenerics: Record<string, string | undefined> = {
+    MetaFunction: 'T',
+  };
+
   typedefsFromImports.forEach((typeElements, moduleSpecifier) => {
     for (const typeElement of typeElements) {
       // We only use this in root.tsx and it's better to
       // reuse the existing LoaderReturnData, so skip it.
       if (typeElement === 'SerializeFrom') continue;
 
       // Note: SerializeFrom also needs generic if we stop skipping it.
-      const hasGeneric = typeElement === 'MetaFunction';
+      const hasGeneric = !!knownGenerics[typeElement];
 
       typedefs.push(
         `/** ${
-          hasGeneric ? '@template T ' : ''
+          hasGeneric ? `@template ${knownGenerics[typeElement]} ` : ''
         }@typedef {import('${moduleSpecifier}').${typeElement}${
-          hasGeneric ? '<T>' : ''
+          hasGeneric ? `<${knownGenerics[typeElement]}>` : ''
         }} ${typeElement} */`,
       );
     }

templates/skeleton/remix.env.d.ts

@@ -9,6 +9,7 @@ import type {
   Storefront,
   CustomerAccount,
   HydrogenCart,
+  HydrogenSessionData,
 } from '@shopify/hydrogen';
 import type {AppSession} from '~/lib/session';
 
@@ -36,12 +37,17 @@ declare module '@shopify/remix-oxygen' {
   /**
    * Declare local additions to the Remix loader context.
    */
-  export interface AppLoadContext {
+  interface AppLoadContext {
     env: Env;
     cart: HydrogenCart;
     storefront: Storefront;
     customerAccount: CustomerAccount;
     session: AppSession;
     waitUntil: ExecutionContext['waitUntil'];
   }
+
+  /**
+   * Declare local additions to the Remix session data.
+   */
+  interface SessionData extends HydrogenSessionData {}
 }