docs(angular-query): add basic persister example

examples/angular/basic-persister/.devcontainer/devcontainer.json

@@ -0,0 +1,4 @@
+{
+  "name": "Node.js",
+  "image": "mcr.microsoft.com/devcontainers/javascript-node:18"
+}

examples/angular/basic-persister/.eslintrc.cjs

@@ -0,0 +1,6 @@
+// @ts-check
+
+/** @type {import('eslint').Linter.Config} */
+const config = {}
+
+module.exports = config

examples/angular/basic-persister/README.md

@@ -0,0 +1,6 @@
+# TanStack Query Angular basic example
+
+To run this example:
+
+- `npm install` or `yarn` or `pnpm i` or `bun i`
+- `npm run start` or `yarn start` or `pnpm start` or `bun start`

examples/angular/basic-persister/angular.json

@@ -0,0 +1,104 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "cli": {
+    "packageManager": "pnpm",
+    "analytics": false,
+    "cache": {
+      "enabled": false
+    }
+  },
+  "newProjectRoot": "projects",
+  "projects": {
+    "basic": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "inlineTemplate": true,
+          "inlineStyle": true,
+          "skipTests": true
+        },
+        "@schematics/angular:class": {
+          "skipTests": true
+        },
+        "@schematics/angular:directive": {
+          "skipTests": true
+        },
+        "@schematics/angular:guard": {
+          "skipTests": true
+        },
+        "@schematics/angular:interceptor": {
+          "skipTests": true
+        },
+        "@schematics/angular:pipe": {
+          "skipTests": true
+        },
+        "@schematics/angular:resolver": {
+          "skipTests": true
+        },
+        "@schematics/angular:service": {
+          "skipTests": true
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:application",
+          "options": {
+            "outputPath": "dist/basic",
+            "index": "src/index.html",
+            "browser": "src/main.ts",
+            "polyfills": ["zone.js"],
+            "tsConfig": "tsconfig.app.json",
+            "assets": ["src/favicon.ico", "src/assets"],
+            "styles": [],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kb",
+                  "maximumError": "1mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "configurations": {
+            "production": {
+              "buildTarget": "basic:build:production"
+            },
+            "development": {
+              "buildTarget": "basic:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "buildTarget": "basic:build"
+          }
+        }
+      }
+    }
+  }
+}

examples/angular/basic-persister/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tanstack/query-example-angular-basic-persister",
+  "type": "module",
+  "scripts": {
+    "ng": "ng",
+    "start": "ng serve",
+    "build": "ng build",
+    "watch": "ng build --watch --configuration development"
+  },
+  "private": true,
+  "dependencies": {
+    "@angular/common": "^17.3.12",
+    "@angular/compiler": "^17.3.12",
+    "@angular/core": "^17.3.12",
+    "@angular/platform-browser": "^17.3.12",
+    "@angular/platform-browser-dynamic": "^17.3.12",
+    "@tanstack/angular-query-experimental": "^5.60.5",
+    "@tanstack/angular-query-persist-client-experimental": "^5.60.5",
+    "@tanstack/query-sync-storage-persister": "^5.60.6",
+    "rxjs": "^7.8.1",
+    "tslib": "^2.6.3",
+    "zone.js": "^0.14.8"
+  },
+  "devDependencies": {
+    "@angular-devkit/build-angular": "^17.3.8",
+    "@angular/cli": "^17.3.8",
+    "@angular/compiler-cli": "^17.3.12",
+    "typescript": "5.3.3"
+  }
+}

examples/angular/basic-persister/src/app/app.component.html

@@ -0,0 +1,10 @@
+<p>
+    Try to mock offline behavior with the button in the devtools. You can
+    navigate around as long as there is already data in the cache. You'll get
+    a refetch as soon as you go "online" again.
+</p>
+@if (postId() > -1) {
+  <post [postId]="postId()" (setPostId)="postId.set($event)"></post>
+} @else {
+  <posts (setPostId)="postId.set($event)" />
+}

examples/angular/basic-persister/src/app/app.component.ts

@@ -0,0 +1,14 @@
+import { ChangeDetectionStrategy, Component, signal } from '@angular/core'
+import { PostComponent } from './components/post.component'
+import { PostsComponent } from './components/posts.component'
+
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'basic-example',
+  standalone: true,
+  templateUrl: './app.component.html',
+  imports: [PostComponent, PostsComponent],
+})
+export class BasicExampleComponent {
+  postId = signal(-1)
+}

examples/angular/basic-persister/src/app/app.config.ts

@@ -0,0 +1,37 @@
+import { provideHttpClient, withFetch } from '@angular/common/http'
+import {
+  QueryClient,
+  provideTanStackQuery,
+  withDevtools,
+} from '@tanstack/angular-query-experimental'
+import { withPersistQueryClient } from '@tanstack/angular-query-persist-client-experimental'
+import { createSyncStoragePersister } from '@tanstack/query-sync-storage-persister'
+import type { ApplicationConfig } from '@angular/core'
+
+const localStoragePersister = createSyncStoragePersister({
+  storage: window.localStorage,
+})
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    provideHttpClient(withFetch()),
+    provideTanStackQuery(
+      new QueryClient({
+        defaultOptions: {
+          queries: {
+            staleTime: 1000 * 60,
+            gcTime: 1000 * 60 * 60 * 24, // 24 hours
+          },
+        },
+      }),
+      withDevtools(),
+      withPersistQueryClient([
+        {
+          persistOptions: {
+            persister: localStoragePersister,
+          },
+        },
+      ]),
+    ),
+  ],
+}

examples/angular/basic-persister/src/app/components/post.component.html

@@ -0,0 +1,19 @@
+<div>
+  <div>
+    <a (click)="setPostId.emit(-1)" href="#"> Back </a>
+  </div>
+  @if (postQuery.isPending()) {
+    Loading...
+  } @else if (postQuery.isError()) {
+    Error: {{ postQuery.error().message }}
+  }
+  @if (postQuery.data(); as post) {
+    <h1>{{ post.title }}</h1>
+    <div>
+      <p>{{ post.body }}</p>
+    </div>
+    @if (postQuery.isFetching()) {
+      Background Updating...
+    }
+  }
+</div>

examples/angular/basic-persister/src/app/components/post.component.ts

@@ -0,0 +1,39 @@
+import {
+  ChangeDetectionStrategy,
+  Component,
+  EventEmitter,
+  Output,
+  inject,
+  input,
+} from '@angular/core'
+import { QueryClient, injectQuery } from '@tanstack/angular-query-experimental'
+import { fromEvent, lastValueFrom, takeUntil } from 'rxjs'
+import { PostsService } from '../services/posts-service'
+
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'post',
+  standalone: true,
+  templateUrl: './post.component.html',
+})
+export class PostComponent {
+  #postsService = inject(PostsService)
+
+  @Output() setPostId = new EventEmitter<number>()
+
+  postId = input(0)
+
+  postQuery = injectQuery(() => ({
+    enabled: this.postId() > 0,
+    queryKey: ['post', this.postId()],
+    queryFn: async (context) => {
+      // Cancels the request when component is destroyed before the request finishes
+      const abort$ = fromEvent(context.signal, 'abort')
+      return lastValueFrom(
+        this.#postsService.postById$(this.postId()).pipe(takeUntil(abort$)),
+      )
+    },
+  }))
+
+  queryClient = inject(QueryClient)
+}

examples/angular/basic-persister/src/app/components/posts.component.html

@@ -0,0 +1,39 @@
+<div>
+  <h1>Posts</h1>
+  @switch (postsQuery.status()) {
+    @case ('pending') {
+      Loading...
+    }
+    @case ('error') {
+      Error: {{ postsQuery.error()?.message }}
+    }
+    @default {
+      <div class="todo-container">
+        @for (post of postsQuery.data(); track post.id) {
+          <p>
+            <!--          We can access the query data here to show bold links for-->
+            <!--          ones that are cached-->
+            <a
+              href="#"
+              (click)="setPostId.emit(post.id)"
+              [style]="
+                queryClient.getQueryData(['post', post.id])
+                  ? {
+                      fontWeight: 'bold',
+                      color: 'green',
+                    }
+                  : {}
+              "
+              >{{ post.title }}</a
+            >
+          </p>
+        }
+      </div>
+    }
+  }
+  <div>
+    @if (postsQuery.isFetching()) {
+      Background Updating...
+    }
+  </div>
+</div>

examples/angular/basic-persister/src/app/components/posts.component.ts

@@ -0,0 +1,28 @@
+import {
+  ChangeDetectionStrategy,
+  Component,
+  EventEmitter,
+  Output,
+  inject,
+} from '@angular/core'
+import { QueryClient, injectQuery } from '@tanstack/angular-query-experimental'
+import { lastValueFrom } from 'rxjs'
+import { PostsService } from '../services/posts-service'
+
+@Component({
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  selector: 'posts',
+  standalone: true,
+  templateUrl: './posts.component.html',
+})
+export class PostsComponent {
+  queryClient = inject(QueryClient)
+  #postsService = inject(PostsService)
+
+  @Output() setPostId = new EventEmitter<number>()
+
+  postsQuery = injectQuery(() => ({
+    queryKey: ['posts'],
+    queryFn: () => lastValueFrom(this.#postsService.allPosts$()),
+  }))
+}

examples/angular/basic-persister/src/app/services/posts-service.ts

@@ -0,0 +1,21 @@
+import { HttpClient } from '@angular/common/http'
+import { Injectable, inject } from '@angular/core'
+
+@Injectable({
+  providedIn: 'root',
+})
+export class PostsService {
+  #http = inject(HttpClient)
+
+  postById$ = (postId: number) =>
+    this.#http.get<Post>(`https://jsonplaceholder.typicode.com/posts/${postId}`)
+
+  allPosts$ = () =>
+    this.#http.get<Array<Post>>('https://jsonplaceholder.typicode.com/posts')
+}
+
+export interface Post {
+  id: number
+  title: string
+  body: string
+}

examples/angular/basic-persister/src/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>TanStack Query Angular basic example</title>
+    <base href="/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
+  </head>
+  <body>
+    <basic-example></basic-example>
+  </body>
+</html>

examples/angular/basic-persister/src/main.ts

@@ -0,0 +1,7 @@
+import { bootstrapApplication } from '@angular/platform-browser'
+import { appConfig } from './app/app.config'
+import { BasicExampleComponent } from './app/app.component'
+
+bootstrapApplication(BasicExampleComponent, appConfig).catch((err) =>
+  console.error(err),
+)